In general, most of the Apigee Edge APIs are supported for Apigee hybrid organizations. A few public APIs specific to hybrid are listed below. For a list of APIs that are not supported for hybrid, see Unsupported APIs.
Get deployment details for an API proxy in an organization
Returns a list of deployment details for an API proxy across all environments in an organization. The
response includes the deployment status of the proxy in each environment. Possible return values for
deployment status are: deployed
or error
.
Available query parameters
The following table lists query parameters for this API. All parameters are required.
Name | Type | Description |
---|---|---|
proxySubtype
|
enum |
Distinguishes between an API proxy and a shared flow. Possible values for
|
proxyName
|
string | The name of the API proxy whose deployment details you are requesting. |
revision
|
int | The revision number of the API proxy. |
Resource URL
https://api.enterprise.apigee.com/v1/organizations/org_name/events/deploymentstatus?proxySubtype=proxy_subtype&proxyName=proxy_name&revision=revision
For example:
https://api.enterprise.apigee.com/v1/organizations/hybridOrg/events/deploymentstatus?proxySubtype=apiProxy&proxyName=proxy1&revision=8
Resource summary
The following table lists the requirements for requests to this API:Security types supported | Basic Auth or OAuth2 |
---|---|
Content-Type request header
|
Set to "application/json" or "text/xml" |
Accept request header
|
Set to "application/json" or "application/xml" |
Sample response
{ "deployments": [ { "environment": "staging", "eventTime": "1550034032", "podName": "ashga_6576_as", "appVersion": "180608_10", "proxySubType": "apiProxy", "proxyName": "proxy1", "revision": "8", "statusDetails": { "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "reason text here", "deploymentTime": "1550034032", "data": [ { "name": "value" } ] } }, { "environment": "staging", "eventTime": "1550034032", "podName": "ashga_6577_as", "appVersion": "180608_10", "proxySubType": "apiProxy", "proxyName": "proxy1", "revision": "8", "statusDetails": { "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "reason text here", "deploymentTime": "1550034032", "data": [ { "name": "value" } ] } }, { "environment": "prod", "eventTime": "1550038979", "podName": "ashga_6578_as", "appVersion": "180608_10", "proxySubType": "apiProxy", "proxyName": "proxy1", "revision": "8", "statusDetails": { "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "reason text here", "deploymentTime": "1550033567", "data": [ { "name": "value" } ] } }, { "environment": "prod", "eventTime": "1550038979", "podName": "ashga_6579_as", "appVersion": "180608_10", "proxySubType": "apiProxy", "proxyName": "proxy1", "revision": "8", "statusDetails": { "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "reason text here", "deploymentTime": "1550033567", "data": [ { "name": "value" } ] } } ] }
Get deployment details for an API proxy in an environment
Returns a list of deployment details for an API proxy in a specified environment. The response includes
the deployment status of the proxy. Possible return values for deployment status are: deployed
or error
.
Available query parameters
The following table lists query parameters for this API. All parameters are required.
Name | Type | Description |
---|---|---|
proxySubtype
|
enum |
Distinguishes between an API proxy and a shared flow. Possible values for
|
proxyName
|
string | The name of the API proxy whose deployment details you are requesting. |
revision
|
int | The revision number of the API proxy. |
Resource URL
https://api.enterprise.apigee.com/v1/organizations/org_name/environments/environment/events/deploymentstatus?proxySubtype=proxy_subtype&proxyName=proxy_name&revision=revision
For example:
https://api.enterprise.apigee.com/v1/organizations/hybridOrg/environments/prod/events/deploymentstatus?proxySubtype=apiProxy&proxyName=proxy1&revision=8
Resource summary
The following table lists the requirements for requests to this API:Security types supported | Basic Auth or OAuth2 |
---|---|
Content-Type request header
|
Set to "application/json" or "text/xml" |
Accept request header
|
Set to "application/json" or "application/xml" |
Sample response
{ "deployments": [ { "environment": "prod", "eventTime": "1550038979", "podName": "ashga_6578_as", "appVersion": "180608_10", "proxySubType": "apiProxy", "proxyName": "proxy1", "revision": "8", "statusDetails": { "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "reason text here", "deploymentTime": "1550033567", "data": [ { "name": "value" } ] } }, { "environment": "prod", "eventTime": "1550038979", "podName": "ashga_6579_as", "appVersion": "180608_10", "proxySubType": "apiProxy", "proxyName": "proxy1", "revision": "8", "statusDetails": { "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "reason text here", "deploymentTime": "1550033567", "data": [ { "name": "value" } ] } } ] }
Get pod details for an organization
Returns a list of pod details for all pods across a given organization.
Resource URL
https://api.enterprise.apigee.com/v1/organizations/org_name/events/poddetails
For example:
https://api.enterprise.apigee.com/v1/organizations/hybridOrg/events/poddetails
Resource summary
The following table lists the requirements for requests to this API:Security types supported | Basic Auth or OAuth2 |
---|---|
Content-Type request header
|
Set to "application/json" or "text/xml" |
Accept request header
|
Set to "application/json" or "application/xml" |
Sample response
[ { "organization" : "test-org" "environment" : "test-env" "podName" : "pod1" "eventTime" : 1554225246196 }, { "organization" : "test-org" "environment" : "test-env" "podName" : "pod2" "eventTime" : 1554225246196 } ... ... ... ]