List objective templates in Dynatrace with the SLO API, using page, filter, and sort parameters to page and refine results.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/slo/v1/objective-templates |
You use page-size, page, page-key, filter, and sort to control which objective templates appear and how they are ordered. The response returns a paged array of objective templates.
To execute this request, you need a platform token or OAuth access token with one of the following scopes:
slo:objective-templates:readslo:slos:readTo learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| page-size | integer | How many items to return at one time (max 500) | query | Optional |
| page | integer | The page number to retrieve, 1-indexed. Can't be used together with | query | Optional |
| page-key | string | Cursor for the next page of results, obtained from | query | Optional |
| filter | string | The filter parameter, as explained here. Filtering is supported on the following fields:
| query | Optional |
| sort | string | The sort parameter, as explained here. Sorting is supported on the following fields:
| query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Objective | A paged array of objective templates |
| 400 | - | - |
| 401 | - | - |
| 403 | - | - |
| 429 | - | - |
| 5XX | - | - |
ObjectiveTemplateList object| Element | Type | Description |
|---|---|---|
| totalCount | 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 page-key query parameter to obtain subsequent pages of the result. |
| items | Objective | - |
ObjectiveTemplate objectObjectiveTemplateConfig object| Element | Type | Description |
|---|---|---|
| name | string | - |
| description | string | - |
| indicator | string | - |
| variables | Template | - |
| tags | string[] | A list of tags for this objective template. Tags can be plain strings (e.g. |
| applicableScope | Template | -The element can hold these values
|
| externalId | string | An optional user-provided external identifier for the objective template. Must be unique across all objective templates. |
Deprecation object| Element | Type | Description |
|---|---|---|
| deprecated | boolean | True if this template is deprecated and shouldn't be used for new SLOs. |
| replacementTemplateId | string | If deprecated=true, this field may contain the ID of the template to use instead. |
{"totalCount": 1,"nextPageKey": "string","items": [{"id": "string","version": "string","builtIn": false,"deprecation": {"deprecated": true,"replacementTemplateId": "string"}}]}