Embedded APIResourcesOn-prem

Get On-prem Group status

Retrieves the status of an On-prem group in a customer workspace.

Path parameters

idstringRequired

Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).

group_idintegerRequired

The unique ID of the On-prem group.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Success - The On-prem group status was retrieved successfully.

idinteger or null

The unique identifier of the On-prem group.

statusstring or null

The current status of the On-prem group.

last_checked_atdatetime or null
Timestamp indicating when the group status was last checked.

Errors