Developers
Replicas2

Retrieve a replica

GET/account/replicas/{replica_id}

Retrieves a replica of the current account by its public ID.

Only replicas of the account associated with the current credentials can be retrieved. Accounts that only share billing with the current account are not replicas. Any other ID, including the current account's own, returns 404 Not Found.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

replica_id*string

Public ID of the replica, prefixed with rep_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/account/replicas/string"
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "id": "string",    "name": "string",    "object": "replica",    "status": "initial",    "students_limit": 0,    "subdomain": "string",    "subdomain_url": "string",    "sync_enabled": true  }}

List replicas GET

Lists the replicas of the account associated with the current credentials, sorted by ID and paginated with a cursor. Accounts that only share billing with the current account are not replicas and are not included. Requires the `replicas.read` permission, which grants access to every replica of the account.

Administrators8

Next Page