Settings API - GET all schemas
Lists all settings schemas available in your environment.
The request produces an application/json payload.
Early Adopter
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 settings (settings.read) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
| Code | Description |
|---|---|
| 200 | Success |
Response body
The SchemaList object
The list of available settings schemas.
| Element | Type | Description |
|---|---|---|
| items | SchemaStub[] | A list of settings schemas. |
| totalCount | integer | The number of schemas in the list. |
The SchemaStub object
The short representation of the settings schema.
| Element | Type | Description |
|---|---|---|
| latestSchemaVersion | string | The most recent version of the schema. |
| displayName | string | The name of the schema. |
| schemaId | string | The ID of the schema. |
{
"items": [
{
"latestSchemaVersion": "1.4.2",
"displayName": "Anomaly Detection for Infrastructure",
"schemaId": "builtin:anomaly.infrastructure"
}
],
"totalCount": 1
}