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

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Responses

Returns the result of the bulk API key rotation.

application/json

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."
}

Required authorization

Authentication

Header parameters

Request body { }

Responses

Request body