Install a package from the registry

Server: https://{kibana_url}

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

Install a specific version of a package from the Elastic Package Registry.

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

Path Parameters

Query Parameters

Request

Responses

Successful response

application/json

Bad Request

application/json

Examples

Install a package, optionally ignoring constraints

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
{
  "ignore_constraints": false
}

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/epm/packages/{pkgName}/{pkgVersion}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "ignore_constraints": false
}'

Response

{
  "_meta": {
    "install_source": "registry"
  },
  "items": [
    {
      "id": "aws-logs-aws.cloudwatch_logs-default",
      "type": "index_template"
    }
  ]
}

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

Path Parameters { pkgName , pkgVersion , }

Query Parameters { prerelease , ignoreMappingUpdateErrors , skipDataStreamRollover , skipDependencyCheck , }

Request { allow_outdated_version , force , ignore_constraints , }

Responses

Path Parameters

Query Parameters

Request