diff --git a/docs/api-generated/fleet/fleet-apis-passthru.asciidoc b/docs/api-generated/fleet/fleet-apis-passthru.asciidoc new file mode 100644 index 0000000000000..5d8b478e9e94e --- /dev/null +++ b/docs/api-generated/fleet/fleet-apis-passthru.asciidoc @@ -0,0 +1,7329 @@ +//// +This content is generated from the open API specification. +Any modifications made to this file will be overwritten. +//// + +++++ +
+

Access

+
    +
  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
    2. +
  2. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
    3. +
  3. HTTP Basic Authentication
    4. +
+ +

Methods

+ [ Jump to Models ] + +

Table of Contents

+
+

Default

+ + +

Default

+
+
+ Up + 
post /agent_policies/{agentPolicyId}/copy
+
Agent policy - copy one policy (agentPolicyCopy)
+
+ +

Path parameters

+
+
agentPolicyId (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
agent_policy_copy_request agent_policy_copy_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ agent_policy_info_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{ }
+ +

Produces

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

Responses

+

200

+ OK + agent_policy_info_200_response +
+
+
+
+ Up + 
get /agent_policies/{agentPolicyId}
+
Agent policy - Info (agentPolicyInfo)
+
Get one agent policy
+ +

Path parameters

+
+
agentPolicyId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ agent_policy_info_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{ }
+ +

Produces

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

Responses

+

200

+ OK + agent_policy_info_200_response +
+
+
+
+ Up + 
get /agent_policies
+
Agent policies - List (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
+
+ + +

Return type

+
+ agent_policy_list_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_list_200_response +
+
+
+
+ Up + 
get /agents/action_status
+
Agents - Action status (agentsActionStatus)
+
+ + + + + +

Query parameters

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

Return type

+
+ agents_action_status_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agents_action_status_200_response +
+
+
+
+ Up + 
get /agents/current_upgrades
+
Agents - Current Bulk Upgrades (agentsCurrentUpgrades)
+
+ + + + + + + +

Return type

+
+ agents_current_upgrades_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "items" : [ {
+    "nbAgents" : 0.8008281904610115,
+    "actionId" : "actionId",
+    "nbAgentsAck" : 6.027456183070403,
+    "startTime" : "startTime",
+    "complete" : true,
+    "version" : "version"
+  }, {
+    "nbAgents" : 0.8008281904610115,
+    "actionId" : "actionId",
+    "nbAgentsAck" : 6.027456183070403,
+    "startTime" : "startTime",
+    "complete" : true,
+    "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. + + +

Responses

+

200

+ OK + agents_current_upgrades_200_response +
+
+
+
+ Up + 
post /agent_policies/_bulk_get
+
Agent policies - Bulk Get (bulkGetAgentPolicies)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
bulk_get_agent_policies_request bulk_get_agent_policies_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ bulk_get_agent_policies_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "items" : [ 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. + + +

Responses

+

200

+ OK + bulk_get_agent_policies_200_response +
+
+
+
+ Up + 
post /package_policies/_bulk_get
+
Package policies - Bulk Get (bulkGetPackagePolicies)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
bulk_get_package_policies_request bulk_get_package_policies_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ bulk_get_package_policies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_get_package_policies_200_response +
+
+
+
+ Up + 
post /epm/packages/_bulk
+
Packages - Bulk install (bulkInstallPackages)
+
+ + + + + + + +

Return type

+
+ bulk_install_packages_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_install_packages_response +
+
+
+
+ Up + 
post /agents/bulk_reassign
+
Agents - Bulk reassign (bulkReassignAgents)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
bulk_reassign_agents_request bulk_reassign_agents_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +
+
+
+
+ Up + 
post /agents/bulk_request_diagnostics
+
Agent - Bulk Request Diagnostics (bulkRequestDiagnostics)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
bulk_request_diagnostics_request bulk_request_diagnostics_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +
+
+
+
+ Up + 
post /agents/bulk_unenroll
+
Agents - Bulk unenroll (bulkUnenrollAgents)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
bulk_unenroll_agents_request bulk_unenroll_agents_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +
+
+
+
+ Up + 
post /agents/bulk_update_agent_tags
+
Agents - Bulk update tags (bulkUpdateAgentTags)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
bulk_update_agent_tags_request bulk_update_agent_tags_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +
+
+
+
+ Up + 
post /agents/bulk_upgrade
+
Agents - Bulk Upgrade (bulkUpgradeAgents)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
bulk_upgrade_agents bulk_upgrade_agents (required)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +

400

+ BAD REQUEST + upgrade_agent +
+
+
+
+ Up + 
post /agent_policies
+
Agent policy - Create (createAgentPolicy)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
new_agent_policy new_agent_policy (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ create_agent_policy_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{ }
+ +

Produces

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

Responses

+

200

+ OK + create_agent_policy_200_response +
+
+
+
+ Up + 
post /enrollment_api_keys
+
Enrollment API Key - Create (createEnrollmentApiKeys)
+
+ + + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ create_enrollment_api_keys_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + create_enrollment_api_keys_deprecated_200_response +
+
+
+
+ Up + 
post /enrollment-api-keys
+
Enrollment API Key - Create (createEnrollmentApiKeysDeprecated)
+
+ + + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ create_enrollment_api_keys_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + create_enrollment_api_keys_deprecated_200_response +
+
+
+
+ Up + 
post /package_policies
+
Package policy - Create (createPackagePolicy)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
create_package_policy_request create_package_policy_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ create_package_policy_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{ }
+ +

Produces

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

Responses

+

200

+ OK + create_package_policy_200_response +
+
+
+
+ Up + 
get /data_streams
+
Data streams - List (dataStreamsList)
+
+ + + + + + + +

Return type

+
+ data_streams_list_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + data_streams_list_200_response +
+
+
+
+ Up + 
delete /agents/{agentId}
+
Agent - Delete (deleteAgent)
+
+ +

Path parameters

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

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_200_response +
+
+
+
+ Up + 
post /agent_policies/delete
+
Agent policy - Delete (deleteAgentPolicy)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
delete_agent_policy_request delete_agent_policy_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_agent_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_policy_200_response +
+
+
+
+ Up + 
delete /agent_download_sources/{sourceId}
+
Agent Download Sources - Delete (deleteDownloadSource)
+
+ +

Path parameters

+
+
sourceId (required)
+ +
Path Parameter — default: null
+
+ + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +
+
+
+
+ Up + 
delete /enrollment_api_keys/{keyId}
+
Enrollment API Key - Delete (deleteEnrollmentApiKey)
+
+ +

Path parameters

+
+
keyId (required)
+ +
Path Parameter — default: null
+
+ + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_200_response +
+
+
+
+ Up + 
delete /enrollment-api-keys/{keyId}
+
Enrollment API Key - Delete (deleteEnrollmentApiKeyDeprecated)
+
+ +

Path parameters

+
+
keyId (required)
+ +
Path Parameter — default: null
+
+ + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_200_response +
+
+
+
+ Up + 
delete /proxies/{itemId}
+
Fleet Proxies - Delete (deleteFleetProxies)
+
+ +

Path parameters

+
+
itemId (required)
+ +
Path Parameter — default: null
+
+ + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +
+
+
+
+ Up + 
delete /fleet_server_hosts/{itemId}
+
Fleet Server Hosts - Delete (deleteFleetServerHosts)
+
+ +

Path parameters

+
+
itemId (required)
+ +
Path Parameter — default: null
+
+ + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +
+
+
+
+ Up + 
delete /outputs/{outputId}
+
Output - Delete (deleteOutput)
+
+ +

Path parameters

+
+
outputId (required)
+ +
Path Parameter — default: null
+
+ + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +
+
+
+
+ Up + 
delete /epm/packages/{pkgName}/{pkgVersion}
+
Packages - Delete (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: + + +

Request body

+
+
install_package_deprecated_request install_package_deprecated_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header 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
+
+ + +

Return type

+
+ update_package_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + update_package_200_response +
+
+
+
+ Up + 
delete /epm/packages/{pkgkey}
+
Packages - Delete (deletePackageDeprecated)
+
+ +

Path parameters

+
+
pkgkey (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
install_package_deprecated_request install_package_deprecated_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ install_package_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + install_package_deprecated_200_response +
+
+
+
+ Up + 
delete /package_policies/{packagePolicyId}
+
Package policy - Delete (deletePackagePolicy)
+
+ +

Path parameters

+
+
packagePolicyId (required)
+ +
Path Parameter — default: null
+
+ + + + +

Query parameters

+
+
force (optional)
+ +
Query Parameter — default: null
+
+ + +

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +
+
+
+
+ Up + 
post /logstash_api_keys
+
Generate Logstash API key (generateLogstashApiKey)
+
+ + + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ generate_logstash_api_key_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + generate_logstash_api_key_200_response +
+
+
+
+ Up + 
post /service_tokens
+
Generate service tokens (generateServiceToken)
+
+ + + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ generate_service_token_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + generate_service_token_deprecated_200_response +
+
+
+
+ Up + 
post /service-tokens
+
Generate service tokens (generateServiceTokenDeprecated)
+
+ + + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ generate_service_token_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + generate_service_token_deprecated_200_response +
+
+
+
+ Up + 
get /agents/{agentId}
+
Agent - Info (getAgent)
+
+ +

Path parameters

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

Return type

+
+ get_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_200_response +
+
+
+
+ Up + 
get /agent_status/data
+
Agents - Get incoming data (getAgentData)
+
+ + + + + +

Query parameters

+
+
agentsIds (required)
+ +
Query Parameter — default: null
+
+ + +

Return type

+
+ get_agent_data_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_data_200_response +
+
+
+
+ Up + 
get /agent_status
+
Agents - Summary stats (getAgentStatus)
+
+ + + + + +

Query parameters

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

Return type

+
+ get_agent_status_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_status_deprecated_200_response +
+
+
+
+ Up + 
get /agent-status
+
Agents - Summary stats (getAgentStatusDeprecated)
+
+ + + + + +

Query parameters

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

Return type

+
+ get_agent_status_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_status_deprecated_200_response +
+
+
+
+ Up + 
get /agents/tags
+
Agent Tags - List (getAgentTags)
+
List all agent tags
+ + + + + + + +

Return type

+
+ get_agent_tags_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_tags_response +
+
+
+
+ Up + 
get /agents
+
Agents - List (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
+
+ + +

Return type

+
+ get_agents_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "total" : 6.027456183070403,
+  "perPage" : 5.962133916683182,
+  "page" : 1.4658129805029452,
+  "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"
+  }, {
+    "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"
+  } ],
+  "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"
+  }, {
+    "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"
+  } ]
+}
+ +

Produces

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

Responses

+

200

+ OK + get_agents_response +
+
+
+
+ Up + 
get /agents/setup
+
Agents setup - Info (getAgentsSetupStatus)
+
+ + + + + + + +

Return type

+
+ fleet_status_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_status_response +
+
+
+
+ Up + 
get /agent_download_sources
+
Agent Download Sources (getDownloadSources)
+
+ + + + + + + +

Return type

+
+ get_download_sources_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_download_sources_200_response +
+
+
+
+ Up + 
get /enrollment_api_keys/{keyId}
+
Enrollment API Key - Info (getEnrollmentApiKey)
+
+ +

Path parameters

+
+
keyId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ get_enrollment_api_key_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_enrollment_api_key_deprecated_200_response +
+
+
+
+ Up + 
get /enrollment-api-keys/{keyId}
+
Enrollment API Key - Info (getEnrollmentApiKeyDeprecated)
+
+ +

Path parameters

+
+
keyId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ get_enrollment_api_key_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_enrollment_api_key_deprecated_200_response +
+
+
+
+ Up + 
get /enrollment_api_keys
+
Enrollment API Keys - List (getEnrollmentApiKeys)
+
+ + + + + + + +

Return type

+
+ get_enrollment_api_keys_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_enrollment_api_keys_deprecated_200_response +
+
+
+
+ Up + 
get /enrollment-api-keys
+
Enrollment API Keys - List (getEnrollmentApiKeysDeprecated)
+
+ + + + + + + +

Return type

+
+ get_enrollment_api_keys_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_enrollment_api_keys_deprecated_200_response +
+
+
+
+ Up + 
get /proxies
+
Fleet Proxies - List (getFleetProxies)
+
Return a list of Proxies
+ + + + + + + +

Return type

+
+ get_fleet_proxies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_fleet_proxies_200_response +
+
+
+
+ Up + 
get /fleet_server_hosts
+
Fleet Server Hosts - List (getFleetServerHosts)
+
Return a list of Fleet server hosts
+ + + + + + + +

Return type

+
+ get_fleet_server_hosts_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_fleet_server_hosts_200_response +
+
+
+
+ Up + 
get /agent_download_sources/{sourceId}
+
Agent Download Sources - Info (getOneDownloadSource)
+
+ +

Path parameters

+
+
sourceId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ get_one_download_source_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_download_source_200_response +
+
+
+
+ Up + 
get /proxies/{itemId}
+
Fleet Proxies - Info (getOneFleetProxies)
+
+ +

Path parameters

+
+
itemId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ get_one_fleet_proxies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_fleet_proxies_200_response +
+
+
+
+ Up + 
get /fleet_server_hosts/{itemId}
+
Fleet Server Hosts - Info (getOneFleetServerHosts)
+
+ +

Path parameters

+
+
itemId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ get_one_fleet_server_hosts_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_fleet_server_hosts_200_response +
+
+
+
+ Up + 
get /outputs/{outputId}
+
Output - Info (getOutput)
+
+ +

Path parameters

+
+
outputId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ get_output_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "item" : {
+    "ca_sha256" : "ca_sha256",
+    "hosts" : [ "hosts", "hosts" ],
+    "name" : "name",
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "id" : "id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "config" : "{}",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "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. + + +

Responses

+

200

+ OK + get_output_200_response +
+
+
+
+ Up + 
get /outputs
+
Outputs (getOutputs)
+
+ + + + + + + +

Return type

+
+ get_outputs_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "total" : 0,
+  "perPage" : 1,
+  "page" : 6,
+  "items" : [ {
+    "ca_sha256" : "ca_sha256",
+    "hosts" : [ "hosts", "hosts" ],
+    "name" : "name",
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "id" : "id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "config" : "{}",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "key"
+    }
+  }, {
+    "ca_sha256" : "ca_sha256",
+    "hosts" : [ "hosts", "hosts" ],
+    "name" : "name",
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "id" : "id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "config" : "{}",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "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. + + +

Responses

+

200

+ OK + get_outputs_200_response +
+
+
+
+ Up + 
get /epm/packages/{pkgName}/{pkgVersion}
+
Packages - Info (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
+
+ + +

Return type

+
+ get_package_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
null
+ +

Produces

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

Responses

+

200

+ OK + get_package_200_response +
+
+
+
+ Up + 
get /epm/categories
+
Package categories (getPackageCategories)
+
+ + + + + +

Query parameters

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

Return type

+
+ get_categories_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_categories_response +
+
+
+
+ Up + 
get /epm/packages/{pkgkey}
+
Packages - Info (getPackageDeprecated)
+
+ +

Path parameters

+
+
pkgkey (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ get_package_deprecated_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
null
+ +

Produces

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

Responses

+

200

+ OK + get_package_deprecated_200_response +
+
+
+
+ Up + 
get /package_policies
+
Package policies - List (getPackagePolicies)
+
+ + + + + + + +

Return type

+
+ get_package_policies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_package_policies_200_response +
+
+
+
+ Up + 
get /package_policies/{packagePolicyId}
+
Package policy - Info (getPackagePolicy)
+
+ +

Path parameters

+
+
packagePolicyId (required)
+ +
Path Parameter — default: null
+
+ + + + + + +

Return type

+
+ create_package_policy_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{ }
+ +

Produces

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

Responses

+

200

+ OK + create_package_policy_200_response +
+
+
+
+ Up + 
get /epm/packages/{pkgName}/stats
+
Get stats for a package (getPackageStats)
+
+ +

Path parameters

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

Return type

+
+ get_package_stats_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_package_stats_200_response +
+
+
+
+ Up + 
get /settings
+
Settings (getSettings)
+
+ + + + + + + +

Return type

+
+ fleet_settings_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_settings_response +
+
+
+
+ Up + 
post /epm/packages/{pkgName}/{pkgVersion}
+
Packages - Install (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: + + +

Request body

+
+
install_package_request install_package_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header 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
+
+ + +

Return type

+
+ install_package_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + install_package_200_response +
+
+
+
+ Up + 
post /epm/packages/{pkgkey}
+
Packages - Install (installPackageDeprecated)
+
+ +

Path parameters

+
+
pkgkey (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
install_package_deprecated_request install_package_deprecated_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ install_package_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + install_package_deprecated_200_response +
+
+
+
+ Up + 
get /epm/packages
+
Packages - List (listAllPackages)
+
+ + + + + +

Query parameters

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

Return type

+
+ get_packages_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_packages_response +
+
+
+
+ Up + 
get /epm/packages/limited
+
Packages - Get limited list (listLimitedPackages)
+
+ + + + + + + +

Return type

+
+ list_limited_packages_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + list_limited_packages_200_response +
+
+
+
+ Up + 
post /agents/{agentId}/actions
+
Agent - Actions (newAgentAction)
+
+ +

Path parameters

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

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
new_agent_action_request new_agent_action_request (required)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ new_agent_action_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + new_agent_action_200_response +
+
+
+
+ Up + 
get /epm/packages/{pkgName}/{pkgVersion}/{filePath}
+
Packages - Get file from registry (packagesGetFile)
+
+ +

Path parameters

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

Return type

+
+ packages_get_file_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + packages_get_file_200_response +
+
+
+
+ Up + 
post /package_policies/delete
+
Package policy - Delete (postDeletePackagePolicy)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
post_delete_package_policy_request post_delete_package_policy_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ array[post_delete_package_policy_200_response_inner] + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "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. + + +

Responses

+

200

+ OK + +
+
+
+
+ Up + 
post /agent_download_sources
+
Agent Download Sources (postDownloadSources)
+
Create a new agent download source
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
post_download_sources_request post_download_sources_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ post_download_sources_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + post_download_sources_200_response +
+
+
+
+ Up + 
post /proxies
+
Fleet Proxies - Create (postFleetProxies)
+
Create a new Fleet Server Host
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
post_fleet_proxies_request post_fleet_proxies_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ post_fleet_proxies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + post_fleet_proxies_200_response +
+
+
+
+ Up + 
post /fleet_server_hosts
+
Fleet Server Hosts - Create (postFleetServerHosts)
+
Create a new Fleet Server Host
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
post_fleet_server_hosts_request post_fleet_server_hosts_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ post_fleet_server_hosts_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + post_fleet_server_hosts_200_response +
+
+
+
+ Up + 
post /outputs
+
Outputs (postOutputs)
+
Create a new output
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
post_outputs_request post_outputs_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ post_outputs_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "item" : {
+    "ca_sha256" : "ca_sha256",
+    "hosts" : [ "hosts", "hosts" ],
+    "name" : "name",
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "id" : "id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "config" : "{}",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "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. + + +

Responses

+

200

+ OK + post_outputs_200_response +
+
+
+
+ Up + 
put /setup/preconfiguration
+
Preconfiguration (putPreconfiguration)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
put_preconfiguration_request put_preconfiguration_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ put_preconfiguration_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "agentPolicies" : [ "", "" ],
+  "packages" : {
+    "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. + + +

Responses

+

200

+ OK + put_preconfiguration_200_response +
+
+
+
+ Up + 
put /agents/{agentId}/reassign
+
Agent - Reassign (reassignAgent)
+
+ +

Path parameters

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

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
reassign_agent_request reassign_agent_request (required)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — 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. + + +

Responses

+

200

+ OK + Object +
+
+
+
+ Up + 
post /agents/{agentId}/request_diagnostics
+
Agent - Request Diagnostics (requestDiagnosticsAgent)
+
+ +

Path parameters

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

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +
+
+
+
+ Up + 
post /setup
+
Setup (setup)
+
+ + + + +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ fleet_setup_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_setup_response +

500

+ Internal Server Error + setup_500_response +
+
+
+
+ Up + 
post /agents/setup
+
Agents setup - Create (setupAgents)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
setup_agents_request setup_agents_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ fleet_setup_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_setup_response +
+
+
+
+ Up + 
post /agents/{agentId}/unenroll
+
Agent - Unenroll (unenrollAgent)
+
+ +

Path parameters

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

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
unenroll_agent_request unenroll_agent_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — 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. + + +

Responses

+

200

+ OK + Object +

400

+ BAD REQUEST + unenroll_agent_400_response +
+
+
+
+ Up + 
put /agents/{agentId}
+
Agent - Update (updateAgent)
+
+ +

Path parameters

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

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
update_agent_request update_agent_request (required)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ get_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_200_response +
+
+
+
+ Up + 
put /agent_policies/{agentPolicyId}
+
Agent policy - Update (updateAgentPolicy)
+
+ +

Path parameters

+
+
agentPolicyId (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
new_agent_policy new_agent_policy (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ agent_policy_info_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{ }
+ +

Produces

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

Responses

+

200

+ OK + agent_policy_info_200_response +
+
+
+
+ Up + 
put /agent_download_sources/{sourceId}
+
Agent Download Sources - Update (updateDownloadSource)
+
+ +

Path parameters

+
+
sourceId (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
update_download_source_request update_download_source_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ get_one_download_source_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_download_source_200_response +
+
+
+
+ Up + 
put /proxies/{itemId}
+
Fleet Proxies - Update (updateFleetProxies)
+
+ +

Path parameters

+
+
itemId (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
update_fleet_proxies_request update_fleet_proxies_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ get_one_fleet_proxies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_fleet_proxies_200_response +
+
+
+
+ Up + 
put /fleet_server_hosts/{itemId}
+
Fleet Server Hosts - Update (updateFleetServerHosts)
+
+ +

Path parameters

+
+
itemId (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
update_fleet_server_hosts_request update_fleet_server_hosts_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ get_one_fleet_server_hosts_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_fleet_server_hosts_200_response +
+
+
+
+ Up + 
put /outputs/{outputId}
+
Output - Update (updateOutput)
+
+ +

Path parameters

+
+
outputId (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
update_output_request update_output_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ get_output_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
{
+  "item" : {
+    "ca_sha256" : "ca_sha256",
+    "hosts" : [ "hosts", "hosts" ],
+    "name" : "name",
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "id" : "id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "config" : "{}",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "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. + + +

Responses

+

200

+ OK + get_output_200_response +
+
+
+
+ Up + 
put /epm/packages/{pkgName}/{pkgVersion}
+
Packages - Update (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: + + +

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

Return type

+
+ update_package_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + update_package_200_response +
+
+
+
+ Up + 
put /package_policies/{packagePolicyId}
+
Package policy - Update (updatePackagePolicy)
+
+ +

Path parameters

+
+
packagePolicyId (required)
+ +
Path Parameter — default: null
+
+ +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
update_package_policy update_package_policy (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ update_package_policy_200_response + +
+ + + +

Example data

+
Content-Type: application/json
+ 
null
+ +

Produces

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

Responses

+

200

+ OK + update_package_policy_200_response +
+
+
+
+ Up + 
post /settings
+
Settings - Update (updateSettings)
+
+ + + + + + + +

Return type

+
+ fleet_settings_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_settings_response +
+
+
+
+ Up + 
post /agents/{agentId}/upgrade
+
Agent - Upgrade (upgradeAgent)
+
+ +

Path parameters

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

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
upgrade_agent upgrade_agent (required)
+ +
Body Parameter —
+ +
+ +

Request headers

+
+
kbn-xsrf (required)
+ +
Header Parameter — default: null
+ +
+ + + +

Return type

+
+ upgrade_agent + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + upgrade_agent +

400

+ BAD REQUEST + upgrade_agent +
+
+
+
+ Up + 
post /package_policies/upgrade
+
Package policy - Upgrade (upgradePackagePolicy)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
upgrade_package_policy_request upgrade_package_policy_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ array[post_delete_package_policy_200_response_inner] + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + +
+
+
+
+ Up + 
post /package_policies/upgrade/dryrun
+
Package policy - Upgrade Dry run (upgradePackagePolicyDryRun)
+
+ + +

Consumes

+ This API call consumes the following media types via the Content-Type request header: + + +

Request body

+
+
upgrade_package_policy_dry_run_request upgrade_package_policy_dry_run_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ array[upgrade_package_policy_dry_run_200_response_inner] + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + +
+
+ +

Models

+ [ Jump to Methods ] + +

Table of Contents

+
    +
  1. agent - Agent
    2. +
  2. agent_action - Agent action
    3. +
  3. agent_action_oneOf -
    4. +
  4. agent_action_oneOf_1 -
    5. +
  5. agent_action_oneOf_1_data -
    6. +
  6. agent_component - Agent component
    7. +
  7. agent_component_status - Agent component status
    8. +
  8. agent_component_unit - Agent component unit
    9. +
  9. agent_component_unit_type - Agent component unit type
    10. +
  10. agent_policy -
    11. +
  11. agent_policy_allOf -
    12. +
  12. agent_policy_copy_request -
    13. +
  13. agent_policy_info_200_response -
    14. +
  14. agent_policy_list_200_response -
    15. +
  15. agent_status - Agent status
    16. +
  16. agent_type - Agent type
    17. +
  17. agents_action_status_200_response -
    18. +
  18. agents_action_status_200_response_items_inner -
    19. +
  19. agents_current_upgrades_200_response -
    20. +
  20. agents_current_upgrades_200_response_items_inner -
    21. +
  21. bulk_get_agent_policies_200_response -
    22. +
  22. bulk_get_agent_policies_request -
    23. +
  23. bulk_get_package_policies_200_response -
    24. +
  24. bulk_get_package_policies_request -
    25. +
  25. bulk_install_packages_response - Bulk install packages response
    26. +
  26. bulk_reassign_agents_request -
    27. +
  27. bulk_reassign_agents_request_agents -
    28. +
  28. bulk_request_diagnostics_request -
    29. +
  29. bulk_unenroll_agents_request -
    30. +
  30. bulk_update_agent_tags_request -
    31. +
  31. bulk_upgrade_agents - Bulk upgrade agents
    32. +
  32. bulk_upgrade_agents_200_response -
    33. +
  33. create_agent_policy_200_response -
    34. +
  34. create_enrollment_api_keys_deprecated_200_response -
    35. +
  35. create_package_policy_200_response -
    36. +
  36. create_package_policy_request -
    37. +
  37. create_package_policy_request_oneOf -
    38. +
  38. create_package_policy_request_oneOf_allOf -
    39. +
  39. data_stream - Data stream
    40. +
  40. data_stream_dashboard_inner -
    41. +
  41. data_streams_list_200_response -
    42. +
  42. delete_agent_200_response -
    43. +
  43. delete_agent_policy_200_response -
    44. +
  44. delete_agent_policy_request -
    45. +
  45. delete_package_policy_200_response -
    46. +
  46. download_sources - Download Source
    47. +
  47. elasticsearch_asset_type - Elasticsearch asset type
    48. +
  48. enrollment_api_key - Enrollment API key
    49. +
  49. fleet_server_host - Fleet Server Host
    50. +
  50. fleet_settings_response - Fleet settings response
    51. +
  51. fleet_setup_response - Fleet Setup response
    52. +
  52. fleet_setup_response_nonFatalErrors_inner -
    53. +
  53. fleet_status_response - Fleet status response
    54. +
  54. full_agent_policy_input - Full agent policy input
    55. +
  55. full_agent_policy_input_allOf -
    56. +
  56. full_agent_policy_input_allOf_data_stream -
    57. +
  57. full_agent_policy_input_stream - Full agent policy input stream
    58. +
  58. full_agent_policy_input_stream_allOf -
    59. +
  59. full_agent_policy_input_stream_allOf_data_stream -
    60. +
  60. generate_logstash_api_key_200_response -
    61. +
  61. generate_service_token_deprecated_200_response -
    62. +
  62. get_agent_200_response -
    63. +
  63. get_agent_data_200_response -
    64. +
  64. get_agent_data_200_response_items_inner_value -
    65. +
  65. get_agent_status_deprecated_200_response -
    66. +
  66. get_agent_tags_response - Get Agent Tags response
    67. +
  67. get_agents_response - Get Agent response
    68. +
  68. get_categories_response - Get categories response
    69. +
  69. get_categories_response_items_inner -
    70. +
  70. get_categories_response_response_inner -
    71. +
  71. get_download_sources_200_response -
    72. +
  72. get_enrollment_api_key_deprecated_200_response -
    73. +
  73. get_enrollment_api_keys_deprecated_200_response -
    74. +
  74. get_fleet_proxies_200_response -
    75. +
  75. get_fleet_server_hosts_200_response -
    76. +
  76. get_one_download_source_200_response -
    77. +
  77. get_one_fleet_proxies_200_response -
    78. +
  78. get_one_fleet_server_hosts_200_response -
    79. +
  79. get_output_200_response -
    80. +
  80. get_outputs_200_response -
    81. +
  81. get_package_200_response -
    82. +
  82. get_package_200_response_allOf -
    83. +
  83. get_package_200_response_allOf_1 -
    84. +
  84. get_package_deprecated_200_response -
    85. +
  85. get_package_deprecated_200_response_allOf -
    86. +
  86. get_package_deprecated_200_response_allOf_1 -
    87. +
  87. get_package_policies_200_response -
    88. +
  88. get_package_stats_200_response -
    89. +
  89. get_packages_response - Get Packages response
    90. +
  90. install_package_200_response -
    91. +
  91. install_package_200_response__meta -
    92. +
  92. install_package_deprecated_200_response -
    93. +
  93. install_package_deprecated_200_response_response_inner -
    94. +
  94. install_package_deprecated_200_response_response_inner_type -
    95. +
  95. install_package_deprecated_request -
    96. +
  96. install_package_request -
    97. +
  97. kibana_saved_object_type - Kibana saved object asset type
    98. +
  98. list_limited_packages_200_response -
    99. +
  99. new_agent_action_200_response -
    100. +
  100. new_agent_action_request -
    101. +
  101. new_agent_policy - New agent policy
    102. +
  102. new_package_policy - New package policy
    103. +
  103. new_package_policy_inputs_inner -
    104. +
  104. new_package_policy_package -
    105. +
  105. output - Output
    106. +
  106. output_ssl -
    107. +
  107. package_info - Package information
    108. +
  108. package_info_conditions -
    109. +
  109. package_info_conditions_elasticsearch -
    110. +
  110. package_info_conditions_kibana -
    111. +
  111. package_info_data_streams_inner -
    112. +
  112. package_info_data_streams_inner_vars_inner -
    113. +
  113. package_info_elasticsearch -
    114. +
  114. package_info_elasticsearch_privileges -
    115. +
  115. package_info_screenshots_inner -
    116. +
  116. package_info_source -
    117. +
  117. package_policy - Package policy
    118. +
  118. package_policy_allOf -
    119. +
  119. package_usage_stats - Package usage stats
    120. +
  120. packages_get_file_200_response -
    121. +
  121. post_delete_package_policy_200_response_inner -
    122. +
  122. post_delete_package_policy_request -
    123. +
  123. post_download_sources_200_response -
    124. +
  124. post_download_sources_request -
    125. +
  125. post_fleet_proxies_200_response -
    126. +
  126. post_fleet_proxies_request -
    127. +
  127. post_fleet_server_hosts_200_response -
    128. +
  128. post_fleet_server_hosts_request -
    129. +
  129. post_outputs_200_response -
    130. +
  130. post_outputs_request -
    131. +
  131. preconfigured_agent_policies - Preconfigured agent policies
    132. +
  132. preconfigured_agent_policies_id -
    133. +
  133. preconfigured_agent_policies_package_policies_inner -
    134. +
  134. preconfigured_agent_policies_package_policies_inner_inputs_inner -
    135. +
  135. preconfigured_agent_policies_package_policies_inner_inputs_inner_vars -
    136. +
  136. preconfigured_agent_policies_package_policies_inner_package -
    137. +
  137. proxies - Fleet Proxy
    138. +
  138. put_preconfiguration_200_response -
    139. +
  139. put_preconfiguration_200_response_packages -
    140. +
  140. put_preconfiguration_request -
    141. +
  141. put_preconfiguration_request_body -
    142. +
  142. put_preconfiguration_request_body_packages -
    143. +
  143. reassign_agent_request -
    144. +
  144. search_result - Search result
    145. +
  145. settings - Settings
    146. +
  146. setup_500_response -
    147. +
  147. setup_agents_request -
    148. +
  148. simplified_package_policy - Simplified Package Policy
    149. +
  149. simplified_package_policy_inputs_value -
    150. +
  150. simplified_package_policy_inputs_value_streams_value -
    151. +
  151. simplified_package_policy_package -
    152. +
  152. unenroll_agent_400_response -
    153. +
  153. unenroll_agent_request -
    154. +
  154. update_agent_request -
    155. +
  155. update_download_source_request -
    156. +
  156. update_fleet_proxies_request -
    157. +
  157. update_fleet_server_hosts_request -
    158. +
  158. update_output_request -
    159. +
  159. update_package_200_response -
    160. +
  160. update_package_policy - Update package policy
    161. +
  161. update_package_policy_200_response -
    162. +
  162. update_package_policy_200_response_oneOf -
    163. +
  163. update_package_policy_inputs_inner -
    164. +
  164. update_package_policy_package -
    165. +
  165. update_package_request -
    166. +
  166. upgrade_agent - Upgrade agent
    167. +
  167. upgrade_diff_inner -
    168. +
  168. upgrade_diff_inner_allOf -
    169. +
  169. upgrade_diff_inner_allOf_allOf -
    170. +
  170. upgrade_diff_inner_allOf_allOf_errors_inner -
    171. +
  171. upgrade_package_policy_dry_run_200_response_inner -
    172. +
  172. upgrade_package_policy_dry_run_request -
    173. +
  173. upgrade_package_policy_request -
    174. +
+ +
+

agent - Agent Up

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

agent_action - Agent action Up

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

agent_action_oneOf - Up

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

agent_action_oneOf_1 - Up

+
+
+
type (optional)
String
+
data (optional)
agent_action_oneOf_1_data
+
+
+
+

agent_action_oneOf_1_data - Up

+
+
+
log_level (optional)
String
+
Enum:
+
debug
info
warning
error
+
+
+
+

agent_component - Agent component Up

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

agent_component_status - Agent component status Up

+
+
+
+
+
+

agent_component_unit - Agent component unit Up

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

agent_component_unit_type - Agent component unit type Up

+
+
+
+
+
+

agent_policy - Up

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

agent_policy_allOf - Up

+
+
+
id
String
+
status
String
+
Enum:
+
active
inactive
+
package_policies (optional)
array[package_policy] This field is present only when retrieving a single agent policy, or when retrieving a list of agent policy with the ?full=true parameter
+
updated_on (optional)
Date format: date-time
+
updated_by (optional)
String
+
data_output_id (optional)
String
+
monitoring_output_id (optional)
String
+
fleet_server_host_id (optional)
String
+
download_source_id (optional)
String
+
revision (optional)
BigDecimal
+
agents (optional)
BigDecimal
+
+
+
+

agent_policy_copy_request - Up

+
+
+
name
String
+
description (optional)
String
+
+
+
+

agent_policy_info_200_response - Up

+
+
+
item
agent_policy
+
+
+
+

agent_policy_list_200_response - Up

+
+
+
items
array[agent_policy]
+
total
BigDecimal
+
page
BigDecimal
+
perPage
BigDecimal
+
+
+
+

agent_status - Agent status Up

+
+
+
+
+
+

agent_type - Agent type Up

+
+
+
+
+
+

agents_action_status_200_response - Up

+
+
+
items
array[agents_action_status_200_response_items_inner]
+
+
+
+

agents_action_status_200_response_items_inner - Up

+
+
+
actionId
String
+
status
String
+
Enum:
+
COMPLETE
EXPIRED
CANCELLED
FAILED
IN_PROGRESS
+
nbAgentsActioned
BigDecimal
+
nbAgentsActionCreated
BigDecimal
+
nbAgentsAck
BigDecimal
+
nbAgentsFailed
BigDecimal
+
version (optional)
String
+
startTime (optional)
String
+
type (optional)
String
+
expiration (optional)
String
+
completionTime (optional)
String
+
cancellationTime (optional)
String
+
newPolicyId (optional)
String
+
creationTime
String
+
+
+
+

agents_current_upgrades_200_response - Up

+
+
+
items
array[agents_current_upgrades_200_response_items_inner]
+
+
+
+

agents_current_upgrades_200_response_items_inner - Up

+
+
+
actionId
String
+
complete
Boolean
+
nbAgents
BigDecimal
+
nbAgentsAck
BigDecimal
+
version
String
+
startTime
String
+
+
+
+

bulk_get_agent_policies_200_response - Up

+
+
+
items
array[agent_policy]
+
+
+
+

bulk_get_agent_policies_request - Up

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

bulk_get_package_policies_200_response - Up

+
+
+
items
array[package_policy]
+
+
+
+

bulk_get_package_policies_request - Up

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

bulk_install_packages_response - Bulk install packages response Up

+
+
+
response (optional)
array[put_preconfiguration_200_response_packages]
+
items
array[put_preconfiguration_200_response_packages]
+
+
+
+

bulk_reassign_agents_request - Up

+
+
+
policy_id
String new agent policy id
+
agents
bulk_reassign_agents_request_agents
+
+
+
+

bulk_reassign_agents_request_agents - Up

+
+
+
+
+
+

bulk_request_diagnostics_request - Up

+
+
+
batchSize (optional)
BigDecimal
+
agents
bulk_reassign_agents_request_agents
+
+
+
+

bulk_unenroll_agents_request - Up

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

bulk_update_agent_tags_request - Up

+
+
+
agents
bulk_reassign_agents_request_agents
+
tagsToAdd (optional)
array[String]
+
tagsToRemove (optional)
array[String]
+
batchSize (optional)
BigDecimal
+
+
+
+

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)
BigDecimal rolling upgrade window duration in seconds
+
start_time (optional)
String start time of upgrade in ISO 8601 format
+
agents
bulk_reassign_agents_request_agents
+
force (optional)
Boolean Force upgrade, skipping validation (should be used with caution)
+
+
+
+

bulk_upgrade_agents_200_response - Up

+
+
+
actionId (optional)
String
+
+
+
+

create_agent_policy_200_response - Up

+
+
+
item (optional)
agent_policy
+
+
+
+

create_enrollment_api_keys_deprecated_200_response - Up

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

create_package_policy_200_response - Up

+
+
+
item
package_policy
+
+
+
+

create_package_policy_request - Up

+
+
+
id (optional)
String
+
name
String
+
description (optional)
String
+
namespace (optional)
String
+
policy_id
String
+
package
new_package_policy_package
+
vars (optional)
Object Package root level variable (see integration documentation for more information)
+
inputs
array[new_package_policy_inputs_inner]
+
force (optional)
Boolean
+
enabled (optional)
Boolean
+
output_id (optional)
String
+
+
+
+

create_package_policy_request_oneOf - Up

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

create_package_policy_request_oneOf_allOf - Up

+
+
+
id (optional)
String
+
+
+
+

data_stream - Data stream Up

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

data_stream_dashboard_inner - Up

+
+
+
id (optional)
String
+
title (optional)
String
+
+
+
+

data_streams_list_200_response - Up

+
+
+
data_streams (optional)
array[data_stream]
+
+
+
+

delete_agent_200_response - Up

+
+
+
action
String
+
Enum:
+
deleted
+
+
+
+

delete_agent_policy_200_response - Up

+
+
+
id
String
+
success
Boolean
+
+
+
+

delete_agent_policy_request - Up

+
+
+
agentPolicyId
String
+
+
+
+

delete_package_policy_200_response - Up

+
+
+
id
String
+
+
+
+

download_sources - Download Source Up

+
+
+
id (optional)
String
+
is_default
Boolean
+
name
String
+
host
String
+
+
+
+

elasticsearch_asset_type - Elasticsearch asset type Up

+
+
+
+
+
+

enrollment_api_key - Enrollment API key Up

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

fleet_server_host - Fleet Server Host Up

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

fleet_settings_response - Fleet settings response Up

+
+
+
item
settings
+
+
+
+

fleet_setup_response - Fleet Setup response Up

+
+
+
isInitialized
Boolean
+
nonFatalErrors
array[fleet_setup_response_nonFatalErrors_inner]
+
+
+
+

fleet_setup_response_nonFatalErrors_inner - Up

+
+
+
name
String
+
message
String
+
+
+
+

fleet_status_response - Fleet status response Up

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

full_agent_policy_input - Full agent policy input Up

+
+
+
id
String
+
name
String
+
revision
BigDecimal
+
type
String
+
data_stream
full_agent_policy_input_allOf_data_stream
+
use_output
String
+
meta (optional)
map[String, oas_any_type_not_mapped]
+
streams (optional)
full_agent_policy_input_stream
+
+
+
+

full_agent_policy_input_allOf - Up

+
+
+
id
String
+
name
String
+
revision
BigDecimal
+
type
String
+
data_stream
full_agent_policy_input_allOf_data_stream
+
use_output
String
+
meta (optional)
map[String, oas_any_type_not_mapped]
+
streams (optional)
full_agent_policy_input_stream
+
+
+
+

full_agent_policy_input_allOf_data_stream - Up

+
+
+
namespace
String
+
+
+
+

full_agent_policy_input_stream - Full agent policy input stream Up

+
+
+
id
String
+
data_stream
full_agent_policy_input_stream_allOf_data_stream
+
+
+
+

full_agent_policy_input_stream_allOf - Up

+
+
+
id
String
+
data_stream
full_agent_policy_input_stream_allOf_data_stream
+
+
+
+

full_agent_policy_input_stream_allOf_data_stream - Up

+
+
+
dataset
String
+
type
String
+
+
+
+

generate_logstash_api_key_200_response - Up

+
+
+
api_key (optional)
String
+
+
+
+

generate_service_token_deprecated_200_response - Up

+
+
+
name (optional)
String
+
value (optional)
String
+
+
+
+

get_agent_200_response - Up

+
+
+
item
agent
+
+
+
+

get_agent_data_200_response - Up

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

get_agent_data_200_response_items_inner_value - Up

+
+
+
data (optional)
Boolean
+
+
+
+

get_agent_status_deprecated_200_response - Up

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

get_agent_tags_response - Get Agent Tags response Up

+
+
+
items (optional)
array[String]
+
+
+
+

get_agents_response - Get Agent response Up

+
+
+
list (optional)
array[agent]
+
items
array[agent]
+
total
BigDecimal
+
page
BigDecimal
+
perPage
BigDecimal
+
+
+
+

get_categories_response - Get categories response Up

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

get_categories_response_items_inner - Up

+
+
+
id
String
+
title
String
+
count
BigDecimal
+
+
+
+

get_categories_response_response_inner - Up

+
+
+
id
String
+
title
String
+
count
BigDecimal
+
+
+
+

get_download_sources_200_response - Up

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

get_enrollment_api_key_deprecated_200_response - Up

+
+
+
item
enrollment_api_key
+
+
+
+

get_enrollment_api_keys_deprecated_200_response - Up

+
+
+
list (optional)
array[enrollment_api_key]
+
items
array[enrollment_api_key]
+
page
BigDecimal
+
perPage
BigDecimal
+
total
BigDecimal
+
+
+
+

get_fleet_proxies_200_response - Up

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

get_fleet_server_hosts_200_response - Up

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

get_one_download_source_200_response - Up

+
+
+
item
download_sources
+
+
+
+

get_one_fleet_proxies_200_response - Up

+
+
+
item
proxies
+
+
+
+

get_one_fleet_server_hosts_200_response - Up

+
+
+
item
fleet_server_host
+
+
+
+

get_output_200_response - Up

+
+
+
item
output
+
+
+
+

get_outputs_200_response - Up

+
+
+
items (optional)
array[output]
+
total (optional)
Integer
+
page (optional)
Integer
+
perPage (optional)
Integer
+
+
+
+

get_package_200_response - Up

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

get_package_200_response_allOf - Up

+
+
+
item (optional)
package_info
+
+
+
+

get_package_200_response_allOf_1 - Up

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

get_package_deprecated_200_response - Up

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

get_package_deprecated_200_response_allOf - Up

+
+
+
response (optional)
package_info
+
+
+
+

get_package_deprecated_200_response_allOf_1 - Up

+
+
+
status
String
+
Enum:
+
installed
installing
install_failed
not_installed
+
savedObject
String
+
+
+
+

get_package_policies_200_response - Up

+
+
+
items
array[package_policy]
+
total (optional)
BigDecimal
+
page (optional)
BigDecimal
+
perPage (optional)
BigDecimal
+
+
+
+

get_package_stats_200_response - Up

+
+
+
response
package_usage_stats
+
+
+
+

get_packages_response - Get Packages response Up

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

install_package_200_response - Up

+
+
+
items
array[install_package_deprecated_200_response_response_inner]
+
_meta (optional)
install_package_200_response__meta
+
+
+
+

install_package_200_response__meta - Up

+
+
+
install_source (optional)
String
+
Enum:
+
registry
upload
bundled
+
+
+
+

install_package_deprecated_200_response - Up

+
+
+
response
array[install_package_deprecated_200_response_response_inner]
+
+
+
+

install_package_deprecated_200_response_response_inner - Up

+
+
+
id
String
+
type
install_package_deprecated_200_response_response_inner_type
+
+
+
+

install_package_deprecated_200_response_response_inner_type - Up

+
+
+
+
+
+

install_package_deprecated_request - Up

+
+
+
force (optional)
Boolean
+
+
+
+

install_package_request - Up

+
+
+
force (optional)
Boolean
+
ignore_constraints (optional)
Boolean
+
+
+
+

kibana_saved_object_type - Kibana saved object asset type Up

+
+
+
+
+
+

list_limited_packages_200_response - Up

+
+
+
items (optional)
array[String]
+
+
+
+

new_agent_action_200_response - Up

+
+
+
body (optional)
array[BigDecimal]
+
statusCode (optional)
BigDecimal
+
headers (optional)
String
+
+
+
+

new_agent_action_request - Up

+
+
+
action (optional)
agent_action
+
+
+
+

new_agent_policy - New agent policy Up

+
+
+
id (optional)
String
+
name
String
+
namespace
String
+
description (optional)
String
+
monitoring_enabled (optional)
array[String]
+
Enum:
+ +
data_output_id (optional)
String
+
monitoring_output_id (optional)
String
+
fleet_server_host_id (optional)
String
+
download_source_id (optional)
String
+
+
+
+

new_package_policy - New package policy Up

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

new_package_policy_inputs_inner - Up

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

new_package_policy_package - Up

+
+
+
name
String
+
version
String
+
title (optional)
String
+
+
+
+

output - Output Up

+
+
+
id
String
+
is_default
Boolean
+
is_default_monitoring (optional)
Boolean
+
name
String
+
type
String
+
Enum:
+
elasticsearch
+
hosts (optional)
array[String]
+
ca_sha256 (optional)
String
+
ca_trusted_fingerprint (optional)
String
+
config (optional)
Object
+
config_yaml (optional)
String
+
ssl (optional)
output_ssl
+
+
+
+

output_ssl - Up

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

package_info - Package information Up

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

package_info_conditions - Up

+
+
+
kibana (optional)
package_info_conditions_kibana
+
elasticsearch (optional)
package_info_conditions_elasticsearch
+
+
+
+

package_info_conditions_elasticsearch - Up

+
+
+
subscription (optional)
String
+
Enum:
+
basic
gold
platinum
enterprise
+
+
+
+

package_info_conditions_kibana - Up

+
+
+
versions (optional)
String
+
+
+
+

package_info_data_streams_inner - Up

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

package_info_data_streams_inner_vars_inner - Up

+
+
+
name
String
+
default
String
+
+
+
+

package_info_elasticsearch - Up

+
+
+
privileges (optional)
package_info_elasticsearch_privileges
+
+
+
+

package_info_elasticsearch_privileges - Up

+
+
+
cluster (optional)
array[String]
+
+
+
+

package_info_screenshots_inner - Up

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

package_info_source - Up

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

package_policy - Package policy Up

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

package_policy_allOf - Up

+
+
+
id
String
+
revision
BigDecimal
+
inputs (optional)
array[oas_any_type_not_mapped]
+
+
+
+

package_usage_stats - Package usage stats Up

+
+
+
agent_policy_count
Integer
+
+
+
+

packages_get_file_200_response - Up

+
+
+
body (optional)
Object
+
statusCode (optional)
BigDecimal
+
headers (optional)
Object
+
+
+
+

post_delete_package_policy_200_response_inner - Up

+
+
+
id
String
+
name (optional)
String
+
success
Boolean
+
+
+
+

post_delete_package_policy_request - Up

+
+
+
packagePolicyIds
array[String]
+
force (optional)
Boolean
+
+
+
+

post_download_sources_200_response - Up

+
+
+
item (optional)
download_sources
+
+
+
+

post_download_sources_request - Up

+
+
+
id (optional)
String
+
name
String
+
is_default
Boolean
+
host
String
+
+
+
+

post_fleet_proxies_200_response - Up

+
+
+
item (optional)
proxies
+
+
+
+

post_fleet_proxies_request - Up

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

post_fleet_server_hosts_200_response - Up

+
+
+
item (optional)
fleet_server_host
+
+
+
+

post_fleet_server_hosts_request - Up

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

post_outputs_200_response - Up

+
+
+
item (optional)
output
+
+
+
+

post_outputs_request - Up

+
+
+
id (optional)
String
+
name
String
+
type
String
+
Enum:
+
elasticsearch
+
is_default (optional)
Boolean
+
is_default_monitoring (optional)
Boolean
+
hosts (optional)
array[String]
+
ca_sha256 (optional)
String
+
config_yaml (optional)
String
+
+
+
+

preconfigured_agent_policies - Preconfigured agent policies Up

+
+
+
name
String
+
description (optional)
String
+
is_managed (optional)
String
+
unenroll_timeout (optional)
BigDecimal
+
monitoring_enabled (optional)
array[String]
+
Enum:
+ +
namespace
String
+
id (optional)
preconfigured_agent_policies_id
+
is_default (optional)
Boolean
+
is_default_fleet_server (optional)
Boolean
+
has_fleet_server (optional)
Boolean
+
data_output_id (optional)
String
+
monitoring_output_id (optional)
String
+
package_policies
array[preconfigured_agent_policies_package_policies_inner]
+
+
+
+

preconfigured_agent_policies_id - Up

+
+
+
+
+
+

preconfigured_agent_policies_package_policies_inner - Up

+
+
+
id (optional)
preconfigured_agent_policies_id
+
name (optional)
String
+
package (optional)
preconfigured_agent_policies_package_policies_inner_package
+
description (optional)
String
+
namespace (optional)
String
+
inputs (optional)
array[preconfigured_agent_policies_package_policies_inner_inputs_inner]
+
+
+
+

preconfigured_agent_policies_package_policies_inner_inputs_inner - Up

+
+
+
type
String
+
enabled (optional)
Boolean
+
keep_enabled (optional)
Boolean
+
vars (optional)
preconfigured_agent_policies_package_policies_inner_inputs_inner_vars
+
+
+
+

preconfigured_agent_policies_package_policies_inner_inputs_inner_vars - Up

+
+
+
name (optional)
String
+
type (optional)
String
+
value (optional)
String
+
frozen (optional)
Boolean
+
+
+
+

preconfigured_agent_policies_package_policies_inner_package - Up

+
+
+
name (optional)
String
+
+
+
+

proxies - Fleet Proxy Up

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

put_preconfiguration_200_response - Up

+
+
+
agentPolicies (optional)
array[oas_any_type_not_mapped]
+
packages (optional)
put_preconfiguration_200_response_packages
+
+
+
+

put_preconfiguration_200_response_packages - Up

+
+
+
name (optional)
String
+
version (optional)
String
+
+
+
+

put_preconfiguration_request - Up

+
+
+
body (optional)
put_preconfiguration_request_body
+
+
+
+

put_preconfiguration_request_body - Up

+
+
+
agentPolicies (optional)
preconfigured_agent_policies
+
packages (optional)
put_preconfiguration_request_body_packages
+
+
+
+

put_preconfiguration_request_body_packages - Up

+
+
+
name
String
+
version
String
+
+
+
+

reassign_agent_request - Up

+
+
+
policy_id
String
+
+
+
+

search_result - Search result Up

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

settings - Settings Up

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

setup_500_response - Up

+
+
+
message (optional)
String
+
+
+
+

setup_agents_request - Up

+
+
+
admin_username
String
+
admin_password
String
+
+
+
+

simplified_package_policy - Simplified Package Policy 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
simplified_package_policy_package
+
vars (optional)
Object Package root level variable (see integration documentation for more information)
+
inputs (optional)
map[String, simplified_package_policy_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.
+
+
+
+

simplified_package_policy_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, simplified_package_policy_inputs_value_streams_value] Input streams (see integration documentation to know what streams are available)
+
+
+
+

simplified_package_policy_inputs_value_streams_value - Up

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

simplified_package_policy_package - Up

+
+
+
name
String Package name
+
version
String Package version
+
+
+
+

unenroll_agent_400_response - Up

+
+
+
error (optional)
String
+
message (optional)
String
+
statusCode (optional)
BigDecimal
+
Enum:
+
400
+
+
+
+

unenroll_agent_request - Up

+
+
+
revoke (optional)
Boolean
+
force (optional)
Boolean
+
+
+
+

update_agent_request - Up

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

update_download_source_request - Up

+
+
+
name
String
+
is_default
Boolean
+
host
String
+
+
+
+

update_fleet_proxies_request - Up

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

update_fleet_server_hosts_request - Up

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

update_output_request - Up

+
+
+
name
String
+
type
String
+
Enum:
+
elasticsearch
+
is_default (optional)
Boolean
+
is_default_monitoring (optional)
Boolean
+
hosts (optional)
array[String]
+
ca_sha256 (optional)
String
+
ca_trusted_fingerprint (optional)
String
+
config_yaml (optional)
String
+
+
+
+

update_package_200_response - Up

+
+
+
items
array[install_package_deprecated_200_response_response_inner]
+
+
+
+

update_package_policy - Update package policy Up

+
+
+
version (optional)
String
+
enabled
Boolean
+
package (optional)
update_package_policy_package
+
namespace
String
+
output_id (optional)
String Not supported output can be set at the agent policy level only
+
inputs (optional)
array[update_package_policy_inputs_inner]
+
policy_id
String
+
name
String
+
description (optional)
String
+
force (optional)
Boolean
+
+
+
+

update_package_policy_200_response - 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
simplified_package_policy_package
+
vars (optional)
Object Package root level variable (see integration documentation for more information)
+
inputs (optional)
map[String, simplified_package_policy_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.
+
item
package_policy
+
sucess
Boolean
+
+
+
+

update_package_policy_200_response_oneOf - Up

+
+
+
item
package_policy
+
sucess
Boolean
+
+
+
+

update_package_policy_inputs_inner - Up

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

update_package_policy_package - Up

+
+
+
name
String
+
version
String
+
title
String
+
+
+
+

update_package_request - Up

+
+
+
keepPoliciesUpToDate (optional)
Boolean
+
+
+
+

upgrade_agent - Upgrade agent Up

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

upgrade_diff_inner - Up

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

upgrade_diff_inner_allOf - Up

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

upgrade_diff_inner_allOf_allOf - Up

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

upgrade_diff_inner_allOf_allOf_errors_inner - Up

+
+
+
key (optional)
String
+
message (optional)
String
+
+
+
+

upgrade_package_policy_dry_run_200_response_inner - Up

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

upgrade_package_policy_dry_run_request - Up

+
+
+
packagePolicyIds
array[String]
+
packageVersion (optional)
String
+
+
+
+

upgrade_package_policy_request - Up

+
+
+
packagePolicyIds
array[String]
+
+
+
+++++ diff --git a/docs/api-generated/fleet/fleet-apis.asciidoc b/docs/api-generated/fleet/fleet-apis.asciidoc new file mode 100644 index 0000000000000..aee6ce65bb0ae --- /dev/null +++ b/docs/api-generated/fleet/fleet-apis.asciidoc @@ -0,0 +1,13 @@ +[[fleet-apis]] +== Fleet APIs + +preview::[] + +//// +This file includes content that has been generated from https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/openapi. Any modifications required must be done in that open API specification. +//// + +include::fleet-apis-passthru.asciidoc[] + + +/Users/dedemorton/go/src/github.com/elastic/kibana/x-pack/plugins/fleet/common/openapi diff --git a/docs/apis.asciidoc b/docs/apis.asciidoc index d85d9ce3f35eb..3d954ba2f6d1c 100644 --- a/docs/apis.asciidoc +++ b/docs/apis.asciidoc @@ -13,5 +13,6 @@ version of the specification is 3.0. For more information, go to https://openapi include::api-generated/cases/case-apis.asciidoc[] include::api-generated/connectors/connector-apis.asciidoc[] +include::api-generated/fleet/fleet-apis.asciidoc[] include::api-generated/machine-learning/ml-apis.asciidoc[] -include::api-generated/rules/rule-apis.asciidoc[] \ No newline at end of file +include::api-generated/rules/rule-apis.asciidoc[]