GET

/#Action=DescribeInstancesHealth

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

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html">enhanced health reporting</a>.

Access Token Required: API Key

Query Params

EnvironmentNamestring

Specify the AWS Elastic Beanstalk environment by name.

EnvironmentIdstring

Specify the AWS Elastic Beanstalk environment by ID.

AttributeNamesarray

Specifies the response elements you wish to receive. To retrieve all attributes, set to <code>All</code>. If no attribute names are specified, returns a list of instances.

NextTokenstring

Specify the pagination token returned by a previous call.

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=DescribeInstancesHealth' \
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}