POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}/rule_assets

Spaces method and path for this operation:

post /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/rule_assets

Refer to Spaces for more information.

Install Kibana alert rule assets for a specific package version.

[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • pkgName string Required
  • pkgVersion string Required
application/json

Body

  • force boolean

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • success boolean Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}/rule_assets
curl \
 --request POST 'https://<KIBANA_URL>/api/fleet/epm/packages/{pkgName}/{pkgVersion}/rule_assets' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"description":"Install alert rule assets for a specific package version","value":{}}'
Request example
Install alert rule assets for a specific package version
{
  "description": "Install alert rule assets for a specific package version",
  "value": {}
}
Response examples (200)
Rule assets successfully installed
{
  "items": [
    {
      "id": "rule-asset-id-1",
      "type": "security_rule"
    }
  ]
}
Response examples (400)
Example of a generic error response
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}