Was this helpful?

API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /apis/{api_name}/revisions/{revision_number}/deployments

Get Deployments for an API Revision

Verb: GET

Auth: Basic Auth

Returns deployment details for a specific revision number of an API.

Sample Request:
$ curl https://api.enterprise.apigee.com/v1/o/(org_name)/apis/{api_name}/revisions/{revision_number}/deployments \ -u myname:mypass
Sample Response:
{
  "aPIProxy" : "weatherTest",
  "environment" : [ {
    "configuration" : {
      "basePath" : "/",
      "steps" : [ ]
    },
    "name" : "test",
    "server" : [ {
      "status" : "deployed",
      "type" : [ "message-processor" ],
      "uUID" : "90096dd1-1019-406b-9f42-fbb80cd01200"
    }, {
      "status" : "deployed",
      "type" : [ "message-processor" ],
      "uUID" : "7d6e2eb1-581a-4db0-8045-20d9c3306549"
    }, {
      "status" : "deployed",
      "type" : [ "router" ],
      "uUID" : "1619e2d7-c822-45e0-9f97-63882fb6a805"
    }, {
      "status" : "deployed",
      "type" : [ "router" ],
      "uUID" : "8a5f3d5f-46f8-4e99-b4cc-955875c8a8c8"
    } ],
    "state" : "deployed"
  } ],
  "name" : "1",
  "organization" : "myorg"
}
Response Payload Elements:
Name Description
aPIProxy APi proxy settings
environment Environment settings
configuration Confirguation settings for the revision
basePath Basepath for the API in this environment
steps Policies attached to the API revision
name Name of the environment where the revision is deployed
name Name of the revision (the revision numer deployed)
organization The organization where the API is deployed
Errors
Failure 4xx with proper error message
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Error>
     <Code>messaging.config.beans.ApplicationRevisionDoesNotExist</Code>
     <Message>APIProxy revision 2 does not exist</Message>
     <Contexts/>
</Error>

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)