Skip to main content
GET
/
deployments
List Deployments
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/deployments \
  --header 'Authorization: <api-key>'
{
  "deployments": [
    {
      "id": "<string>",
      "name": "<string>",
      "resources": [
        {
          "cloud_id": "<string>",
          "credentials": {
            "password": "<string>",
            "username": "<string>"
          },
          "elasticsearch_cluster_ref_id": "<string>",
          "id": "<string>",
          "kind": "<string>",
          "ref_id": "<string>",
          "region": "<string>",
          "secret_token": "<string>",
          "warnings": [
            {
              "code": "<string>",
              "message": "<string>"
            },
            {
              "code": "<string>",
              "message": "<string>"
            }
          ]
        },
        {
          "cloud_id": "<string>",
          "credentials": {
            "password": "<string>",
            "username": "<string>"
          },
          "elasticsearch_cluster_ref_id": "<string>",
          "id": "<string>",
          "kind": "<string>",
          "ref_id": "<string>",
          "region": "<string>",
          "secret_token": "<string>",
          "warnings": [
            {
              "code": "<string>",
              "message": "<string>"
            },
            {
              "code": "<string>",
              "message": "<string>"
            }
          ]
        }
      ]
    },
    {
      "id": "<string>",
      "name": "<string>",
      "resources": [
        {
          "cloud_id": "<string>",
          "credentials": {
            "password": "<string>",
            "username": "<string>"
          },
          "elasticsearch_cluster_ref_id": "<string>",
          "id": "<string>",
          "kind": "<string>",
          "ref_id": "<string>",
          "region": "<string>",
          "secret_token": "<string>",
          "warnings": [
            {
              "code": "<string>",
              "message": "<string>"
            },
            {
              "code": "<string>",
              "message": "<string>"
            }
          ]
        },
        {
          "cloud_id": "<string>",
          "credentials": {
            "password": "<string>",
            "username": "<string>"
          },
          "elasticsearch_cluster_ref_id": "<string>",
          "id": "<string>",
          "kind": "<string>",
          "ref_id": "<string>",
          "region": "<string>",
          "secret_token": "<string>",
          "warnings": [
            {
              "code": "<string>",
              "message": "<string>"
            },
            {
              "code": "<string>",
              "message": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Response

The list of deployments that belong to the authenticated user.

deployments
object[]
Example:
[
{
"id": "<string>",
"name": "<string>",
"resources": [
{
"cloud_id": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"elasticsearch_cluster_ref_id": "<string>",
"id": "<string>",
"kind": "<string>",
"ref_id": "<string>",
"region": "<string>",
"secret_token": "<string>",
"warnings": [
{ "code": "<string>", "message": "<string>" },
{ "code": "<string>", "message": "<string>" }
]
},
{
"cloud_id": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"elasticsearch_cluster_ref_id": "<string>",
"id": "<string>",
"kind": "<string>",
"ref_id": "<string>",
"region": "<string>",
"secret_token": "<string>",
"warnings": [
{ "code": "<string>", "message": "<string>" },
{ "code": "<string>", "message": "<string>" }
]
}
]
},
{
"id": "<string>",
"name": "<string>",
"resources": [
{
"cloud_id": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"elasticsearch_cluster_ref_id": "<string>",
"id": "<string>",
"kind": "<string>",
"ref_id": "<string>",
"region": "<string>",
"secret_token": "<string>",
"warnings": [
{ "code": "<string>", "message": "<string>" },
{ "code": "<string>", "message": "<string>" }
]
},
{
"cloud_id": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"elasticsearch_cluster_ref_id": "<string>",
"id": "<string>",
"kind": "<string>",
"ref_id": "<string>",
"region": "<string>",
"secret_token": "<string>",
"warnings": [
{ "code": "<string>", "message": "<string>" },
{ "code": "<string>", "message": "<string>" }
]
}
]
}
]
I