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 SchemaDefinitionSummariesList object
The list of available schema definitions
Element | Type | Description |
---|---|---|
totalCount | integer | The total count of schemas in this list |
items |
Schema |
The list of schemas |
The SchemaDefinitionSummary object
A schema definition summary
Element | Type | Description |
---|---|---|
latestSchemaVersion | string | The latest version of the schema |
schemaId | string | The identifier of the schema |
displayName | string | The display name of the schema |
{
"totalCount": 1,
"items": [
{
"latestSchemaVersion": "1.4.2",
"schemaId": "builtin:anomaly.infrastructure",
"displayName": "Anomaly Detection for Infrastructure"
}
]
}