Batch delete rollup and summary data

Base URL: https://{kibana_url}

POST /s/{spaceId}/api/observability/slos/_bulk_purge_rollup

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.

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.; Example: default

Header parameters

kbn-xsrf string required: Cross-site request forgery protection

Request body

list string[] required: An array of slo ids
purgePolicy union oneOf required: Policy that dictates which SLI documents to purge based on age; One of:

Responses

Successful request

application/json

taskId string: The task id of the purge operation

Bad request

application/json

Unauthorized response

application/json

Forbidden response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/s/default/api/observability/slos/_bulk_purge_rollup
{
  "list": [
    "8853df00-ae2e-11ed-90af-09bb6422b258"
  ],
  "purgePolicy": {
    "age": "7d",
    "purgeType": "fixed-age"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/s/default/api/observability/slos/_bulk_purge_rollup" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "list": [
      "8853df00-ae2e-11ed-90af-09bb6422b258"
    ],
    "purgePolicy": {
      "age": "7d",
      "purgeType": "fixed-age"
    }
  }'

Generated from the API spec

Response

{
  "taskId": "8853df00-ae2e-11ed-90af-09bb6422b258"
}

{
  "error": "Bad Request",
  "message": "Invalid value \u0027foo\u0027 supplied to: purgePolicy/purgeType",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "security_exception: unable to authenticate user for REST request [/api/observability/slos]",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "security_exception: action [slo_write] is unauthorized for user",
  "statusCode": 403
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/s/SPACE_ID/api/observability/slos/_bulk_purge_rollup
{
  "list": [
    "8853df00-ae2e-11ed-90af-09bb6422b258",
    "d077e940-1515-11ee-9c50-9d096392f520"
  ],
  "purgePolicy": {
    "purgeType": "fixed-time",
    "timestamp": "2024-12-31T00:00:00.000Z"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/s/${SPACE_ID}/api/observability/slos/_bulk_purge_rollup" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "list": [
      "8853df00-ae2e-11ed-90af-09bb6422b258",
      "d077e940-1515-11ee-9c50-9d096392f520"
    ],
    "purgePolicy": {
      "purgeType": "fixed-time",
      "timestamp": "2024-12-31T00:00:00.000Z"
    }
  }'

Generated from the API spec

Response

{
  "taskId": "8853df00-ae2e-11ed-90af-09bb6422b258"
}

{
  "error": "Bad Request",
  "message": "Invalid value \u0027foo\u0027 supplied to: purgePolicy/purgeType",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "security_exception: unable to authenticate user for REST request [/api/observability/slos]",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "security_exception: action [slo_write] is unauthorized for user",
  "statusCode": 403
}

Path parameters

Header parameters

Request body { }

Responses

Request body