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
ErrorResponse
Method | Endpoint | Description |
---|---|---|
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 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 Notes:
|
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:
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 |
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 |
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 Note: This API cannot be executed using the Try this API panel. |
Extension
Method | Endpoint | Description |
---|---|---|
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:
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
When you set 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: Note: You must be an organization administrator to call this API. |
ExtensionCollectionResponse
Method | Endpoint | Description |
---|---|---|
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 Notes:
|
ExtensionLogsResponse
Method | Endpoint | Description |
---|---|---|
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 Note: This API cannot be executed using the Try this API panel. |
ExtensionOutput
Method | Endpoint | Description |
---|---|---|
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
When you set 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: Note: You must be an organization administrator to call this API. |
ExtensionPackageOutput
Method | Endpoint | Description |
---|---|---|
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
ExtensionPackagesResponse
Method | Endpoint | Description |
---|---|---|
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 Note: This API cannot be executed using the Try this API panel. |
ExtensionResponse
Method | Endpoint | Description |
---|---|---|
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:
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 |