This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Fleet APIs
editFleet APIs
editThis 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
post /agents/{agentId}/actions/{actionId}/cancelget /agents/action_statuspost /agents/{agentId}/actions
Agent Binary Download Sources
delete /agent_download_sources/{sourceId}get /agent_download_sourcesget /agent_download_sources/{sourceId}post /agent_download_sourcesput /agent_download_sources/{sourceId}
Agent Policies
post /agent_policies/{agentPolicyId}/copyget /agent_policies/{agentPolicyId}/downloadget /agent_policies/{agentPolicyId}/fullget /agent_policies/{agentPolicyId}get /agent_policiespost /agent_policies/_bulk_getpost /agent_policiespost /agent_policies/deleteput /agent_policies/{agentPolicyId}
Agent Status
Agents
post /agents/bulk_reassignpost /agents/bulk_request_diagnosticspost /agents/bulk_unenrollpost /agents/bulk_update_agent_tagspost /agents/bulk_upgradedelete /agents/{agentId}get /agents/{agentId}get /agents/tagsget /agents/files@{fileId}@{fileName}get /agentspost /agentsget /agents/setupget /agents/{agentId}/uploadspost /agents/{agentId}/reassignput /agents/{agentId}/reassignpost /agents/{agentId}/request_diagnosticspost /agents/setuppost /agents/{agentId}/unenrollput /agents/{agentId}post /agents/{agentId}/upgrade
Data Streams
Elastic Package Manager EPM
post /epm/bulk_assetspost /epm/packages/_bulkdelete /epm/packages/{pkgName}/{pkgVersion}delete /epm/packages/{pkgkey}get /epm/packages/{pkgName}/{pkgVersion}get /epm/categoriesget /epm/packages/{pkgkey}get /epm/packages/{pkgName}/statspost /epm/packages/{pkgName}/{pkgVersion}post /epm/packagespost /epm/packages/{pkgkey}get /epm/packagesget /epm/packages/limitedget /epm/packages/{pkgName}/{pkgVersion}/{filePath}get /epm/verification_key_idput /epm/packages/{pkgName}/{pkgVersion}
Enrollment APIKeys
post /enrollment_api_keyspost /enrollment-api-keysdelete /enrollment_api_keys/{keyId}delete /enrollment-api-keys/{keyId}get /enrollment_api_keys/{keyId}get /enrollment-api-keys/{keyId}get /enrollment_api_keysget /enrollment-api-keys
Fleet Internals
Fleet Server Hosts
delete /fleet_server_hosts/{itemId}get /fleet_server_hostsget /fleet_server_hosts/{itemId}post /fleet_server_hostsput /fleet_server_hosts/{itemId}
Kubernetes
Outputs
delete /outputs/{outputId}post /logstash_api_keysget /outputs/{outputId}get /outputspost /outputsput /outputs/{outputId}
Package Policies
post /package_policies/_bulk_getpost /package_policiesdelete /package_policies/{packagePolicyId}get /package_policiesget /package_policies/{packagePolicyId}post /package_policies/deleteput /package_policies/{packagePolicyId}post /package_policies/upgradepost /package_policies/upgrade/dryrun
Proxies
Service Tokens
Agent Actions
edit
Up
post /agents/{agentId}/actions/{actionId}/cancelCancel agent action (agentActionCancel)
Path parameters
agentId (required)
Path Parameter — default: null
actionId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{ }Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK agent_action_cancel_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agents/action_statusGet agent action status (agentsActionStatus)
Query parameters
perPage (optional)
Query Parameter — The number of items to return default: 20
page (optional)
Query Parameter — default: 1
errorSize (optional)
Query Parameter — default: 5
Return type
Example data
Content-Type: application/json
{
"items" : [ {
"nbAgentsActioned" : 0.8008281904610115,
"creationTime" : "creationTime",
"cancellationTime" : "cancellationTime",
"latestErrors" : [ {
"agentId" : "agentId",
"error" : "error",
"timestamp" : "timestamp"
}, {
"agentId" : "agentId",
"error" : "error",
"timestamp" : "timestamp"
} ],
"type" : "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_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/{agentId}/actionsCreate agent action (newAgentAction)
Path parameters
agentId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
new_agent_action_request new_agent_action_request (required)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"headers" : "headers",
"body" : [ 0.8008281904610115, 0.8008281904610115 ],
"statusCode" : 6.027456183070403
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK new_agent_action_200_response400
Generic Error fleet_server_health_check_400_responseAgent Binary Download Sources
edit
Up
delete /agent_download_sources/{sourceId}Delete agent binary download source by ID (deleteDownloadSource)
Path parameters
sourceId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"id" : "id"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_package_policy_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent_download_sourcesList agent binary download sources (getDownloadSources)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"perPage" : 1,
"page" : 6,
"items" : [ {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}, {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_download_sources_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent_download_sources/{sourceId}Get agent binary download source by ID (getOneDownloadSource)
Path parameters
sourceId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_one_download_source_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agent_download_sourcesCreate agent binary download source (postDownloadSources)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
post_download_sources_request post_download_sources_request (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"item" : {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK post_download_sources_200_response400
Generic Error fleet_server_health_check_400_response
Up
put /agent_download_sources/{sourceId}Update agent binary download source by ID (updateDownloadSource)
Path parameters
sourceId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
update_download_source_request update_download_source_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_one_download_source_200_response400
Generic Error fleet_server_health_check_400_responseAgent Policies
edit
Up
post /agent_policies/{agentPolicyId}/copyCopy agent policy by ID (agentPolicyCopy)
Path parameters
agentPolicyId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
agent_policy_copy_request agent_policy_copy_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"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_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent_policies/{agentPolicyId}/downloadDownload agent policy by ID (agentPolicyDownload)
Path parameters
agentPolicyId (required)
Path Parameter — default: null
Query parameters
download (optional)
Query Parameter — default: null
standalone (optional)
Query Parameter — default: null
kubernetes (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : "item"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK agent_policy_download_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent_policies/{agentPolicyId}/fullGet full agent policy by ID (agentPolicyFull)
Path parameters
agentPolicyId (required)
Path Parameter — default: null
Query parameters
download (optional)
Query Parameter — default: null
standalone (optional)
Query Parameter — default: null
kubernetes (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{ }Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK agent_policy_full_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent_policies/{agentPolicyId}Get agent policy by ID (agentPolicyInfo)
Get one agent policy
Path parameters
agentPolicyId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"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_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent_policiesList agent policies (agentPolicyList)
Query parameters
perPage (optional)
Query Parameter — The number of items to return default: 20
page (optional)
Query Parameter — default: 1
kuery (optional)
Query Parameter — default: null
full (optional)
Query Parameter — When set to true, retrieve the related package policies for each agent policy. default: null
noAgentCount (optional)
Query Parameter — When set to true, do not count how many agents are in the agent policy, this can improve performance if you are searching over a large number of agent policies. The "agents" property will always be 0 if set to true. default: null
Return type
Example data
Content-Type: application/json
{
"total" : 5.637376656633329,
"perPage" : 7.061401241503109,
"page" : 2.3021358869347655,
"items" : [ {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"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_response400
Generic Error fleet_server_health_check_400_response
Up
post /agent_policies/_bulk_getBulk get agent policies (bulkGetAgentPolicies)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
bulk_get_agent_policies_request bulk_get_agent_policies_request (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"items" : [ {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"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_response400
Generic Error fleet_server_health_check_400_response
Up
post /agent_policiesCreate agent policy (createAgentPolicy)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
agent_policy_create_request agent_policy_create_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"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_response400
Generic Error fleet_server_health_check_400_response
Up
post /agent_policies/deleteDelete agent policy by ID (deleteAgentPolicy)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
delete_agent_policy_request delete_agent_policy_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"success" : true,
"id" : "id"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_agent_policy_200_response400
Generic Error fleet_server_health_check_400_response
Up
put /agent_policies/{agentPolicyId}Update agent policy by ID (updateAgentPolicy)
Path parameters
agentPolicyId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
agent_policy_update_request agent_policy_update_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"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_response400
Generic Error fleet_server_health_check_400_responseAgent Status
edit
Up
get /agent_status/dataGet incoming agent data (getAgentData)
Query parameters
agentsIds (required)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"items" : [ {
"key" : {
"data" : true
}
}, {
"key" : {
"data" : true
}
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agent_data_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent_statusGet agent status summary (getAgentStatus)
Query parameters
policyId (optional)
Query Parameter — default: null
kuery (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"all" : 2,
"offline" : 5,
"other" : 7,
"total" : 9,
"inactive" : 1,
"updating" : 3,
"online" : 2,
"active" : 4,
"error" : 0,
"unenrolled" : 5,
"events" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agent_status_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agent-statusGet agent status summary (getAgentStatusDeprecated)
Query parameters
policyId (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"offline" : 5,
"other" : 2,
"total" : 7,
"inactive" : 1,
"updating" : 9,
"online" : 5,
"error" : 0,
"events" : 6
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agent_status_deprecated_200_response400
Generic Error fleet_server_health_check_400_responseAgents
edit
Up
post /agents/bulk_reassignBulk reassign agents (bulkReassignAgents)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
bulk_reassign_agents_request bulk_reassign_agents_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"actionId" : "actionId"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK bulk_upgrade_agents_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/bulk_request_diagnosticsBulk request diagnostics from agents (bulkRequestDiagnostics)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
bulk_request_diagnostics_request bulk_request_diagnostics_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"actionId" : "actionId"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK bulk_upgrade_agents_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/bulk_unenrollBulk unenroll agents (bulkUnenrollAgents)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
bulk_unenroll_agents_request bulk_unenroll_agents_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"actionId" : "actionId"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK bulk_upgrade_agents_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/bulk_update_agent_tagsBulk update agent tags (bulkUpdateAgentTags)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
bulk_update_agent_tags_request bulk_update_agent_tags_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"actionId" : "actionId"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK bulk_upgrade_agents_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/bulk_upgradeBulk upgrade agents (bulkUpgradeAgents)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
bulk_upgrade_agents bulk_upgrade_agents (required)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"actionId" : "actionId"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK bulk_upgrade_agents_200_response400
Generic Error fleet_server_health_check_400_response
Up
delete /agents/{agentId}Delete agent by ID (deleteAgent)
Path parameters
agentId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"action" : "deleted"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_agent_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agents/{agentId}Get agent by ID (getAgent)
Path parameters
agentId (required)
Path Parameter — default: null
Query parameters
withMetrics (optional)
Query Parameter — Return agent metrics, false by default default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agent_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agents/tagsList agent tags (getAgentTags)
Return type
Example data
Content-Type: application/json
{
"items" : [ "items", "items" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agent_tags_response400
Generic Error fleet_server_health_check_400_response
Up
get /agents/files@{fileId}@{fileName}Get file uploaded by agent (getAgentUploadFile)
Path parameters
fileId (required)
Path Parameter — default: null
fileName (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"body" : {
"items" : {
"headers" : "",
"body" : ""
}
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agent_upload_file_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /agentsList agents (getAgents)
Query parameters
perPage (optional)
Query Parameter — The number of items to return default: 20
page (optional)
Query Parameter — default: 1
kuery (optional)
Query Parameter — default: null
showInactive (optional)
Query Parameter — default: null
showUpgradeable (optional)
Query Parameter — default: null
sortField (optional)
Query Parameter — default: null
sortOrder (optional)
Query Parameter — default: null
withMetrics (optional)
Query Parameter — Return agent metrics, false by default default: null
getStatusSummary (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"total" : 5.962133916683182,
"statusSummary" : {
"offline" : 7.061401241503109,
"inactive" : 2.027123023002322,
"updating" : 1.0246457001441578,
"online" : 3.616076749251911,
"enrolling" : 4.145608029883936,
"unenrolling" : 7.386281948385884,
"degraded'" : 1.4894159098541704,
"error" : 9.301444243932576,
"unenrolled" : 1.2315135367772556
},
"perPage" : 2.3021358869347655,
"page" : 5.637376656633329,
"list" : [ {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}, {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
} ],
"items" : [ {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}, {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agents_response400
Generic Error fleet_server_health_check_400_response
Up
post /agentsList 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
OK400
Generic Error fleet_server_health_check_400_response
Up
get /agents/setupGet agent setup info (getAgentsSetupStatus)
Return type
Example data
Content-Type: application/json
{
"missing_requirements" : [ "tls_required", "tls_required" ],
"package_verification_key_id" : "package_verification_key_id",
"isReady" : true,
"missing_optional_features" : [ "encrypted_saved_object_encryption_key_required", "encrypted_saved_object_encryption_key_required" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK fleet_status_response400
Generic Error fleet_server_health_check_400_response
Up
get /agents/{agentId}/uploadsList agent uploads (listAgentUploads)
Path parameters
agentId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"body" : {
"item" : [ {
"createTime" : "createTime",
"filePath" : "filePath",
"name" : "name",
"actionId" : "actionId",
"id" : "id",
"status" : "READY"
}, {
"createTime" : "createTime",
"filePath" : "filePath",
"name" : "name",
"actionId" : "actionId",
"id" : "id",
"status" : "READY"
} ]
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK list_agent_uploads_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/{agentId}/reassignReassign 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 Object400
Generic Error fleet_server_health_check_400_response
Up
put /agents/{agentId}/reassignReassign 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 Object400
Generic Error fleet_server_health_check_400_response
Up
post /agents/{agentId}/request_diagnosticsRequest agent diagnostics (requestDiagnosticsAgent)
Path parameters
agentId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"actionId" : "actionId"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK bulk_upgrade_agents_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/setupInitiate agent setup (setupAgents)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
setup_agents_request setup_agents_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"isInitialized" : true,
"nonFatalErrors" : [ {
"name" : "name",
"message" : "message"
}, {
"name" : "name",
"message" : "message"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK fleet_setup_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/{agentId}/unenrollUnenroll 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 Object400
BAD REQUEST unenroll_agent_400_response
Up
put /agents/{agentId}Update agent by ID (updateAgent)
Path parameters
agentId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
update_agent_request update_agent_request (required)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_agent_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /agents/{agentId}/upgradeUpgrade agent (upgradeAgent)
Path parameters
agentId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
upgrade_agent upgrade_agent (required)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"force" : true,
"version" : "version",
"source_uri" : "source_uri"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK upgrade_agent400
Generic Error fleet_server_health_check_400_responseData Streams
edit
Up
get /data_streamsList data streams (dataStreamsList)
Return type
Example data
Content-Type: application/json
{
"data_streams" : [ {
"last_activity_ms" : 0.8008281904610115,
"size_in_bytes_formatted" : "size_in_bytes_formatted",
"package" : "package",
"package_version" : "package_version",
"namespace" : "namespace",
"size_in_bytes" : 6.027456183070403,
"index" : "index",
"type" : "type",
"dataset" : "dataset",
"dashboard" : [ {
"id" : "id",
"title" : "title"
}, {
"id" : "id",
"title" : "title"
} ]
}, {
"last_activity_ms" : 0.8008281904610115,
"size_in_bytes_formatted" : "size_in_bytes_formatted",
"package" : "package",
"package_version" : "package_version",
"namespace" : "namespace",
"size_in_bytes" : 6.027456183070403,
"index" : "index",
"type" : "type",
"dataset" : "dataset",
"dashboard" : [ {
"id" : "id",
"title" : "title"
}, {
"id" : "id",
"title" : "title"
} ]
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK data_streams_list_200_response400
Generic Error fleet_server_health_check_400_responseElastic Package Manager EPM
edit
Up
post /epm/bulk_assetsBulk 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
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_response400
Generic Error fleet_server_health_check_400_response
Up
post /epm/packages/_bulkBulk install packages (bulkInstallPackages)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
bulk_install_packages_request bulk_install_packages_request (optional)
Body Parameter —
Query parameters
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
Return type
Example data
Content-Type: application/json
{
"response" : [ {
"name" : "name",
"version" : "version"
}, {
"name" : "name",
"version" : "version"
} ],
"items" : [ {
"name" : "name",
"version" : "version"
}, {
"name" : "name",
"version" : "version"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK bulk_install_packages_response400
Generic Error fleet_server_health_check_400_response
Up
delete /epm/packages/{pkgName}/{pkgVersion}Delete package (deletePackage)
Path parameters
pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
install_package_deprecated_request install_package_deprecated_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Query parameters
ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
Return type
Example data
Content-Type: application/json
{
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK update_package_200_response400
Generic Error fleet_server_health_check_400_response
Up
delete /epm/packages/{pkgkey}Delete ackage (deletePackageDeprecated)
Path parameters
pkgkey (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
install_package_deprecated_request install_package_deprecated_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"response" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK install_package_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/packages/{pkgName}/{pkgVersion}Get package (getPackage)
Path parameters
pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null
Query parameters
ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
Return type
Example data
Content-Type: application/json
nullProduces
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_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/categoriesList package categories (getPackageCategories)
Query parameters
prerelease (optional)
Query Parameter — Whether to include prerelease packages in categories count (e.g. beta, rc, preview) default: false
experimental (optional)
Query Parameter — default: false
include_policy_templates (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"response" : [ {
"count" : 0.8008281904610115,
"id" : "id",
"title" : "title"
}, {
"count" : 0.8008281904610115,
"id" : "id",
"title" : "title"
} ],
"items" : [ {
"count" : 6.027456183070403,
"id" : "id",
"title" : "title"
}, {
"count" : 6.027456183070403,
"id" : "id",
"title" : "title"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_categories_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/packages/{pkgkey}Get package (getPackageDeprecated)
Path parameters
pkgkey (required)
Path Parameter — default: null
Query parameters
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
Return type
Example data
Content-Type: application/json
nullProduces
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_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/packages/{pkgName}/statsGet package stats (getPackageStats)
Path parameters
pkgName (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"response" : {
"agent_policy_count" : 0
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_package_stats_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /epm/packages/{pkgName}/{pkgVersion}Install package (installPackage)
Path parameters
pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
install_package_request install_package_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Query parameters
ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
Return type
Example data
Content-Type: application/json
{
"_meta" : {
"install_source" : "registry"
},
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK install_package_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /epm/packagesInstall by package by direct upload (installPackageByUpload)
Consumes
This API call consumes the following media types via the Content-Type request header:application/zipapplication/gzip
Request body
body file (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"_meta" : {
"install_source" : "upload"
},
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK install_package_by_upload_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /epm/packages/{pkgkey}Install package (installPackageDeprecated)
Path parameters
pkgkey (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
install_package_deprecated_request install_package_deprecated_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"response" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK install_package_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/packagesList packages (listAllPackages)
Query parameters
excludeInstallStatus (optional)
Query Parameter — Whether to exclude the install status of each package. Enabling this option will opt in to caching for the response via
cache-control headers. If you don't need up-to-date installation info for a package, and are querying for a list of available packages, providing this flag can improve performance substantially. default: false prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
experimental (optional)
Query Parameter — default: false
category (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"response" : [ {
"savedObject" : "{}",
"path" : "path",
"download" : "download",
"name" : "name",
"description" : "description",
"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_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/packages/limitedGet limited package list (listLimitedPackages)
Return type
Example data
Content-Type: application/json
{
"items" : [ "items", "items" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK list_limited_packages_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/packages/{pkgName}/{pkgVersion}/{filePath}Get package file (packagesGetFile)
Path parameters
pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null
filePath (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"headers" : "{}",
"body" : "{}",
"statusCode" : 0.8008281904610115
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK packages_get_file_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /epm/verification_key_idGet package signature verification key ID (packagesGetVerificationKeyId)
Return type
Example data
Content-Type: application/json
{
"headers" : "{}",
"body" : {
"id" : "id"
},
"statusCode" : 0.8008281904610115
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK packages_get_verification_key_id_200_response400
Generic Error fleet_server_health_check_400_response
Up
put /epm/packages/{pkgName}/{pkgVersion}Update package settings (updatePackage)
Path parameters
pkgName (required)
Path Parameter — default: null
pkgVersion (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
update_package_request update_package_request (optional)
Body Parameter —
Query parameters
ignoreUnverified (optional)
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
Return type
Example data
Content-Type: application/json
{
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK update_package_200_response400
Generic Error fleet_server_health_check_400_responseEnrollment APIKeys
edit
Up
post /enrollment_api_keysCreate enrollment API key (createEnrollmentApiKeys)
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
},
"action" : "created"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK create_enrollment_api_keys_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /enrollment-api-keysCreate enrollment API key (createEnrollmentApiKeysDeprecated)
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
},
"action" : "created"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK create_enrollment_api_keys_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
delete /enrollment_api_keys/{keyId}Delete enrollment API key by ID (deleteEnrollmentApiKey)
Path parameters
keyId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"action" : "deleted"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_agent_200_response400
Generic Error fleet_server_health_check_400_response
Up
delete /enrollment-api-keys/{keyId}Delete enrollment API key by ID (deleteEnrollmentApiKeyDeprecated)
Path parameters
keyId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"action" : "deleted"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_agent_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /enrollment_api_keys/{keyId}Get enrollment API key by ID (getEnrollmentApiKey)
Path parameters
keyId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_enrollment_api_key_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /enrollment-api-keys/{keyId}Get enrollment API key by ID (getEnrollmentApiKeyDeprecated)
Path parameters
keyId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_enrollment_api_key_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /enrollment_api_keysList enrollment API keys (getEnrollmentApiKeys)
Return type
Example data
Content-Type: application/json
{
"total" : 1.4658129805029452,
"perPage" : 6.027456183070403,
"page" : 0.8008281904610115,
"list" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ],
"items" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_enrollment_api_keys_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /enrollment-api-keysList enrollment API keys (getEnrollmentApiKeysDeprecated)
Return type
Example data
Content-Type: application/json
{
"total" : 1.4658129805029452,
"perPage" : 6.027456183070403,
"page" : 0.8008281904610115,
"list" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ],
"items" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_enrollment_api_keys_deprecated_200_response400
Generic Error fleet_server_health_check_400_responseFleet Internals
edit
Up
post /health_checkFleet Server health check (fleetServerHealthCheck)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
fleet_server_health_check_request fleet_server_health_check_request (required)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"host" : "host",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK fleet_server_health_check_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /settingsGet settings (getSettings)
Return type
Example data
Content-Type: application/json
{
"item" : {
"has_seen_add_data_notice" : true,
"fleet_server_hosts" : [ "fleet_server_hosts", "fleet_server_hosts" ],
"prerelease_integrations_enabled" : true,
"id" : "id"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK fleet_settings_response400
Generic Error fleet_server_health_check_400_response
Up
post /setupInitiate Fleet setup (setup)
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"isInitialized" : true,
"nonFatalErrors" : [ {
"name" : "name",
"message" : "message"
}, {
"name" : "name",
"message" : "message"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK fleet_setup_response400
Generic Error fleet_server_health_check_400_response500
Internal Server Error setup_500_response
Up
put /settingsUpdate settings (updateSettings)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
update_settings_request update_settings_request (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"item" : {
"has_seen_add_data_notice" : true,
"fleet_server_hosts" : [ "fleet_server_hosts", "fleet_server_hosts" ],
"prerelease_integrations_enabled" : true,
"id" : "id"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK fleet_settings_response400
Generic Error fleet_server_health_check_400_responseFleet Server Hosts
edit
Up
delete /fleet_server_hosts/{itemId}Delete Fleet Server host by ID (deleteFleetServerHosts)
Path parameters
itemId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"id" : "id"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_package_policy_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /fleet_server_hostsList Fleet Server hosts (getFleetServerHosts)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"perPage" : 1,
"page" : 6,
"items" : [ {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}, {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_fleet_server_hosts_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /fleet_server_hosts/{itemId}Get Fleet Server host by ID (getOneFleetServerHosts)
Path parameters
itemId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_one_fleet_server_hosts_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /fleet_server_hostsCreate Fleet Server host (postFleetServerHosts)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
post_fleet_server_hosts_request post_fleet_server_hosts_request (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"item" : {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK post_fleet_server_hosts_200_response400
Generic Error fleet_server_health_check_400_response
Up
put /fleet_server_hosts/{itemId}Update Fleet Server host by ID (updateFleetServerHosts)
Path parameters
itemId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
update_fleet_server_hosts_request update_fleet_server_hosts_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_one_fleet_server_hosts_200_response400
Generic Error fleet_server_health_check_400_responseKubernetes
edit
Up
get /kubernetesGet full K8s agent manifest (getFullK8sManifest)
Query parameters
download (optional)
Query Parameter — default: null
fleetServer (optional)
Query Parameter — default: null
enrolToken (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : "item"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK agent_policy_download_200_response400
Generic Error fleet_server_health_check_400_responseOutputs
edit
Up
delete /outputs/{outputId}Delete output by ID (deleteOutput)
Path parameters
outputId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"id" : "id"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_package_policy_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /logstash_api_keysGenerate Logstash API key (generateLogstashApiKey)
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"api_key" : "api_key"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK generate_logstash_api_key_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /outputs/{outputId}Get output by ID (getOutput)
Path parameters
outputId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
nullProduces
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_request400
Generic Error fleet_server_health_check_400_response
Up
get /outputsList outputs (getOutputs)
Return type
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_response400
Generic Error fleet_server_health_check_400_response
Up
post /outputsCreate 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
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_response400
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
Example data
Content-Type: application/json
nullProduces
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_request400
Generic Error fleet_server_health_check_400_responsePackage Policies
edit
Up
post /package_policies/_bulk_getBulk 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
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_response400
Generic Error fleet_server_health_check_400_response
Up
post /package_policiesCreate 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
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_response400
Generic Error fleet_server_health_check_400_response409
Generic Error fleet_server_health_check_400_response
Up
delete /package_policies/{packagePolicyId}Delete package policy by ID (deletePackagePolicy)
Path parameters
packagePolicyId (required)
Path Parameter — default: null
Query parameters
force (optional)
Query Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"id" : "id"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_package_policy_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /package_policiesList 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
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_response400
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
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_response400
Generic Error fleet_server_health_check_400_response
Up
post /package_policies/deleteDelete package policy (postDeletePackagePolicy)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
post_delete_package_policy_request post_delete_package_policy_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
[ {
"success" : true,
"name" : "name",
"id" : "id"
}, {
"success" : true,
"name" : "name",
"id" : "id"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK400
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
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_response400
Generic Error fleet_server_health_check_400_response
Up
post /package_policies/upgradeUpgrade package policy to a newer package version (upgradePackagePolicy)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
upgrade_package_policy_request upgrade_package_policy_request (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
[ {
"success" : true,
"name" : "name",
"id" : "id"
}, {
"success" : true,
"name" : "name",
"id" : "id"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK400
Generic Error fleet_server_health_check_400_response409
Generic Error fleet_server_health_check_400_response
Up
post /package_policies/upgrade/dryrunDry run package policy upgrade (upgradePackagePolicyDryRun)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
upgrade_package_policy_dry_run_request upgrade_package_policy_dry_run_request (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
[ {
"hasErrors" : true,
"agent_diff" : [ [ null, null ], [ null, null ] ],
"diff" : [ null, null ]
}, {
"hasErrors" : true,
"agent_diff" : [ [ null, null ], [ null, null ] ],
"diff" : [ null, null ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK400
Generic Error fleet_server_health_check_400_responseProxies
edit
Up
delete /proxies/{itemId}Delete proxy by ID (deleteFleetProxies)
Path parameters
itemId (required)
Path Parameter — default: null
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"id" : "id"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK delete_package_policy_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /proxiesList proxies (getFleetProxies)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"perPage" : 1,
"page" : 6,
"items" : [ {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}, {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_fleet_proxies_200_response400
Generic Error fleet_server_health_check_400_response
Up
get /proxies/{itemId}Get proxy by ID (getOneFleetProxies)
Path parameters
itemId (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_one_fleet_proxies_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /proxiesCreate proxy (postFleetProxies)
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
post_fleet_proxies_request post_fleet_proxies_request (optional)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"item" : {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK post_fleet_proxies_200_response400
Generic Error fleet_server_health_check_400_response
Up
put /proxies/{itemId}Update proxy by ID (updateFleetProxies)
Path parameters
itemId (required)
Path Parameter — default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
update_fleet_proxies_request update_fleet_proxies_request (optional)
Body Parameter —
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"item" : {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK get_one_fleet_proxies_200_response400
Generic Error fleet_server_health_check_400_responseService Tokens
edit
Up
post /service_tokensCreate service token (generateServiceToken)
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"value" : "value"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK generate_service_token_deprecated_200_response400
Generic Error fleet_server_health_check_400_response
Up
post /service-tokensCreate service token (generateServiceTokenDeprecated)
Request headers
kbn-xsrf (required)
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"value" : "value"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK generate_service_token_deprecated_200_response400
Generic Error fleet_server_health_check_400_responseModels
[ Jump to Methods ]Table of Contents
Full_agent_policy_output_permissions-Full_agent_policy_output_permissions_data-Full_agent_policy_output_permissions_data_indices_inner-agent- Agentagent_action- Agent actionagent_action_cancel_200_response-agent_action_oneOf-agent_action_oneOf_1-agent_action_oneOf_1_data-agent_component- Agent componentagent_component_status- Agent component statusagent_component_unit- Agent component unitagent_component_unit_type- Agent component unit typeagent_diagnostics- Agent diagnosticsagent_metrics-agent_policy- Agent Policyagent_policy_agent_features_inner-agent_policy_copy_request-agent_policy_create_request- Create agent policy requestagent_policy_download_200_response-agent_policy_full- Agent policy full responseagent_policy_full_200_response-agent_policy_full_200_response_item-agent_policy_full_oneOf-agent_policy_info_200_response-agent_policy_list_200_response-agent_policy_update_request- Update agent policy requestagent_status- Agent statusagent_type- Agent typeagents_action_status_200_response-agents_action_status_200_response_items_inner-agents_action_status_200_response_items_inner_latestErrors_inner-bulk_get_agent_policies_200_response-bulk_get_agent_policies_request-bulk_get_assets_request-bulk_get_assets_request_assetIds_inner-bulk_get_package_policies_200_response-bulk_get_package_policies_request-bulk_install_packages_request-bulk_install_packages_request_packages_inner-bulk_install_packages_request_packages_inner_oneOf-bulk_install_packages_response- Bulk install packages responsebulk_install_packages_response_response_inner-bulk_reassign_agents_request-bulk_reassign_agents_request_agents-bulk_request_diagnostics_request-bulk_unenroll_agents_request-bulk_update_agent_tags_request-bulk_upgrade_agents- Bulk upgrade agentsbulk_upgrade_agents_200_response-create_agent_policy_200_response-create_enrollment_api_keys_deprecated_200_response-create_package_policy_200_response-data_stream- Data streamdata_stream_dashboard_inner-data_streams_list_200_response-delete_agent_200_response-delete_agent_policy_200_response-delete_agent_policy_request-delete_package_policy_200_response-download_sources- Download Sourceelasticsearch_asset_type- Elasticsearch asset typeenrollment_api_key- Enrollment API keyfleet_server_health_check_200_response-fleet_server_health_check_400_response-fleet_server_health_check_request-fleet_server_host- Fleet Server Hostfleet_settings_response- Fleet settings responsefleet_setup_response- Fleet Setup responsefleet_setup_response_nonFatalErrors_inner-fleet_status_response- Fleet status responsefull_agent_policy- Full agent policyfull_agent_policy_fleet-full_agent_policy_fleet_oneOf-full_agent_policy_fleet_oneOf_1-full_agent_policy_fleet_oneOf_1_kibana-full_agent_policy_fleet_oneOf_ssl-full_agent_policy_input- Full agent policy inputfull_agent_policy_input_allOf-full_agent_policy_input_allOf_data_stream-full_agent_policy_input_allOf_meta-full_agent_policy_input_allOf_meta_package-full_agent_policy_input_stream- Full agent policy input streamfull_agent_policy_input_stream_allOf-full_agent_policy_input_stream_allOf_data_stream-full_agent_policy_output- Full agent policyfull_agent_policy_output_additionalProperties-full_agent_policy_output_permissions_1_value-full_agent_policy_secret_references_inner-generate_logstash_api_key_200_response-generate_service_token_deprecated_200_response-get_agent_200_response-get_agent_data_200_response-get_agent_data_200_response_items_inner_value-get_agent_status_200_response-get_agent_status_deprecated_200_response-get_agent_tags_response- Get Agent Tags responseget_agent_upload_file_200_response-get_agent_upload_file_200_response_body-get_agent_upload_file_200_response_body_items-get_agents_by_actions_request-get_agents_response- Get Agent responseget_agents_response_statusSummary-get_bulk_assets_response- Bulk get assets responseget_bulk_assets_response_response_inner_inner-get_bulk_assets_response_response_inner_inner_attributes-get_categories_response- Get categories responseget_categories_response_items_inner-get_categories_response_response_inner-get_download_sources_200_response-get_enrollment_api_key_deprecated_200_response-get_enrollment_api_keys_deprecated_200_response-get_fleet_proxies_200_response-get_fleet_server_hosts_200_response-get_one_download_source_200_response-get_one_fleet_proxies_200_response-get_one_fleet_server_hosts_200_response-get_outputs_200_response-get_package_200_response-get_package_200_response_allOf-get_package_200_response_allOf_1-get_package_deprecated_200_response-get_package_deprecated_200_response_allOf-get_package_deprecated_200_response_allOf_1-get_package_policies_200_response-get_package_stats_200_response-get_packages_response- Get Packages responseinstall_package_200_response-install_package_200_response__meta-install_package_by_upload_200_response-install_package_by_upload_200_response__meta-install_package_by_upload_200_response_items_inner-install_package_by_upload_200_response_items_inner_type-install_package_deprecated_200_response-install_package_deprecated_request-install_package_request-installation_info- Installation info objectinstallation_info_installed_es-installation_info_installed_kibana-kibana_saved_object_type- Kibana saved object asset typelist_agent_uploads_200_response-list_agent_uploads_200_response_body-list_limited_packages_200_response-new_agent_action_200_response-new_agent_action_request-new_package_policy- New package policynew_package_policy_inputs_inner-new_package_policy_package-output_create_request- Outputoutput_create_request_elasticsearch- elasticsearchoutput_create_request_elasticsearch_shipper-output_create_request_elasticsearch_ssl-output_create_request_kafka- kafkaoutput_create_request_kafka_headers_inner-output_create_request_kafka_random-output_create_request_kafka_sasl-output_create_request_kafka_topics_inner-output_create_request_kafka_topics_inner_when-output_create_request_logstash- logstashoutput_update_request- Outputoutput_update_request_elasticsearch- elasticsearchoutput_update_request_kafka- kafkaoutput_update_request_logstash- logstashpackage_info- Package informationpackage_info_conditions-package_info_conditions_elasticsearch-package_info_conditions_kibana-package_info_data_streams_inner-package_info_data_streams_inner_vars_inner-package_info_elasticsearch-package_info_elasticsearch_privileges-package_info_screenshots_inner-package_info_source-package_policy- Package policypackage_policy_allOf-package_policy_allOf_inputs-package_policy_request- Package Policy Requestpackage_policy_request_inputs_value-package_policy_request_inputs_value_streams_value-package_policy_request_package-package_usage_stats- Package usage statspackages_get_file_200_response-packages_get_verification_key_id_200_response-packages_get_verification_key_id_200_response_body-post_delete_package_policy_200_response_inner-post_delete_package_policy_request-post_download_sources_200_response-post_download_sources_request-post_fleet_proxies_200_response-post_fleet_proxies_request-post_fleet_server_hosts_200_response-post_fleet_server_hosts_request-post_outputs_200_response-proxies- Fleet Proxyreassign_agent_deprecated_request-saved_object_type- Saved Object typesearch_result- Search resultsettings- Settingssetup_500_response-setup_agents_request-unenroll_agent_400_response-unenroll_agent_request-update_agent_request-update_download_source_request-update_fleet_proxies_request-update_fleet_server_hosts_request-update_package_200_response-update_package_policy_200_response-update_package_request-update_settings_request-upgrade_agent- Upgrade agentupgrade_diff_inner-upgrade_diff_inner_allOf-upgrade_diff_inner_allOf_allOf-upgrade_diff_inner_allOf_allOf_errors_inner-upgrade_package_policy_dry_run_200_response_inner-upgrade_package_policy_dry_run_request-upgrade_package_policy_request-
Full_agent_policy_output_permissions_data - Up
cluster (optional)
indices (optional)
agent - Agent Up
type
active
enrolled_at
unenrolled_at (optional)
unenrollment_started_at (optional)
access_api_key_id (optional)
default_api_key_id (optional)
policy_id (optional)
policy_revision (optional)
last_checkin (optional)
user_provided_metadata (optional)
local_metadata (optional)
id
access_api_key (optional)
status
default_api_key (optional)
components (optional)
metrics (optional)
agent_action_cancel_200_response - Up
item (optional)
agent_component - Agent component Up
id (optional)
type (optional)
status (optional)
message (optional)
units (optional)
agent_component_unit - Agent component unit Up
id (optional)
type (optional)
status (optional)
message (optional)
payload (optional)
agent_metrics - Up
cpu_avg (optional)
Big Decimal Average agent CPU usage during the last 5 minutes, number between 0-1
memory_size_byte_avg (optional)
Big Decimal Average agent memory consumption during the last 5 minutes
agent_policy - Agent Policy Up
id
name
namespace
description (optional)
monitoring_enabled (optional)
Enum:
data_output_id (optional)
monitoring_output_id (optional)
fleet_server_host_id (optional)
download_source_id (optional)
unenroll_timeout (optional)
inactivity_timeout (optional)
package_policies (optional)
array[package_policy] This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
updated_on (optional)
Date format: date-time
updated_by (optional)
revision (optional)
agents (optional)
agent_features (optional)
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_create_request - Create agent policy request Up
id (optional)
name
namespace
description (optional)
monitoring_enabled (optional)
Enum:
data_output_id (optional)
monitoring_output_id (optional)
fleet_server_host_id (optional)
download_source_id (optional)
unenroll_timeout (optional)
inactivity_timeout (optional)
agent_features (optional)
is_protected (optional)
agent_policy_download_200_response - Up
item (optional)
agent_policy_full - Agent policy full response Up
item (optional)
agent_policy_full_200_response_item - Up
item (optional)
agent_policy_full_oneOf - Up
item (optional)
agent_policy_update_request - Update agent policy request Up
name
namespace
description (optional)
monitoring_enabled (optional)
Enum:
data_output_id (optional)
monitoring_output_id (optional)
fleet_server_host_id (optional)
download_source_id (optional)
unenroll_timeout (optional)
inactivity_timeout (optional)
agent_features (optional)
is_protected (optional)
agents_action_status_200_response_items_inner - Up
actionId
status
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
Enum:
POLICY_REASSIGN
UPGRADE
UNENROLL
FORCE_UNENROLL
UPDATE_TAGS
CANCEL
REQUEST_DIAGNOSTICS
SETTINGS
POLICY_CHANGE
INPUT_ACTION
expiration (optional)
completionTime (optional)
cancellationTime (optional)
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
bulk_get_agent_policies_request - Up
ids
array[String] list of agent policy ids
full (optional)
Boolean get full policies with package policies populated
ignoreMissing (optional)
bulk_get_assets_request - Up
assetIds
array[bulk_get_assets_request_assetIds_inner] list of items necessary to fetch assets
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_response - Bulk install packages response Up
response (optional)
items
bulk_unenroll_agents_request - Up
bulk_update_agent_tags_request - Up
agents
tagsToAdd (optional)
tagsToRemove (optional)
batchSize (optional)
bulk_upgrade_agents - Bulk upgrade agents Up
version
String version to upgrade to
source_uri (optional)
String alternative upgrade binary download url
rollout_duration_seconds (optional)
Big Decimal rolling upgrade window duration in seconds
start_time (optional)
String start time of upgrade in ISO 8601 format
agents
force (optional)
Boolean Force upgrade, skipping validation (should be used with caution)
bulk_upgrade_agents_200_response - Up
actionId (optional)
create_agent_policy_200_response - Up
item (optional)
data_stream - Data stream Up
index (optional)
dataset (optional)
namespace (optional)
type (optional)
package (optional)
package_version (optional)
last_activity_ms (optional)
size_in_bytes (optional)
size_in_bytes_formatted (optional)
dashboard (optional)
data_streams_list_200_response - Up
data_streams (optional)
delete_agent_policy_request - Up
agentPolicyId
fleet_server_health_check_request - Up
host (optional)
fleet_status_response - Fleet status response Up
isReady
missing_requirements
Enum:
missing_optional_features
Enum:
package_verification_key_id (optional)
full_agent_policy - Full agent policy Up
id
outputs
output_permissions (optional)
fleet (optional)
inputs
revision (optional)
agent (optional)
secret_references (optional)
full_agent_policy_fleet - Up
hosts (optional)
proxy_url (optional)
proxy_headers (optional)
ssl (optional)
kibana (optional)
full_agent_policy_fleet_oneOf - Up
hosts (optional)
proxy_url (optional)
proxy_headers (optional)
ssl (optional)
full_agent_policy_fleet_oneOf_1 - Up
kibana (optional)
full_agent_policy_fleet_oneOf_ssl - Up
verification_mode (optional)
certificate (optional)
key (optional)
certificate_authorities (optional)
renegotiation (optional)
full_agent_policy_input - Full agent policy input Up
id
name
revision
type
data_stream
use_output
meta (optional)
streams (optional)
full_agent_policy_input_allOf - Up
id
name
revision
type
data_stream
use_output
meta (optional)
streams (optional)
full_agent_policy_input_allOf_meta - Up
package (optional)
full_agent_policy_output - Full agent policy Up
hosts
ca_sha256
proxy_url (optional)
proxy_headers (optional)
type
additionalProperties (optional)
full_agent_policy_secret_references_inner - Up
id (optional)
generate_logstash_api_key_200_response - Up
api_key (optional)
get_agent_data_200_response_items_inner_value - Up
data (optional)
get_agent_tags_response - Get Agent Tags response Up
items (optional)
get_agent_upload_file_200_response_body - Up
items (optional)
get_agents_by_actions_request - Up
actionIds (optional)
get_agents_response - Get Agent response Up
list (optional)
items
total
page
perPage
statusSummary (optional)
get_agents_response_statusSummary - Up
offline (optional)
error (optional)
online (optional)
inactive (optional)
enrolling (optional)
unenrolling (optional)
unenrolled (optional)
updating (optional)
degradedQuote (optional)
get_bulk_assets_response - Bulk get assets response Up
response (optional)
get_bulk_assets_response_response_inner_inner - Up
id (optional)
type (optional)
updatedAt (optional)
attributes (optional)
get_categories_response - Get categories response Up
response (optional)
items
get_download_sources_200_response - Up
items (optional)
total (optional)
page (optional)
perPage (optional)
get_enrollment_api_keys_deprecated_200_response - Up
list (optional)
items
page
perPage
total
get_fleet_proxies_200_response - Up
items (optional)
total (optional)
page (optional)
perPage (optional)
get_fleet_server_hosts_200_response - Up
items (optional)
total (optional)
page (optional)
perPage (optional)
get_outputs_200_response - Up
items (optional)
total (optional)
page (optional)
perPage (optional)
get_package_200_response_allOf - Up
item (optional)
get_package_deprecated_200_response - Up
response (optional)
status
Enum:
installed
installing
install_failed
not_installed
savedObject
get_package_deprecated_200_response_allOf - Up
response (optional)
get_package_policies_200_response - Up
items
total (optional)
page (optional)
perPage (optional)
install_package_200_response - Up
items
_meta (optional)
install_package_deprecated_request - Up
force (optional)
installation_info - Installation info object Up
type (optional)
created_at (optional)
updated_at (optional)
namespaces (optional)
installed_kibana
installed_es
name
version
install_status
Enum:
installed
installing
install_failed
install_source
Enum:
registry
upload
bundled
install_kibana_space_id (optional)
install_format_schema_version (optional)
verification_status
Enum:
verified
unverified
unknown
verification_key_id (optional)
experimental_data_stream_features (optional)
list_agent_uploads_200_response_body - Up
item (optional)
list_limited_packages_200_response - Up
items (optional)
new_agent_action_request - Up
action (optional)
new_package_policy - New package policy Up
enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
inputs
policy_id (optional)
name
description (optional)
new_package_policy_inputs_inner - Up
type
enabled
processors (optional)
streams (optional)
config (optional)
vars (optional)
output_create_request - Output Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type
Enum:
logstash
hosts
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
version (optional)
key (optional)
compression (optional)
compression_level (optional)
client_id (optional)
auth_type
username (optional)
password (optional)
sasl (optional)
partition (optional)
random (optional)
round_robin (optional)
topics
headers (optional)
timeout (optional)
broker_timeout (optional)
broker_buffer_size (optional)
broker_ack_reliability (optional)
output_create_request_elasticsearch - elasticsearch Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type (optional)
Enum:
elasticsearch
hosts (optional)
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
output_create_request_elasticsearch_shipper - Up
disk_queue_enabled (optional)
disk_queue_path (optional)
disk_queue_max_size (optional)
disk_queue_encryption_enabled (optional)
disk_queue_compression_enabled (optional)
compression_level (optional)
loadbalance (optional)
output_create_request_kafka - kafka Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type
Enum:
kafka
hosts
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
version (optional)
key (optional)
compression (optional)
compression_level (optional)
client_id (optional)
auth_type
username (optional)
password (optional)
sasl (optional)
partition (optional)
random (optional)
round_robin (optional)
topics
headers (optional)
timeout (optional)
broker_timeout (optional)
broker_buffer_size (optional)
broker_ack_reliability (optional)
output_create_request_kafka_random - Up
group_events (optional)
output_create_request_kafka_sasl - Up
mechanism (optional)
output_create_request_logstash - logstash Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type
Enum:
logstash
hosts
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
output_update_request - Output Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type
Enum:
logstash
hosts
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
version (optional)
key (optional)
compression (optional)
compression_level (optional)
client_id (optional)
auth_type (optional)
username (optional)
password (optional)
sasl (optional)
partition (optional)
random (optional)
round_robin (optional)
topics (optional)
headers (optional)
timeout (optional)
broker_timeout (optional)
broker_ack_reliability (optional)
broker_buffer_size (optional)
output_update_request_elasticsearch - elasticsearch Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type
Enum:
elasticsearch
hosts
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
output_update_request_kafka - kafka Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type (optional)
Enum:
kafka
hosts (optional)
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
version (optional)
key (optional)
compression (optional)
compression_level (optional)
client_id (optional)
auth_type (optional)
username (optional)
password (optional)
sasl (optional)
partition (optional)
random (optional)
round_robin (optional)
topics (optional)
headers (optional)
timeout (optional)
broker_timeout (optional)
broker_ack_reliability (optional)
broker_buffer_size (optional)
output_update_request_logstash - logstash Up
id (optional)
is_default (optional)
is_default_monitoring (optional)
name
type (optional)
Enum:
logstash
hosts (optional)
ca_sha256 (optional)
ca_trusted_fingerprint (optional)
config (optional)
config_yaml (optional)
ssl (optional)
proxy_id (optional)
shipper (optional)
package_info - Package information Up
name
title
version
release (optional)
String release label is deprecated, derive from the version instead (packages follow semver)
Enum:
experimental
beta
ga
source (optional)
readme (optional)
description
type
categories
conditions
screenshots (optional)
icons (optional)
assets
internal (optional)
format_version
data_streams (optional)
download
path
elasticsearch (optional)
package_info_conditions - Up
kibana (optional)
elasticsearch (optional)
package_info_conditions_kibana - Up
versions (optional)
package_info_elasticsearch - Up
privileges (optional)
package_info_elasticsearch_privileges - Up
cluster (optional)
package_policy - Package policy Up
id
revision
inputs
enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
policy_id (optional)
name
description (optional)
package_policy_request - Package Policy Request Up
id (optional)
String Package policy unique identifier
name
String Package policy name (should be unique)
description (optional)
String Package policy description
namespace (optional)
String namespace by default "default"
policy_id
String Agent policy ID where that package policy will be added
package
vars (optional)
Object Package root level variable (see integration documentation for more information)
inputs (optional)
map[String, package_policy_request_inputs_value] Package policy inputs (see integration documentation to know what inputs are available)
force (optional)
Boolean Force package policy creation even if package is not verified, or if the agent policy is managed.
package_policy_request_inputs_value - Up
enabled (optional)
Boolean enable or disable that input, (default to true)
vars (optional)
Object Input level variable (see integration documentation for more information)
streams (optional)
map[String, package_policy_request_inputs_value_streams_value] Input streams (see integration documentation to know what streams are available)
package_usage_stats - Package usage stats Up
agent_policy_count
packages_get_verification_key_id_200_response - Up
body (optional)
statusCode (optional)
headers (optional)
packages_get_verification_key_id_200_response_body - Up
id (optional)
String the key ID of the GPG key used to verify package signatures
post_download_sources_200_response - Up
item (optional)
post_fleet_proxies_200_response - Up
item (optional)
post_fleet_server_hosts_200_response - Up
item (optional)
post_outputs_200_response - Up
item (optional)
reassign_agent_deprecated_request - Up
policy_id
settings - Settings Up
id
has_seen_add_data_notice (optional)
fleet_server_hosts
prerelease_integrations_enabled (optional)
setup_500_response - Up
message (optional)
update_package_request - Up
keepPoliciesUpToDate (optional)
update_settings_request - Up
fleet_server_hosts (optional)
array[String] Protocol and path must be the same for each URL
has_seen_add_data_notice (optional)
additional_yaml_config (optional)
upgrade_diff_inner - Up
id
revision
inputs
enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
policy_id (optional)
name
description (optional)
errors (optional)
missingVars (optional)
upgrade_diff_inner_allOf - Up
enabled (optional)
package (optional)
namespace (optional)
output_id (optional)
inputs
policy_id (optional)
name
description (optional)
errors (optional)
missingVars (optional)
upgrade_diff_inner_allOf_allOf - Up
errors (optional)
missingVars (optional)
upgrade_package_policy_dry_run_200_response_inner - Up
hasErrors
diff (optional)
agent_diff (optional)
upgrade_package_policy_request - Up
packagePolicyIds