API Reference / API Methods / MultiClusters / Has pending mappings

Has Pending Mappings

Required API Key: Admin
Method signature
$client->hasPendingMappings([
    // All the following parameters are optional
    'retrieveMappings' => bool,
]);

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

Get the status of your clusters’ migrations or user creations.

Creating a large batch of users or migrating your multi-cluster may take quite some time. This method lets you retrieve the status of the migration, so you can know when it’s done.

Examples

Has pending mappings

1
$client->hasPendingMappings(true);

Parameters

retrieveMappings
type: boolean
default: false
Optional

When true, the API returns an object with all pending migrations for each cluster. The objects’ keys are the names of clusters with a pending status, the values are arrays of strings containing the mapping IDs that are currently pending.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
5
6
7
8
9
10
11
{
  "pending": true,
  "clusters": {
    "cluster_1": [
      'user1',
      'user2',
      'user...',
      'user99999'
    ]
  }
}
pending
boolean

Whether there are any pending migrations on your cluster.

clusters
object

Only returned when the retrieveMappings parameter is set to true. The objects’ keys are the names of clusters with a pending status, the values are arrays of strings containing the mapping IDs that are currently pending.

Did you find this page helpful?