Update the API key for a rule

POST /api/alerting/rule/{ruleId}/_update_api_key

The new API key has the credentials of the user that submits the request.

Headers

  • kbn-xsrf string Required

    Cross-site request forgery protection

Path parameters

  • ruleId string Required

    An identifier for the rule.

Responses

  • 200

    Indicates a successful call.

  • 400 application/json; Elastic-Api-Version=2023-10-31

    Bad request

    Hide response attributes Show response attributes object
POST /api/alerting/rule/{ruleId}/_update_api_key 
curl \
 -X POST https://localhost:5601/api/alerting/rule/ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74/_update_api_key \
 -H "kbn-xsrf: string"
Response examples (400) 
{
  "error": "Bad Request",
  "message": "string",
  "statusCode": 400
}