Fleet APIs

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Methods

[ Jump to Models ]

Table of Contents

Agent Actions

Agent Binary Download Sources

Agent Policies

Agent Status

Agents

Data Streams

Elastic Package Manager EPM

Enrollment APIKeys

Fleet Internals

Fleet Server Hosts

Kubernetes

Outputs

Package Policies

Proxies

Service Tokens

Agent Actions

edit
Up
post /agents/{agentId}/actions/{actionId}/cancel
Cancel agent action (agentActionCancel)

Path parameters

agentId (required)
Path Parameter — default: null
actionId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_action_cancel_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agents/action_status
Get agent action status (agentsActionStatus)

Query parameters

perPage (optional)
Query Parameter — The number of items to return default: 20
page (optional)
Query Parameter — default: 1
errorSize (optional)
Query Parameter — default: 5

Return type

Example data

Content-Type: application/json
{
  "items" : [ {
    "nbAgentsActioned" : 0.8008281904610115,
    "creationTime" : "creationTime",
    "cancellationTime" : "cancellationTime",
    "latestErrors" : [ {
      "agentId" : "agentId",
      "error" : "error",
      "timestamp" : "timestamp"
    }, {
      "agentId" : "agentId",
      "error" : "error",
      "timestamp" : "timestamp"
    } ],
    "type" : "type",
    "newPolicyId" : "newPolicyId",
    "version" : "version",
    "completionTime" : "completionTime",
    "actionId" : "actionId",
    "nbAgentsAck" : 1.4658129805029452,
    "nbAgentsFailed" : 5.962133916683182,
    "startTime" : "startTime",
    "expiration" : "expiration",
    "nbAgentsActionCreated" : 6.027456183070403,
    "status" : "COMPLETE"
  }, {
    "nbAgentsActioned" : 0.8008281904610115,
    "creationTime" : "creationTime",
    "cancellationTime" : "cancellationTime",
    "latestErrors" : [ {
      "agentId" : "agentId",
      "error" : "error",
      "timestamp" : "timestamp"
    }, {
      "agentId" : "agentId",
      "error" : "error",
      "timestamp" : "timestamp"
    } ],
    "type" : "type",
    "newPolicyId" : "newPolicyId",
    "version" : "version",
    "completionTime" : "completionTime",
    "actionId" : "actionId",
    "nbAgentsAck" : 1.4658129805029452,
    "nbAgentsFailed" : 5.962133916683182,
    "startTime" : "startTime",
    "expiration" : "expiration",
    "nbAgentsActionCreated" : 6.027456183070403,
    "status" : "COMPLETE"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agents_action_status_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/{agentId}/actions
Create agent action (newAgentAction)

Path parameters

agentId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

new_agent_action_request new_agent_action_request (required)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "headers" : "headers",
  "body" : [ 0.8008281904610115, 0.8008281904610115 ],
  "statusCode" : 6.027456183070403
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK new_agent_action_200_response

400

Generic Error fleet_server_health_check_400_response

Agent Binary Download Sources

edit
Up
delete /agent_download_sources/{sourceId}
Delete agent binary download source by ID (deleteDownloadSource)

Path parameters

sourceId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent_download_sources
List agent binary download sources (getDownloadSources)

Return type

Example data

Content-Type: application/json
{
  "total" : 0,
  "perPage" : 1,
  "page" : 6,
  "items" : [ {
    "name" : "name",
    "host" : "host",
    "id" : "id",
    "is_default" : true
  }, {
    "name" : "name",
    "host" : "host",
    "id" : "id",
    "is_default" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_download_sources_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent_download_sources/{sourceId}
Get agent binary download source by ID (getOneDownloadSource)

Path parameters

sourceId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "name" : "name",
    "host" : "host",
    "id" : "id",
    "is_default" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_one_download_source_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agent_download_sources
Create agent binary download source (postDownloadSources)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

post_download_sources_request post_download_sources_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "name" : "name",
    "host" : "host",
    "id" : "id",
    "is_default" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK post_download_sources_200_response

400

Generic Error fleet_server_health_check_400_response

Up
put /agent_download_sources/{sourceId}
Update agent binary download source by ID (updateDownloadSource)

Path parameters

sourceId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

update_download_source_request update_download_source_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "name" : "name",
    "host" : "host",
    "id" : "id",
    "is_default" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_one_download_source_200_response

400

Generic Error fleet_server_health_check_400_response

Agent Policies

edit
Up
post /agent_policies/{agentPolicyId}/copy
Copy agent policy by ID (agentPolicyCopy)

Path parameters

agentPolicyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

agent_policy_copy_request agent_policy_copy_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_policy_info_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent_policies/{agentPolicyId}/download
Download agent policy by ID (agentPolicyDownload)

Path parameters

agentPolicyId (required)
Path Parameter — default: null

Query parameters

download (optional)
Query Parameter — default: null
standalone (optional)
Query Parameter — default: null
kubernetes (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : "item"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_policy_download_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent_policies/{agentPolicyId}/full
Get full agent policy by ID (agentPolicyFull)

Path parameters

agentPolicyId (required)
Path Parameter — default: null

Query parameters

download (optional)
Query Parameter — default: null
standalone (optional)
Query Parameter — default: null
kubernetes (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_policy_full_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent_policies/{agentPolicyId}
Get agent policy by ID (agentPolicyInfo)
Get one agent policy

Path parameters

agentPolicyId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_policy_info_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent_policies
List agent policies (agentPolicyList)

Query parameters

perPage (optional)
Query Parameter — The number of items to return default: 20
page (optional)
Query Parameter — default: 1
kuery (optional)
Query Parameter — default: null
full (optional)
Query Parameter — When set to true, retrieve the related package policies for each agent policy. default: null
noAgentCount (optional)
Query Parameter — When set to true, do not count how many agents are in the agent policy, this can improve performance if you are searching over a large number of agent policies. The "agents" property will always be 0 if set to true. default: null

Return type

Example data

Content-Type: application/json
{
  "total" : 5.637376656633329,
  "perPage" : 7.061401241503109,
  "page" : 2.3021358869347655,
  "items" : [ {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  }, {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_policy_list_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agent_policies/_bulk_get
Bulk get agent policies (bulkGetAgentPolicies)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_get_agent_policies_request bulk_get_agent_policies_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "items" : [ {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  }, {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_get_agent_policies_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agent_policies
Create agent policy (createAgentPolicy)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

agent_policy_create_request agent_policy_create_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK create_agent_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agent_policies/delete
Delete agent policy by ID (deleteAgentPolicy)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

delete_agent_policy_request delete_agent_policy_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "success" : true,
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_agent_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
put /agent_policies/{agentPolicyId}
Update agent policy by ID (updateAgentPolicy)

Path parameters

agentPolicyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

agent_policy_update_request agent_policy_update_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "updated_on" : "2000-01-23T04:56:07.000+00:00",
    "package_policies" : [ null, null ],
    "agent_features" : [ {
      "name" : "name",
      "enabled" : true
    }, {
      "name" : "name",
      "enabled" : true
    } ],
    "description" : "description",
    "fleet_server_host_id" : "fleet_server_host_id",
    "monitoring_output_id" : "monitoring_output_id",
    "inactivity_timeout" : 6.027456183070403,
    "download_source_id" : "download_source_id",
    "revision" : 1.4658129805029452,
    "agents" : 5.962133916683182,
    "monitoring_enabled" : [ "metrics", "metrics" ],
    "name" : "name",
    "namespace" : "namespace",
    "updated_by" : "updated_by",
    "data_output_id" : "data_output_id",
    "id" : "id",
    "unenroll_timeout" : 0.8008281904610115
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_policy_info_200_response

400

Generic Error fleet_server_health_check_400_response

Agent Status

edit
Up
get /agent_status/data
Get incoming agent data (getAgentData)

Query parameters

agentsIds (required)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "items" : [ {
    "key" : {
      "data" : true
    }
  }, {
    "key" : {
      "data" : true
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agent_data_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent_status
Get agent status summary (getAgentStatus)

Query parameters

policyId (optional)
Query Parameter — default: null
kuery (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "all" : 2,
  "offline" : 5,
  "other" : 7,
  "total" : 9,
  "inactive" : 1,
  "updating" : 3,
  "online" : 2,
  "active" : 4,
  "error" : 0,
  "unenrolled" : 5,
  "events" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agent_status_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agent-status
Get agent status summary (getAgentStatusDeprecated)

Query parameters

policyId (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "offline" : 5,
  "other" : 2,
  "total" : 7,
  "inactive" : 1,
  "updating" : 9,
  "online" : 5,
  "error" : 0,
  "events" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agent_status_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Agents

edit
Up
post /agents/bulk_reassign
Bulk reassign agents (bulkReassignAgents)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_reassign_agents_request bulk_reassign_agents_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "actionId" : "actionId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_upgrade_agents_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/bulk_request_diagnostics
Bulk request diagnostics from agents (bulkRequestDiagnostics)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_request_diagnostics_request bulk_request_diagnostics_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "actionId" : "actionId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_upgrade_agents_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/bulk_unenroll
Bulk unenroll agents (bulkUnenrollAgents)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_unenroll_agents_request bulk_unenroll_agents_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "actionId" : "actionId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_upgrade_agents_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/bulk_update_agent_tags
Bulk update agent tags (bulkUpdateAgentTags)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_update_agent_tags_request bulk_update_agent_tags_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "actionId" : "actionId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_upgrade_agents_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/bulk_upgrade
Bulk upgrade agents (bulkUpgradeAgents)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_upgrade_agents bulk_upgrade_agents (required)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "actionId" : "actionId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_upgrade_agents_200_response

400

Generic Error fleet_server_health_check_400_response

Up
delete /agents/{agentId}
Delete agent by ID (deleteAgent)

Path parameters

agentId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "action" : "deleted"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_agent_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agents/{agentId}
Get agent by ID (getAgent)

Path parameters

agentId (required)
Path Parameter — default: null

Query parameters

withMetrics (optional)
Query Parameter — Return agent metrics, false by default default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "default_api_key" : "default_api_key",
    "enrolled_at" : "enrolled_at",
    "access_api_key" : "access_api_key",
    "components" : [ {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    }, {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    } ],
    "user_provided_metadata" : "{}",
    "unenrollment_started_at" : "unenrollment_started_at",
    "policy_id" : "policy_id",
    "policy_revision" : 0.8008281904610115,
    "active" : true,
    "local_metadata" : "{}",
    "last_checkin" : "last_checkin",
    "access_api_key_id" : "access_api_key_id",
    "default_api_key_id" : "default_api_key_id",
    "unenrolled_at" : "unenrolled_at",
    "id" : "id",
    "metrics" : {
      "cpu_avg" : 6.027456183070403,
      "memory_size_byte_avg" : 1.4658129805029452
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agent_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agents/tags
List agent tags (getAgentTags)

Return type

Example data

Content-Type: application/json
{
  "items" : [ "items", "items" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agent_tags_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agents/files@{fileId}@{fileName}
Get file uploaded by agent (getAgentUploadFile)

Path parameters

fileId (required)
Path Parameter — default: null
fileName (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "body" : {
    "items" : {
      "headers" : "",
      "body" : ""
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agent_upload_file_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agents
List agents (getAgents)

Query parameters

perPage (optional)
Query Parameter — The number of items to return default: 20
page (optional)
Query Parameter — default: 1
kuery (optional)
Query Parameter — default: null
showInactive (optional)
Query Parameter — default: null
showUpgradeable (optional)
Query Parameter — default: null
sortField (optional)
Query Parameter — default: null
sortOrder (optional)
Query Parameter — default: null
withMetrics (optional)
Query Parameter — Return agent metrics, false by default default: null
getStatusSummary (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "total" : 5.962133916683182,
  "statusSummary" : {
    "offline" : 7.061401241503109,
    "inactive" : 2.027123023002322,
    "updating" : 1.0246457001441578,
    "online" : 3.616076749251911,
    "enrolling" : 4.145608029883936,
    "unenrolling" : 7.386281948385884,
    "degraded'" : 1.4894159098541704,
    "error" : 9.301444243932576,
    "unenrolled" : 1.2315135367772556
  },
  "perPage" : 2.3021358869347655,
  "page" : 5.637376656633329,
  "list" : [ {
    "default_api_key" : "default_api_key",
    "enrolled_at" : "enrolled_at",
    "access_api_key" : "access_api_key",
    "components" : [ {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    }, {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    } ],
    "user_provided_metadata" : "{}",
    "unenrollment_started_at" : "unenrollment_started_at",
    "policy_id" : "policy_id",
    "policy_revision" : 0.8008281904610115,
    "active" : true,
    "local_metadata" : "{}",
    "last_checkin" : "last_checkin",
    "access_api_key_id" : "access_api_key_id",
    "default_api_key_id" : "default_api_key_id",
    "unenrolled_at" : "unenrolled_at",
    "id" : "id",
    "metrics" : {
      "cpu_avg" : 6.027456183070403,
      "memory_size_byte_avg" : 1.4658129805029452
    }
  }, {
    "default_api_key" : "default_api_key",
    "enrolled_at" : "enrolled_at",
    "access_api_key" : "access_api_key",
    "components" : [ {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    }, {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    } ],
    "user_provided_metadata" : "{}",
    "unenrollment_started_at" : "unenrollment_started_at",
    "policy_id" : "policy_id",
    "policy_revision" : 0.8008281904610115,
    "active" : true,
    "local_metadata" : "{}",
    "last_checkin" : "last_checkin",
    "access_api_key_id" : "access_api_key_id",
    "default_api_key_id" : "default_api_key_id",
    "unenrolled_at" : "unenrolled_at",
    "id" : "id",
    "metrics" : {
      "cpu_avg" : 6.027456183070403,
      "memory_size_byte_avg" : 1.4658129805029452
    }
  } ],
  "items" : [ {
    "default_api_key" : "default_api_key",
    "enrolled_at" : "enrolled_at",
    "access_api_key" : "access_api_key",
    "components" : [ {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    }, {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    } ],
    "user_provided_metadata" : "{}",
    "unenrollment_started_at" : "unenrollment_started_at",
    "policy_id" : "policy_id",
    "policy_revision" : 0.8008281904610115,
    "active" : true,
    "local_metadata" : "{}",
    "last_checkin" : "last_checkin",
    "access_api_key_id" : "access_api_key_id",
    "default_api_key_id" : "default_api_key_id",
    "unenrolled_at" : "unenrolled_at",
    "id" : "id",
    "metrics" : {
      "cpu_avg" : 6.027456183070403,
      "memory_size_byte_avg" : 1.4658129805029452
    }
  }, {
    "default_api_key" : "default_api_key",
    "enrolled_at" : "enrolled_at",
    "access_api_key" : "access_api_key",
    "components" : [ {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    }, {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    } ],
    "user_provided_metadata" : "{}",
    "unenrollment_started_at" : "unenrollment_started_at",
    "policy_id" : "policy_id",
    "policy_revision" : 0.8008281904610115,
    "active" : true,
    "local_metadata" : "{}",
    "last_checkin" : "last_checkin",
    "access_api_key_id" : "access_api_key_id",
    "default_api_key_id" : "default_api_key_id",
    "unenrolled_at" : "unenrolled_at",
    "id" : "id",
    "metrics" : {
      "cpu_avg" : 6.027456183070403,
      "memory_size_byte_avg" : 1.4658129805029452
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agents_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agents/setup
Get agent setup info (getAgentsSetupStatus)

Return type

Example data

Content-Type: application/json
{
  "missing_requirements" : [ "tls_required", "tls_required" ],
  "package_verification_key_id" : "package_verification_key_id",
  "isReady" : true,
  "missing_optional_features" : [ "encrypted_saved_object_encryption_key_required", "encrypted_saved_object_encryption_key_required" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK fleet_status_response

400

Generic Error fleet_server_health_check_400_response

Up
get /agents/{agentId}/uploads
List agent uploads (listAgentUploads)

Path parameters

agentId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "body" : {
    "item" : [ {
      "createTime" : "createTime",
      "filePath" : "filePath",
      "name" : "name",
      "actionId" : "actionId",
      "id" : "id",
      "status" : "READY"
    }, {
      "createTime" : "createTime",
      "filePath" : "filePath",
      "name" : "name",
      "actionId" : "actionId",
      "id" : "id",
      "status" : "READY"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK list_agent_uploads_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/{agentId}/reassign
Reassign agent (reassignAgent)

Path parameters

agentId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

reassign_agent_deprecated_request reassign_agent_deprecated_request (required)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK Object

400

Generic Error fleet_server_health_check_400_response

Up
put /agents/{agentId}/reassign
Reassign agent (reassignAgentDeprecated)

Path parameters

agentId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

reassign_agent_deprecated_request reassign_agent_deprecated_request (required)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK Object

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/{agentId}/request_diagnostics
Request agent diagnostics (requestDiagnosticsAgent)

Path parameters

agentId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "actionId" : "actionId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_upgrade_agents_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/setup
Initiate agent setup (setupAgents)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

setup_agents_request setup_agents_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "isInitialized" : true,
  "nonFatalErrors" : [ {
    "name" : "name",
    "message" : "message"
  }, {
    "name" : "name",
    "message" : "message"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK fleet_setup_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/{agentId}/unenroll
Unenroll agent (unenrollAgent)

Path parameters

agentId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

unenroll_agent_request unenroll_agent_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK Object

400

BAD REQUEST unenroll_agent_400_response

Up
put /agents/{agentId}
Update agent by ID (updateAgent)

Path parameters

agentId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

update_agent_request update_agent_request (required)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "default_api_key" : "default_api_key",
    "enrolled_at" : "enrolled_at",
    "access_api_key" : "access_api_key",
    "components" : [ {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    }, {
      "id" : "id",
      "units" : [ {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      }, {
        "payload" : "{}",
        "id" : "id",
        "message" : "message"
      } ],
      "type" : "type",
      "message" : "message"
    } ],
    "user_provided_metadata" : "{}",
    "unenrollment_started_at" : "unenrollment_started_at",
    "policy_id" : "policy_id",
    "policy_revision" : 0.8008281904610115,
    "active" : true,
    "local_metadata" : "{}",
    "last_checkin" : "last_checkin",
    "access_api_key_id" : "access_api_key_id",
    "default_api_key_id" : "default_api_key_id",
    "unenrolled_at" : "unenrolled_at",
    "id" : "id",
    "metrics" : {
      "cpu_avg" : 6.027456183070403,
      "memory_size_byte_avg" : 1.4658129805029452
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_agent_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /agents/{agentId}/upgrade
Upgrade agent (upgradeAgent)

Path parameters

agentId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

upgrade_agent upgrade_agent (required)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "force" : true,
  "version" : "version",
  "source_uri" : "source_uri"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK upgrade_agent

400

Generic Error fleet_server_health_check_400_response

Data Streams

edit
Up
get /data_streams
List data streams (dataStreamsList)

Return type

Example data

Content-Type: application/json
{
  "data_streams" : [ {
    "last_activity_ms" : 0.8008281904610115,
    "size_in_bytes_formatted" : "size_in_bytes_formatted",
    "package" : "package",
    "package_version" : "package_version",
    "namespace" : "namespace",
    "size_in_bytes" : 6.027456183070403,
    "index" : "index",
    "type" : "type",
    "dataset" : "dataset",
    "dashboard" : [ {
      "id" : "id",
      "title" : "title"
    }, {
      "id" : "id",
      "title" : "title"
    } ]
  }, {
    "last_activity_ms" : 0.8008281904610115,
    "size_in_bytes_formatted" : "size_in_bytes_formatted",
    "package" : "package",
    "package_version" : "package_version",
    "namespace" : "namespace",
    "size_in_bytes" : 6.027456183070403,
    "index" : "index",
    "type" : "type",
    "dataset" : "dataset",
    "dashboard" : [ {
      "id" : "id",
      "title" : "title"
    }, {
      "id" : "id",
      "title" : "title"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK data_streams_list_200_response

400

Generic Error fleet_server_health_check_400_response

Elastic Package Manager EPM

edit
Up
post /epm/packages/_bulk
Bulk install packages (bulkInstallPackages)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_install_packages_request bulk_install_packages_request (optional)
Body Parameter

Query parameters

prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false

Return type

Example data

Content-Type: application/json
{
  "response" : [ {
    "name" : "name",
    "version" : "version"
  }, {
    "name" : "name",
    "version" : "version"
  } ],
  "items" : [ {
    "name" : "name",
    "version" : "version"
  }, {
    "name" : "name",
    "version" : "version"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_install_packages_response

400

Generic Error fleet_server_health_check_400_response

Up
delete /epm/packages/{pkgName}/{pkgVersion}
Delete package (deletePackage)

Path parameters

pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

install_package_deprecated_request install_package_deprecated_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Query parameters

ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false

Return type

Example data

Content-Type: application/json
{
  "items" : [ {
    "id" : "id"
  }, {
    "id" : "id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK update_package_200_response

400

Generic Error fleet_server_health_check_400_response

Up
delete /epm/packages/{pkgkey}
Delete ackage (deletePackageDeprecated)

Path parameters

pkgkey (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

install_package_deprecated_request install_package_deprecated_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "response" : [ {
    "id" : "id"
  }, {
    "id" : "id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK install_package_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/packages/{pkgName}/{pkgVersion}
Get package (getPackage)

Path parameters

pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null

Query parameters

ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false

Return type

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_package_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/categories
List package categories (getPackageCategories)

Query parameters

prerelease (optional)
Query Parameter — Whether to include prerelease packages in categories count (e.g. beta, rc, preview) default: false
experimental (optional)
Query Parameter — default: false
include_policy_templates (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "response" : [ {
    "count" : 0.8008281904610115,
    "id" : "id",
    "title" : "title"
  }, {
    "count" : 0.8008281904610115,
    "id" : "id",
    "title" : "title"
  } ],
  "items" : [ {
    "count" : 6.027456183070403,
    "id" : "id",
    "title" : "title"
  }, {
    "count" : 6.027456183070403,
    "id" : "id",
    "title" : "title"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_categories_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/packages/{pkgkey}
Get package (getPackageDeprecated)

Path parameters

pkgkey (required)
Path Parameter — default: null

Query parameters

prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false

Return type

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_package_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/packages/{pkgName}/stats
Get package stats (getPackageStats)

Path parameters

pkgName (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "response" : {
    "agent_policy_count" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_package_stats_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /epm/packages/{pkgName}/{pkgVersion}
Install package (installPackage)

Path parameters

pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

install_package_request install_package_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Query parameters

ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false

Return type

Example data

Content-Type: application/json
{
  "_meta" : {
    "install_source" : "registry"
  },
  "items" : [ {
    "id" : "id"
  }, {
    "id" : "id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK install_package_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /epm/packages
Install by package by direct upload (installPackageByUpload)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/zip
  • application/gzip

Request body

body file (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "_meta" : {
    "install_source" : "upload"
  },
  "items" : [ {
    "id" : "id"
  }, {
    "id" : "id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK install_package_by_upload_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /epm/packages/{pkgkey}
Install package (installPackageDeprecated)

Path parameters

pkgkey (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

install_package_deprecated_request install_package_deprecated_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "response" : [ {
    "id" : "id"
  }, {
    "id" : "id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK install_package_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/packages
List packages (listAllPackages)

Query parameters

excludeInstallStatus (optional)
Query Parameter — Whether to exclude the install status of each package. Enabling this option will opt in to caching for the response via cache-control headers. If you don't need up-to-date installation info for a package, and are querying for a list of available packages, providing this flag can improve performance substantially. default: false
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
experimental (optional)
Query Parameter — default: false
category (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "response" : [ {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "icons" : "icons",
    "title" : "title",
    "type" : "type",
    "version" : "version",
    "status" : "status"
  }, {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "icons" : "icons",
    "title" : "title",
    "type" : "type",
    "version" : "version",
    "status" : "status"
  } ],
  "items" : [ {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "icons" : "icons",
    "title" : "title",
    "type" : "type",
    "version" : "version",
    "status" : "status"
  }, {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "icons" : "icons",
    "title" : "title",
    "type" : "type",
    "version" : "version",
    "status" : "status"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_packages_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/packages/limited
Get limited package list (listLimitedPackages)

Return type

Example data

Content-Type: application/json
{
  "items" : [ "items", "items" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK list_limited_packages_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/packages/{pkgName}/{pkgVersion}/{filePath}
Get package file (packagesGetFile)

Path parameters

pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null
filePath (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "headers" : "{}",
  "body" : "{}",
  "statusCode" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK packages_get_file_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /epm/verification_key_id
Get package signature verification key ID (packagesGetVerificationKeyId)

Return type

Example data

Content-Type: application/json
{
  "headers" : "{}",
  "body" : {
    "id" : "id"
  },
  "statusCode" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK packages_get_verification_key_id_200_response

400

Generic Error fleet_server_health_check_400_response

Up
put /epm/packages/{pkgName}/{pkgVersion}
Update package settings (updatePackage)

Path parameters

pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

update_package_request update_package_request (optional)
Body Parameter

Query parameters

ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false

Return type

Example data

Content-Type: application/json
{
  "items" : [ {
    "id" : "id"
  }, {
    "id" : "id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK update_package_200_response

400

Generic Error fleet_server_health_check_400_response

Enrollment APIKeys

edit
Up
post /enrollment_api_keys
Create enrollment API key (createEnrollmentApiKeys)

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  },
  "action" : "created"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK create_enrollment_api_keys_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /enrollment-api-keys
Create enrollment API key (createEnrollmentApiKeysDeprecated)

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  },
  "action" : "created"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK create_enrollment_api_keys_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
delete /enrollment_api_keys/{keyId}
Delete enrollment API key by ID (deleteEnrollmentApiKey)

Path parameters

keyId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "action" : "deleted"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_agent_200_response

400

Generic Error fleet_server_health_check_400_response

Up
delete /enrollment-api-keys/{keyId}
Delete enrollment API key by ID (deleteEnrollmentApiKeyDeprecated)

Path parameters

keyId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "action" : "deleted"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_agent_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /enrollment_api_keys/{keyId}
Get enrollment API key by ID (getEnrollmentApiKey)

Path parameters

keyId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_enrollment_api_key_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /enrollment-api-keys/{keyId}
Get enrollment API key by ID (getEnrollmentApiKeyDeprecated)

Path parameters

keyId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_enrollment_api_key_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /enrollment_api_keys
List enrollment API keys (getEnrollmentApiKeys)

Return type

Example data

Content-Type: application/json
{
  "total" : 1.4658129805029452,
  "perPage" : 6.027456183070403,
  "page" : 0.8008281904610115,
  "list" : [ {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  }, {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  } ],
  "items" : [ {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  }, {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_enrollment_api_keys_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /enrollment-api-keys
List enrollment API keys (getEnrollmentApiKeysDeprecated)

Return type

Example data

Content-Type: application/json
{
  "total" : 1.4658129805029452,
  "perPage" : 6.027456183070403,
  "page" : 0.8008281904610115,
  "list" : [ {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  }, {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  } ],
  "items" : [ {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  }, {
    "policy_id" : "policy_id",
    "api_key" : "api_key",
    "name" : "name",
    "active" : true,
    "created_at" : "created_at",
    "id" : "id",
    "api_key_id" : "api_key_id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_enrollment_api_keys_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Fleet Internals

edit
Up
post /health_check
Fleet Server health check (fleetServerHealthCheck)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

fleet_server_health_check_request fleet_server_health_check_request (required)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "host" : "host",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK fleet_server_health_check_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /settings
Get settings (getSettings)

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "has_seen_add_data_notice" : true,
    "fleet_server_hosts" : [ "fleet_server_hosts", "fleet_server_hosts" ],
    "prerelease_integrations_enabled" : true,
    "id" : "id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK fleet_settings_response

400

Generic Error fleet_server_health_check_400_response

Up
post /setup
Initiate Fleet setup (setup)

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "isInitialized" : true,
  "nonFatalErrors" : [ {
    "name" : "name",
    "message" : "message"
  }, {
    "name" : "name",
    "message" : "message"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK fleet_setup_response

400

Generic Error fleet_server_health_check_400_response

500

Internal Server Error setup_500_response

Up
put /settings
Update settings (updateSettings)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

update_settings_request update_settings_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "has_seen_add_data_notice" : true,
    "fleet_server_hosts" : [ "fleet_server_hosts", "fleet_server_hosts" ],
    "prerelease_integrations_enabled" : true,
    "id" : "id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK fleet_settings_response

400

Generic Error fleet_server_health_check_400_response

Fleet Server Hosts

edit
Up
delete /fleet_server_hosts/{itemId}
Delete Fleet Server host by ID (deleteFleetServerHosts)

Path parameters

itemId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /fleet_server_hosts
List Fleet Server hosts (getFleetServerHosts)

Return type

Example data

Content-Type: application/json
{
  "total" : 0,
  "perPage" : 1,
  "page" : 6,
  "items" : [ {
    "host_urls" : [ "host_urls", "host_urls" ],
    "is_preconfigured" : true,
    "name" : "name",
    "id" : "id",
    "is_default" : true
  }, {
    "host_urls" : [ "host_urls", "host_urls" ],
    "is_preconfigured" : true,
    "name" : "name",
    "id" : "id",
    "is_default" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_fleet_server_hosts_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /fleet_server_hosts/{itemId}
Get Fleet Server host by ID (getOneFleetServerHosts)

Path parameters

itemId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "host_urls" : [ "host_urls", "host_urls" ],
    "is_preconfigured" : true,
    "name" : "name",
    "id" : "id",
    "is_default" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_one_fleet_server_hosts_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /fleet_server_hosts
Create Fleet Server host (postFleetServerHosts)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

post_fleet_server_hosts_request post_fleet_server_hosts_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "host_urls" : [ "host_urls", "host_urls" ],
    "is_preconfigured" : true,
    "name" : "name",
    "id" : "id",
    "is_default" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK post_fleet_server_hosts_200_response

400

Generic Error fleet_server_health_check_400_response

Up
put /fleet_server_hosts/{itemId}
Update Fleet Server host by ID (updateFleetServerHosts)

Path parameters

itemId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

update_fleet_server_hosts_request update_fleet_server_hosts_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "host_urls" : [ "host_urls", "host_urls" ],
    "is_preconfigured" : true,
    "name" : "name",
    "id" : "id",
    "is_default" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_one_fleet_server_hosts_200_response

400

Generic Error fleet_server_health_check_400_response

Kubernetes

edit
Up
get /kubernetes
Get full K8s agent manifest (getFullK8sManifest)

Query parameters

download (optional)
Query Parameter — default: null
fleetServer (optional)
Query Parameter — default: null
enrolToken (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : "item"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK agent_policy_download_200_response

400

Generic Error fleet_server_health_check_400_response

Outputs

edit
Up
delete /outputs/{outputId}
Delete output by ID (deleteOutput)

Path parameters

outputId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /logstash_api_keys
Generate Logstash API key (generateLogstashApiKey)

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "api_key" : "api_key"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK generate_logstash_api_key_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /outputs/{outputId}
Get output by ID (getOutput)

Path parameters

outputId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "shipper" : {
      "disk_queue_max_size" : 0.8008281904610115,
      "disk_queue_compression_enabled" : true,
      "disk_queue_enabled" : true,
      "disk_queue_path" : "disk_queue_path",
      "disk_queue_encryption_enabled" : true,
      "compression_level" : 6.027456183070403,
      "loadbalance" : true
    },
    "hosts" : [ "hosts", "hosts" ],
    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
    "is_default_monitoring" : true,
    "config_yaml" : "config_yaml",
    "proxy_id" : "proxy_id",
    "is_default" : true,
    "type" : "elasticsearch",
    "ssl" : {
      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
      "certificate" : "certificate",
      "key" : "key"
    },
    "ca_sha256" : "ca_sha256",
    "name" : "name",
    "id" : "id",
    "config" : "{}"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_output_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /outputs
List outputs (getOutputs)

Return type

Example data

Content-Type: application/json
{
  "total" : 1,
  "perPage" : 5,
  "page" : 5,
  "items" : [ {
    "shipper" : {
      "disk_queue_max_size" : 0.8008281904610115,
      "disk_queue_compression_enabled" : true,
      "disk_queue_enabled" : true,
      "disk_queue_path" : "disk_queue_path",
      "disk_queue_encryption_enabled" : true,
      "compression_level" : 6.027456183070403,
      "loadbalance" : true
    },
    "hosts" : [ "hosts", "hosts" ],
    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
    "is_default_monitoring" : true,
    "config_yaml" : "config_yaml",
    "proxy_id" : "proxy_id",
    "is_default" : true,
    "type" : "elasticsearch",
    "ssl" : {
      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
      "certificate" : "certificate",
      "key" : "key"
    },
    "ca_sha256" : "ca_sha256",
    "name" : "name",
    "id" : "id",
    "config" : "{}"
  }, {
    "shipper" : {
      "disk_queue_max_size" : 0.8008281904610115,
      "disk_queue_compression_enabled" : true,
      "disk_queue_enabled" : true,
      "disk_queue_path" : "disk_queue_path",
      "disk_queue_encryption_enabled" : true,
      "compression_level" : 6.027456183070403,
      "loadbalance" : true
    },
    "hosts" : [ "hosts", "hosts" ],
    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
    "is_default_monitoring" : true,
    "config_yaml" : "config_yaml",
    "proxy_id" : "proxy_id",
    "is_default" : true,
    "type" : "elasticsearch",
    "ssl" : {
      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
      "certificate" : "certificate",
      "key" : "key"
    },
    "ca_sha256" : "ca_sha256",
    "name" : "name",
    "id" : "id",
    "config" : "{}"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_outputs_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /outputs
Create output (postOutputs)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

post_outputs_request post_outputs_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "shipper" : {
      "disk_queue_max_size" : 0.8008281904610115,
      "disk_queue_compression_enabled" : true,
      "disk_queue_enabled" : true,
      "disk_queue_path" : "disk_queue_path",
      "disk_queue_encryption_enabled" : true,
      "compression_level" : 6.027456183070403,
      "loadbalance" : true
    },
    "hosts" : [ "hosts", "hosts" ],
    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
    "is_default_monitoring" : true,
    "config_yaml" : "config_yaml",
    "proxy_id" : "proxy_id",
    "is_default" : true,
    "type" : "elasticsearch",
    "ssl" : {
      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
      "certificate" : "certificate",
      "key" : "key"
    },
    "ca_sha256" : "ca_sha256",
    "name" : "name",
    "id" : "id",
    "config" : "{}"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK post_outputs_200_response

400

Generic Error fleet_server_health_check_400_response

Up
put /outputs/{outputId}
Update output by ID (updateOutput)

Path parameters

outputId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

update_output_request update_output_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "shipper" : {
      "disk_queue_max_size" : 0.8008281904610115,
      "disk_queue_compression_enabled" : true,
      "disk_queue_enabled" : true,
      "disk_queue_path" : "disk_queue_path",
      "disk_queue_encryption_enabled" : true,
      "compression_level" : 6.027456183070403,
      "loadbalance" : true
    },
    "hosts" : [ "hosts", "hosts" ],
    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
    "is_default_monitoring" : true,
    "config_yaml" : "config_yaml",
    "proxy_id" : "proxy_id",
    "is_default" : true,
    "type" : "elasticsearch",
    "ssl" : {
      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
      "certificate" : "certificate",
      "key" : "key"
    },
    "ca_sha256" : "ca_sha256",
    "name" : "name",
    "id" : "id",
    "config" : "{}"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_output_200_response

400

Generic Error fleet_server_health_check_400_response

Package Policies

edit
Up
post /package_policies/_bulk_get
Bulk get package policies (bulkGetPackagePolicies)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

bulk_get_package_policies_request bulk_get_package_policies_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "items" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK bulk_get_package_policies_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /package_policies
Create package policy (createPackagePolicy)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

package_policy_request package_policy_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK create_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
delete /package_policies/{packagePolicyId}
Delete package policy by ID (deletePackagePolicy)

Path parameters

packagePolicyId (required)
Path Parameter — default: null

Query parameters

force (optional)
Query Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /package_policies
List package policies (getPackagePolicies)

Return type

Example data

Content-Type: application/json
{
  "total" : 0.8008281904610115,
  "perPage" : 1.4658129805029452,
  "page" : 6.027456183070403,
  "items" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_package_policies_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /package_policies/{packagePolicyId}
Get package policy by ID (getPackagePolicy)

Path parameters

packagePolicyId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK create_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /package_policies/delete
Delete package policy (postDeletePackagePolicy)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

post_delete_package_policy_request post_delete_package_policy_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
[ {
  "success" : true,
  "name" : "name",
  "id" : "id"
}, {
  "success" : true,
  "name" : "name",
  "id" : "id"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK

400

Generic Error fleet_server_health_check_400_response

Up
put /package_policies/{packagePolicyId}
Update package policy by ID (updatePackagePolicy)

Path parameters

packagePolicyId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

package_policy_request package_policy_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "sucess" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK update_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /package_policies/upgrade
Upgrade package policy to a newer package version (upgradePackagePolicy)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

upgrade_package_policy_request upgrade_package_policy_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
[ {
  "success" : true,
  "name" : "name",
  "id" : "id"
}, {
  "success" : true,
  "name" : "name",
  "id" : "id"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK

400

Generic Error fleet_server_health_check_400_response

Up
post /package_policies/upgrade/dryrun
Dry run package policy upgrade (upgradePackagePolicyDryRun)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

upgrade_package_policy_dry_run_request upgrade_package_policy_dry_run_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
[ {
  "hasErrors" : true,
  "agent_diff" : [ [ null, null ], [ null, null ] ],
  "diff" : [ null, null ]
}, {
  "hasErrors" : true,
  "agent_diff" : [ [ null, null ], [ null, null ] ],
  "diff" : [ null, null ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK

400

Generic Error fleet_server_health_check_400_response

Proxies

edit
Up
delete /proxies/{itemId}
Delete proxy by ID (deleteFleetProxies)

Path parameters

itemId (required)
Path Parameter — default: null

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK delete_package_policy_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /proxies
List proxies (getFleetProxies)

Return type

Example data

Content-Type: application/json
{
  "total" : 0,
  "perPage" : 1,
  "page" : 6,
  "items" : [ {
    "proxy_headers" : "{}",
    "certificate_authorities" : "certificate_authorities",
    "certificate_key" : "certificate_key",
    "name" : "name",
    "certificate" : "certificate",
    "id" : "id",
    "url" : "url"
  }, {
    "proxy_headers" : "{}",
    "certificate_authorities" : "certificate_authorities",
    "certificate_key" : "certificate_key",
    "name" : "name",
    "certificate" : "certificate",
    "id" : "id",
    "url" : "url"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_fleet_proxies_200_response

400

Generic Error fleet_server_health_check_400_response

Up
get /proxies/{itemId}
Get proxy by ID (getOneFleetProxies)

Path parameters

itemId (required)
Path Parameter — default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "proxy_headers" : "{}",
    "certificate_authorities" : "certificate_authorities",
    "certificate_key" : "certificate_key",
    "name" : "name",
    "certificate" : "certificate",
    "id" : "id",
    "url" : "url"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_one_fleet_proxies_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /proxies
Create proxy (postFleetProxies)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

post_fleet_proxies_request post_fleet_proxies_request (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "proxy_headers" : "{}",
    "certificate_authorities" : "certificate_authorities",
    "certificate_key" : "certificate_key",
    "name" : "name",
    "certificate" : "certificate",
    "id" : "id",
    "url" : "url"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK post_fleet_proxies_200_response

400

Generic Error fleet_server_health_check_400_response

Up
put /proxies/{itemId}
Update proxy by ID (updateFleetProxies)

Path parameters

itemId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

update_fleet_proxies_request update_fleet_proxies_request (optional)
Body Parameter

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "item" : {
    "proxy_headers" : "{}",
    "certificate_authorities" : "certificate_authorities",
    "certificate_key" : "certificate_key",
    "name" : "name",
    "certificate" : "certificate",
    "id" : "id",
    "url" : "url"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK get_one_fleet_proxies_200_response

400

Generic Error fleet_server_health_check_400_response

Service Tokens

edit
Up
post /service_tokens
Create service token (generateServiceToken)

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "value" : "value"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK generate_service_token_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Up
post /service-tokens
Create service token (generateServiceTokenDeprecated)

Request headers

kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "value" : "value"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

OK generate_service_token_deprecated_200_response

400

Generic Error fleet_server_health_check_400_response

Models

[ Jump to Methods ]

Table of Contents

  1. Full_agent_policy_output_permissions -
  2. Full_agent_policy_output_permissions_data -
  3. Full_agent_policy_output_permissions_data_indices_inner -
  4. agent - Agent
  5. agent_action - Agent action
  6. agent_action_cancel_200_response -
  7. agent_action_oneOf -
  8. agent_action_oneOf_1 -
  9. agent_action_oneOf_1_data -
  10. agent_component - Agent component
  11. agent_component_status - Agent component status
  12. agent_component_unit - Agent component unit
  13. agent_component_unit_type - Agent component unit type
  14. agent_diagnostics - Agent diagnostics
  15. agent_metrics -
  16. agent_policy - Agent Policy
  17. agent_policy_agent_features_inner -
  18. agent_policy_copy_request -
  19. agent_policy_create_request - Create agent policy request
  20. agent_policy_download_200_response -
  21. agent_policy_full - Agent policy full response
  22. agent_policy_full_200_response -
  23. agent_policy_full_200_response_item -
  24. agent_policy_full_oneOf -
  25. agent_policy_full_oneOf_1 -
  26. agent_policy_info_200_response -
  27. agent_policy_list_200_response -
  28. agent_policy_update_request - Update agent policy request
  29. agent_status - Agent status
  30. agent_type - Agent type
  31. agents_action_status_200_response -
  32. agents_action_status_200_response_items_inner -
  33. agents_action_status_200_response_items_inner_latestErrors_inner -
  34. bulk_get_agent_policies_200_response -
  35. bulk_get_agent_policies_request -
  36. bulk_get_package_policies_200_response -
  37. bulk_get_package_policies_request -
  38. bulk_install_packages_request -
  39. bulk_install_packages_response - Bulk install packages response
  40. bulk_install_packages_response_response_inner -
  41. bulk_reassign_agents_request -
  42. bulk_reassign_agents_request_agents -
  43. bulk_request_diagnostics_request -
  44. bulk_unenroll_agents_request -
  45. bulk_update_agent_tags_request -
  46. bulk_upgrade_agents - Bulk upgrade agents
  47. bulk_upgrade_agents_200_response -
  48. create_agent_policy_200_response -
  49. create_enrollment_api_keys_deprecated_200_response -
  50. create_package_policy_200_response -
  51. data_stream - Data stream
  52. data_stream_dashboard_inner -
  53. data_streams_list_200_response -
  54. delete_agent_200_response -
  55. delete_agent_policy_200_response -
  56. delete_agent_policy_request -
  57. delete_package_policy_200_response -
  58. download_sources - Download Source
  59. elasticsearch_asset_type - Elasticsearch asset type
  60. enrollment_api_key - Enrollment API key
  61. fleet_server_health_check_200_response -
  62. fleet_server_health_check_400_response -
  63. fleet_server_health_check_request -
  64. fleet_server_host - Fleet Server Host
  65. fleet_settings_response - Fleet settings response
  66. fleet_setup_response - Fleet Setup response
  67. fleet_setup_response_nonFatalErrors_inner -
  68. fleet_status_response - Fleet status response
  69. full_agent_policy - Full agent policy
  70. full_agent_policy_fleet -
  71. full_agent_policy_fleet_oneOf -
  72. full_agent_policy_fleet_oneOf_1 -
  73. full_agent_policy_fleet_oneOf_1_kibana -
  74. full_agent_policy_fleet_oneOf_ssl -
  75. full_agent_policy_input - Full agent policy input
  76. full_agent_policy_input_allOf -
  77. full_agent_policy_input_allOf_data_stream -
  78. full_agent_policy_input_stream - Full agent policy input stream
  79. full_agent_policy_input_stream_allOf -
  80. full_agent_policy_input_stream_allOf_data_stream -
  81. full_agent_policy_output - Full agent policy
  82. full_agent_policy_output_additionalProperties -
  83. full_agent_policy_output_permissions_1_value -
  84. generate_logstash_api_key_200_response -
  85. generate_service_token_deprecated_200_response -
  86. get_agent_200_response -
  87. get_agent_data_200_response -
  88. get_agent_data_200_response_items_inner_value -
  89. get_agent_status_200_response -
  90. get_agent_status_deprecated_200_response -
  91. get_agent_tags_response - Get Agent Tags response
  92. get_agent_upload_file_200_response -
  93. get_agent_upload_file_200_response_body -
  94. get_agent_upload_file_200_response_body_items -
  95. get_agents_response - Get Agent response
  96. get_agents_response_statusSummary -
  97. get_categories_response - Get categories response
  98. get_categories_response_items_inner -
  99. get_categories_response_response_inner -
  100. get_download_sources_200_response -
  101. get_enrollment_api_key_deprecated_200_response -
  102. get_enrollment_api_keys_deprecated_200_response -
  103. get_fleet_proxies_200_response -
  104. get_fleet_server_hosts_200_response -
  105. get_one_download_source_200_response -
  106. get_one_fleet_proxies_200_response -
  107. get_one_fleet_server_hosts_200_response -
  108. get_output_200_response -
  109. get_outputs_200_response -
  110. get_package_200_response -
  111. get_package_200_response_allOf -
  112. get_package_200_response_allOf_1 -
  113. get_package_deprecated_200_response -
  114. get_package_deprecated_200_response_allOf -
  115. get_package_deprecated_200_response_allOf_1 -
  116. get_package_policies_200_response -
  117. get_package_stats_200_response -
  118. get_packages_response - Get Packages response
  119. install_package_200_response -
  120. install_package_200_response__meta -
  121. install_package_by_upload_200_response -
  122. install_package_by_upload_200_response__meta -
  123. install_package_by_upload_200_response_items_inner -
  124. install_package_by_upload_200_response_items_inner_type -
  125. install_package_deprecated_200_response -
  126. install_package_deprecated_request -
  127. install_package_request -
  128. kibana_saved_object_type - Kibana saved object asset type
  129. list_agent_uploads_200_response -
  130. list_agent_uploads_200_response_body -
  131. list_limited_packages_200_response -
  132. new_agent_action_200_response -
  133. new_agent_action_request -
  134. new_package_policy - New package policy
  135. new_package_policy_inputs_inner -
  136. new_package_policy_package -
  137. output - Output
  138. output_shipper -
  139. output_ssl -
  140. package_info - Package information
  141. package_info_conditions -
  142. package_info_conditions_elasticsearch -
  143. package_info_conditions_kibana -
  144. package_info_data_streams_inner -
  145. package_info_data_streams_inner_vars_inner -
  146. package_info_elasticsearch -
  147. package_info_elasticsearch_privileges -
  148. package_info_screenshots_inner -
  149. package_info_source -
  150. package_policy - Package policy
  151. package_policy_allOf -
  152. package_policy_request - Package Policy Request
  153. package_policy_request_inputs_value -
  154. package_policy_request_inputs_value_streams_value -
  155. package_policy_request_package -
  156. package_usage_stats - Package usage stats
  157. packages_get_file_200_response -
  158. packages_get_verification_key_id_200_response -
  159. packages_get_verification_key_id_200_response_body -
  160. post_delete_package_policy_200_response_inner -
  161. post_delete_package_policy_request -
  162. post_download_sources_200_response -
  163. post_download_sources_request -
  164. post_fleet_proxies_200_response -
  165. post_fleet_proxies_request -
  166. post_fleet_server_hosts_200_response -
  167. post_fleet_server_hosts_request -
  168. post_outputs_200_response -
  169. post_outputs_request -
  170. proxies - Fleet Proxy
  171. reassign_agent_deprecated_request -
  172. search_result - Search result
  173. settings - Settings
  174. setup_500_response -
  175. setup_agents_request -
  176. unenroll_agent_400_response -
  177. unenroll_agent_request -
  178. update_agent_request -
  179. update_download_source_request -
  180. update_fleet_proxies_request -
  181. update_fleet_server_hosts_request -
  182. update_output_request -
  183. update_package_200_response -
  184. update_package_policy_200_response -
  185. update_package_request -
  186. update_settings_request -
  187. upgrade_agent - Upgrade agent
  188. upgrade_diff_inner -
  189. upgrade_diff_inner_allOf -
  190. upgrade_diff_inner_allOf_allOf -
  191. upgrade_diff_inner_allOf_allOf_errors_inner -
  192. upgrade_package_policy_dry_run_200_response_inner -
  193. upgrade_package_policy_dry_run_request -
  194. upgrade_package_policy_request -

agent - Agent Up

type
active
enrolled_at
unenrolled_at (optional)
unenrollment_started_at (optional)
access_api_key_id (optional)
default_api_key_id (optional)
policy_id (optional)
policy_revision (optional)
last_checkin (optional)
user_provided_metadata (optional)
local_metadata (optional)
id
access_api_key (optional)
status
default_api_key (optional)
components (optional)
metrics (optional)

agent_action - Agent action Up

data (optional)
ack_data (optional)
type (optional)

agent_action_oneOf - Up

data (optional)
ack_data (optional)
type (optional)
Enum:
UNENROLL
UPGRADE
POLICY_REASSIGN

agent_action_oneOf_1_data - Up

log_level (optional)
Enum:
debug
info
warning
error

agent_component - Agent component Up

id (optional)
type (optional)
status (optional)
message (optional)
units (optional)

agent_component_unit - Agent component unit Up

id (optional)
type (optional)
status (optional)
message (optional)
payload (optional)

agent_diagnostics - Agent diagnostics Up

id
name
createTime
filePath
actionId
status
Enum:
READY
AWAITING_UPLOAD
DELETED
IN_PROGRESS

agent_metrics - Up

cpu_avg (optional)
Big Decimal Average agent CPU usage during the last 5 minutes, number between 0-1
memory_size_byte_avg (optional)
Big Decimal Average agent memory consumption during the last 5 minutes

agent_policy - Agent Policy Up

id
name
namespace
description (optional)
monitoring_enabled (optional)
Enum:
data_output_id (optional)
monitoring_output_id (optional)
fleet_server_host_id (optional)
download_source_id (optional)
unenroll_timeout (optional)
inactivity_timeout (optional)
package_policies (optional)
array[package_policy] This field is present only when retrieving a single agent policy, or when retrieving a list of agent policy with the ?full=true parameter
updated_on (optional)
Date format: date-time
updated_by (optional)
revision (optional)
agents (optional)
agent_features (optional)

agent_policy_copy_request - Up

name
description (optional)

agent_policy_create_request - Create agent policy request Up

id (optional)
name
namespace
description (optional)
monitoring_enabled (optional)
Enum:
data_output_id (optional)
monitoring_output_id (optional)
fleet_server_host_id (optional)
download_source_id (optional)
unenroll_timeout (optional)
inactivity_timeout (optional)
agent_features (optional)

agent_policy_update_request - Update agent policy request Up

name
namespace
description (optional)
monitoring_enabled (optional)
Enum:
data_output_id (optional)
monitoring_output_id (optional)
fleet_server_host_id (optional)
download_source_id (optional)
unenroll_timeout (optional)
inactivity_timeout (optional)
agent_features (optional)

agents_action_status_200_response_items_inner - Up

actionId
status
Enum:
COMPLETE
EXPIRED
CANCELLED
FAILED
IN_PROGRESS
ROLLOUT_PASSED
nbAgentsActioned
nbAgentsActionCreated
nbAgentsAck
nbAgentsFailed
version (optional)
startTime (optional)
type (optional)
expiration (optional)
completionTime (optional)
cancellationTime (optional)
newPolicyId (optional)
creationTime
latestErrors (optional)
array[agents_action_status_200_response_items_inner_latestErrors_inner] latest errors that happened when the agents executed the action

agents_action_status_200_response_items_inner_latestErrors_inner - Up

agentId (optional)
error (optional)
timestamp (optional)

bulk_get_agent_policies_request - Up

ids
array[String] list of agent policy ids
full (optional)
Boolean get full policies with package policies populated
ignoreMissing (optional)

bulk_get_package_policies_request - Up

ids
array[String] list of package policy ids
ignoreMissing (optional)

bulk_install_packages_request - Up

packages
array[String] list of package names to install
force (optional)
Boolean force install to ignore package verification errors

bulk_unenroll_agents_request - Up

revoke (optional)
Boolean Revokes API keys of agents
force (optional)
Boolean Unenroll hosted agents too
agents

bulk_update_agent_tags_request - Up

agents
tagsToAdd (optional)
tagsToRemove (optional)
batchSize (optional)

bulk_upgrade_agents - Bulk upgrade agents Up

version
String version to upgrade to
source_uri (optional)
String alternative upgrade binary download url
rollout_duration_seconds (optional)
Big Decimal rolling upgrade window duration in seconds
start_time (optional)
String start time of upgrade in ISO 8601 format
agents
force (optional)
Boolean Force upgrade, skipping validation (should be used with caution)

data_stream - Data stream Up

index (optional)
dataset (optional)
namespace (optional)
type (optional)
package (optional)
package_version (optional)
last_activity_ms (optional)
size_in_bytes (optional)
size_in_bytes_formatted (optional)
dashboard (optional)

data_stream_dashboard_inner - Up

id (optional)
title (optional)

delete_agent_200_response - Up

action
Enum:
deleted

download_sources - Download Source Up

id (optional)
is_default
name
host

enrollment_api_key - Enrollment API key Up

id
api_key_id
api_key
name (optional)
active
policy_id (optional)
created_at

fleet_server_health_check_200_response - Up

name (optional)
status (optional)
host (optional)

fleet_server_health_check_400_response - Up

statusCode (optional)
error (optional)
message (optional)

fleet_server_host - Fleet Server Host Up

id
name (optional)
is_default
is_preconfigured
host_urls

fleet_status_response - Fleet status response Up

isReady
missing_requirements
Enum:
missing_optional_features
Enum:
package_verification_key_id (optional)

full_agent_policy - Full agent policy Up

id
outputs
output_permissions (optional)
fleet (optional)
inputs
revision (optional)
agent (optional)
download_source_id (optional)

full_agent_policy_fleet - Up

hosts (optional)
proxy_url (optional)
proxy_headers (optional)
ssl (optional)
kibana (optional)

full_agent_policy_fleet_oneOf - Up

hosts (optional)
proxy_url (optional)
proxy_headers (optional)
ssl (optional)

full_agent_policy_fleet_oneOf_1_kibana - Up

hosts (optional)
protocol (optional)
path (optional)

full_agent_policy_fleet_oneOf_ssl - Up

verification_mode (optional)
certificate (optional)
key (optional)
certificate_authorities (optional)
renegotiation (optional)

get_agent_status_200_response - Up

error
events
inactive
unenrolled (optional)
offline
online
other
total
updating
all
active

get_agent_status_deprecated_200_response - Up

error
events
inactive
offline
online
other
total
updating

get_agents_response_statusSummary - Up

offline (optional)
error (optional)
online (optional)
inactive (optional)
enrolling (optional)
unenrolling (optional)
unenrolled (optional)
updating (optional)
degradedQuote (optional)

get_download_sources_200_response - Up

items (optional)
total (optional)
page (optional)
perPage (optional)

get_fleet_proxies_200_response - Up

items (optional)
total (optional)
page (optional)
perPage (optional)

get_fleet_server_hosts_200_response - Up

items (optional)
total (optional)
page (optional)
perPage (optional)

get_outputs_200_response - Up

items (optional)
total (optional)
page (optional)
perPage (optional)

get_package_200_response - Up

item (optional)
status
Enum:
installed
installing
install_failed
not_installed
savedObject
latestVersion (optional)
keepPoliciesUpToDate (optional)
notice (optional)
licensePath (optional)

get_package_200_response_allOf_1 - Up

status
Enum:
installed
installing
install_failed
not_installed
savedObject
latestVersion (optional)
keepPoliciesUpToDate (optional)
notice (optional)
licensePath (optional)

get_package_deprecated_200_response - Up

response (optional)
status
Enum:
installed
installing
install_failed
not_installed
savedObject

get_package_deprecated_200_response_allOf_1 - Up

status
Enum:
installed
installing
install_failed
not_installed
savedObject

install_package_200_response__meta - Up

install_source (optional)
Enum:
registry
upload
bundled

install_package_by_upload_200_response__meta - Up

install_source (optional)
Enum:
upload
registry
bundled

install_package_request - Up

force (optional)
ignore_constraints (optional)

new_agent_action_200_response - Up

body (optional)
statusCode (optional)
headers (optional)

new_package_policy - New package policy Up

enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
inputs
policy_id (optional)
name
description (optional)

new_package_policy_inputs_inner - Up

type
enabled
processors (optional)
streams (optional)
config (optional)
vars (optional)

new_package_policy_package - Up

name
version
title (optional)

output - Output Up

id
is_default
is_default_monitoring (optional)
name
type
Enum:
elasticsearch
logstash
hosts (optional)
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)

output_shipper - Up

disk_queue_enabled (optional)
disk_queue_path (optional)
disk_queue_max_size (optional)
disk_queue_encryption_enabled (optional)
disk_queue_compression_enabled (optional)
compression_level (optional)
loadbalance (optional)

output_ssl - Up

certificate_authorities (optional)
certificate (optional)
key (optional)

package_info - Package information Up

name
title
version
release (optional)
String release label is deprecated, derive from the version instead (packages follow semver)
Enum:
experimental
beta
ga
source (optional)
readme (optional)
description
type
categories
conditions
screenshots (optional)
icons (optional)
assets
internal (optional)
format_version
data_streams (optional)
download
path
elasticsearch (optional)

package_info_conditions_elasticsearch - Up

subscription (optional)
Enum:
basic
gold
platinum
enterprise

package_info_screenshots_inner - Up

src
path
title (optional)
size (optional)
type (optional)

package_info_source - Up

license (optional)
Enum:
Apache-2.0
Elastic-2.0

package_policy - Package policy Up

id
revision
inputs
enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
policy_id (optional)
name
description (optional)

package_policy_request - Package Policy Request Up

id (optional)
String Package policy unique identifier
name
String Package policy name (should be unique)
description (optional)
String Package policy description
namespace (optional)
String namespace by default "default"
policy_id
String Agent policy ID where that package policy will be added
package
vars (optional)
Object Package root level variable (see integration documentation for more information)
inputs (optional)
map[String, package_policy_request_inputs_value] Package policy inputs (see integration documentation to know what inputs are available)
force (optional)
Boolean Force package policy creation even if package is not verified, or if the agent policy is managed.

package_policy_request_inputs_value - Up

enabled (optional)
Boolean enable or disable that input, (default to true)
vars (optional)
Object Input level variable (see integration documentation for more information)
streams (optional)
map[String, package_policy_request_inputs_value_streams_value] Input streams (see integration documentation to know what streams are available)

package_policy_request_inputs_value_streams_value - Up

enabled (optional)
Boolean enable or disable that stream, (default to true)
vars (optional)
Object Stream level variable (see integration documentation for more information)

package_policy_request_package - Up

name
String Package name
version
String Package version

packages_get_file_200_response - Up

body (optional)
statusCode (optional)
headers (optional)

packages_get_verification_key_id_200_response_body - Up

id (optional)
String the key ID of the GPG key used to verify package signatures

post_download_sources_request - Up

id (optional)
name
is_default
host

post_fleet_proxies_request - Up

id (optional)
name
url
proxy_headers (optional)
certificate_authorities (optional)
certificate (optional)
certificate_key (optional)

post_fleet_server_hosts_request - Up

id (optional)
name
is_default (optional)
host_urls

post_outputs_request - Up

id (optional)
name
type
Enum:
elasticsearch
is_default (optional)
is_default_monitoring (optional)
hosts (optional)
ca_sha256 (optional)
config_yaml (optional)

proxies - Fleet Proxy Up

id (optional)
name
url
proxy_headers (optional)
certificate_authorities (optional)
certificate (optional)
certificate_key (optional)

search_result - Search result Up

description
download
icons
name
path
title
type
version
status
savedObject (optional)

settings - Settings Up

id
has_seen_add_data_notice (optional)
fleet_server_hosts
prerelease_integrations_enabled (optional)

setup_500_response - Up

message (optional)

setup_agents_request - Up

admin_username
admin_password

unenroll_agent_400_response - Up

error (optional)
message (optional)
statusCode (optional)
Enum:
400

unenroll_agent_request - Up

revoke (optional)
force (optional)

update_agent_request - Up

user_provided_metadata (optional)
tags (optional)

update_fleet_proxies_request - Up

name (optional)
url (optional)
proxy_headers (optional)
certificate_authorities (optional)
certificate (optional)
certificate_key (optional)

update_fleet_server_hosts_request - Up

name (optional)
is_default (optional)
host_urls (optional)

update_output_request - Up

name
type
Enum:
elasticsearch
is_default (optional)
is_default_monitoring (optional)
hosts (optional)
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config_yaml (optional)

update_package_request - Up

keepPoliciesUpToDate (optional)

update_settings_request - Up

fleet_server_hosts (optional)
array[String] Protocol and path must be the same for each URL
has_seen_add_data_notice (optional)
additional_yaml_config (optional)

upgrade_agent - Upgrade agent Up

version
source_uri (optional)
force (optional)
Boolean Force upgrade, skipping validation (should be used with caution)

upgrade_diff_inner - Up

id
revision
inputs
enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
policy_id (optional)
name
description (optional)
errors (optional)
missingVars (optional)

upgrade_diff_inner_allOf - Up

enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
inputs
policy_id (optional)
name
description (optional)
errors (optional)
missingVars (optional)

upgrade_package_policy_dry_run_request - Up

packagePolicyIds
packageVersion (optional)