AmazonApiGatewayV2
  1. Root
AmazonApiGatewayV2
  • Root
    • /v2/apis
      POST
    • /v2/apis
      GET
    • /v2/apis
      PUT
    • /v2/domainnames/{domainName}/apimappings
      POST
    • /v2/domainnames/{domainName}/apimappings
      GET
    • /v2/apis/{apiId}/authorizers
      POST
    • /v2/apis/{apiId}/authorizers
      GET
    • /v2/apis/{apiId}/deployments
      POST
    • /v2/apis/{apiId}/deployments
      GET
    • /v2/domainnames
      POST
    • /v2/domainnames
      GET
    • /v2/apis/{apiId}/integrations
      POST
    • /v2/apis/{apiId}/integrations
      GET
    • /v2/apis/{apiId}/integrations/{integrationId}/integrationresponses
      POST
    • /v2/apis/{apiId}/integrations/{integrationId}/integrationresponses
      GET
    • /v2/apis/{apiId}/models
      POST
    • /v2/apis/{apiId}/models
      GET
    • /v2/apis/{apiId}/routes
      POST
    • /v2/apis/{apiId}/routes
      GET
    • /v2/apis/{apiId}/routes/{routeId}/routeresponses
      POST
    • /v2/apis/{apiId}/routes/{routeId}/routeresponses
      GET
    • /v2/apis/{apiId}/stages
      POST
    • /v2/apis/{apiId}/stages
      GET
    • /v2/vpclinks
      POST
    • /v2/vpclinks
      GET
    • /v2/apis/{apiId}/stages/{stageName}/accesslogsettings
      DELETE
    • /v2/apis/{apiId}
      DELETE
    • /v2/apis/{apiId}
      GET
    • /v2/apis/{apiId}
      PUT
    • /v2/apis/{apiId}
      PATCH
    • /v2/domainnames/{domainName}/apimappings/{apiMappingId}
      DELETE
    • /v2/domainnames/{domainName}/apimappings/{apiMappingId}
      GET
    • /v2/domainnames/{domainName}/apimappings/{apiMappingId}
      PATCH
    • /v2/apis/{apiId}/authorizers/{authorizerId}
      DELETE
    • /v2/apis/{apiId}/authorizers/{authorizerId}
      GET
    • /v2/apis/{apiId}/authorizers/{authorizerId}
      PATCH
    • /v2/apis/{apiId}/cors
      DELETE
    • /v2/apis/{apiId}/deployments/{deploymentId}
      DELETE
    • /v2/apis/{apiId}/deployments/{deploymentId}
      GET
    • /v2/apis/{apiId}/deployments/{deploymentId}
      PATCH
    • /v2/domainnames/{domainName}
      DELETE
    • /v2/domainnames/{domainName}
      GET
    • /v2/domainnames/{domainName}
      PATCH
    • /v2/apis/{apiId}/integrations/{integrationId}
      DELETE
    • /v2/apis/{apiId}/integrations/{integrationId}
      GET
    • /v2/apis/{apiId}/integrations/{integrationId}
      PATCH
    • /v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}
      DELETE
    • /v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}
      GET
    • /v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}
      PATCH
    • /v2/apis/{apiId}/models/{modelId}
      DELETE
    • /v2/apis/{apiId}/models/{modelId}
      GET
    • /v2/apis/{apiId}/models/{modelId}
      PATCH
    • /v2/apis/{apiId}/routes/{routeId}
      DELETE
    • /v2/apis/{apiId}/routes/{routeId}
      GET
    • /v2/apis/{apiId}/routes/{routeId}
      PATCH
    • /v2/apis/{apiId}/routes/{routeId}/requestparameters/{requestParameterKey}
      DELETE
    • /v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}
      DELETE
    • /v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}
      GET
    • /v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}
      PATCH
    • /v2/apis/{apiId}/stages/{stageName}/routesettings/{routeKey}
      DELETE
    • /v2/apis/{apiId}/stages/{stageName}
      DELETE
    • /v2/apis/{apiId}/stages/{stageName}
      GET
    • /v2/apis/{apiId}/stages/{stageName}
      PATCH
    • /v2/vpclinks/{vpcLinkId}
      DELETE
    • /v2/vpclinks/{vpcLinkId}
      GET
    • /v2/vpclinks/{vpcLinkId}
      PATCH
    • /v2/apis/{apiId}/exports/{specification}
      GET
    • /v2/apis/{apiId}/stages/{stageName}/cache/authorizers
      DELETE
    • /v2/apis/{apiId}/models/{modelId}/template
      GET
    • /v2/tags/{resource-arn}
      GET
    • /v2/tags/{resource-arn}
      POST
    • /v2/tags/{resource-arn}
      DELETE
  1. Root

/v2/apis/{apiId}/deployments

GET
/v2/apis/{apiId}/deployments
Gets the Deployments for an API.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/apis//deployments'
Response Response Example
200 - Example 1
{
  "Items": [],
  "NextToken": "string"
}

Request

Path Params
apiId
string 
required
The API identifier.
Query Params
maxResults
string 
optional
The maximum number of elements to be returned for this resource.
nextToken
string 
optional
The next page of elements from this collection. Not valid for the last element of the collection.

Responses

🟢200Success
application/json
Body
Items
array[object (Deployment) {6}] 
optional
The elements from this collection.
AutoDeployed
boolean 
optional
Specifies whether a deployment was automatically released.
CreatedDate
string <date-time>
optional
The date and time when the Deployment resource was created.
DeploymentId
string 
optional
The identifier for the deployment.
DeploymentStatus
enum<string> 
optional
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
Allowed values:
PENDINGFAILEDDEPLOYED
DeploymentStatusMessage
string 
optional
May contain additional feedback on the status of an API deployment.
Description
string 
optional
The description for the deployment.
NextToken
string 
optional
The next page of elements from this collection. Not valid for the last element of the collection.
🟠480NotFoundException
🟠481TooManyRequestsException
🟠482BadRequestException
Modified at 2023-08-15 05:49:07
Previous
/v2/apis/{apiId}/deployments
Next
/v2/domainnames
Built with