Rotate API keys for action policies in bulk by ID

Base URL: https://{kibana_url}

POST /api/alerting/v2/action_policies/_bulk_update_api_key
POST /s/{space_id}/api/alerting/v2/action_policies/_bulk_update_api_key

Auth

Required privileges

Privileges manage_alerting-v2-action-policies

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

ids string[] · min items: 1 · max items: 100 required: Explicit list of IDs to operate on. Each id can appear at most once.

Responses

Returns the result of the bulk API key rotation.

application/json

affected_count integer · min: 0 · max: 9007199254740991 required: Number of resources the operation successfully touched.
errors object[] required: Errors encountered during the operation.

Indicates an invalid schema or parameters.

application/json

Indicates the request was not authenticated.

application/json

Indicates the user does not have the required privileges to perform the request.

application/json

Indicates an unexpected server-side error.

application/json

Indicates the alerting engine is disabled by the alerting:v2:enabled advanced setting.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/alerting/v2/action_policies/_bulk_update_api_key
{
  "ids": [
    "action-policy-1",
    "action-policy-2"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/v2/action_policies/_bulk_update_api_key" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "action-policy-1",
      "action-policy-2"
    ]
  }'

Generated from the API spec

Response

{
  "affected_count": 2,
  "errors": []
}

{
  "code": "BAD_REQUEST",
  "details": {
    "errors": {
      "errors": [],
      "properties": {
        "ids": {
          "errors": [
            "Invalid input: expected array, received undefined"
          ]
        }
      }
    }
  },
  "error": "Bad Request",
  "message": "ids: Invalid input: expected array, received undefined"
}

{
  "code": "UNAUTHORIZED",
  "error": "Unauthorized",
  "message": "Authentication required to access this API."
}

{
  "code": "FORBIDDEN",
  "error": "Forbidden",
  "message": "The current user does not have the required privileges for this request."
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred."
}

{
  "code": "ALERTING_DISABLED",
  "error": "Service Unavailable",
  "message": "Alerting is disabled."
}