Create a package policy

Server: https://{kibana_url}

POST /api/fleet/package_policies
POST /s/{space_id}/api/fleet/package_policies

Api key auth

Refer to Spaces for more information.

Create a new package policy and assign it to an agent policy.

Query Parameters

format enum: Format for the response: simplified or legacy; Values: simplified legacy

Request

Responses

Successful response

application/json

Bad Request

application/json

Conflict

application/json

Examples

Create a new nginx package policy

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/package_policies
{
  "inputs": {},
  "name": "nginx-1",
  "namespace": "default",
  "package": {
    "name": "nginx",
    "version": "1.20.0"
  },
  "policy_ids": [
    "agent-policy-id-1"
  ]
}

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/package_policies" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {},
  "name": "nginx-1",
  "namespace": "default",
  "package": {
    "name": "nginx",
    "version": "1.20.0"
  },
  "policy_ids": [
    "agent-policy-id-1"
  ]
}'

Response

{
  "item": {
    "created_at": "2024-01-15T10:00:00.000Z",
    "enabled": true,
    "id": "package-policy-id-2",
    "inputs": [],
    "name": "nginx-1",
    "namespace": "default",
    "package": {
      "name": "nginx",
      "title": "Nginx",
      "version": "1.20.0"
    },
    "policy_ids": [
      "agent-policy-id-1"
    ],
    "updated_at": "2024-01-15T10:00:00.000Z"
  }
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}

{
  "error": "Conflict",
  "message": "An error message describing what went wrong",
  "statusCode": 409
}

Query Parameters

Request Kibana_HTTP_APIs_create_package_policy_request | Kibana_HTTP_APIs_simplified_create_package_policy_request |

Responses

Request