Extensions API

Add, update, and configure extensions in your Apigee organization.

Extensions enable you to integrate external resources into your API proxies. For example, you could integrate Google Cloud Platform services such as Google Cloud Storage. At run time, an API proxy uses the extension to exchange requests and responses with the external resource.

Note that you must authenticate with this API using an OAuth token; basic authentication is not supported. For more about retrieving a token, see Using get_token.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/, unless otherwise noted.

APIResponse

For more information, see APIResponse.
No methods use this type.

CollectionResponse

For more information, see CollectionResponse.
No methods use this type.

ErrorResponse

For more information, see ErrorResponse.
MethodEndpointDescription
get/extensionpackages

Gets public extension packages using the query parameters to search for specific values. To get a list of all extension packages, don't specify any search values. When you get a collection, each item in the collection includes a self property with a URL to the item, including its ID. You can use that ID to retrieve details for a specific extension.

Note: This API cannot be executed using the Try this API panel.

get/extensionpackages/{name}/{version}

Gets the permalink for the specified extension package.

Note: This API cannot be executed using the Try this API panel.

delete/v1/organizations/{org}/environments/{env}/extensions

Deletes all extensions in an environment. Note: This API cannot be executed using the Try this API panel.

get/v1/organizations/{org}/environments/{env}/extensions

Gets a collection of extensions. You can divide the collection into pages of a particular size with the size parameter. Navigate the pages by following links in the next and previous properties.

Notes:

  • You must be an organization administrator to call this API.
  • This API cannot be executed using the Try this API panel.
post/v1/organizations/{org}/environments/{env}/extensions

Creates a new extension by configuring an instance of an installed extension and adding it to the specified organization. After you create the extension, use the Update an extension to deploy it.

Notes:

  • You must be an organization administrator to call this API.
  • This API cannot be executed using the Try this API panel.

This API requires that you pass the package name and version number of the extension. Use the Get public extension packages API to get all available packages and versions.

delete/v1/organizations/{org}/environments/{env}/extensions/{id}

Deletes an extension.

Note: This API cannot be executed using the Try this API panel.

When you retrieve a list of extensions, each extension in the collection includes a self property with a URL to the extension, including its ID. Use that ID value in this request.

get/v1/organizations/{org}/environments/{env}/extensions/{id}

Gets an extension.

Note: This API cannot be executed using the Try this API panel.

When you get a collection of extensions, each item in the collection includes a self property with a URL pointing to the item, including its ID. Pass that ID value in this request.

get/v1/organizations/{org}/environments/{env}/extensions/{id}/logs

Gets the logs of a deployed extension. When you get a collection, each item in the collection includes a self property with a URL to the item, including its ID.

Note: This API cannot be executed using the Try this API panel.

Extension

For more information, see Extension.
MethodEndpointDescription
post/v1/organizations/{org}/environments/{env}/extensions

Creates a new extension by configuring an instance of an installed extension and adding it to the specified organization. After you create the extension, use the Update an extension to deploy it.

Notes:

  • You must be an organization administrator to call this API.
  • This API cannot be executed using the Try this API panel.

This API requires that you pass the package name and version number of the extension. Use the Get public extension packages API to get all available packages and versions.

patch/v1/organizations/{org}/environments/{env}/extensions/{id}

Updates an extension.

Note: This API cannot be executed using the Try this API panel.

When you retrieve a list of extensions, each extension in the collection includes a self property with a URL to the extension, including its ID. Use the ID value in that URL to complete the URL here.

To deploy the an extension, specify {state:"DEPLOYED"} in the body. The state property can take the following values:

  • DEPLOYED
  • UNDEPLOYED

When you set state UNDEPLOYED, you cannot update name, packageName, version, or configuration. You can only specify description, credentials, and state.

Each extension type defines the properties that you can set in the configuration object. For more on each extension type, see Extensions reference overview. For example, when the cponfiguration object for the Google Stackdriver Logging Extension is: {"projectId": "gcp_project_name"}

Note: You must be an organization administrator to call this API.

ExtensionCollectionResponse

For more information, see ExtensionCollectionResponse.
MethodEndpointDescription
get/v1/organizations/{org}/environments/{env}/extensions

Gets a collection of extensions. You can divide the collection into pages of a particular size with the size parameter. Navigate the pages by following links in the next and previous properties.

Notes:

  • You must be an organization administrator to call this API.
  • This API cannot be executed using the Try this API panel.

ExtensionLogEntry

For more information, see ExtensionLogEntry.
No methods use this type.

ExtensionLogsResponse

For more information, see ExtensionLogsResponse.
MethodEndpointDescription
get/v1/organizations/{org}/environments/{env}/extensions/{id}/logs

Gets the logs of a deployed extension. When you get a collection, each item in the collection includes a self property with a URL to the item, including its ID.

Note: This API cannot be executed using the Try this API panel.

ExtensionOutput

For more information, see ExtensionOutput.
MethodEndpointDescription
patch/v1/organizations/{org}/environments/{env}/extensions/{id}

Updates an extension.

Note: This API cannot be executed using the Try this API panel.

When you retrieve a list of extensions, each extension in the collection includes a self property with a URL to the extension, including its ID. Use the ID value in that URL to complete the URL here.

To deploy the an extension, specify {state:"DEPLOYED"} in the body. The state property can take the following values:

  • DEPLOYED
  • UNDEPLOYED

When you set state UNDEPLOYED, you cannot update name, packageName, version, or configuration. You can only specify description, credentials, and state.

Each extension type defines the properties that you can set in the configuration object. For more on each extension type, see Extensions reference overview. For example, when the cponfiguration object for the Google Stackdriver Logging Extension is: {"projectId": "gcp_project_name"}

Note: You must be an organization administrator to call this API.

ExtensionPackage

For more information, see ExtensionPackage.
No methods use this type.

ExtensionPackageOutput

For more information, see ExtensionPackageOutput.
MethodEndpointDescription
get/extensionpackages/{name}/{version}

Gets the permalink for the specified extension package.

Note: This API cannot be executed using the Try this API panel.

ExtensionPackagesCollectionResponse

For more information, see ExtensionPackagesCollectionResponse.
No methods use this type.

ExtensionPackagesResponse

For more information, see ExtensionPackagesResponse.
MethodEndpointDescription
get/extensionpackages

Gets public extension packages using the query parameters to search for specific values. To get a list of all extension packages, don't specify any search values. When you get a collection, each item in the collection includes a self property with a URL to the item, including its ID. You can use that ID to retrieve details for a specific extension.

Note: This API cannot be executed using the Try this API panel.

ExtensionResponse

For more information, see ExtensionResponse.
MethodEndpointDescription
post/v1/organizations/{org}/environments/{env}/extensions

Creates a new extension by configuring an instance of an installed extension and adding it to the specified organization. After you create the extension, use the Update an extension to deploy it.

Notes:

  • You must be an organization administrator to call this API.
  • This API cannot be executed using the Try this API panel.

This API requires that you pass the package name and version number of the extension. Use the Get public extension packages API to get all available packages and versions.

get/v1/organizations/{org}/environments/{env}/extensions/{id}

Gets an extension.

Note: This API cannot be executed using the Try this API panel.

When you get a collection of extensions, each item in the collection includes a self property with a URL pointing to the item, including its ID. Pass that ID value in this request.