Create or update a protection updates note

Base URL: https://{kibana_url}

POST /api/endpoint/protection_updates_note/{package_policy_id}
POST /s/{space_id}/api/endpoint/protection_updates_note/{package_policy_id}

Auth

Create or update the protection updates note for a package policy.

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.
package_policy_id string · max length: 256 required: The package policy ID to create or update the protection updates note for.

Request body

note string · max length: 10000 required: The note content.

Response

Indicates a successful call.

application/json

note string: A note associated with the protection updates for the given package policy.

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/endpoint/protection_updates_note/PACKAGE_POLICY_ID
{
  "note": "Pinned protection updates to 2025-01-01 while validating new signatures."
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/endpoint/protection_updates_note/${PACKAGE_POLICY_ID}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Pinned protection updates to 2025-01-01 while validating new signatures."
  }'

Generated from the API spec

Response

{
  "note": "Pinned protection updates to 2025-01-01 while validating new signatures."
}

Path parameters

Request body { }

Response

Request body