Skip to main content
GET
/
1
/
clusters
/
mapping
/
pending
curl
curl --request GET \
  --url 'https://algolia_application_id.algolia.net/1/clusters/mapping/pending?getClusters=true' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "pending": true,
  "clusters": {}
}
Requires Admin API key

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

​
getClusters
boolean

Whether to include the cluster's pending mapping state in the response.

Response

OK

​
pending
boolean
required

Whether there are clusters undergoing migration, creation, or deletion.

​
clusters
object

Cluster pending mapping state: migrating, creating, deleting.

⌘I