Retrieve servers

Retrieves the servers that belong to clusters.

The response depends on whether you authenticate your API request:

• With authentication, the response lists the servers assigned to your Algolia application’s cluster.

• Without authentication, the response lists the servers for all Algolia clusters.

GET /1/inventory/servers

curl

cURL

curl --request GET \
  --url https://status.algolia.com/1/inventory/servers \
  --header 'accept: application/json' \
  --header 'x-algolia-application-id: ZHVtbXkgYmluYXJ5IHNhbXBsZQA='

200

{
  "inventory": [
    {
      "name": "c16-de-3",
      "region": "de",
      "is_slave": false,
      "is_replica": false,
      "cluster": "c16-de",
      "status": "PRODUCTION",
      "type": "cluster"
    },
    {
      "name": "c16-de-2",
      "region": "de",
      "is_slave": false,
      "is_replica": false,
      "cluster": "c16-de",
      "status": "PRODUCTION",
      "type": "cluster"
    },
    {
      "name": "c16-de-1",
      "region": "de",
      "is_slave": false,
      "is_replica": false,
      "cluster": "c16-de",
      "status": "PRODUCTION",
      "type": "cluster"
    }
  ]
}

Authorizations

X-Algolia-Application-Id · string · header · required

Your Algolia application ID.

Response

200

application/json

OK

inventory · server · object[]

Show child attributes

inventory. name · string

Server name.

Example:

"c16-de-1"

inventory. region · enum<string>

Region where the cluster is located.

Available options: au, br, ca, de, eu, hk, in, jp, sg, uae, uk, usc, use, usw, za

Example:

"de"

inventory. is_slave · boolean · default: false · deprecated

Included to support legacy applications. Use is_replica instead.

Example:

false

inventory. is_replica · boolean · default: false

Whether this server is a replica of another server.

Example:

false

inventory. cluster · string

Name of the cluster to which this server belongs.

Example:

"c16-de"

inventory. status · enum<string>

Available options: PRODUCTION

inventory. type · enum<string>

Available options: cluster