GET

/#Action=DescribeEnvironments

http://elasticbeanstalk.{region}.amazonaws.com/#Action=DescribeEnvironments

Returns descriptions for existing environments.

Access Token Required: API Key

Query Params

ApplicationNamestring

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

VersionLabelstring

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

EnvironmentIdsarray

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

EnvironmentNamesarray

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

IncludeDeletedboolean

Indicates whether to include deleted environments: <code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed. <code>false</code>: Do not include deleted environments.

IncludedDeletedBackTostring

If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed.

MaxRecordsinteger

For a paginated request. Specify a maximum number of environments to include in each response. If no <code>MaxRecords</code> is specified, all available environments are retrieved in a single response.

NextTokenstring

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no <code>NextToken</code> is specified, the first page is retrieved.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://elasticbeanstalk.{region}.amazonaws.com/#Action=DescribeEnvironments' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}