Api

class Api : KotlinCustomResource

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the name query parameter to the name of the API proxy. * Set the action query parameter to import. * Set the Content-Type header to multipart/form-data. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

Properties

Link copied to clipboard
val action: Output<String>?

Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.

Link copied to clipboard
val apiProxyType: Output<String>

The type of the API proxy.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val labels: Output<Map<String, String>>

User labels applied to this API Proxy.

Link copied to clipboard

The id of the most recently created revision for this api proxy.

Link copied to clipboard

Metadata describing the API proxy.

Link copied to clipboard
val name: Output<String>

Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-

Link copied to clipboard
val organizationId: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val readOnly: Output<Boolean>

Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.

Link copied to clipboard
val revision: Output<List<String>>

List of revisions defined for the API proxy.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val validate: Output<Boolean>?

Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.