Amazon API Gateway REST API Reference

deployment:by-id

Gets a Deployment resource with the specified identifier.

HTTP Request

GET /restapis/<restapi_id>/deployments/{deployment_id}{?embed}

Template Variable

Response

Deployment

Remarks

Example

Request

The following example retrieves the API summary of a specified deployment.

Request


GET /restapis/{restapi_id}/deployments/{deployment-id}?embed=apisummary HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160520T055303Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160520/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={hash}
Cache-Control: no-cache
          
Response

The successful (200 OK) response returns the embedded API summary of the specified deployment.


{
"_links": {
  "curies": {
    "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html&quot;,
    "name": "deployment",
    "templated": true
  },
  "self": {
    "href": "/restapis/{restapi-id}/deployments/{deployment-id}"
  },
  "deployment:delete": {
    "href": "/restapis/{restapi-id}/deployments/{deployment-id}"
  },
  "deployment:stages": {
    "href": "/restapis/{restapi-id}/stages?deployment_id={deployment-id}"
  },
  "deployment:update": {
    "href": "/restapis/{restapi-id}/deployments/{deployment-id}"
  }
},
"apiSummary": {
  "/petstorewalkthrough/pets/{petId}": {
    "GET": {
      "apiKeyRequired": false,
      "authorizationType": "NONE"
    }
  },
  "/mydemoawsproxy": {
    "GET": {
      "apiKeyRequired": false,
      "authorizationType": "NONE"
    }
  }
},
"createdDate": "2016-02-12T22:20:25Z",
"id": "{deployment-id}"
}
          

See Also

Deploying an API, AWS CLI, AWS SDKs