Extensions API - GET states of an extension
Lists the endpoint states of the specified extension.
States are stored in server memory and are cleared with restart.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
GET |
|
Authentication
To execute this request, you need the Read configuration (ReadConfig
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The ID of the required extension. |
path | required |
pageSize | integer |
The number of results per result page. Must be between 1 and 500 |
query | optional |
nextPageKey | string |
The cursor for the next page of results. |
query | optional |
state | string |
Extension state to filter. |
query | optional |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The ExtensionStateList object
A list of extension states.
Element | Type | Description |
---|---|---|
states | ExtensionState[] | A list of extension states. |
totalResults | integer | The total number of entries in the result. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
The ExtensionState object
The state of the extension.
Element | Type | Description |
---|---|---|
extensionId | string | The ID of the extension. |
version | string | The version of the extension (for example |
endpointId | string | The ID of the endpoint where the state is detected - Active Gate only. |
state | string | The state of the extension. |
stateDescription | string | A short description of the state. |
timestamp | integer | The timestamp when the state was detected, in UTC milliseconds. |
hostId | string | The ID of the host on which the extension runs. |
processId | string | The ID of the entity on which the extension is active. |
{
"states": [
{
"extensionId": "custom.python.connectionpool",
"version": "1.82",
"endpointId": "null",
"state": "OK",
"stateDescription": "",
"timestamp": 1578578108213,
"hostId": "HOST-01A7DEFA5340A86D",
"processId": "PROCESS_GROUP_INSTANCE-2182DF2E20E3E067"
}
],
"totalResults": 9,
"nextPageToken": "LlUdYmu5S2MfX/ppfCInR9M="
}