POST /s/{spaceId}/api/observability/slos/_bulk_purge_rollup
Api key auth

The deletion occurs for the specified list of sloId. You must have all privileges for the SLOs feature in the Observability section of the Kibana feature privileges.

Headers

  • kbn-xsrf string Required

    Cross-site request forgery protection

Path parameters

  • spaceId string Required

    An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.

application/json

Body Required

  • list array[string] Required

    An array of slo ids

  • purgePolicy object Required

    Policy that dictates which SLI documents to purge based on age

    One of:
    object-1 object object-2 object

Responses

  • 200 application/json

    Successful request

    Hide response attribute Show response attribute object
    • taskId string

      The task id of the purge operation
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode number Required
  • 401 application/json

    Unauthorized response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode number Required
  • 403 application/json

    Forbidden response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode number Required
POST /s/{spaceId}/api/observability/slos/_bulk_purge_rollup 
curl \
 --request POST 'https://<KIBANA_URL>/s/default/api/observability/slos/_bulk_purge_rollup' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: string" \
 --data '{"list":["8853df00-ae2e-11ed-90af-09bb6422b258"],"purgePolicy":{"age":"7d","purgeType":"fixed-age"}}'
Request examples 
{
  "list": [
    "8853df00-ae2e-11ed-90af-09bb6422b258"
  ],
  "purgePolicy": {
    "age": "7d",
    "purgeType": "fixed-age"
  }
}
{
  "list": [
    "8853df00-ae2e-11ed-90af-09bb6422b258",
    "d077e940-1515-11ee-9c50-9d096392f520"
  ],
  "purgePolicy": {
    "purgeType": "fixed-time",
    "timestamp": "2024-12-31T00:00:00.000Z"
  }
}
Response examples (200) 
{
  "taskId": "8853df00-ae2e-11ed-90af-09bb6422b258"
}
Response examples (400) 
{
  "error": "Bad Request",
  "message": "Invalid value 'foo' supplied to: purgePolicy/purgeType",
  "statusCode": 400
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "security_exception: unable to authenticate user for REST request [/api/observability/slos]",
  "statusCode": 401
}
Response examples (403) 
{
  "error": "Forbidden",
  "message": "security_exception: action [slo_write] is unauthorized for user",
  "statusCode": 403
}