Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more.
Note: This product is available as a free trial for a time period of 60 days.
- REST Resource: v1.organizations
- REST Resource: v1.organizations.analytics.datastores
- REST Resource: v1.organizations.apiproducts
- REST Resource: v1.organizations.apiproducts.attributes
- REST Resource: v1.organizations.apis
- REST Resource: v1.organizations.apis.deployments
- REST Resource: v1.organizations.apis.keyvaluemaps
- REST Resource: v1.organizations.apis.revisions
- REST Resource: v1.organizations.apis.revisions.deployments
- REST Resource: v1.organizations.apps
- REST Resource: v1.organizations.datacollectors
- REST Resource: v1.organizations.deployments
- REST Resource: v1.organizations.developers
- REST Resource: v1.organizations.developers.apps
- REST Resource: v1.organizations.developers.apps.attributes
- REST Resource: v1.organizations.developers.apps.keys
- REST Resource: v1.organizations.developers.apps.keys.apiproducts
- REST Resource: v1.organizations.developers.apps.keys.create
- REST Resource: v1.organizations.developers.attributes
- REST Resource: v1.organizations.envgroups
- REST Resource: v1.organizations.envgroups.attachments
- REST Resource: v1.organizations.environments
- REST Resource: v1.organizations.environments.analytics.admin
- REST Resource: v1.organizations.environments.analytics.exports
- REST Resource: v1.organizations.environments.apis.deployments
- REST Resource: v1.organizations.environments.apis.revisions
- REST Resource: v1.organizations.environments.apis.revisions.debugsessions
- REST Resource: v1.organizations.environments.apis.revisions.debugsessions.data
- REST Resource: v1.organizations.environments.apis.revisions.deployments
- REST Resource: v1.organizations.environments.caches
- REST Resource: v1.organizations.environments.deployments
- REST Resource: v1.organizations.environments.flowhooks
- REST Resource: v1.organizations.environments.keystores
- REST Resource: v1.organizations.environments.keystores.aliases
- REST Resource: v1.organizations.environments.keyvaluemaps
- REST Resource: v1.organizations.environments.optimizedStats
- REST Resource: v1.organizations.environments.queries
- REST Resource: v1.organizations.environments.references
- REST Resource: v1.organizations.environments.resourcefiles
- REST Resource: v1.organizations.environments.sharedflows.deployments
- REST Resource: v1.organizations.environments.sharedflows.revisions.deployments
- REST Resource: v1.organizations.environments.stats
- REST Resource: v1.organizations.environments.targetservers
- REST Resource: v1.organizations.hostQueries
- REST Resource: v1.organizations.hostStats
- REST Resource: v1.organizations.instances
- REST Resource: v1.organizations.instances.attachments
- REST Resource: v1.organizations.instances.natAddresses
- REST Resource: v1.organizations.keyvaluemaps
- REST Resource: v1.organizations.operations
- REST Resource: v1.organizations.optimizedHostStats
- REST Resource: v1.organizations.reports
- REST Resource: v1.organizations.sharedflows
- REST Resource: v1.organizations.sharedflows.deployments
- REST Resource: v1.organizations.sharedflows.revisions
- REST Resource: v1.organizations.sharedflows.revisions.deployments
- REST Resource: v1.projects
Service: apigee.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://apigee.googleapis.com
REST Resource: v1.organizations
Methods | |
---|---|
create |
POST /v1/organizations Creates an Apigee organization. |
delete |
DELETE /v1/{name=organizations/*} Delete an Apigee organization. |
get |
GET /v1/{name=organizations/*} Gets the profile for an Apigee organization. |
getSyncAuthorization |
POST /v1/{name=organizations/*}:getSyncAuthorization Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. |
list |
GET /v1/{parent} Lists the Apigee organizations and associated GCP projects that you have permission to access. |
setSyncAuthorization |
POST /v1/{name=organizations/*}:setSyncAuthorization Sets the permissions required to allow the Synchronizer to download environment data from the control plane. |
update |
PUT /v1/{name=organizations/*} Updates the properties for an Apigee organization. |
REST Resource: v1.organizations.analytics.datastores
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/analytics/datastores Create a Datastore for an org |
delete |
DELETE /v1/{name=organizations/*/analytics/datastores/*} Delete a Datastore from an org. |
get |
GET /v1/{name=organizations/*/analytics/datastores/*} Get a Datastore |
list |
GET /v1/{parent=organizations/*}/analytics/datastores List Datastores |
test |
POST /v1/{parent=organizations/*}/analytics/datastores:test Test if Datastore configuration is correct. |
update |
PUT /v1/{name=organizations/*/analytics/datastores/*} Update a Datastore |
REST Resource: v1.organizations.apiproducts
Methods | |
---|---|
attributes |
POST /v1/{name=organizations/*/apiproducts/*}/attributes Updates or creates API product attributes. |
create |
POST /v1/{parent=organizations/*}/apiproducts Creates an API product in an organization. |
delete |
DELETE /v1/{name=organizations/*/apiproducts/*} Deletes an API product from an organization. |
get |
GET /v1/{name=organizations/*/apiproducts/*} Gets configuration details for an API product. |
list |
GET /v1/{parent=organizations/*}/apiproducts Lists all API product names for an organization. |
update |
PUT /v1/{name=organizations/*/apiproducts/*} Updates an existing API product. |
REST Resource: v1.organizations.apiproducts.attributes
Methods | |
---|---|
delete |
DELETE /v1/{name=organizations/*/apiproducts/*/attributes/*} Deletes an API product attribute. |
get |
GET /v1/{name=organizations/*/apiproducts/*/attributes/*} Gets the value of an API product attribute. |
list |
GET /v1/{parent=organizations/*/apiproducts/*}/attributes Lists all API product attributes. |
updateApiProductAttribute |
POST /v1/{name=organizations/*/apiproducts/*/attributes/*} Updates the value of an API product attribute. |
REST Resource: v1.organizations.apis
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/apis Creates an API proxy. |
delete |
DELETE /v1/{name=organizations/*/apis/*} Deletes an API proxy and all associated endpoints, policies, resources, and revisions. |
get |
GET /v1/{name=organizations/*/apis/*} Gets an API proxy including a list of existing revisions. |
list |
GET /v1/{parent=organizations/*}/apis Lists the names of all API proxies in an organization. |
REST Resource: v1.organizations.apis.deployments
Methods | |
---|---|
list |
GET /v1/{parent=organizations/*/apis/*}/deployments Lists all deployments of an API proxy. |
REST Resource: v1.organizations.apis.keyvaluemaps
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/apis/*}/keyvaluemaps Creates a key value map in an api proxy. |
delete |
DELETE /v1/{name=organizations/*/apis/*/keyvaluemaps/*} Delete a key value map in an api proxy. |
list |
GET /v1/{parent=organizations/*/apis/*}/keyvaluemaps List key value maps in an api proxy. |
REST Resource: v1.organizations.apis.revisions
Methods | |
---|---|
delete |
DELETE /v1/{name=organizations/*/apis/*/revisions/*} Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. |
get |
GET /v1/{name=organizations/*/apis/*/revisions/*} Gets an API proxy revision. |
list |
GET /v1/{parent=organizations/*/apis/*}/revisions Lists all revisions for an API proxy. |
updateApiProxyRevision |
POST /v1/{name=organizations/*/apis/*/revisions/*} Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. |
REST Resource: v1.organizations.apis.revisions.deployments
Methods | |
---|---|
list |
GET /v1/{parent=organizations/*/apis/*/revisions/*}/deployments Lists all deployments of an API proxy revision. |
REST Resource: v1.organizations.apps
Methods | |
---|---|
get |
GET /v1/{name=organizations/*/apps/*} Gets the app profile for the specified app ID. |
list |
GET /v1/{parent=organizations/*}/apps Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company). |
REST Resource: v1.organizations.datacollectors
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/datacollectors Creates a new data collector. |
delete |
DELETE /v1/{name=organizations/*/datacollectors/*} Deletes a data collector. |
get |
GET /v1/{name=organizations/*/datacollectors/*} Gets a data collector. |
list |
GET /v1/{parent=organizations/*}/datacollectors Lists all data collectors. |
patch |
PATCH /v1/{name=organizations/*/datacollectors/*} Updates a data collector. |
REST Resource: v1.organizations.deployments
Methods | |
---|---|
list |
GET /v1/{parent=organizations/*}/deployments Lists all deployments of API proxies or shared flows. |
REST Resource: v1.organizations.developers
Methods | |
---|---|
attributes |
POST /v1/{parent=organizations/*/developers/*}/attributes Updates developer attributes. |
create |
POST /v1/{parent=organizations/*}/developers Creates a developer. |
delete |
DELETE /v1/{name=organizations/*/developers/*} Deletes a developer. |
get |
GET /v1/{name=organizations/*/developers/*} Returns the developer details, including the developer's name, email address, apps, and other information. |
list |
GET /v1/{parent=organizations/*}/developers Lists all developers in an organization by email address. |
setDeveloperStatus |
POST /v1/{name=organizations/*/developers/*} Sets the status of a developer. |
update |
PUT /v1/{name=organizations/*/developers/*} Updates a developer. |
REST Resource: v1.organizations.developers.apps
Methods | |
---|---|
attributes |
POST /v1/{name=organizations/*/developers/*/apps/*}/attributes Updates attributes for a developer app. |
create |
POST /v1/{parent=organizations/*/developers/*}/apps Creates an app associated with a developer. |
delete |
DELETE /v1/{name=organizations/*/developers/*/apps/*} Deletes a developer app. |
generateKeyPairOrUpdateDeveloperAppStatus |
POST /v1/{name=organizations/*/developers/*/apps/*} Manages access to a developer app by enabling you to:
To approve or revoke a developer app, set the |
get |
GET /v1/{name=organizations/*/developers/*/apps/*} Returns the details for a developer app. |
list |
GET /v1/{parent=organizations/*/developers/*}/apps Lists all apps created by a developer in an Apigee organization. |
update |
PUT /v1/{name=organizations/*/developers/*/apps/*} Updates the details for a developer app. |
REST Resource: v1.organizations.developers.apps.attributes
Methods | |
---|---|
delete |
DELETE /v1/{name=organizations/*/developers/*/apps/*/attributes/*} Deletes a developer app attribute. |
get |
GET /v1/{name=organizations/*/developers/*/apps/*/attributes/*} Returns a developer app attribute. |
list |
GET /v1/{parent=organizations/*/developers/*/apps/*}/attributes Returns a list of all developer app attributes. |
updateDeveloperAppAttribute |
POST /v1/{name=organizations/*/developers/*/apps/*/attributes/*} Updates a developer app attribute. |
REST Resource: v1.organizations.developers.apps.keys
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/developers/*/apps/*}/keys Creates a custom consumer key and secret for a developer app. |
delete |
DELETE /v1/{name=organizations/*/developers/*/apps/*/keys/*} Deletes an app's consumer key and removes all API products associated with the app. |
get |
GET /v1/{name=organizations/*/developers/*/apps/*/keys/*} Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information. |
replaceDeveloperAppKey |
PUT /v1/{name=organizations/*/developers/*/apps/*/keys/*} Updates the scope of an app. |
updateDeveloperAppKey |
POST /v1/{name=organizations/*/developers/*/apps/*/keys/*} Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. |
REST Resource: v1.organizations.developers.apps.keys.apiproducts
Methods | |
---|---|
delete |
DELETE /v1/{name=organizations/*/developers/*/apps/*/keys/*/apiproducts/*} Removes an API product from an app's consumer key. |
updateDeveloperAppKeyApiProduct |
POST /v1/{name=organizations/*/developers/*/apps/*/keys/*/apiproducts/*} Approve or revoke an app's consumer key. |
REST Resource: v1.organizations.developers.apps.keys.create
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/developers/*/apps/*}/keys/create Creates a custom consumer key and secret for a developer app. |
REST Resource: v1.organizations.developers.attributes
Methods | |
---|---|
delete |
DELETE /v1/{name=organizations/*/developers/*/attributes/*} Deletes a developer attribute. |
get |
GET /v1/{name=organizations/*/developers/*/attributes/*} Returns the value of the specified developer attribute. |
list |
GET /v1/{parent=organizations/*/developers/*}/attributes Returns a list of all developer attributes. |
updateDeveloperAttribute |
POST /v1/{name=organizations/*/developers/*/attributes/*} Updates a developer attribute. |
REST Resource: v1.organizations.envgroups
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/envgroups Creates a new environment group. |
delete |
DELETE /v1/{name=organizations/*/envgroups/*} Deletes an environment group. |
get |
GET /v1/{name=organizations/*/envgroups/*} Gets an environment group. |
list |
GET /v1/{parent=organizations/*}/envgroups Lists all environment groups. |
patch |
PATCH /v1/{name=organizations/*/envgroups/*} Updates an environment group. |
REST Resource: v1.organizations.envgroups.attachments
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/envgroups/*}/attachments Creates a new attachment of an environment to an environment group. |
delete |
DELETE /v1/{name=organizations/*/envgroups/*/attachments/*} Deletes an environment group attachment. |
get |
GET /v1/{name=organizations/*/envgroups/*/attachments/*} Gets an environment group attachment. |
list |
GET /v1/{parent=organizations/*/envgroups/*}/attachments Lists all attachments of an environment group. |
REST Resource: v1.organizations.environments
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/environments Creates an environment in an organization. |
delete |
DELETE /v1/{name=organizations/*/environments/*} Deletes an environment from an organization. |
get |
GET /v1/{name=organizations/*/environments/*} Gets environment details. |
getDebugmask |
GET /v1/{name=organizations/*/environments/*/debugmask} Gets the debug mask singleton resource for an environment. |
getIamPolicy |
GET /v1/{resource=organizations/*/environments/*}:getIamPolicy Gets the IAM policy on an environment. |
list |
GET /v1/{parent=organizations/*}/environments Lists all environments in an organization. |
setIamPolicy |
POST /v1/{resource=organizations/*/environments/*}:setIamPolicy Sets the IAM policy on an environment, if the policy already exists it will be replaced. |
testIamPermissions |
POST /v1/{resource=organizations/*/environments/*}:testIamPermissions Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. |
update |
PUT /v1/{name=organizations/*/environments/*} Updates an existing environment. |
updateDebugmask |
PATCH /v1/{debugMask.name=organizations/*/environments/*/debugmask} Updates the debug mask singleton resource for an environment. |
updateEnvironment |
POST /v1/{name=organizations/*/environments/*} Updates an existing environment. |
REST Resource: v1.organizations.environments.analytics.admin
Methods | |
---|---|
getSchemav2 |
GET /v1/{name=organizations/*/environments/*/analytics/admin/schemav2} Get a list of metrics and dimensions which can be used for creating analytics queries and reports. |
REST Resource: v1.organizations.environments.analytics.exports
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*}/analytics/exports Submit a data export job to be processed in the background. |
get |
GET /v1/{name=organizations/*/environments/*/analytics/exports/*} Gets the details and status of an analytics export job. |
list |
GET /v1/{parent=organizations/*/environments/*}/analytics/exports Lists the details and status of all analytics export jobs belonging to the parent organization and environment. |
REST Resource: v1.organizations.environments.apis.deployments
Methods | |
---|---|
list |
GET /v1/{parent=organizations/*/environments/*/apis/*}/deployments Lists all deployments of an API proxy in an environment. |
REST Resource: v1.organizations.environments.apis.revisions.debugsessions
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*/apis/*/revisions/*}/debugsessions Creates a debug session for a deployed API Proxy revision. |
deleteData |
DELETE /v1/{name=organizations/*/environments/*/apis/*/revisions/*/debugsessions/*}/data Deletes the data from a debug session. |
get |
GET /v1/{name=organizations/*/environments/*/apis/*/revisions/*/debugsessions/*} Retrieves a debug session. |
list |
GET /v1/{parent=organizations/*/environments/*/apis/*/revisions/*}/debugsessions Lists debug sessions that are currently active in the given API Proxy revision. |
REST Resource: v1.organizations.environments.apis.revisions.debugsessions.data
Methods | |
---|---|
get |
GET /v1/{name=organizations/*/environments/*/apis/*/revisions/*/debugsessions/*/data/*} Gets the debug data from a transaction. |
list |
GET /v1/{parent=organizations/*/environments/*/apis/*/revisions/*/debugsessions/*}/data Lists the transaction IDs from a debug session. |
REST Resource: v1.organizations.environments.apis.revisions.deployments
Methods | |
---|---|
deploy |
POST /v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments Deploys a revision of an API proxy. |
generateDeployChangeReport |
POST /v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments:generateDeployChangeReport Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. |
generateUndeployChangeReport |
POST /v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments:generateUndeployChangeReport Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. |
get |
GET /v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments Gets the deployment of an API proxy revision and actual state reported by runtime pods. |
undeploy |
DELETE /v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments Undeploys an API proxy revision from an environment. |
REST Resource: v1.organizations.environments.caches
Methods | |
---|---|
delete |
DELETE /v1/{name=organizations/*/environments/*/caches/*} Deletes a cache. |
list |
GET /v1/{parent=organizations/*/environments/*}/caches Lists all caches in an environment. |
REST Resource: v1.organizations.environments.deployments
Methods | |
---|---|
list |
GET /v1/{parent=organizations/*/environments/*}/deployments Lists all deployments of API proxies or shared flows in an environment. |
REST Resource: v1.organizations.environments.flowhooks
Methods | |
---|---|
attachSharedFlowToFlowHook |
PUT /v1/{name=organizations/*/environments/*/flowhooks/*} Attaches a shared flow to a flow hook. |
detachSharedFlowFromFlowHook |
DELETE /v1/{name=organizations/*/environments/*/flowhooks/*} Detaches a shared flow from a flow hook. |
get |
GET /v1/{name=organizations/*/environments/*/flowhooks/*} Returns the name of the shared flow attached to the specified flow hook. |
list |
GET /v1/{parent=organizations/*/environments/*}/flowhooks Lists the flow hooks attached to an environment. |
REST Resource: v1.organizations.environments.keystores
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*}/keystores Creates a keystore or truststore. |
delete |
DELETE /v1/{name=organizations/*/environments/*/keystores/*} Deletes a keystore or truststore. |
get |
GET /v1/{name=organizations/*/environments/*/keystores/*} Gets a keystore or truststore. |
list |
GET /v1/{parent=organizations/*/environments/*}/keystores Lists all keystores and truststores. |
REST Resource: v1.organizations.environments.keystores.aliases
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*/keystores/*}/aliases Creates an alias from a key/certificate pair. |
csr |
GET /v1/{name=organizations/*/environments/*/keystores/*/aliases/*}/csr Generates a PKCS #10 Certificate Signing Request for the private key in an alias. |
delete |
DELETE /v1/{name=organizations/*/environments/*/keystores/*/aliases/*} Deletes an alias. |
get |
GET /v1/{name=organizations/*/environments/*/keystores/*/aliases/*} Gets an alias. |
getCertificate |
GET /v1/{name=organizations/*/environments/*/keystores/*/aliases/*}/certificate Gets the certificate from an alias in PEM-encoded form. |
list |
GET /v1/{parent=organizations/*/environments/*/keystores/*}/aliases Lists all aliases. |
update |
PUT /v1/{name=organizations/*/environments/*/keystores/*/aliases/*} Updates the certificate in an alias. |
REST Resource: v1.organizations.environments.keyvaluemaps
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*}/keyvaluemaps Creates a key value map in an environment. |
delete |
DELETE /v1/{name=organizations/*/environments/*/keyvaluemaps/*} Delete a key value map in an environment. |
list |
GET /v1/{parent=organizations/*/environments/*}/keyvaluemaps List key value maps in an environment. |
REST Resource: v1.organizations.environments.optimizedStats
Methods | |
---|---|
get |
GET /v1/{name=organizations/*/environments/*/optimizedStats/**} This api is similar to GetStats except that the response is less verbose. |
REST Resource: v1.organizations.environments.queries
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*}/queries Submit a query to be processed in the background. |
get |
GET /v1/{name=organizations/*/environments/*/queries/*} Get query status If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed" |
getResult |
GET /v1/{name=organizations/*/environments/*/queries/*/result} After the query is completed, use this API to retrieve the results. |
list |
GET /v1/{parent=organizations/*/environments/*}/queries Return a list of Asynchronous Queries |
REST Resource: v1.organizations.environments.references
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*}/references Creates a Reference in the specified environment. |
delete |
DELETE /v1/{name=organizations/*/environments/*/references/*} Deletes a Reference from an environment. |
get |
GET /v1/{name=organizations/*/environments/*/references/*} Gets a Reference resource. |
list |
GET /v1/{parent=organizations/*/environments/*}/references Lists all References in an environment as a JSON array. |
update |
PUT /v1/{name=organizations/*/environments/*/references/*} Updates an existing Reference. |
REST Resource: v1.organizations.environments.resourcefiles
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*}/resourcefiles Creates a resource file. |
delete |
DELETE /v1/{parent=organizations/*/environments/*}/resourcefiles/{type}/{resourceFileId} Deletes a resource file. |
get |
GET /v1/{parent=organizations/*/environments/*}/resourcefiles/{type}/{resourceFileId} Gets the contents of a resource file. |
list |
GET /v1/{parent=organizations/*/environments/*}/resourcefiles Lists all resource files, optionally filtering by type. |
listEnvironmentResources |
GET /v1/{parent=organizations/*/environments/*}/resourcefiles/{type} Lists all resource files, optionally filtering by type. |
update |
PUT /v1/{parent=organizations/*/environments/*}/resourcefiles/{type}/{resourceFileId} Updates a resource file. |
REST Resource: v1.organizations.environments.stats
Methods | |
---|---|
get |
GET /v1/{name=organizations/*/environments/*/stats/**} Retrieve metrics grouped by dimensions. |
REST Resource: v1.organizations.environments.targetservers
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/environments/*}/targetservers Creates a TargetServer in the specified environment. |
delete |
DELETE /v1/{name=organizations/*/environments/*/targetservers/*} Deletes a TargetServer from an environment. |
get |
GET /v1/{name=organizations/*/environments/*/targetservers/*} Gets a TargetServer resource. |
list |
GET /v1/{parent=organizations/*/environments/*}/targetservers Lists all TargetServers in an environment as a JSON array. |
update |
PUT /v1/{name=organizations/*/environments/*/targetservers/*} Updates an existing TargetServer. |
REST Resource: v1.organizations.hostQueries
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/hostQueries Submit a query at host level to be processed in the background. |
get |
GET /v1/{name=organizations/*/hostQueries/*} Get status of a query submitted at host level. |
getResult |
GET /v1/{name=organizations/*/hostQueries/*/result} After the query is completed, use this API to retrieve the results. |
getResultView |
GET /v1/{name=organizations/*/hostQueries/*/resultView} |
list |
GET /v1/{parent=organizations/*}/hostQueries Return a list of Asynchronous Queries at host level. |
REST Resource: v1.organizations.hostStats
Methods | |
---|---|
get |
GET /v1/{name=organizations/*/hostStats/**} Retrieve metrics grouped by dimensions in host level. |
REST Resource: v1.organizations.instances
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/instances Creates an Apigee runtime instance. |
delete |
DELETE /v1/{name=organizations/*/instances/*} Deletes an Apigee runtime instance. |
get |
GET /v1/{name=organizations/*/instances/*} Gets the details for an Apigee runtime instance. |
list |
GET /v1/{parent=organizations/*}/instances Lists all Apigee runtime instances for the organization. |
REST Resource: v1.organizations.instances.attachments
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*/instances/*}/attachments Creates a new attachment of an environment to an instance. |
delete |
DELETE /v1/{name=organizations/*/instances/*/attachments/*} Deletes an attachment. |
get |
GET /v1/{name=organizations/*/instances/*/attachments/*} Gets an attachment. |
list |
GET /v1/{parent=organizations/*/instances/*}/attachments Lists all attachments to an instance. |
REST Resource: v1.organizations.instances.natAddresses
Methods | |
---|---|
activate |
POST /v1/{name=organizations/*/instances/*/natAddresses/*}:activate Activates the NAT address. |
create |
POST /v1/{parent=organizations/*/instances/*}/natAddresses Creates a NAT address. |
delete |
DELETE /v1/{name=organizations/*/instances/*/natAddresses/*} Deletes the NAT address. |
get |
GET /v1/{name=organizations/*/instances/*/natAddresses/*} Gets the details of a NAT address. |
list |
GET /v1/{parent=organizations/*/instances/*}/natAddresses Lists the NAT addresses for an Apigee instance. |
REST Resource: v1.organizations.keyvaluemaps
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/keyvaluemaps Creates a key value map in an organization. |
delete |
DELETE /v1/{name=organizations/*/keyvaluemaps/*} Delete a key value map in an organization. |
list |
GET /v1/{parent=organizations/*}/keyvaluemaps List key value maps in an organization. |
REST Resource: v1.organizations.operations
Methods | |
---|---|
get |
GET /v1/{name=organizations/*/operations/*} Gets the latest state of a long-running operation. |
list |
GET /v1/{name=organizations/*}/operations Lists operations that match the specified filter in the request. |
REST Resource: v1.organizations.optimizedHostStats
Methods | |
---|---|
get |
GET /v1/{name=organizations/*/optimizedHostStats/**} This api is similar to GetHostStats except that the response is less verbose. |
REST Resource: v1.organizations.reports
Methods | |
---|---|
create |
POST /v1/{parent=organizations/*}/reports Creates a Custom Report for an Organization. |
delete |
DELETE /v1/{name=organizations/*/reports/*} Deletes an existing custom report definition |
get |
GET /v1/{name=organizations/*/reports/*} Retrieve a custom report definition. |
list |
GET /v1/{parent=organizations/*}/reports Return a list of Custom Reports |
update |
PUT /v1/{name=organizations/*/reports/*} Update an existing custom report definition |
REST Resource: v1.projects
Methods | |
---|---|
provisionOrganization |
POST /v1/{project=projects/*}:provisionOrganization Provisions a new Apigee organization with a functioning runtime. |