POST

/2015-01-01/es/upgradeDomain

http://es.{region}.amazonaws.com/2015-01-01/es/upgradeDomain

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Access Token Required: API Key

Body Params

DomainNamestringrequired

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

TargetVersionstringrequired

The version of Elasticsearch that you intend to upgrade the domain to.

PerformCheckOnlyboolean

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

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 POST \
2     --url 'http://es.{region}.amazonaws.com/2015-01-01/es/upgradeDomain' \
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}