You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. For cross-site search, click Search all in the search results.

Updates an extension

Updates an extension

PATCH

Updates an extension

Updates an extension. 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.

Resource URL

https://api.enterprise.apigee.com /v1/organizations/{org}/environments/{env}/extensions/{id}

Header Parameters


Name Values Description
Authorization
(required)

OAuth token. Replace $TOKEN with your access token. See Get the tokens.

Content-Type
(required)

Request content type.

Body Parameters


Name Values Description
extension

Request Body

Name Description Default Required?
name The name of your new extension. Use this name to reference the extension in the API. N/A No
packageName The package name of the extension. Use the Retrieves public extension packages API to retrieve all available packages and versions. N/A No
version The version number of the extension. Use the Retrieves public extension packages API to retrieve all available packages and versions. N/A No
description A description of the extension. N/A No
configuration JSON object containing any configuration properties specific to the extension. See the doc for each extension for more. N/A Yes for "state"="DEPLOYED"
credentials Base64 encoded credentials used to access the extension. For example, for a Google extension, the base64 encoded JSON object containing the credentials for the service account. N/A Yes
state The state of the extension.

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

N/A Yes

org Name of the Apigee organization to use. null true

env Name of the Apigee environment to use. null true

id The extension\'s unique identifier. To get extension IDs, use the API that gets a list of all extensions. The ID is the last part of the `self` property of each extension. null true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Content Type

application/json

Category

Extensions

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)