- URL:
- https://<root>/machines/<machine>/status
- Methods:
GET- Version Introduced:
- 10.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The status resource provides the configured and current status of a server machine.
The configured status represents the state of the resource as you have configured it to be. For example, starting a server machine would set its configured status to be STARTED. The status is persisted to the configuration store.
However, it is possible that the configured state may not match the actual state of the resource. The real-time status represents the actual state of a resource. For instance, consider that you have configured the server machine to be STARTED but the machine was abruptly powered off. In this case, its real-time status would be STOPPED. The real-time status information is harvested when the request is made, and it is not persisted.
For most purposes, the real-time status should be used.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the status resource:
https://organization.example.com/<context>/admin/machines/MACHINE.EXAMPLE.COM/status?f=pjsonJSON Response example
{
"configuredState":"STARTED",
"realTimeState":"STARTED"
}