IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« API Appendix B: Deleted pages »
Elastic Docs ›Fleet and Elastic Agent Guide [8.11] ›API

Fleet APIs

edit

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

agent_action_cancel_200_response

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

agents_action_status_200_response

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" : "POLICY_REASSIGN",
    "newPolicyId" : "newPolicyId",
    "version" : "version",
    "revision" : "revision",
    "completionTime" : "completionTime",
    "policyId" : "policyId",
    "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" : "POLICY_REASSIGN",
    "newPolicyId" : "newPolicyId",
    "version" : "version",
    "revision" : "revision",
    "completionTime" : "completionTime",
    "policyId" : "policyId",
    "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

new_agent_action_200_response

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

delete_package_policy_200_response

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

get_download_sources_200_response

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

get_one_download_source_200_response

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

post_download_sources_200_response

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

get_one_download_source_200_response

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

agent_policy_info_200_response

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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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

agent_policy_download_200_response

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

agent_policy_full_200_response

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

agent_policy_info_200_response

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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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

agent_policy_list_200_response

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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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

bulk_get_agent_policies_200_response

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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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

create_agent_policy_200_response

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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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

delete_agent_policy_200_response

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

agent_policy_info_200_response

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,
    "overrides" : "{}",
    "download_source_id" : "download_source_id",
    "is_protected" : true,
    "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

get_agent_data_200_response

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

get_agent_status_200_response

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

get_agent_status_deprecated_200_response

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

bulk_upgrade_agents_200_response

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

bulk_upgrade_agents_200_response

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

bulk_upgrade_agents_200_response

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

bulk_upgrade_agents_200_response

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

bulk_upgrade_agents_200_response

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

delete_agent_200_response

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

get_agent_200_response

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

get_agent_tags_response

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

get_agent_upload_file_200_response

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

get_agents_response

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 
post /agents
List agents by action ids (getAgentsByActions)

Consumes

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

Request body

get_agents_by_actions_request get_agents_by_actions_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

array[array[String]]

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

400

Generic Error fleet_server_health_check_400_response
Up 
get /agents/setup
Get agent setup info (getAgentsSetupStatus)

Return type

fleet_status_response

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

list_agent_uploads_200_response

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

bulk_upgrade_agents_200_response

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

fleet_setup_response

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

get_agent_200_response

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

upgrade_agent

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

data_streams_list_200_response

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/bulk_assets
Bulk get assets (bulkGetAssets)

Consumes

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

Request body

bulk_get_assets_request bulk_get_assets_request (optional)
Body Parameter —

Return type

get_bulk_assets_response

Example data

Content-Type: application/json
{
  "response" : [ [ {
    "attributes" : {
      "description" : "description",
      "title" : "title"
    },
    "id" : "id",
    "updatedAt" : "updatedAt"
  }, {
    "attributes" : {
      "description" : "description",
      "title" : "title"
    },
    "id" : "id",
    "updatedAt" : "updatedAt"
  } ], [ {
    "attributes" : {
      "description" : "description",
      "title" : "title"
    },
    "id" : "id",
    "updatedAt" : "updatedAt"
  }, {
    "attributes" : {
      "description" : "description",
      "title" : "title"
    },
    "id" : "id",
    "updatedAt" : "updatedAt"
  } ] ]
}

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_bulk_assets_response

400

Generic Error fleet_server_health_check_400_response
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

bulk_install_packages_response

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

update_package_200_response

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

install_package_deprecated_200_response

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

get_package_200_response

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

get_categories_response

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

get_package_deprecated_200_response

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

get_package_stats_200_response

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

install_package_200_response

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

install_package_by_upload_200_response

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

install_package_deprecated_200_response

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

get_packages_response

Example data

Content-Type: application/json
{
  "response" : [ {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "installationInfo" : {
      "installed_kibana" : {
        "id" : "id"
      },
      "created_at" : "created_at",
      "type" : "type",
      "verification_status" : "verified",
      "installed_es" : {
        "deferred" : true,
        "id" : "id"
      },
      "version" : "version",
      "experimental_data_stream_features" : "",
      "updated_at" : "updated_at",
      "install_status" : "installed",
      "install_kibana_space_id" : "install_kibana_space_id",
      "verification_key_id" : "verification_key_id",
      "name" : "name",
      "install_source" : "registry",
      "install_format_schema_version" : "install_format_schema_version",
      "namespaces" : [ "namespaces", "namespaces" ]
    },
    "icons" : "icons",
    "title" : "title",
    "type" : "type",
    "version" : "version",
    "status" : "status"
  }, {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "installationInfo" : {
      "installed_kibana" : {
        "id" : "id"
      },
      "created_at" : "created_at",
      "type" : "type",
      "verification_status" : "verified",
      "installed_es" : {
        "deferred" : true,
        "id" : "id"
      },
      "version" : "version",
      "experimental_data_stream_features" : "",
      "updated_at" : "updated_at",
      "install_status" : "installed",
      "install_kibana_space_id" : "install_kibana_space_id",
      "verification_key_id" : "verification_key_id",
      "name" : "name",
      "install_source" : "registry",
      "install_format_schema_version" : "install_format_schema_version",
      "namespaces" : [ "namespaces", "namespaces" ]
    },
    "icons" : "icons",
    "title" : "title",
    "type" : "type",
    "version" : "version",
    "status" : "status"
  } ],
  "items" : [ {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "installationInfo" : {
      "installed_kibana" : {
        "id" : "id"
      },
      "created_at" : "created_at",
      "type" : "type",
      "verification_status" : "verified",
      "installed_es" : {
        "deferred" : true,
        "id" : "id"
      },
      "version" : "version",
      "experimental_data_stream_features" : "",
      "updated_at" : "updated_at",
      "install_status" : "installed",
      "install_kibana_space_id" : "install_kibana_space_id",
      "verification_key_id" : "verification_key_id",
      "name" : "name",
      "install_source" : "registry",
      "install_format_schema_version" : "install_format_schema_version",
      "namespaces" : [ "namespaces", "namespaces" ]
    },
    "icons" : "icons",
    "title" : "title",
    "type" : "type",
    "version" : "version",
    "status" : "status"
  }, {
    "savedObject" : "{}",
    "path" : "path",
    "download" : "download",
    "name" : "name",
    "description" : "description",
    "installationInfo" : {
      "installed_kibana" : {
        "id" : "id"
      },
      "created_at" : "created_at",
      "type" : "type",
      "verification_status" : "verified",
      "installed_es" : {
        "deferred" : true,
        "id" : "id"
      },
      "version" : "version",
      "experimental_data_stream_features" : "",
      "updated_at" : "updated_at",
      "install_status" : "installed",
      "install_kibana_space_id" : "install_kibana_space_id",
      "verification_key_id" : "verification_key_id",
      "name" : "name",
      "install_source" : "registry",
      "install_format_schema_version" : "install_format_schema_version",
      "namespaces" : [ "namespaces", "namespaces" ]
    },
    "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

list_limited_packages_200_response

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

packages_get_file_200_response

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

packages_get_verification_key_id_200_response

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

update_package_200_response

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

create_enrollment_api_keys_deprecated_200_response

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

create_enrollment_api_keys_deprecated_200_response

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

delete_agent_200_response

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

delete_agent_200_response

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

get_enrollment_api_key_deprecated_200_response

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

get_enrollment_api_key_deprecated_200_response

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

get_enrollment_api_keys_deprecated_200_response

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

get_enrollment_api_keys_deprecated_200_response

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

fleet_server_health_check_200_response

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

fleet_settings_response

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

fleet_setup_response

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

fleet_settings_response

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

delete_package_policy_200_response

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

get_fleet_server_hosts_200_response

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

get_one_fleet_server_hosts_200_response

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

post_fleet_server_hosts_200_response

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

get_one_fleet_server_hosts_200_response

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

agent_policy_download_200_response

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

delete_package_policy_200_response

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

generate_logstash_api_key_200_response

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

output_create_request

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 output_create_request

400

Generic Error fleet_server_health_check_400_response
Up 
get /outputs
List outputs (getOutputs)

Return type

get_outputs_200_response

Example data

Content-Type: application/json
{
  "total" : 0,
  "perPage" : 1,
  "page" : 6,
  "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_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

output_create_request output_create_request (required)
Body Parameter —

Return type

post_outputs_200_response

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 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

output_update_request output_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

output_update_request

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 output_update_request

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 —

Query parameters

format (optional)
Query Parameter — Simplified or legacy format for package inputs default: null

Return type

bulk_get_package_policies_200_response

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

Query parameters

format (optional)
Query Parameter — Simplified or legacy format for package inputs default: null

Return type

create_package_policy_200_response

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

409

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

delete_package_policy_200_response

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)

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
format (optional)
Query Parameter — Simplified or legacy format for package inputs default: null

Return type

get_package_policies_200_response

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

Query parameters

format (optional)
Query Parameter — Simplified or legacy format for package inputs default: null

Return type

create_package_policy_200_response

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

array[post_delete_package_policy_200_response_inner]

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

Query parameters

format (optional)
Query Parameter — Simplified or legacy format for package inputs default: null

Return type

update_package_policy_200_response

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

array[post_delete_package_policy_200_response_inner]

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

409

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

array[upgrade_package_policy_dry_run_200_response_inner]

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

delete_package_policy_200_response

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

get_fleet_proxies_200_response

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

get_one_fleet_proxies_200_response

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

post_fleet_proxies_200_response

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

get_one_fleet_proxies_200_response

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

generate_service_token_deprecated_200_response

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

generate_service_token_deprecated_200_response

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_info_200_response -
  26. agent_policy_list_200_response -
  27. agent_policy_update_request - Update agent policy request
  28. agent_status - Agent status
  29. agent_type - Agent type
  30. agents_action_status_200_response -
  31. agents_action_status_200_response_items_inner -
  32. agents_action_status_200_response_items_inner_latestErrors_inner -
  33. bulk_get_agent_policies_200_response -
  34. bulk_get_agent_policies_request -
  35. bulk_get_assets_request -
  36. bulk_get_assets_request_assetIds_inner -
  37. bulk_get_package_policies_200_response -
  38. bulk_get_package_policies_request -
  39. bulk_install_packages_request -
  40. bulk_install_packages_request_packages_inner -
  41. bulk_install_packages_request_packages_inner_oneOf -
  42. bulk_install_packages_response - Bulk install packages response
  43. bulk_install_packages_response_response_inner -
  44. bulk_reassign_agents_request -
  45. bulk_reassign_agents_request_agents -
  46. bulk_request_diagnostics_request -
  47. bulk_unenroll_agents_request -
  48. bulk_update_agent_tags_request -
  49. bulk_upgrade_agents - Bulk upgrade agents
  50. bulk_upgrade_agents_200_response -
  51. create_agent_policy_200_response -
  52. create_enrollment_api_keys_deprecated_200_response -
  53. create_package_policy_200_response -
  54. data_stream - Data stream
  55. data_stream_dashboard_inner -
  56. data_streams_list_200_response -
  57. delete_agent_200_response -
  58. delete_agent_policy_200_response -
  59. delete_agent_policy_request -
  60. delete_package_policy_200_response -
  61. download_sources - Download Source
  62. elasticsearch_asset_type - Elasticsearch asset type
  63. enrollment_api_key - Enrollment API key
  64. fleet_server_health_check_200_response -
  65. fleet_server_health_check_400_response -
  66. fleet_server_health_check_request -
  67. fleet_server_host - Fleet Server Host
  68. fleet_settings_response - Fleet settings response
  69. fleet_setup_response - Fleet Setup response
  70. fleet_setup_response_nonFatalErrors_inner -
  71. fleet_status_response - Fleet status response
  72. full_agent_policy - Full agent policy
  73. full_agent_policy_fleet -
  74. full_agent_policy_fleet_oneOf -
  75. full_agent_policy_fleet_oneOf_1 -
  76. full_agent_policy_fleet_oneOf_1_kibana -
  77. full_agent_policy_fleet_oneOf_ssl -
  78. full_agent_policy_input - Full agent policy input
  79. full_agent_policy_input_allOf -
  80. full_agent_policy_input_allOf_data_stream -
  81. full_agent_policy_input_allOf_meta -
  82. full_agent_policy_input_allOf_meta_package -
  83. full_agent_policy_input_stream - Full agent policy input stream
  84. full_agent_policy_input_stream_allOf -
  85. full_agent_policy_input_stream_allOf_data_stream -
  86. full_agent_policy_output - Full agent policy
  87. full_agent_policy_output_additionalProperties -
  88. full_agent_policy_output_permissions_1_value -
  89. full_agent_policy_secret_references_inner -
  90. generate_logstash_api_key_200_response -
  91. generate_service_token_deprecated_200_response -
  92. get_agent_200_response -
  93. get_agent_data_200_response -
  94. get_agent_data_200_response_items_inner_value -
  95. get_agent_status_200_response -
  96. get_agent_status_deprecated_200_response -
  97. get_agent_tags_response - Get Agent Tags response
  98. get_agent_upload_file_200_response -
  99. get_agent_upload_file_200_response_body -
  100. get_agent_upload_file_200_response_body_items -
  101. get_agents_by_actions_request -
  102. get_agents_response - Get Agent response
  103. get_agents_response_statusSummary -
  104. get_bulk_assets_response - Bulk get assets response
  105. get_bulk_assets_response_response_inner_inner -
  106. get_bulk_assets_response_response_inner_inner_attributes -
  107. get_categories_response - Get categories response
  108. get_categories_response_items_inner -
  109. get_categories_response_response_inner -
  110. get_download_sources_200_response -
  111. get_enrollment_api_key_deprecated_200_response -
  112. get_enrollment_api_keys_deprecated_200_response -
  113. get_fleet_proxies_200_response -
  114. get_fleet_server_hosts_200_response -
  115. get_one_download_source_200_response -
  116. get_one_fleet_proxies_200_response -
  117. get_one_fleet_server_hosts_200_response -
  118. get_outputs_200_response -
  119. get_package_200_response -
  120. get_package_200_response_allOf -
  121. get_package_200_response_allOf_1 -
  122. get_package_deprecated_200_response -
  123. get_package_deprecated_200_response_allOf -
  124. get_package_deprecated_200_response_allOf_1 -
  125. get_package_policies_200_response -
  126. get_package_stats_200_response -
  127. get_packages_response - Get Packages response
  128. install_package_200_response -
  129. install_package_200_response__meta -
  130. install_package_by_upload_200_response -
  131. install_package_by_upload_200_response__meta -
  132. install_package_by_upload_200_response_items_inner -
  133. install_package_by_upload_200_response_items_inner_type -
  134. install_package_deprecated_200_response -
  135. install_package_deprecated_request -
  136. install_package_request -
  137. installation_info - Installation info object
  138. installation_info_installed_es -
  139. installation_info_installed_kibana -
  140. kibana_saved_object_type - Kibana saved object asset type
  141. list_agent_uploads_200_response -
  142. list_agent_uploads_200_response_body -
  143. list_limited_packages_200_response -
  144. new_agent_action_200_response -
  145. new_agent_action_request -
  146. new_package_policy - New package policy
  147. new_package_policy_inputs_inner -
  148. new_package_policy_package -
  149. output_create_request - Output
  150. output_create_request_elasticsearch - elasticsearch
  151. output_create_request_elasticsearch_shipper -
  152. output_create_request_elasticsearch_ssl -
  153. output_create_request_kafka - kafka
  154. output_create_request_kafka_headers_inner -
  155. output_create_request_kafka_random -
  156. output_create_request_kafka_sasl -
  157. output_create_request_kafka_topics_inner -
  158. output_create_request_kafka_topics_inner_when -
  159. output_create_request_logstash - logstash
  160. output_update_request - Output
  161. output_update_request_elasticsearch - elasticsearch
  162. output_update_request_kafka - kafka
  163. output_update_request_logstash - logstash
  164. package_info - Package information
  165. package_info_conditions -
  166. package_info_conditions_elasticsearch -
  167. package_info_conditions_kibana -
  168. package_info_data_streams_inner -
  169. package_info_data_streams_inner_vars_inner -
  170. package_info_elasticsearch -
  171. package_info_elasticsearch_privileges -
  172. package_info_screenshots_inner -
  173. package_info_source -
  174. package_policy - Package policy
  175. package_policy_allOf -
  176. package_policy_allOf_inputs -
  177. package_policy_request - Package Policy Request
  178. package_policy_request_inputs_value -
  179. package_policy_request_inputs_value_streams_value -
  180. package_policy_request_package -
  181. package_usage_stats - Package usage stats
  182. packages_get_file_200_response -
  183. packages_get_verification_key_id_200_response -
  184. packages_get_verification_key_id_200_response_body -
  185. post_delete_package_policy_200_response_inner -
  186. post_delete_package_policy_request -
  187. post_download_sources_200_response -
  188. post_download_sources_request -
  189. post_fleet_proxies_200_response -
  190. post_fleet_proxies_request -
  191. post_fleet_server_hosts_200_response -
  192. post_fleet_server_hosts_request -
  193. post_outputs_200_response -
  194. proxies - Fleet Proxy
  195. reassign_agent_deprecated_request -
  196. saved_object_type - Saved Object type
  197. search_result - Search result
  198. settings - Settings
  199. setup_500_response -
  200. setup_agents_request -
  201. unenroll_agent_400_response -
  202. unenroll_agent_request -
  203. update_agent_request -
  204. update_download_source_request -
  205. update_fleet_proxies_request -
  206. update_fleet_server_hosts_request -
  207. update_package_200_response -
  208. update_package_policy_200_response -
  209. update_package_request -
  210. update_settings_request -
  211. upgrade_agent - Upgrade agent
  212. upgrade_diff_inner -
  213. upgrade_diff_inner_allOf -
  214. upgrade_diff_inner_allOf_allOf -
  215. upgrade_diff_inner_allOf_allOf_errors_inner -
  216. upgrade_package_policy_dry_run_200_response_inner -
  217. upgrade_package_policy_dry_run_request -
  218. upgrade_package_policy_request -

Full_agent_policy_output_permissions - Up

packagePolicyName (optional)
String
data (optional)
Full_agent_policy_output_permissions_data

Full_agent_policy_output_permissions_data - Up

cluster (optional)
array[String]
indices (optional)
array[Full_agent_policy_output_permissions_data_indices_inner]

Full_agent_policy_output_permissions_data_indices_inner - Up

names (optional)
array[String]
privileges (optional)
array[String]

agent - Agent Up

type
agent_type
active
Boolean
enrolled_at
String
unenrolled_at (optional)
String
unenrollment_started_at (optional)
String
access_api_key_id (optional)
String
default_api_key_id (optional)
String
policy_id (optional)
String
policy_revision (optional)
Big Decimal
last_checkin (optional)
String
user_provided_metadata (optional)
Object
local_metadata (optional)
Object
id
String
access_api_key (optional)
String
status
agent_status
default_api_key (optional)
String
components (optional)
array[agent_component]
metrics (optional)
agent_metrics

agent_action - Agent action Up

data (optional)
agent_action_oneOf_1_data
ack_data (optional)
String
type (optional)
String

agent_action_cancel_200_response - Up

item (optional)
agent_action

agent_action_oneOf - Up

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

agent_action_oneOf_1 - Up

type (optional)
String
data (optional)
agent_action_oneOf_1_data

agent_action_oneOf_1_data - Up

log_level (optional)
String
Enum:
debug
info
warning
error

agent_component - Agent component Up

id (optional)
String
type (optional)
String
status (optional)
agent_component_status
message (optional)
String
units (optional)
array[agent_component_unit]

agent_component_status - Agent component status Up

agent_component_unit - Agent component unit Up

id (optional)
String
type (optional)
agent_component_unit_type
status (optional)
agent_component_status
message (optional)
String
payload (optional)
Object

agent_component_unit_type - Agent component unit type Up

agent_diagnostics - Agent diagnostics Up

id
String
name
String
createTime
String
filePath
String
actionId
String
status
String
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
String
name
String
namespace
String
description (optional)
String
monitoring_enabled (optional)
array[String]
Enum:
data_output_id (optional)
String
monitoring_output_id (optional)
String
fleet_server_host_id (optional)
String
download_source_id (optional)
String
unenroll_timeout (optional)
Big Decimal
inactivity_timeout (optional)
Big Decimal
package_policies (optional)
array[package_policy] This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
updated_on (optional)
Date format: date-time
updated_by (optional)
String
revision (optional)
Big Decimal
agents (optional)
Big Decimal
agent_features (optional)
array[agent_policy_agent_features_inner]
is_protected (optional)
Boolean Indicates whether the agent policy has tamper protection enabled. Default false.
overrides (optional)
Object Override settings that are defined in the agent policy. Input settings cannot be overridden. The override option should be used only in unusual circumstances and not as a routine procedure.

agent_policy_agent_features_inner - Up

name
String
enabled
Boolean

agent_policy_copy_request - Up

name
String
description (optional)
String

agent_policy_create_request - Create agent policy request Up

id (optional)
String
name
String
namespace
String
description (optional)
String
monitoring_enabled (optional)
array[String]
Enum:
data_output_id (optional)
String
monitoring_output_id (optional)
String
fleet_server_host_id (optional)
String
download_source_id (optional)
String
unenroll_timeout (optional)
Big Decimal
inactivity_timeout (optional)
Big Decimal
agent_features (optional)
array[agent_policy_agent_features_inner]
is_protected (optional)
Boolean

agent_policy_download_200_response - Up

item (optional)
String

agent_policy_full - Agent policy full response Up

item (optional)
full_agent_policy

agent_policy_full_200_response - Up

item (optional)
agent_policy_full_200_response_item

agent_policy_full_200_response_item - Up

item (optional)
full_agent_policy

agent_policy_full_oneOf - Up

item (optional)
full_agent_policy

agent_policy_info_200_response - Up

item
agent_policy

agent_policy_list_200_response - Up

items
array[agent_policy]
total
Big Decimal
page
Big Decimal
perPage
Big Decimal

agent_policy_update_request - Update agent policy request Up

name
String
namespace
String
description (optional)
String
monitoring_enabled (optional)
array[String]
Enum:
data_output_id (optional)
String
monitoring_output_id (optional)
String
fleet_server_host_id (optional)
String
download_source_id (optional)
String
unenroll_timeout (optional)
Big Decimal
inactivity_timeout (optional)
Big Decimal
agent_features (optional)
array[agent_policy_agent_features_inner]
is_protected (optional)
Boolean

agent_status - Agent status Up

agent_type - Agent type Up

agents_action_status_200_response - Up

items
array[agents_action_status_200_response_items_inner]

agents_action_status_200_response_items_inner - Up

actionId
String
status
String
Enum:
COMPLETE
EXPIRED
CANCELLED
FAILED
IN_PROGRESS
ROLLOUT_PASSED
nbAgentsActioned
Big Decimal number of agents actioned
nbAgentsActionCreated
Big Decimal number of agents included in action from kibana
nbAgentsAck
Big Decimal number of agents that acknowledged the action
nbAgentsFailed
Big Decimal number of agents that failed to execute the action
version (optional)
String agent version number (UPGRADE action)
startTime (optional)
String start time of action (scheduled actions)
type
String
Enum:
POLICY_REASSIGN
UPGRADE
UNENROLL
FORCE_UNENROLL
UPDATE_TAGS
CANCEL
REQUEST_DIAGNOSTICS
SETTINGS
POLICY_CHANGE
INPUT_ACTION
expiration (optional)
String
completionTime (optional)
String
cancellationTime (optional)
String
newPolicyId (optional)
String new policy id (POLICY_REASSIGN action)
policyId (optional)
String policy id (POLICY_CHANGE action)
revision (optional)
String new policy revision (POLICY_CHANGE action)
creationTime
String creation time of action
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)
String
error (optional)
String
timestamp (optional)
String

bulk_get_agent_policies_200_response - Up

items
array[agent_policy]

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)
Boolean

bulk_get_assets_request - Up

assetIds
array[bulk_get_assets_request_assetIds_inner] list of items necessary to fetch assets

bulk_get_assets_request_assetIds_inner - Up

type (optional)
String
id (optional)
String

bulk_get_package_policies_200_response - Up

items
array[package_policy]

bulk_get_package_policies_request - Up

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

bulk_install_packages_request - Up

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

bulk_install_packages_request_packages_inner - Up

name (optional)
String package name
version (optional)
String package version

bulk_install_packages_request_packages_inner_oneOf - Up

name (optional)
String package name
version (optional)
String package version

bulk_install_packages_response - Bulk install packages response Up

response (optional)
array[bulk_install_packages_response_response_inner]
items
array[bulk_install_packages_response_response_inner]

bulk_install_packages_response_response_inner - Up

name (optional)
String
version (optional)
String

bulk_reassign_agents_request - Up

policy_id
String new agent policy id
agents
bulk_reassign_agents_request_agents

bulk_reassign_agents_request_agents - Up

bulk_request_diagnostics_request - Up

batchSize (optional)
Big Decimal
agents
bulk_reassign_agents_request_agents

bulk_unenroll_agents_request - Up

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

bulk_update_agent_tags_request - Up

agents
bulk_reassign_agents_request_agents
tagsToAdd (optional)
array[String]
tagsToRemove (optional)
array[String]
batchSize (optional)
Big Decimal

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
bulk_reassign_agents_request_agents
force (optional)
Boolean Force upgrade, skipping validation (should be used with caution)

bulk_upgrade_agents_200_response - Up

actionId (optional)
String

create_agent_policy_200_response - Up

item (optional)
agent_policy

create_enrollment_api_keys_deprecated_200_response - Up

item (optional)
enrollment_api_key
action (optional)
String
Enum:
created

create_package_policy_200_response - Up

item
package_policy

data_stream - Data stream Up

index (optional)
String
dataset (optional)
String
namespace (optional)
String
type (optional)
String
package (optional)
String
package_version (optional)
String
last_activity_ms (optional)
Big Decimal
size_in_bytes (optional)
Big Decimal
size_in_bytes_formatted (optional)
String
dashboard (optional)
array[data_stream_dashboard_inner]

data_stream_dashboard_inner - Up

id (optional)
String
title (optional)
String

data_streams_list_200_response - Up

data_streams (optional)
array[data_stream]

delete_agent_200_response - Up

action
String
Enum:
deleted

delete_agent_policy_200_response - Up

id
String
success
Boolean

delete_agent_policy_request - Up

agentPolicyId
String

delete_package_policy_200_response - Up

id
String

download_sources - Download Source Up

id (optional)
String
is_default
Boolean
name
String
host
String

elasticsearch_asset_type - Elasticsearch asset type Up

enrollment_api_key - Enrollment API key Up

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

fleet_server_health_check_200_response - Up

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

fleet_server_health_check_400_response - Up

statusCode (optional)
Big Decimal
error (optional)
String
message (optional)
String

fleet_server_health_check_request - Up

host (optional)
String

fleet_server_host - Fleet Server Host Up

id
String
name (optional)
String
is_default
Boolean
is_preconfigured
Boolean
host_urls
array[String]

fleet_settings_response - Fleet settings response Up

item
settings

fleet_setup_response - Fleet Setup response Up

isInitialized
Boolean
nonFatalErrors
array[fleet_setup_response_nonFatalErrors_inner]

fleet_setup_response_nonFatalErrors_inner - Up

name
String
message
String

fleet_status_response - Fleet status response Up

isReady
Boolean
missing_requirements
array[String]
Enum:
missing_optional_features
array[String]
Enum:
package_verification_key_id (optional)
String

full_agent_policy - Full agent policy Up

id
String
outputs
map[String, full_agent_policy_output]
output_permissions (optional)
map[String, full_agent_policy_output_permissions_1_value]
fleet (optional)
full_agent_policy_fleet
inputs
String
revision (optional)
Big Decimal
agent (optional)
String
secret_references (optional)
array[full_agent_policy_secret_references_inner]

full_agent_policy_fleet - Up

hosts (optional)
array[String]
proxy_url (optional)
String
proxy_headers (optional)
oas_any_type_not_mapped
ssl (optional)
full_agent_policy_fleet_oneOf_ssl
kibana (optional)
full_agent_policy_fleet_oneOf_1_kibana

full_agent_policy_fleet_oneOf - Up

hosts (optional)
array[String]
proxy_url (optional)
String
proxy_headers (optional)
oas_any_type_not_mapped
ssl (optional)
full_agent_policy_fleet_oneOf_ssl

full_agent_policy_fleet_oneOf_1 - Up

kibana (optional)
full_agent_policy_fleet_oneOf_1_kibana

full_agent_policy_fleet_oneOf_1_kibana - Up

hosts (optional)
array[String]
protocol (optional)
String
path (optional)
String

full_agent_policy_fleet_oneOf_ssl - Up

verification_mode (optional)
String
certificate (optional)
String
key (optional)
String
certificate_authorities (optional)
array[String]
renegotiation (optional)
String

full_agent_policy_input - Full agent policy input Up

id
String
name
String
revision
Big Decimal
type
String
data_stream
full_agent_policy_input_allOf_data_stream
use_output
String
meta (optional)
full_agent_policy_input_allOf_meta
streams (optional)
full_agent_policy_input_stream

full_agent_policy_input_allOf - Up

id
String
name
String
revision
Big Decimal
type
String
data_stream
full_agent_policy_input_allOf_data_stream
use_output
String
meta (optional)
full_agent_policy_input_allOf_meta
streams (optional)
full_agent_policy_input_stream

full_agent_policy_input_allOf_data_stream - Up

namespace
String

full_agent_policy_input_allOf_meta - Up

package (optional)
full_agent_policy_input_allOf_meta_package

full_agent_policy_input_allOf_meta_package - Up

name
String
version
String

full_agent_policy_input_stream - Full agent policy input stream Up

id
String
data_stream
full_agent_policy_input_stream_allOf_data_stream

full_agent_policy_input_stream_allOf - Up

id
String
data_stream
full_agent_policy_input_stream_allOf_data_stream

full_agent_policy_input_stream_allOf_data_stream - Up

dataset
String
type
String

full_agent_policy_output - Full agent policy Up

hosts
array[String]
ca_sha256
String
proxy_url (optional)
String
proxy_headers (optional)
oas_any_type_not_mapped
type
oas_any_type_not_mapped
additionalProperties (optional)
full_agent_policy_output_additionalProperties

full_agent_policy_output_additionalProperties - Up

text (optional)
oas_any_type_not_mapped

full_agent_policy_output_permissions_1_value - Up

output (optional)
Integer
data (optional)
map[String, Full_agent_policy_output_permissions]

full_agent_policy_secret_references_inner - Up

id (optional)
String

generate_logstash_api_key_200_response - Up

api_key (optional)
String

generate_service_token_deprecated_200_response - Up

name (optional)
String
value (optional)
String

get_agent_200_response - Up

item
agent

get_agent_data_200_response - Up

items (optional)
array[map[String, get_agent_data_200_response_items_inner_value]]

get_agent_data_200_response_items_inner_value - Up

data (optional)
Boolean

get_agent_status_200_response - Up

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

get_agent_status_deprecated_200_response - Up

error
Integer
events
Integer
inactive
Integer
offline
Integer
online
Integer
other
Integer
total
Integer
updating
Integer

get_agent_tags_response - Get Agent Tags response Up

items (optional)
array[String]

get_agent_upload_file_200_response - Up

body (optional)
get_agent_upload_file_200_response_body

get_agent_upload_file_200_response_body - Up

items (optional)
get_agent_upload_file_200_response_body_items

get_agent_upload_file_200_response_body_items - Up

body (optional)
oas_any_type_not_mapped
headers (optional)
oas_any_type_not_mapped

get_agents_by_actions_request - Up

actionIds (optional)
array[String]

get_agents_response - Get Agent response Up

list (optional)
array[agent]
items
array[agent]
total
Big Decimal
page
Big Decimal
perPage
Big Decimal
statusSummary (optional)
get_agents_response_statusSummary

get_agents_response_statusSummary - Up

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

get_bulk_assets_response - Bulk get assets response Up

response (optional)
array[array[get_bulk_assets_response_response_inner_inner]]

get_bulk_assets_response_response_inner_inner - Up

id (optional)
String
type (optional)
saved_object_type
updatedAt (optional)
String
attributes (optional)
get_bulk_assets_response_response_inner_inner_attributes

get_bulk_assets_response_response_inner_inner_attributes - Up

title (optional)
String
description (optional)
String

get_categories_response - Get categories response Up

response (optional)
array[get_categories_response_response_inner]
items
array[get_categories_response_items_inner]

get_categories_response_items_inner - Up

id
String
title
String
count
Big Decimal

get_categories_response_response_inner - Up

id
String
title
String
count
Big Decimal

get_download_sources_200_response - Up

items (optional)
array[download_sources]
total (optional)
Integer
page (optional)
Integer
perPage (optional)
Integer

get_enrollment_api_key_deprecated_200_response - Up

item
enrollment_api_key

get_enrollment_api_keys_deprecated_200_response - Up

list (optional)
array[enrollment_api_key]
items
array[enrollment_api_key]
page
Big Decimal
perPage
Big Decimal
total
Big Decimal

get_fleet_proxies_200_response - Up

items (optional)
array[proxies]
total (optional)
Integer
page (optional)
Integer
perPage (optional)
Integer

get_fleet_server_hosts_200_response - Up

items (optional)
array[fleet_server_host]
total (optional)
Integer
page (optional)
Integer
perPage (optional)
Integer

get_one_download_source_200_response - Up

item
download_sources

get_one_fleet_proxies_200_response - Up

item
proxies

get_one_fleet_server_hosts_200_response - Up

item
fleet_server_host

get_outputs_200_response - Up

items (optional)
array[output_create_request]
total (optional)
Integer
page (optional)
Integer
perPage (optional)
Integer

get_package_200_response - Up

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

get_package_200_response_allOf - Up

item (optional)
package_info

get_package_200_response_allOf_1 - Up

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

get_package_deprecated_200_response - Up

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

get_package_deprecated_200_response_allOf - Up

response (optional)
package_info

get_package_deprecated_200_response_allOf_1 - Up

status
String
Enum:
installed
installing
install_failed
not_installed
savedObject
String

get_package_policies_200_response - Up

items
array[package_policy]
total (optional)
Big Decimal
page (optional)
Big Decimal
perPage (optional)
Big Decimal

get_package_stats_200_response - Up

response
package_usage_stats

get_packages_response - Get Packages response Up

response (optional)
array[search_result]
items
array[search_result]

install_package_200_response - Up

items
array[install_package_by_upload_200_response_items_inner]
_meta (optional)
install_package_200_response__meta

install_package_200_response__meta - Up

install_source (optional)
String
Enum:
registry
upload
bundled

install_package_by_upload_200_response - Up

items
array[install_package_by_upload_200_response_items_inner]
_meta (optional)
install_package_by_upload_200_response__meta

install_package_by_upload_200_response__meta - Up

install_source (optional)
String
Enum:
upload
registry
bundled

install_package_by_upload_200_response_items_inner - Up

id
String
type
install_package_by_upload_200_response_items_inner_type

install_package_by_upload_200_response_items_inner_type - Up

install_package_deprecated_200_response - Up

response
array[install_package_by_upload_200_response_items_inner]

install_package_deprecated_request - Up

force (optional)
Boolean

install_package_request - Up

force (optional)
Boolean
ignore_constraints (optional)
Boolean

installation_info - Installation info object Up

type (optional)
String
created_at (optional)
String
updated_at (optional)
String
namespaces (optional)
array[String]
installed_kibana
installation_info_installed_kibana
installed_es
installation_info_installed_es
name
String
version
String
install_status
String
Enum:
installed
installing
install_failed
install_source
String
Enum:
registry
upload
bundled
install_kibana_space_id (optional)
String
install_format_schema_version (optional)
String
verification_status
String
Enum:
verified
unverified
unknown
verification_key_id (optional)
String
experimental_data_stream_features (optional)
Object

installation_info_installed_es - Up

id (optional)
String
deferred (optional)
Boolean
type (optional)
elasticsearch_asset_type

installation_info_installed_kibana - Up

id (optional)
String
type (optional)
kibana_saved_object_type

kibana_saved_object_type - Kibana saved object asset type Up

list_agent_uploads_200_response - Up

body (optional)
list_agent_uploads_200_response_body

list_agent_uploads_200_response_body - Up

item (optional)
array[agent_diagnostics]

list_limited_packages_200_response - Up

items (optional)
array[String]

new_agent_action_200_response - Up

body (optional)
array[BigDecimal]
statusCode (optional)
Big Decimal
headers (optional)
String

new_agent_action_request - Up

action (optional)
agent_action

new_package_policy - New package policy Up

enabled (optional)
Boolean
package (optional)
new_package_policy_package
namespace (optional)
String
output_id (optional)
String
inputs
array[new_package_policy_inputs_inner]
policy_id (optional)
String
name
String
description (optional)
String

new_package_policy_inputs_inner - Up

type
String
enabled
Boolean
processors (optional)
array[String]
streams (optional)
array[oas_any_type_not_mapped]
config (optional)
Object
vars (optional)
Object

new_package_policy_package - Up

name
String
version
String
title (optional)
String

output_create_request - Output Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type
String
Enum:
logstash
hosts
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper
version (optional)
String
key (optional)
String
compression (optional)
String
compression_level (optional)
Big Decimal
client_id (optional)
String
auth_type
String
username (optional)
String
password (optional)
String
sasl (optional)
output_create_request_kafka_sasl
partition (optional)
String
random (optional)
output_create_request_kafka_random
round_robin (optional)
output_create_request_kafka_random
topics
array[output_create_request_kafka_topics_inner]
headers (optional)
array[output_create_request_kafka_headers_inner]
timeout (optional)
Big Decimal
broker_timeout (optional)
Big Decimal
broker_buffer_size (optional)
Big Decimal
broker_ack_reliability (optional)
String

output_create_request_elasticsearch - elasticsearch Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type (optional)
String
Enum:
elasticsearch
hosts (optional)
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper

output_create_request_elasticsearch_shipper - Up

disk_queue_enabled (optional)
Boolean
disk_queue_path (optional)
String
disk_queue_max_size (optional)
Big Decimal
disk_queue_encryption_enabled (optional)
Boolean
disk_queue_compression_enabled (optional)
Boolean
compression_level (optional)
Big Decimal
loadbalance (optional)
Boolean

output_create_request_elasticsearch_ssl - Up

certificate_authorities (optional)
array[String]
certificate (optional)
String
key (optional)
String

output_create_request_kafka - kafka Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type
String
Enum:
kafka
hosts
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper
version (optional)
String
key (optional)
String
compression (optional)
String
compression_level (optional)
Big Decimal
client_id (optional)
String
auth_type
String
username (optional)
String
password (optional)
String
sasl (optional)
output_create_request_kafka_sasl
partition (optional)
String
random (optional)
output_create_request_kafka_random
round_robin (optional)
output_create_request_kafka_random
topics
array[output_create_request_kafka_topics_inner]
headers (optional)
array[output_create_request_kafka_headers_inner]
timeout (optional)
Big Decimal
broker_timeout (optional)
Big Decimal
broker_buffer_size (optional)
Big Decimal
broker_ack_reliability (optional)
String

output_create_request_kafka_headers_inner - Up

key (optional)
String
value (optional)
String

output_create_request_kafka_random - Up

group_events (optional)
Big Decimal

output_create_request_kafka_sasl - Up

mechanism (optional)
String

output_create_request_kafka_topics_inner - Up

topic (optional)
String
when (optional)
output_create_request_kafka_topics_inner_when

output_create_request_kafka_topics_inner_when - Up

type (optional)
String
condition (optional)
String

output_create_request_logstash - logstash Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type
String
Enum:
logstash
hosts
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper

output_update_request - Output Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type
String
Enum:
logstash
hosts
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper
version (optional)
String
key (optional)
String
compression (optional)
String
compression_level (optional)
Big Decimal
client_id (optional)
String
auth_type (optional)
String
username (optional)
String
password (optional)
String
sasl (optional)
output_create_request_kafka_sasl
partition (optional)
String
random (optional)
output_create_request_kafka_random
round_robin (optional)
output_create_request_kafka_random
topics (optional)
array[output_create_request_kafka_topics_inner]
headers (optional)
array[output_create_request_kafka_headers_inner]
timeout (optional)
Big Decimal
broker_timeout (optional)
Big Decimal
broker_ack_reliability (optional)
String
broker_buffer_size (optional)
Big Decimal

output_update_request_elasticsearch - elasticsearch Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type
String
Enum:
elasticsearch
hosts
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper

output_update_request_kafka - kafka Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type (optional)
String
Enum:
kafka
hosts (optional)
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper
version (optional)
String
key (optional)
String
compression (optional)
String
compression_level (optional)
Big Decimal
client_id (optional)
String
auth_type (optional)
String
username (optional)
String
password (optional)
String
sasl (optional)
output_create_request_kafka_sasl
partition (optional)
String
random (optional)
output_create_request_kafka_random
round_robin (optional)
output_create_request_kafka_random
topics (optional)
array[output_create_request_kafka_topics_inner]
headers (optional)
array[output_create_request_kafka_headers_inner]
timeout (optional)
Big Decimal
broker_timeout (optional)
Big Decimal
broker_ack_reliability (optional)
String
broker_buffer_size (optional)
Big Decimal

output_update_request_logstash - logstash Up

id (optional)
String
is_default (optional)
Boolean
is_default_monitoring (optional)
Boolean
name
String
type (optional)
String
Enum:
logstash
hosts (optional)
array[String]
ca_sha256 (optional)
String
ca_trusted_fingerprint (optional)
String
config (optional)
Object
config_yaml (optional)
String
ssl (optional)
output_create_request_elasticsearch_ssl
proxy_id (optional)
String
shipper (optional)
output_create_request_elasticsearch_shipper

package_info - Package information Up

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

package_info_conditions - Up

kibana (optional)
package_info_conditions_kibana
elasticsearch (optional)
package_info_conditions_elasticsearch

package_info_conditions_elasticsearch - Up

subscription (optional)
String
Enum:
basic
gold
platinum
enterprise

package_info_conditions_kibana - Up

versions (optional)
String

package_info_data_streams_inner - Up

title
String
name
String
release
String
ingeset_pipeline
String
vars (optional)
array[package_info_data_streams_inner_vars_inner]
type
String
package
String

package_info_data_streams_inner_vars_inner - Up

name
String
default
String

package_info_elasticsearch - Up

privileges (optional)
package_info_elasticsearch_privileges

package_info_elasticsearch_privileges - Up

cluster (optional)
array[String]

package_info_screenshots_inner - Up

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

package_info_source - Up

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

package_policy - Package policy Up

id
String
revision
Big Decimal
inputs
array[new_package_policy_inputs_inner]
enabled (optional)
Boolean
package (optional)
new_package_policy_package
namespace (optional)
String
output_id (optional)
String
policy_id (optional)
String
name
String
description (optional)
String

package_policy_allOf - Up

id
String
revision
Big Decimal
inputs (optional)
package_policy_allOf_inputs

package_policy_allOf_inputs - Up

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
package_policy_request_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

package_usage_stats - Package usage stats Up

agent_policy_count
Integer

packages_get_file_200_response - Up

body (optional)
Object
statusCode (optional)
Big Decimal
headers (optional)
Object

packages_get_verification_key_id_200_response - Up

body (optional)
packages_get_verification_key_id_200_response_body
statusCode (optional)
Big Decimal
headers (optional)
Object

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_delete_package_policy_200_response_inner - Up

id
String
name (optional)
String
success
Boolean

post_delete_package_policy_request - Up

packagePolicyIds
array[String]
force (optional)
Boolean

post_download_sources_200_response - Up

item (optional)
download_sources

post_download_sources_request - Up

id (optional)
String
name
String
is_default
Boolean
host
String

post_fleet_proxies_200_response - Up

item (optional)
proxies

post_fleet_proxies_request - Up

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

post_fleet_server_hosts_200_response - Up

item (optional)
fleet_server_host

post_fleet_server_hosts_request - Up

id (optional)
String
name
String
is_default (optional)
Boolean
host_urls
array[String]

post_outputs_200_response - Up

item (optional)
output_create_request

proxies - Fleet Proxy Up

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

reassign_agent_deprecated_request - Up

policy_id
String

saved_object_type - Saved Object type Up

search_result - Search result Up

description
String
download
String
icons
String
name
String
path
String
title
String
type
String
version
String
status
String
installationInfo (optional)
installation_info
savedObject (optional)
Object

settings - Settings Up

id
String
has_seen_add_data_notice (optional)
Boolean
fleet_server_hosts
array[String]
prerelease_integrations_enabled (optional)
Boolean

setup_500_response - Up

message (optional)
String

setup_agents_request - Up

admin_username
String
admin_password
String

unenroll_agent_400_response - Up

error (optional)
String
message (optional)
String
statusCode (optional)
Big Decimal
Enum:
400

unenroll_agent_request - Up

revoke (optional)
Boolean
force (optional)
Boolean

update_agent_request - Up

user_provided_metadata (optional)
Object
tags (optional)
array[String]

update_download_source_request - Up

name
String
is_default
Boolean
host
String

update_fleet_proxies_request - Up

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

update_fleet_server_hosts_request - Up

name (optional)
String
is_default (optional)
Boolean
host_urls (optional)
array[String]

update_package_200_response - Up

items
array[install_package_by_upload_200_response_items_inner]

update_package_policy_200_response - Up

item
package_policy
sucess
Boolean

update_package_request - Up

keepPoliciesUpToDate (optional)
Boolean

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)
Boolean
additional_yaml_config (optional)
String

upgrade_agent - Upgrade agent Up

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

upgrade_diff_inner - Up

id
String
revision
Big Decimal
inputs
array[new_package_policy_inputs_inner]
enabled (optional)
Boolean
package (optional)
new_package_policy_package
namespace (optional)
String
output_id (optional)
String
policy_id (optional)
String
name
String
description (optional)
String
errors (optional)
array[upgrade_diff_inner_allOf_allOf_errors_inner]
missingVars (optional)
array[String]

upgrade_diff_inner_allOf - Up

enabled (optional)
Boolean
package (optional)
new_package_policy_package
namespace (optional)
String
output_id (optional)
String
inputs
array[new_package_policy_inputs_inner]
policy_id (optional)
String
name
String
description (optional)
String
errors (optional)
array[upgrade_diff_inner_allOf_allOf_errors_inner]
missingVars (optional)
array[String]

upgrade_diff_inner_allOf_allOf - Up

errors (optional)
array[upgrade_diff_inner_allOf_allOf_errors_inner]
missingVars (optional)
array[String]

upgrade_diff_inner_allOf_allOf_errors_inner - Up

key (optional)
String
message (optional)
String

upgrade_package_policy_dry_run_200_response_inner - Up

hasErrors
Boolean
diff (optional)
array[upgrade_diff_inner]
agent_diff (optional)
array[array[full_agent_policy_input]]

upgrade_package_policy_dry_run_request - Up

packagePolicyIds
array[String]
packageVersion (optional)
String

upgrade_package_policy_request - Up

packagePolicyIds
array[String]
« API Appendix B: Deleted pages »