Instance

Map the clients, facilities, devices and endpoints of an instance

Returns the instance tree in batches: client, facility, device (with its address) and endpoint, each with its identifier and description. Start at 0, store the last sequence number received and repeat until the list comes back empty. Only complete branches are returned, so a device without endpoints does not appear. Requires the access token of a global administrator.

get/api/v2/instance/mapping/{sequenceNumber}

Request

  • Base URL: https://gear.cloud.studio
  • URL: https://gear.cloud.studio/api/v2/instance/mapping/{sequenceNumber}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter accessToken

Path parameters

sequenceNumberinteger required

SequenceNumber of the last item received. Use 0 to start from the beginning.

Query parameters

maxCountinteger

Maximum number of records to return. Defaults to 100; 500 at most.

Response

A batch of the instance map. An empty list means there are no updates.

object[] required

Changes

No recorded changes to this operation across all 1 revision of this API.