From 561d76940c01f378cb51d9ca1776472ffb2bbdf3 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Fri, 24 Feb 2023 23:52:47 -0500 Subject: [PATCH 01/11] Add generated Fleet APIs --- .../fleet/api-generated/README.md | 4 + .../fleet-apis-passthru.asciidoc | 8456 +++++++++++++++++ .../fleet/api-generated/fleet-apis.asciidoc | 10 + docs/en/ingest-management/fleet/apis.asciidoc | 14 + .../fleet/fleet-api-docs.asciidoc | 21 +- docs/en/ingest-management/index.asciidoc | 2 + 6 files changed, 8501 insertions(+), 6 deletions(-) create mode 100644 docs/en/ingest-management/fleet/api-generated/README.md create mode 100644 docs/en/ingest-management/fleet/api-generated/fleet-apis-passthru.asciidoc create mode 100644 docs/en/ingest-management/fleet/api-generated/fleet-apis.asciidoc create mode 100644 docs/en/ingest-management/fleet/apis.asciidoc diff --git a/docs/en/ingest-management/fleet/api-generated/README.md b/docs/en/ingest-management/fleet/api-generated/README.md new file mode 100644 index 0000000000..6a15f35bf4 --- /dev/null +++ b/docs/en/ingest-management/fleet/api-generated/README.md @@ -0,0 +1,4 @@ + OpenAPI (Experimental) + +This documentation is experimental and may be incomplete or change later. It has been generated from the [Fleet OpenAPI specification](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/elastic/kibana/{branch}/x-pack/plugins/fleet/common/openapi/bundled.json) in the Kibana repository, using the process described in the Generated APIs [readme file](https://github.com/elastic/kibana/tree/main/docs/api-generated). + diff --git a/docs/en/ingest-management/fleet/api-generated/fleet-apis-passthru.asciidoc b/docs/en/ingest-management/fleet/api-generated/fleet-apis-passthru.asciidoc new file mode 100644 index 0000000000..388e432132 --- /dev/null +++ b/docs/en/ingest-management/fleet/api-generated/fleet-apis-passthru.asciidoc @@ -0,0 +1,8456 @@ +//// +This content is generated from the open API specification. +Any modifications made to this file will be overwritten. +//// + +++++ +
+

Access

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

Methods

+ [ Jump to Models ] + +

Table of Contents

+
+

Default

+ + +

Default

+
+
+ Up + 
post /agents/{agentId}/actions/{actionId}/cancel
+
Agent - Cancel Action (agentActionCancel)
+
+ +

Path parameters

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

Request headers

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

Return type

+
+ agent_action_cancel_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_action_cancel_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ 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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ agent_policy_info_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_info_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /agent_policies/{agentPolicyId}/download
+
Agent policy - Download (agentPolicyDownload)
+
+ +

Path parameters

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

Query parameters

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

Return type

+
+ agent_policy_download_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_download_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /agent_policies/{agentPolicyId}/full
+
Agent policy - Get full policy (agentPolicyFull)
+
+ +

Path parameters

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

Query parameters

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

Return type

+
+ agent_policy_full_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_full_200_response +

400

+ Generic Error + setup_400_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
+ 
{
+  "item" : {
+    "updated_on" : "2000-01-23T04:56:07.000+00:00",
+    "package_policies" : [ null, null ],
+    "agent_features" : [ {
+      "name" : "name",
+      "enabled" : true
+    }, {
+      "name" : "name",
+      "enabled" : true
+    } ],
+    "description" : "description",
+    "fleet_server_host_id" : "fleet_server_host_id",
+    "monitoring_output_id" : "monitoring_output_id",
+    "inactivity_timeout" : 6.027456183070403,
+    "download_source_id" : "download_source_id",
+    "revision" : 1.4658129805029452,
+    "agents" : 5.962133916683182,
+    "monitoring_enabled" : [ "metrics", "metrics" ],
+    "name" : "name",
+    "namespace" : "namespace",
+    "updated_by" : "updated_by",
+    "data_output_id" : "data_output_id",
+    "id" : "id",
+    "unenroll_timeout" : 0.8008281904610115
+  }
+}
+ +

Produces

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

Responses

+

200

+ OK + agent_policy_info_200_response +

400

+ Generic Error + setup_400_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
noAgentCount (optional)
+ +
Query Parameter — When set to true, do not count how many agents are in the agent policy, this can improve performance if you are searching over a large number of agent policies. The "agents" property will always be 0 if set to true. default: null
+
+ + +

Return type

+
+ agent_policy_list_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_list_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + agents_action_status_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Return type

+
+ bulk_get_agent_policies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_get_agent_policies_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + bulk_get_package_policies_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /epm/packages/_bulk
+
Packages - Bulk install (bulkInstallPackages)
+
+ + +

Consumes

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

Request body

+
+
bulk_install_packages_request bulk_install_packages_request (optional)
+ +
Body Parameter —
+ +
+ + +

Query parameters

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

Return type

+
+ bulk_install_packages_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_install_packages_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /agent_policies
+
Agent policy - Create (createAgentPolicy)
+
+ + +

Consumes

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

Request body

+
+
agent_policy_create_request agent_policy_create_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

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

Return type

+
+ create_agent_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + create_agent_policy_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /enrollment_api_keys
+
Enrollment API Key - Create (createEnrollmentApiKeys)
+
+ + + + +

Request headers

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

Return type

+
+ create_enrollment_api_keys_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + create_enrollment_api_keys_deprecated_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /enrollment-api-keys
+
Enrollment API Key - Create (createEnrollmentApiKeysDeprecated)
+
+ + + + +

Request headers

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

Return type

+
+ create_enrollment_api_keys_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + create_enrollment_api_keys_deprecated_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /package_policies
+
Package policy - Create (createPackagePolicy)
+
+ + +

Consumes

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

Request body

+
+
package_policy_request package_policy_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

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

Return type

+
+ create_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + create_package_policy_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + data_streams_list_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
delete /agents/{agentId}
+
Agent - Delete (deleteAgent)
+
+ +

Path parameters

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

Request headers

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

Return type

+
+ delete_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ delete_agent_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_policy_200_response +

400

+ Generic Error + setup_400_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 — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
+ +
+ + + +

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +

400

+ Generic Error + setup_400_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 — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
+ +
+ + + +

Return type

+
+ delete_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_200_response +

400

+ Generic Error + setup_400_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 — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
+ +
+ + + +

Return type

+
+ delete_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_agent_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
delete /proxies/{itemId}
+
Fleet Proxies - Delete (deleteFleetProxies)
+
+ +

Path parameters

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

Request headers

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

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +

400

+ Generic Error + setup_400_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 — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
+ +
+ + + +

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
delete /outputs/{outputId}
+
Output - Delete (deleteOutput)
+
+ +

Path parameters

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

Request headers

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

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + delete_package_policy_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Query parameters

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

Return type

+
+ update_package_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + update_package_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ install_package_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + install_package_deprecated_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + delete_package_policy_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /health_check
+
Fleet Server Health Check (fleetServerHealthCheck)
+
+ + +

Consumes

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

Request body

+
+
fleet_server_health_check_request fleet_server_health_check_request (required)
+ +
Body Parameter —
+ +
+ +

Request headers

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

Return type

+
+ fleet_server_health_check_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_server_health_check_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /logstash_api_keys
+
Generate Logstash API key (generateLogstashApiKey)
+
+ + + + +

Request headers

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

Return type

+
+ generate_logstash_api_key_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + generate_logstash_api_key_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /service_tokens
+
Generate service tokens (generateServiceToken)
+
+ + + + +

Request headers

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

Return type

+
+ generate_service_token_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + generate_service_token_deprecated_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /service-tokens
+
Generate service tokens (generateServiceTokenDeprecated)
+
+ + + + +

Request headers

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

Return type

+
+ generate_service_token_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + generate_service_token_deprecated_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /agents/{agentId}
+
Agent - Info (getAgent)
+
+ +

Path parameters

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

Query parameters

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

Return type

+
+ get_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_agent_data_200_response +

400

+ Generic Error + setup_400_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_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_status_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_agent_status_deprecated_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_agent_tags_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /agents/files@{fileId}@{fileName}
+
Get agent upload file (getAgentUploadFile)
+
+ +

Path parameters

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

Return type

+
+ get_agent_upload_file_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_upload_file_200_response +

400

+ Generic Error + setup_400_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
withMetrics (optional)
+ +
Query Parameter — Return agent metrics, false by default default: null
getStatusSummary (optional)
+ +
Query Parameter — default: null
+
+ + +

Return type

+
+ get_agents_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agents_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + fleet_status_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_download_sources_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_enrollment_api_key_deprecated_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_enrollment_api_key_deprecated_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_enrollment_api_keys_deprecated_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_enrollment_api_keys_deprecated_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_fleet_proxies_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_fleet_server_hosts_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /kubernetes
+
Get K8s Full Agent Manifest (getFullK8sManifest)
+
+ + + + + +

Query parameters

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

Return type

+
+ agent_policy_download_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_download_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_one_download_source_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_one_fleet_proxies_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_one_fleet_server_hosts_200_response +

400

+ Generic Error + setup_400_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" : {
+    "shipper" : {
+      "disk_queue_max_size" : 0.8008281904610115,
+      "disk_queue_compression_enabled" : true,
+      "disk_queue_enabled" : true,
+      "disk_queue_path" : "disk_queue_path",
+      "disk_queue_encryption_enabled" : true,
+      "compression_level" : 6.027456183070403,
+      "loadbalance" : true
+    },
+    "hosts" : [ "hosts", "hosts" ],
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "proxy_id" : "proxy_id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "key"
+    },
+    "ca_sha256" : "ca_sha256",
+    "name" : "name",
+    "id" : "id",
+    "config" : "{}"
+  }
+}
+ +

Produces

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

Responses

+

200

+ OK + get_output_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /outputs
+
Outputs (getOutputs)
+
+ + + + + + + +

Return type

+
+ get_outputs_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_outputs_200_response +

400

+ Generic Error + setup_400_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
prerelease (optional)
+ +
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
+
+ + +

Return type

+
+ get_package_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_package_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_categories_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /epm/packages/{pkgkey}
+
Packages - Info (getPackageDeprecated)
+
+ +

Path parameters

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

Query parameters

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

Return type

+
+ get_package_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_package_deprecated_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_package_policies_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + create_package_policy_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_package_stats_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + fleet_settings_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Query parameters

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

Return type

+
+ install_package_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + install_package_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /epm/packages
+
Packages - Install by upload (installPackageByUpload)
+
+ + +

Consumes

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

Request body

+
+
body file (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

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

Return type

+
+ install_package_by_upload_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + install_package_by_upload_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ install_package_deprecated_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + install_package_deprecated_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
get /agents/{agentId}/uploads
+
List agent uploads (listAgentUploads)
+
+ +

Path parameters

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

Return type

+
+ list_agent_uploads_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + list_agent_uploads_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + get_packages_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + list_limited_packages_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ new_agent_action_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + new_agent_action_200_response +

400

+ Generic Error + setup_400_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. +
    +
  • application/json
    • +
+ +

Responses

+

200

+ OK + packages_get_file_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

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

Example data

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

Produces

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

Responses

+

200

+ OK + +

400

+ Generic Error + setup_400_response +
+
+
+
+ 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: +
    +
  • application/json
    • +
+ +

Request body

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

Return type

+
+ post_download_sources_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + post_download_sources_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Return type

+
+ post_fleet_proxies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + post_fleet_proxies_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Return type

+
+ post_fleet_server_hosts_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + post_fleet_server_hosts_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Return type

+
+ post_outputs_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + post_outputs_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ + Object +
+ + + + +

Produces

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

Responses

+

200

+ OK + Object +

400

+ Generic Error + setup_400_response +
+
+
+
+ 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 — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
+ +
+ + + +

Return type

+
+ bulk_upgrade_agents_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + bulk_upgrade_agents_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /setup
+
Setup (setup)
+
+ + + + +

Request headers

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

Return type

+
+ fleet_setup_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_setup_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ fleet_setup_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_setup_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ + Object +
+ + + + +

Produces

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

Responses

+

200

+ OK + Object +

400

+ BAD REQUEST + unenroll_agent_400_response +
+
+
+
+ Up + 
put /agents/{agentId}
+
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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ get_agent_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_agent_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

+
+
agent_policy_update_request agent_policy_update_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

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

Return type

+
+ agent_policy_info_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_info_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ get_one_download_source_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_download_source_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ get_one_fleet_proxies_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_fleet_proxies_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ get_one_fleet_server_hosts_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_one_fleet_server_hosts_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ get_output_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + get_output_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

+
+
update_package_request update_package_request (optional)
+ +
Body Parameter —
+ +
+ + +

Query parameters

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

Return type

+
+ update_package_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + update_package_200_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

+
+
package_policy_request package_policy_request (optional)
+ +
Body Parameter —
+ +
+ +

Request headers

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

Return type

+
+ update_package_policy_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + update_package_policy_200_response +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
put /settings
+
Settings - Update (updateSettings)
+
+ + +

Consumes

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

Request body

+
+
update_settings_request update_settings_request (optional)
+ +
Body Parameter —
+ +
+ + + + +

Return type

+
+ fleet_settings_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_settings_response +

400

+ Generic Error + setup_400_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: +
    +
  • application/json
    • +
+ +

Request body

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

Request headers

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

Return type

+
+ upgrade_agent + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + upgrade_agent +

400

+ Generic Error + setup_400_response +
+
+
+
+ Up + 
post /package_policies/upgrade
+
Package policy - Upgrade (upgradePackagePolicy)
+
+ + +

Consumes

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

Request body

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

Return type

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

Example data

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

Produces

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

Responses

+

200

+ OK + +

400

+ Generic Error + setup_400_response +
+
+
+
+ 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: +
    +
  • application/json
    • +
+ +

Request body

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

Return type

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

Example data

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

Produces

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

Responses

+

200

+ OK + +

400

+ Generic Error + setup_400_response +
+
+ +

Models

+ [ Jump to Methods ] + +

Table of Contents

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

Full_agent_policy_output_permissions - Up

+
+
+
packagePolicyName (optional)
String
+
data (optional)
Full_agent_policy_output_permissions_data
+
+
+
+

Full_agent_policy_output_permissions_data - Up

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

Full_agent_policy_output_permissions_data_indices_inner - Up

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

agent - Agent Up

+
+
+
type
agent_type
+
active
Boolean
+
enrolled_at
String
+
unenrolled_at (optional)
String
+
unenrollment_started_at (optional)
String
+
access_api_key_id (optional)
String
+
default_api_key_id (optional)
String
+
policy_id (optional)
String
+
policy_revision (optional)
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]
+
metrics (optional)
agent_metrics
+
+
+
+

agent_action - Agent action Up

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

agent_action_cancel_200_response - Up

+
+
+
item (optional)
agent_action
+
+
+
+

agent_action_oneOf - Up

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

agent_action_oneOf_1 - Up

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

agent_action_oneOf_1_data - Up

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

agent_component - Agent component Up

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

agent_component_status - Agent component status Up

+
+
+
+
+
+

agent_component_unit - Agent component unit Up

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

agent_component_unit_type - Agent component unit type Up

+
+
+
+
+
+

agent_diagnostics - Agent diagnostics Up

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

agent_metrics - Up

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

agent_policy - Agent Policy Up

+
+
+
id
String
+
name
String
+
namespace
String
+
description (optional)
String
+
monitoring_enabled (optional)
array[String]
+
Enum:
+ +
data_output_id (optional)
String
+
monitoring_output_id (optional)
String
+
fleet_server_host_id (optional)
String
+
download_source_id (optional)
String
+
unenroll_timeout (optional)
BigDecimal
+
inactivity_timeout (optional)
BigDecimal
+
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_features (optional)
array[agent_policy_agent_features_inner]
+
+
+
+

agent_policy_agent_features_inner - Up

+
+
+
name
String
+
enabled
Boolean
+
+
+
+

agent_policy_copy_request - Up

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

agent_policy_create_request - Create agent policy request Up

+
+
+
id (optional)
String
+
name
String
+
namespace
String
+
description (optional)
String
+
monitoring_enabled (optional)
array[String]
+
Enum:
+ +
data_output_id (optional)
String
+
monitoring_output_id (optional)
String
+
fleet_server_host_id (optional)
String
+
download_source_id (optional)
String
+
unenroll_timeout (optional)
BigDecimal
+
inactivity_timeout (optional)
BigDecimal
+
agent_features (optional)
array[agent_policy_agent_features_inner]
+
+
+
+

agent_policy_download_200_response - Up

+
+
+
item (optional)
String
+
+
+
+

agent_policy_full - Agent policy full response Up

+
+
+
item (optional)
full_agent_policy
+
+
+
+

agent_policy_full_200_response - Up

+
+
+
item (optional)
agent_policy_full_200_response_item
+
+
+
+

agent_policy_full_200_response_item - Up

+
+
+
item (optional)
full_agent_policy
+
+
+
+

agent_policy_full_oneOf - Up

+
+
+
item (optional)
String
+
+
+
+

agent_policy_full_oneOf_1 - Up

+
+
+
item (optional)
full_agent_policy
+
+
+
+

agent_policy_info_200_response - Up

+
+
+
item
agent_policy
+
+
+
+

agent_policy_list_200_response - Up

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

agent_policy_update_request - Update agent policy request Up

+
+
+
name
String
+
namespace
String
+
description (optional)
String
+
monitoring_enabled (optional)
array[String]
+
Enum:
+ +
data_output_id (optional)
String
+
monitoring_output_id (optional)
String
+
fleet_server_host_id (optional)
String
+
download_source_id (optional)
String
+
unenroll_timeout (optional)
BigDecimal
+
inactivity_timeout (optional)
BigDecimal
+
agent_features (optional)
array[agent_policy_agent_features_inner]
+
+
+
+

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

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

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

bulk_install_packages_response - Bulk install packages response Up

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

bulk_install_packages_response_response_inner - Up

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

bulk_reassign_agents_request - Up

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

bulk_reassign_agents_request_agents - Up

+
+
+
+
+
+

bulk_request_diagnostics_request - Up

+
+
+
batchSize (optional)
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
+
+
+
+

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

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

fleet_server_health_check_request - Up

+
+
+
host (optional)
String
+
+
+
+

fleet_server_host - Fleet Server Host Up

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

fleet_settings_response - Fleet settings response Up

+
+
+
item
settings
+
+
+
+

fleet_setup_response - Fleet Setup response Up

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

fleet_setup_response_nonFatalErrors_inner - Up

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

fleet_status_response - Fleet status response Up

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

full_agent_policy - Full agent policy Up

+
+
+
id
String
+
outputs
map[String, full_agent_policy_output]
+
output_permissions (optional)
map[String, full_agent_policy_output_permissions_1_value]
+
fleet (optional)
full_agent_policy_fleet
+
inputs
String
+
revision (optional)
BigDecimal
+
agent (optional)
String
+
download_source_id (optional)
String
+
+
+
+

full_agent_policy_fleet - Up

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

full_agent_policy_fleet_oneOf - Up

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

full_agent_policy_fleet_oneOf_1 - Up

+
+
+
kibana (optional)
full_agent_policy_fleet_oneOf_1_kibana
+
+
+
+

full_agent_policy_fleet_oneOf_1_kibana - Up

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

full_agent_policy_fleet_oneOf_ssl - Up

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

full_agent_policy_input - Full agent policy input Up

+
+
+
id
String
+
name
String
+
revision
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
+
+
+
+

full_agent_policy_output - Full agent policy Up

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

full_agent_policy_output_additionalProperties - Up

+
+
+
text (optional)
oas_any_type_not_mapped
+
+
+
+

full_agent_policy_output_permissions_1_value - Up

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

generate_logstash_api_key_200_response - Up

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

generate_service_token_deprecated_200_response - Up

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

get_agent_200_response - Up

+
+
+
item
agent
+
+
+
+

get_agent_data_200_response - Up

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

get_agent_data_200_response_items_inner_value - Up

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

get_agent_status_200_response - Up

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

get_agent_status_deprecated_200_response - Up

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

get_agent_tags_response - Get Agent Tags response Up

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

get_agent_upload_file_200_response - Up

+
+
+
body (optional)
get_agent_upload_file_200_response_body
+
+
+
+

get_agent_upload_file_200_response_body - Up

+
+
+
items (optional)
get_agent_upload_file_200_response_body_items
+
+
+
+

get_agent_upload_file_200_response_body_items - Up

+
+
+
body (optional)
oas_any_type_not_mapped
+
headers (optional)
oas_any_type_not_mapped
+
+
+
+

get_agents_response - Get Agent response Up

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

get_agents_response_statusSummary - Up

+
+
+
offline (optional)
BigDecimal
+
error (optional)
BigDecimal
+
online (optional)
BigDecimal
+
inactive (optional)
BigDecimal
+
enrolling (optional)
BigDecimal
+
unenrolling (optional)
BigDecimal
+
unenrolled (optional)
BigDecimal
+
updating (optional)
BigDecimal
+
degradedQuote (optional)
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_by_upload_200_response_items_inner]
+
_meta (optional)
install_package_200_response__meta
+
+
+
+

install_package_200_response__meta - Up

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

install_package_by_upload_200_response - Up

+
+
+
items
array[install_package_by_upload_200_response_items_inner]
+
_meta (optional)
install_package_by_upload_200_response__meta
+
+
+
+

install_package_by_upload_200_response__meta - Up

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

install_package_by_upload_200_response_items_inner - Up

+
+
+
id
String
+
type
install_package_by_upload_200_response_items_inner_type
+
+
+
+

install_package_by_upload_200_response_items_inner_type - Up

+
+
+
+
+
+

install_package_deprecated_200_response - Up

+
+
+
response
array[install_package_by_upload_200_response_items_inner]
+
+
+
+

install_package_deprecated_request - Up

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

install_package_request - Up

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

kibana_saved_object_type - Kibana saved object asset type Up

+
+
+
+
+
+

list_agent_uploads_200_response - Up

+
+
+
body (optional)
list_agent_uploads_200_response_body
+
+
+
+

list_agent_uploads_200_response_body - Up

+
+
+
item (optional)
array[agent_diagnostics]
+
+
+
+

list_limited_packages_200_response - Up

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

new_agent_action_200_response - Up

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

new_agent_action_request - Up

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

new_package_policy - New package policy Up

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

new_package_policy_inputs_inner - Up

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

new_package_policy_package - Up

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

output - Output Up

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

output_shipper - Up

+
+
+
disk_queue_enabled (optional)
Boolean
+
disk_queue_path (optional)
String
+
disk_queue_max_size (optional)
BigDecimal
+
disk_queue_encryption_enabled (optional)
Boolean
+
disk_queue_compression_enabled (optional)
Boolean
+
compression_level (optional)
BigDecimal
+
loadbalance (optional)
Boolean
+
+
+
+

output_ssl - Up

+
+
+
certificate_authorities (optional)
array[String]
+
certificate (optional)
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_policy_request - Package Policy Request Up

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

package_policy_request_inputs_value - Up

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

package_policy_request_inputs_value_streams_value - Up

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

package_policy_request_package - Up

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

package_usage_stats - Package usage stats Up

+
+
+
agent_policy_count
Integer
+
+
+
+

packages_get_file_200_response - Up

+
+
+
body (optional)
Object
+
statusCode (optional)
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
+
+
+
+

proxies - Fleet Proxy Up

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

reassign_agent_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_400_response - Up

+
+
+
statusCode (optional)
BigDecimal
+
error (optional)
String
+
message (optional)
String
+
+
+
+

setup_500_response - Up

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

setup_agents_request - Up

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

unenroll_agent_400_response - Up

+
+
+
error (optional)
String
+
message (optional)
String
+
statusCode (optional)
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_by_upload_200_response_items_inner]
+
+
+
+

update_package_policy_200_response - Up

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

update_package_request - Up

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

update_settings_request - Up

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

upgrade_agent - Upgrade agent Up

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

upgrade_diff_inner - Up

+
+
+
id
String
+
revision
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/en/ingest-management/fleet/api-generated/fleet-apis.asciidoc b/docs/en/ingest-management/fleet/api-generated/fleet-apis.asciidoc new file mode 100644 index 0000000000..d4b41cb340 --- /dev/null +++ b/docs/en/ingest-management/fleet/api-generated/fleet-apis.asciidoc @@ -0,0 +1,10 @@ +[[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[] \ No newline at end of file diff --git a/docs/en/ingest-management/fleet/apis.asciidoc b/docs/en/ingest-management/fleet/apis.asciidoc new file mode 100644 index 0000000000..e24e7f38f1 --- /dev/null +++ b/docs/en/ingest-management/fleet/apis.asciidoc @@ -0,0 +1,14 @@ +[role="exclude",id="apis"] += API + +[partintro] +-- + +preview::[] + +The {fleet} API is documented using the OpenAPI specification. The current supported +version of the specification is 3.0. For more information, go to https://openapi-generator.tech/[OpenAPI Generator] + +-- + +include::api-generated/fleet-apis.asciidoc[] \ No newline at end of file diff --git a/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc b/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc index b98d4283b3..ecc28eafa9 100644 --- a/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc +++ b/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc @@ -3,14 +3,23 @@ experimental[] -The official {fleet} API documentation is not yet available in the Elastic docs. -However we do provide a self-contained spec file that you can -https://petstore.swagger.io/?url=https://raw.githubusercontent.com/elastic/kibana/{branch}/x-pack/plugins/fleet/common/openapi/bundled.json[view in Swagger] -(or a similar tool) to explore our Fleet APIs. +You can find details for all available {fleet} API endpoints in our generated +<>. This documentation is experimental and may be +incomplete or change later. +We also provide a +https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/openapi/bundled.json[self-contained spec file] +that you can use to generate docs using Swagger or a similar tool. For more information, refer to the -https://github.com/elastic/kibana/blob/{branch}/x-pack/plugins/fleet/common/openapi/README.md[{fleet} OpenAPI file] -in the {kib} repository. +https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/openapi/README.md[{fleet} OpenAPI readme]. + +//However we do provide a self-contained spec file that you can +//https://petstore.swagger.io/?url=https://raw.githubusercontent.com/elastic/kibana/{branch}/x-pack/plugins/fleet/common/openapi/bundled.json[view in Swagger] +//(or a similar tool) to explore our Fleet APIs. + +//For more information, refer to the +//https://github.com/elastic/kibana/blob/{branch}/x-pack/plugins/fleet/common/openapi/README.md[{fleet} OpenAPI file] +//in the {kib} repository. In this section, we provide examples of some commonly used {fleet} APIs. diff --git a/docs/en/ingest-management/index.asciidoc b/docs/en/ingest-management/index.asciidoc index 807173857c..07d2f18c4f 100644 --- a/docs/en/ingest-management/index.asciidoc +++ b/docs/en/ingest-management/index.asciidoc @@ -179,4 +179,6 @@ include::release-notes/release-notes-8.6.asciidoc[leveloffset=+1] include::elastic-agent/install-fleet-managed-agent.asciidoc[leveloffset=+2] +include::fleet/apis.asciidoc[] + include::redirects.asciidoc[] From 68b76f1330bec49ad96f7cb7e4b51ef0fc884f62 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Sat, 25 Feb 2023 11:50:56 -0500 Subject: [PATCH 02/11] Update to readme and paths to generate into Fleet repo --- .../fleet/api-generated/README.md | 30 +++- .../{ => rules}/fleet-apis-passthru.asciidoc | 0 .../{ => rules}/fleet-apis.asciidoc | 0 .../api-generated/template/index.mustache | 170 ++++++++++++++++++ docs/en/ingest-management/fleet/apis.asciidoc | 2 +- 5 files changed, 200 insertions(+), 2 deletions(-) rename docs/en/ingest-management/fleet/api-generated/{ => rules}/fleet-apis-passthru.asciidoc (100%) rename docs/en/ingest-management/fleet/api-generated/{ => rules}/fleet-apis.asciidoc (100%) create mode 100644 docs/en/ingest-management/fleet/api-generated/template/index.mustache diff --git a/docs/en/ingest-management/fleet/api-generated/README.md b/docs/en/ingest-management/fleet/api-generated/README.md index 6a15f35bf4..cd5edc5318 100644 --- a/docs/en/ingest-management/fleet/api-generated/README.md +++ b/docs/en/ingest-management/fleet/api-generated/README.md @@ -1,4 +1,32 @@ OpenAPI (Experimental) -This documentation is experimental and may be incomplete or change later. It has been generated from the [Fleet OpenAPI specification](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/elastic/kibana/{branch}/x-pack/plugins/fleet/common/openapi/bundled.json) in the Kibana repository, using the process described in the Generated APIs [readme file](https://github.com/elastic/kibana/tree/main/docs/api-generated). +The process described here is a Fleet-specific instance of the process described for adding Kibana APIs in general. Refer to the OpenAPI [readme file](https://github.com/elastic/kibana/tree/main/docs/api-generated) for details. + +Open API specifications (OAS) exist in JSON for the Fleet in Kibana, though they are experimental and may be incomplete or change later. + +A preview of the API specifications can be added to the Fleet Guide by using the following process: + +. Install [OpenAPI Generator](https://openapi-generator.tech/docs/installation), +or a similar tool that can generate HTML output from OAS. + +. Optionally validate the specifications by using the commands listed in the appropriate readmes. + +. Generate HTML output. For example: + + ``` + openapi-generator generate -g html -i $GIT_HOME/kibana/x-pack/plugins/fleet/common/openapi/bundled.json -o $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/rules $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/template + ``` + +. Rename the output files. For example: + ``` + mv $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/rules/index.html $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc + ``` + +. If you're creating a new set of API output, you will need to have a page that incorporates the output by using passthrough blocks. For more information, refer to [Asciidoctor docs](https://docs.asciidoctor.org/asciidoc/latest/pass/pass-block/) + +. Verify the output by building the Kibana documentation. At this time, the output is added as a technical preview in the appendix. + +## Known issues + +- Some OAS 3.0 features such as `anyOf`, `oneOf`, and `allOf` might not display properly in the preview. These are on the [Short-term roadmap](https://openapi-generator.tech/docs/roadmap/) at this time. diff --git a/docs/en/ingest-management/fleet/api-generated/fleet-apis-passthru.asciidoc b/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc similarity index 100% rename from docs/en/ingest-management/fleet/api-generated/fleet-apis-passthru.asciidoc rename to docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc diff --git a/docs/en/ingest-management/fleet/api-generated/fleet-apis.asciidoc b/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis.asciidoc similarity index 100% rename from docs/en/ingest-management/fleet/api-generated/fleet-apis.asciidoc rename to docs/en/ingest-management/fleet/api-generated/rules/fleet-apis.asciidoc diff --git a/docs/en/ingest-management/fleet/api-generated/template/index.mustache b/docs/en/ingest-management/fleet/api-generated/template/index.mustache new file mode 100644 index 0000000000..8c1162f909 --- /dev/null +++ b/docs/en/ingest-management/fleet/api-generated/template/index.mustache @@ -0,0 +1,170 @@ +//// +This content is generated from the open API specification. +Any modifications made to this file will be overwritten. +//// + +++++ +
+

Access

+ {{#hasAuthMethods}} +
    + {{#authMethods}} +
  1. {{#isBasic}}HTTP Basic Authentication{{/isBasic}}{{#isOAuth}}OAuth AuthorizationUrl:{{authorizationUrl}}TokenUrl:{{tokenUrl}}{{/isOAuth}}{{#isApiKey}}APIKey KeyParamName:{{keyParamName}} KeyInQuery:{{isKeyInQuery}} KeyInHeader:{{isKeyInHeader}}{{/isApiKey}}
    2. + {{/authMethods}} +
+ {{/hasAuthMethods}} + +

Methods

+ [ Jump to Models ] + + {{! for the tables of content, I cheat and don't use CSS styles.... }} +

Table of Contents

+
{{access}}
+ {{#apiInfo}} + {{#apis}} + {{#operations}} +

{{baseName}}

+ + {{/operations}} + {{/apis}} + {{/apiInfo}} + + {{#apiInfo}} + {{#apis}} + {{#operations}} +

{{baseName}}

+ {{#operation}} +
+
+ Up + 
{{httpMethod}} {{path}}
+
{{summary}} ({{nickname}})
+ {{! notes is operation.description. So why rename it and make it super confusing???? }} +
{{notes}}
+ + {{#hasPathParams}} +

Path parameters

+
+ {{#pathParams}}{{>pathParam}}{{/pathParams}} +
+ {{/hasPathParams}} + + {{#hasConsumes}} +

Consumes

+ This API call consumes the following media types via the Content-Type request header: +
    + {{#consumes}} +
  • {{{mediaType}}}
    • + {{/consumes}} +
+ {{/hasConsumes}} + + {{#hasBodyParam}} +

Request body

+
+ {{#bodyParams}}{{>bodyParam}}{{/bodyParams}} +
+ {{/hasBodyParam}} + + {{#hasHeaderParams}} +

Request headers

+
+ {{#headerParams}}{{>headerParam}}{{/headerParams}} +
+ {{/hasHeaderParams}} + + {{#hasQueryParams}} +

Query parameters

+
+ {{#queryParams}}{{>queryParam}}{{/queryParams}} +
+ {{/hasQueryParams}} + + {{#hasFormParams}} +

Form parameters

+
+ {{#formParams}}{{>formParam}}{{/formParams}} +
+ {{/hasFormParams}} + + {{#returnType}} +

Return type

+
+ {{#hasReference}}{{^returnSimpleType}}{{returnContainer}}[{{/returnSimpleType}}{{returnBaseType}}{{^returnSimpleType}}]{{/returnSimpleType}}{{/hasReference}} + {{^hasReference}}{{returnType}}{{/hasReference}} +
+ {{/returnType}} + + + + {{#hasExamples}} + {{#examples}} +

Example data

+
Content-Type: {{{contentType}}}
+ 
{{{example}}}
+ {{/examples}} + {{/hasExamples}} + + {{#hasProduces}} +

Produces

+ This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
    + {{#produces}} +
  • {{{mediaType}}}
    • + {{/produces}} +
+ {{/hasProduces}} + +

Responses

+ {{#responses}} +

{{code}}

+ {{message}} + {{^containerType}}{{dataType}}{{/containerType}} + {{#examples}} +

Example data

+
Content-Type: {{{contentType}}}
+ 
{{example}}
+ {{/examples}} + {{/responses}} +
+
+ {{/operation}} + {{/operations}} + {{/apis}} + {{/apiInfo}} + +

Models

+ [ Jump to Methods ] + +

Table of Contents

+
    + {{#models}} + {{#model}} +
  1. {{name}}{{#title}} - {{.}}{{/title}}
    2. + {{/model}} + {{/models}} +
+ + {{#models}} + {{#model}} +
+

{{name}}{{#title}} - {{.}}{{/title}} Up

+ {{#unescapedDescription}}
{{.}}
{{/unescapedDescription}} +
+ {{#vars}}
{{name}} {{^required}}(optional){{/required}}
{{^isPrimitiveType}}{{dataType}}{{/isPrimitiveType}} {{unescapedDescription}} {{#dataFormat}}format: {{{.}}}{{/dataFormat}}
+ {{#isEnum}} +
Enum:
+ {{#_enum}}
{{this}}
{{/_enum}} + {{/isEnum}} + {{/vars}} +
+
+ {{/model}} + {{/models}} +
+++++ diff --git a/docs/en/ingest-management/fleet/apis.asciidoc b/docs/en/ingest-management/fleet/apis.asciidoc index e24e7f38f1..123973c52d 100644 --- a/docs/en/ingest-management/fleet/apis.asciidoc +++ b/docs/en/ingest-management/fleet/apis.asciidoc @@ -11,4 +11,4 @@ version of the specification is 3.0. For more information, go to https://openapi -- -include::api-generated/fleet-apis.asciidoc[] \ No newline at end of file +include::api-generated/rules/fleet-apis.asciidoc[] \ No newline at end of file From b61312c2e1b8b8d6e82fbd48e8c484fbd957ed81 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Sat, 25 Feb 2023 12:01:31 -0500 Subject: [PATCH 03/11] Fix gen command; add ingored generator files --- .../fleet/api-generated/README.md | 2 +- .../rules/.openapi-generator-ignore | 23 +++++++++++++++++++ .../rules/.openapi-generator/FILES | 2 ++ .../rules/.openapi-generator/VERSION | 1 + 4 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator-ignore create mode 100644 docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES create mode 100644 docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/VERSION diff --git a/docs/en/ingest-management/fleet/api-generated/README.md b/docs/en/ingest-management/fleet/api-generated/README.md index cd5edc5318..0112a1bd5d 100644 --- a/docs/en/ingest-management/fleet/api-generated/README.md +++ b/docs/en/ingest-management/fleet/api-generated/README.md @@ -14,7 +14,7 @@ or a similar tool that can generate HTML output from OAS. . Generate HTML output. For example: ``` - openapi-generator generate -g html -i $GIT_HOME/kibana/x-pack/plugins/fleet/common/openapi/bundled.json -o $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/rules $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/template + openapi-generator generate -g html -i $GIT_HOME/kibana/x-pack/plugins/fleet/common/openapi/bundled.json -o $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/rules -t $GIT_HOME/observability-docs/docs/en/ingest-management/fleet/api-generated/template ``` . Rename the output files. For example: diff --git a/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator-ignore b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator-ignore new file mode 100644 index 0000000000..7484ee590a --- /dev/null +++ b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES new file mode 100644 index 0000000000..af3fdae9a0 --- /dev/null +++ b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES @@ -0,0 +1,2 @@ +.openapi-generator-ignore +index.html diff --git a/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/VERSION b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/VERSION new file mode 100644 index 0000000000..c0be8a7992 --- /dev/null +++ b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/VERSION @@ -0,0 +1 @@ +6.4.0 \ No newline at end of file From 497028b15dc198ea1444eedc8c87e67b46d9c7fe Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Sat, 25 Feb 2023 12:03:54 -0500 Subject: [PATCH 04/11] Update readme --- docs/en/ingest-management/fleet/api-generated/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/fleet/api-generated/README.md b/docs/en/ingest-management/fleet/api-generated/README.md index 0112a1bd5d..82d79bd72e 100644 --- a/docs/en/ingest-management/fleet/api-generated/README.md +++ b/docs/en/ingest-management/fleet/api-generated/README.md @@ -1,6 +1,6 @@ OpenAPI (Experimental) -The process described here is a Fleet-specific instance of the process described for adding Kibana APIs in general. Refer to the OpenAPI [readme file](https://github.com/elastic/kibana/tree/main/docs/api-generated) for details. +The process described here is a Fleet-specific instance of the process described for generating Kibana OpenAPI documentation in general. Refer to the Kibana OpenAPI [readme file](https://github.com/elastic/kibana/tree/main/docs/api-generated) for details. Open API specifications (OAS) exist in JSON for the Fleet in Kibana, though they are experimental and may be incomplete or change later. From f1300c6b63d4847bbe354095d9409e60bfc11a88 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Sat, 25 Feb 2023 12:05:52 -0500 Subject: [PATCH 05/11] Update readme --- docs/en/ingest-management/fleet/api-generated/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/ingest-management/fleet/api-generated/README.md b/docs/en/ingest-management/fleet/api-generated/README.md index 82d79bd72e..98d4078705 100644 --- a/docs/en/ingest-management/fleet/api-generated/README.md +++ b/docs/en/ingest-management/fleet/api-generated/README.md @@ -2,9 +2,9 @@ The process described here is a Fleet-specific instance of the process described for generating Kibana OpenAPI documentation in general. Refer to the Kibana OpenAPI [readme file](https://github.com/elastic/kibana/tree/main/docs/api-generated) for details. -Open API specifications (OAS) exist in JSON for the Fleet in Kibana, though they are experimental and may be incomplete or change later. +Open API specifications (OAS) exist in JSON for the Fleet, though they are experimental and may be incomplete or change later. -A preview of the API specifications can be added to the Fleet Guide by using the following process: +A preview of the API specifications can be added to the Fleet and Elastic Agent Guide by using the following process: . Install [OpenAPI Generator](https://openapi-generator.tech/docs/installation), or a similar tool that can generate HTML output from OAS. From 729bf23231f27bba40fd1c038b071d0cd6075db6 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Sat, 25 Feb 2023 12:06:52 -0500 Subject: [PATCH 06/11] Update readme --- docs/en/ingest-management/fleet/api-generated/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/fleet/api-generated/README.md b/docs/en/ingest-management/fleet/api-generated/README.md index 98d4078705..fe2a2877b8 100644 --- a/docs/en/ingest-management/fleet/api-generated/README.md +++ b/docs/en/ingest-management/fleet/api-generated/README.md @@ -2,7 +2,7 @@ The process described here is a Fleet-specific instance of the process described for generating Kibana OpenAPI documentation in general. Refer to the Kibana OpenAPI [readme file](https://github.com/elastic/kibana/tree/main/docs/api-generated) for details. -Open API specifications (OAS) exist in JSON for the Fleet, though they are experimental and may be incomplete or change later. +Open API specifications (OAS) exist in JSON for Fleet, though they are experimental and may be incomplete or change later. A preview of the API specifications can be added to the Fleet and Elastic Agent Guide by using the following process: From 8b2334aff70108fa9fce3502223bb5d567607451 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Mon, 27 Feb 2023 09:37:38 -0500 Subject: [PATCH 07/11] Update readme --- docs/en/ingest-management/fleet/api-generated/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/ingest-management/fleet/api-generated/README.md b/docs/en/ingest-management/fleet/api-generated/README.md index fe2a2877b8..eac187b6bd 100644 --- a/docs/en/ingest-management/fleet/api-generated/README.md +++ b/docs/en/ingest-management/fleet/api-generated/README.md @@ -6,6 +6,8 @@ Open API specifications (OAS) exist in JSON for Fleet, though they are experimen A preview of the API specifications can be added to the Fleet and Elastic Agent Guide by using the following process: +. Create a local clone of the [elastic/kibana](https://github.com/elastic/kibana) and [elastic/observability-docs](https://github.com/elastic/observability-docs) repositories in your `$GIT_PATH` directory. + . Install [OpenAPI Generator](https://openapi-generator.tech/docs/installation), or a similar tool that can generate HTML output from OAS. From 9d8bac492670fc7b0a24b8ef5e5e2788aabfaf37 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Mon, 27 Feb 2023 10:15:47 -0500 Subject: [PATCH 08/11] Update APIs description page --- docs/en/ingest-management/fleet/fleet-api-docs.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc b/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc index ecc28eafa9..752fc69e49 100644 --- a/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc +++ b/docs/en/ingest-management/fleet/fleet-api-docs.asciidoc @@ -7,9 +7,9 @@ You can find details for all available {fleet} API endpoints in our generated <>. This documentation is experimental and may be incomplete or change later. -We also provide a +The main source of truth for the {fleet} API can be found in the https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/openapi/bundled.json[self-contained spec file] -that you can use to generate docs using Swagger or a similar tool. +that you can use to generate docs using Swagger or a similar tool. For more information, refer to the https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/openapi/README.md[{fleet} OpenAPI readme]. From 962ed2dd8867ca84982bb84f034ca76e434848b3 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Mon, 27 Feb 2023 16:06:57 -0500 Subject: [PATCH 09/11] Fix up mustache file and regenerate --- .../fleet/api-generated/rules/.openapi-generator/FILES | 1 - .../fleet/api-generated/rules/fleet-apis-passthru.asciidoc | 5 ++++- .../fleet/api-generated/template/index.mustache | 5 ++++- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES index af3fdae9a0..dcaf71693e 100644 --- a/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES +++ b/docs/en/ingest-management/fleet/api-generated/rules/.openapi-generator/FILES @@ -1,2 +1 @@ -.openapi-generator-ignore index.html diff --git a/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc b/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc index 388e432132..e9d4e001b7 100644 --- a/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc +++ b/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc @@ -5,19 +5,22 @@ Any modifications made to this file will be overwritten. ++++
+ +

Methods

[ Jump to Models ]

Table of Contents

-

Default

+
-
+
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: -
    -
  • application/json
    • -
+ 
get /agent_policies/{agentPolicyId}
+
Get agent policy by ID (agentPolicyInfo)
+
Get one agent policy
-

Request body

+

Path parameters

-
bulk_request_diagnostics_request bulk_request_diagnostics_request (optional)
- -
Body Parameter —
+
agentPolicyId (required)
+
Path Parameter — default: null
-

Request headers

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

Return type

- bulk_upgrade_agents_200_response + agent_policy_info_200_response
@@ -981,7 +908,31 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -994,21 +945,129 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - bulk_upgrade_agents_200_response + agent_policy_info_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/bulk_unenroll
-
Agents - Bulk unenroll (bulkUnenrollAgents)
+ 
get /agent_policies
+
List agent policies (agentPolicyList)
-

Consumes

+ + + +

Query parameters

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

Return type

+
+ agent_policy_list_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + agent_policy_list_200_response +

400

+ Generic Error + fleet_server_health_check_400_response +
+
+
+
+ Up + 
post /agent_policies/_bulk_get
+
Bulk get agent policies (bulkGetAgentPolicies)
+
+ + +

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
    • @@ -1016,25 +1075,18 @@ Any modifications made to this file will be overwritten.

    Request body

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

    Request headers

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

    Return type

    - bulk_upgrade_agents_200_response + bulk_get_agent_policies_200_response
    @@ -1043,7 +1095,55 @@ Any modifications made to this file will be overwritten.

    Example data

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

    Produces

    @@ -1056,17 +1156,17 @@ Any modifications made to this file will be overwritten.

    Responses

    200

    OK - bulk_upgrade_agents_200_response + bulk_get_agent_policies_200_response

    400

    Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/bulk_update_agent_tags
-
Agents - Bulk update tags (bulkUpdateAgentTags)
+ 
post /agent_policies
+
Create agent policy (createAgentPolicy)
@@ -1078,7 +1178,7 @@ Any modifications made to this file will be overwritten.

Request body

-
bulk_update_agent_tags_request bulk_update_agent_tags_request (optional)
+
agent_policy_create_request agent_policy_create_request (optional)
Body Parameter —
@@ -1096,7 +1196,7 @@ Any modifications made to this file will be overwritten.

Return type

- bulk_upgrade_agents_200_response + create_agent_policy_200_response
@@ -1105,7 +1205,31 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1118,17 +1242,17 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - bulk_upgrade_agents_200_response + create_agent_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/bulk_upgrade
-
Agents - Bulk Upgrade (bulkUpgradeAgents)
+ 
post /agent_policies/delete
+
Delete agent policy by ID (deleteAgentPolicy)
@@ -1140,7 +1264,7 @@ Any modifications made to this file will be overwritten.

Request body

-
bulk_upgrade_agents bulk_upgrade_agents (required)
+
delete_agent_policy_request delete_agent_policy_request (optional)
Body Parameter —
@@ -1158,7 +1282,7 @@ Any modifications made to this file will be overwritten.

Return type

- bulk_upgrade_agents_200_response + delete_agent_policy_200_response
@@ -1167,7 +1291,8 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1180,19 +1305,25 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - bulk_upgrade_agents_200_response + delete_agent_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agent_policies
-
Agent policy - Create (createAgentPolicy)
+ 
put /agent_policies/{agentPolicyId}
+
Update agent policy by ID (updateAgentPolicy)
+

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -1202,7 +1333,7 @@ Any modifications made to this file will be overwritten.

Request body

-
agent_policy_create_request agent_policy_create_request (optional)
+
agent_policy_update_request agent_policy_update_request (optional)
Body Parameter —
@@ -1220,7 +1351,7 @@ Any modifications made to this file will be overwritten.

Return type

- create_agent_policy_200_response + agent_policy_info_200_response
@@ -1266,35 +1397,35 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - create_agent_policy_200_response + agent_policy_info_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

AgentStatus

+
Up - 
post /enrollment_api_keys
-
Enrollment API Key - Create (createEnrollmentApiKeys)
+ 
get /agent_status/data
+
Get incoming agent data (getAgentData)
-

Request headers

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

Query parameters

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

Return type

- create_enrollment_api_keys_deprecated_200_response + get_agent_data_200_response
@@ -1303,16 +1434,15 @@ Any modifications made to this file will be overwritten.

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"
+  "items" : [ {
+    "key" : {
+      "data" : true
+    }
+  }, {
+    "key" : {
+      "data" : true
+    }
+  } ]
 }

Produces

@@ -1325,35 +1455,36 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - create_enrollment_api_keys_deprecated_200_response + get_agent_data_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /enrollment-api-keys
-
Enrollment API Key - Create (createEnrollmentApiKeysDeprecated)
+ 
get /agent_status
+
Get agent status summary (getAgentStatus)
-

Request headers

+ +

Query parameters

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

Return type

- create_enrollment_api_keys_deprecated_200_response + get_agent_status_200_response
@@ -1362,16 +1493,17 @@ Any modifications made to this file will be overwritten.

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"
+  "all" : 2,
+  "offline" : 5,
+  "other" : 7,
+  "total" : 9,
+  "inactive" : 1,
+  "updating" : 3,
+  "online" : 2,
+  "active" : 4,
+  "error" : 0,
+  "unenrolled" : 5,
+  "events" : 6
 }

Produces

@@ -1384,47 +1516,34 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - create_enrollment_api_keys_deprecated_200_response + get_agent_status_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /package_policies
-
Package policy - Create (createPackagePolicy)
+ 
get /agent-status
+
Get agent status summary (getAgentStatusDeprecated)
-

Consumes

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

Request body

-
-
package_policy_request package_policy_request (optional)
-
Body Parameter —
-
-

Request headers

+

Query parameters

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

Return type

- create_package_policy_200_response + get_agent_status_deprecated_200_response
@@ -1432,7 +1551,16 @@ Any modifications made to this file will be overwritten.

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; @@ -1444,28 +1572,48 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - create_package_policy_200_response + get_agent_status_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

Agents

+
Up - 
get /data_streams
-
Data streams - List (dataStreamsList)
+ 
post /agents/bulk_reassign
+
Bulk reassign agents (bulkReassignAgents)
+

Consumes

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

Request body

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

Request headers

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

Return type

- data_streams_list_200_response + bulk_upgrade_agents_200_response
@@ -1474,41 +1622,7 @@ Any modifications made to this file will be overwritten.

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"
-    } ]
-  } ]
+  "actionId" : "actionId"
 }

Produces

@@ -1521,27 +1635,33 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - data_streams_list_200_response + bulk_upgrade_agents_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /agents/{agentId}
-
Agent - Delete (deleteAgent)
+ 
post /agents/bulk_request_diagnostics
+
Bulk request diagnostics from agents (bulkRequestDiagnostics)
-

Path parameters

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

Consumes

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

Request body

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

Request headers

@@ -1555,7 +1675,7 @@ Any modifications made to this file will be overwritten.

Return type

- delete_agent_200_response + bulk_upgrade_agents_200_response
@@ -1564,7 +1684,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1577,17 +1697,17 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_agent_200_response + bulk_upgrade_agents_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agent_policies/delete
-
Agent policy - Delete (deleteAgentPolicy)
+ 
post /agents/bulk_unenroll
+
Bulk unenroll agents (bulkUnenrollAgents)
@@ -1599,7 +1719,7 @@ Any modifications made to this file will be overwritten.

Request body

-
delete_agent_policy_request delete_agent_policy_request (optional)
+
bulk_unenroll_agents_request bulk_unenroll_agents_request (optional)
Body Parameter —
@@ -1617,7 +1737,7 @@ Any modifications made to this file will be overwritten.

Return type

- delete_agent_policy_200_response + bulk_upgrade_agents_200_response
@@ -1626,8 +1746,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1640,27 +1759,33 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_agent_policy_200_response + bulk_upgrade_agents_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /agent_download_sources/{sourceId}
-
Agent Download Sources - Delete (deleteDownloadSource)
+ 
post /agents/bulk_update_agent_tags
+
Bulk update agent tags (bulkUpdateAgentTags)
-

Path parameters

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

Consumes

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

Request body

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

Request headers

@@ -1674,7 +1799,7 @@ Any modifications made to this file will be overwritten.

Return type

- delete_package_policy_200_response + bulk_upgrade_agents_200_response
@@ -1683,7 +1808,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1696,27 +1821,33 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_package_policy_200_response + bulk_upgrade_agents_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /enrollment_api_keys/{keyId}
-
Enrollment API Key - Delete (deleteEnrollmentApiKey)
+ 
post /agents/bulk_upgrade
+
Bulk upgrade agents (bulkUpgradeAgents)
-

Path parameters

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

Consumes

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

Request body

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

Request headers

@@ -1730,7 +1861,7 @@ Any modifications made to this file will be overwritten.

Return type

- delete_agent_200_response + bulk_upgrade_agents_200_response
@@ -1739,7 +1870,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1752,22 +1883,22 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_agent_200_response + bulk_upgrade_agents_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /enrollment-api-keys/{keyId}
-
Enrollment API Key - Delete (deleteEnrollmentApiKeyDeprecated)
+ 
delete /agents/{agentId}
+
Delete agent by ID (deleteAgent)

Path parameters

-
keyId (required)
+
agentId (required)
Path Parameter — default: null
@@ -1811,38 +1942,37 @@ Any modifications made to this file will be overwritten. delete_agent_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /proxies/{itemId}
-
Fleet Proxies - Delete (deleteFleetProxies)
+ 
get /agents/{agentId}
+
Get agent by ID (getAgent)

Path parameters

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

Request headers

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

Query parameters

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

Return type

- delete_package_policy_200_response + get_agent_200_response
@@ -1851,7 +1981,53 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1864,41 +2040,28 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_package_policy_200_response + get_agent_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /fleet_server_hosts/{itemId}
-
Fleet Server Hosts - Delete (deleteFleetServerHosts)
+ 
get /agents/tags
+
List agent tags (getAgentTags)
-

Path parameters

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

Request headers

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

Return type

- delete_package_policy_200_response + get_agent_tags_response
@@ -1907,7 +2070,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1920,41 +2083,36 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_package_policy_200_response + get_agent_tags_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /outputs/{outputId}
-
Output - Delete (deleteOutput)
+ 
get /agents/files@{fileId}@{fileName}
+
Get file uploaded by agent (getAgentUploadFile)

Path parameters

-
outputId (required)
+
fileId (required)
+ +
Path Parameter — default: null
fileName (required)
Path Parameter — default: null
-

Request headers

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

Return type

- delete_package_policy_200_response + get_agent_upload_file_200_response
@@ -1963,7 +2121,12 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -1976,137 +2139,50 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_package_policy_200_response + get_agent_upload_file_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
delete /epm/packages/{pkgName}/{pkgVersion}
-
Packages - Delete (deletePackage)
+ 
get /agents
+
List agents (getAgents)
-

Path parameters

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

Consumes

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

Request body

-
-
install_package_deprecated_request install_package_deprecated_request (optional)
- -
Body Parameter —
- -
-

Request headers

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

Query parameters

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

Return type

-
- update_package_200_response - -
- - - -

Example data

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

Produces

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

Responses

-

200

- OK - update_package_200_response -

400

- Generic Error - setup_400_response -
-
-
-
- Up - 
delete /epm/packages/{pkgkey}
-
Packages - Delete (deletePackageDeprecated)
-
+
perPage (optional)
-

Path parameters

-
-
pkgkey (required)
+
Query Parameter — The number of items to return default: 20
page (optional)
-
Path Parameter — default: null
-
+
Query Parameter — default: 1
kuery (optional)
-

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
+
Query Parameter — default: null
showInactive (optional)
-

Request body

-
-
install_package_deprecated_request install_package_deprecated_request (optional)
+
Query Parameter — default: null
showUpgradeable (optional)
-
Body Parameter —
+
Query Parameter — default: null
sortField (optional)
-
+
Query Parameter — default: null
sortOrder (optional)
-

Request headers

-
-
kbn-xsrf (required)
+
Query Parameter — default: null
withMetrics (optional)
-
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
+
Query Parameter — Return agent metrics, false by default default: null
getStatusSummary (optional)
+
Query Parameter — default: null
-

Return type

- install_package_deprecated_200_response + get_agents_response
@@ -2115,57 +2191,292 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

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

Responses

-

200

- OK - install_package_deprecated_200_response -

400

- Generic Error - setup_400_response -
-
-
-
- Up - 
delete /package_policies/{packagePolicyId}
-
Package policy - Delete (deletePackagePolicy)
-
- -

Path parameters

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

Produces

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

Responses

+

200

+ OK + get_agents_response +

400

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

Query parameters

+ + + +

Return type

+
+ fleet_status_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_status_response +

400

+ Generic Error + fleet_server_health_check_400_response +
+
+
+
+ Up + 
get /agents/{agentId}/uploads
+
List agent uploads (listAgentUploads)
+
+ +

Path parameters

-
force (optional)
+
agentId (required)
-
Query Parameter — default: null
+
Path Parameter — default: null
+ + + +

Return type

- delete_package_policy_200_response + list_agent_uploads_200_response
@@ -2174,7 +2485,23 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -2187,19 +2514,25 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - delete_package_policy_200_response + list_agent_uploads_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /health_check
-
Fleet Server Health Check (fleetServerHealthCheck)
+ 
post /agents/{agentId}/reassign
+
Reassign agent (reassignAgent)
+

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -2209,7 +2542,7 @@ Any modifications made to this file will be overwritten.

Request body

-
fleet_server_health_check_request fleet_server_health_check_request (required)
+
reassign_agent_deprecated_request reassign_agent_deprecated_request (required)
Body Parameter —
@@ -2227,19 +2560,12 @@ Any modifications made to this file will be overwritten.

Return type

- fleet_server_health_check_200_response + Object
-

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -2251,19 +2577,88 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - fleet_server_health_check_200_response + Object

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /logstash_api_keys
-
Generate Logstash API key (generateLogstashApiKey)
+ 
put /agents/{agentId}/reassign
+
Reassign agent (reassignAgentDeprecated)
+
+ +

Path parameters

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

Consumes

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

Request body

+
+
reassign_agent_deprecated_request reassign_agent_deprecated_request (required)
+ +
Body Parameter —
+ +
+ +

Request headers

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

Return type

+
+ + Object +
+ + + + +

Produces

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

Responses

+

200

+ OK + Object +

400

+ Generic Error + fleet_server_health_check_400_response +
+
+
+
+ Up + 
post /agents/{agentId}/request_diagnostics
+
Request agent diagnostics (requestDiagnosticsAgent)
+

Path parameters

+
+
agentId (required)
+ +
Path Parameter — default: null
+
@@ -2279,7 +2674,7 @@ Any modifications made to this file will be overwritten.

Return type

- generate_logstash_api_key_200_response + bulk_upgrade_agents_200_response
@@ -2288,7 +2683,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -2301,21 +2696,33 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - generate_logstash_api_key_200_response + bulk_upgrade_agents_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /service_tokens
-
Generate service tokens (generateServiceToken)
+ 
post /agents/setup
+
Initiate agent setup (setupAgents)
+

Consumes

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

Request body

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

Request headers

@@ -2329,7 +2736,7 @@ Any modifications made to this file will be overwritten.

Return type

- generate_service_token_deprecated_200_response + fleet_setup_response
@@ -2338,8 +2745,14 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -2352,21 +2765,39 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - generate_service_token_deprecated_200_response + fleet_setup_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /service-tokens
-
Generate service tokens (generateServiceTokenDeprecated)
+ 
post /agents/{agentId}/unenroll
+
Unenroll agent (unenrollAgent)
+

Path parameters

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

Consumes

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

Request body

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

Request headers

@@ -2380,18 +2811,12 @@ Any modifications made to this file will be overwritten.

Return type

- generate_service_token_deprecated_200_response + Object
-

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; @@ -2403,17 +2828,17 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - generate_service_token_deprecated_200_response + Object

400

- Generic Error - setup_400_response + BAD REQUEST + unenroll_agent_400_response
-
+
Up - 
get /agents/{agentId}
-
Agent - Info (getAgent)
+ 
put /agents/{agentId}
+
Update agent by ID (updateAgent)

Path parameters

@@ -2423,17 +2848,30 @@ Any modifications made to this file will be overwritten.
Path Parameter — default: null
+

Consumes

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

Request body

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

Query parameters

+

Request headers

-
withMetrics (optional)
+
kbn-xsrf (required)
+ +
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
-
Query Parameter — Return agent metrics, false by default default: null
+

Return type

get_agent_200_response @@ -2507,90 +2945,50 @@ Any modifications made to this file will be overwritten. get_agent_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /agent_status/data
-
Agents - Get incoming data (getAgentData)
+ 
post /agents/{agentId}/upgrade
+
Upgrade agent (upgradeAgent)
- - - - -

Query parameters

+

Path parameters

-
agentsIds (required)
+
agentId (required)
-
Query Parameter — default: null
+
Path 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. +

Consumes

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

Responses

-

200

- OK - get_agent_data_200_response -

400

- Generic Error - setup_400_response -
-
-
-
- Up - 
get /agent_status
-
Agents - Summary stats (getAgentStatus)
-
- - +

Request body

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

Query parameters

+

Request headers

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

Return type

- get_agent_status_200_response + upgrade_agent
@@ -2599,17 +2997,9 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -2622,34 +3012,29 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_agent_status_200_response + upgrade_agent

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

DataStreams

+
Up - 
get /agent-status
-
Agents - Summary stats (getAgentStatusDeprecated)
+ 
get /data_streams
+
List data streams (dataStreamsList)
-

Query parameters

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

Return type

- get_agent_status_deprecated_200_response + data_streams_list_200_response
@@ -2658,14 +3043,41 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
{
-  "offline" : 5,
-  "other" : 2,
-  "total" : 7,
-  "inactive" : 1,
-  "updating" : 9,
-  "online" : 5,
-  "error" : 0,
-  "events" : 6
+  "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

@@ -2678,79 +3090,47 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_agent_status_deprecated_200_response + data_streams_list_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

ElasticPackageManagerEPM

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

Return type

-
- get_agent_tags_response - -
- - + 
post /epm/packages/_bulk
+
Bulk install packages (bulkInstallPackages)
+
-

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

Consumes

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

Responses

-

200

- OK - get_agent_tags_response -

400

- Generic Error - setup_400_response -
-
-
-
- Up - 
get /agents/files@{fileId}@{fileName}
-
Get agent upload file (getAgentUploadFile)
-
- -

Path parameters

+

Request body

-
fileId (required)
+
bulk_install_packages_request bulk_install_packages_request (optional)
-
Path Parameter — default: null
fileName (required)
+
Body Parameter —
-
Path Parameter — default: null
+

Query parameters

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

Return type

- get_agent_upload_file_200_response + bulk_install_packages_response
@@ -2759,12 +3139,20 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -2777,50 +3165,65 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_agent_upload_file_200_response + bulk_install_packages_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /agents
-
Agents - List (getAgents)
+ 
delete /epm/packages/{pkgName}/{pkgVersion}
+
Delete package (deletePackage)
+

Path parameters

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

Consumes

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

Query parameters

+

Request body

-
perPage (optional)
+
install_package_deprecated_request install_package_deprecated_request (optional)
-
Query Parameter — The number of items to return default: 20
page (optional)
+
Body Parameter —
-
Query Parameter — default: 1
kuery (optional)
+
-
Query Parameter — default: null
showInactive (optional)
+

Request headers

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

Query parameters

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

Return type

- get_agents_response + update_package_200_response
@@ -2829,205 +3232,10 @@ Any modifications made to this file will be overwritten.

Example data

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

Responses

200

OK - get_agents_response + update_package_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /agents/setup
-
Agents setup - Info (getAgentsSetupStatus)
+ 
delete /epm/packages/{pkgkey}
+
Delete ackage (deletePackageDeprecated)
+

Path parameters

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

Consumes

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

Request body

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

Request headers

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

Return type

- fleet_status_response + install_package_deprecated_200_response
@@ -3071,10 +3304,11 @@ Any modifications made to this file will be overwritten.

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" ]
+  "response" : [ {
+    "id" : "id"
+  }, {
+    "id" : "id"
+  } ]
 }

Produces

@@ -3087,28 +3321,46 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - fleet_status_response + install_package_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /agent_download_sources
-
Agent Download Sources (getDownloadSources)
+ 
get /epm/packages/{pkgName}/{pkgVersion}
+
Get package (getPackage)
+

Path parameters

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

Query parameters

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

Return type

- get_download_sources_200_response + get_package_200_response
@@ -3116,22 +3368,7 @@ Any modifications made to this file will be overwritten.

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
-  } ]
-}
+ 
null

Produces

This API call produces the following media types according to the Accept request header; @@ -3143,34 +3380,38 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_download_sources_200_response + get_package_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /enrollment_api_keys/{keyId}
-
Enrollment API Key - Info (getEnrollmentApiKey)
+ 
get /epm/categories
+
List package categories (getPackageCategories)
-

Path parameters

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

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_enrollment_api_key_deprecated_200_response + get_categories_response
@@ -3179,15 +3420,24 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
{
-  "item" : {
-    "policy_id" : "policy_id",
-    "api_key" : "api_key",
-    "name" : "name",
-    "active" : true,
-    "created_at" : "created_at",
+  "response" : [ {
+    "count" : 0.8008281904610115,
     "id" : "id",
-    "api_key_id" : "api_key_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

@@ -3200,22 +3450,22 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_enrollment_api_key_deprecated_200_response + get_categories_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /enrollment-api-keys/{keyId}
-
Enrollment API Key - Info (getEnrollmentApiKeyDeprecated)
+ 
get /epm/packages/{pkgkey}
+
Get package (getPackageDeprecated)

Path parameters

-
keyId (required)
+
pkgkey (required)
Path Parameter — default: null
@@ -3223,11 +3473,17 @@ Any modifications made to this file will be overwritten. +

Query parameters

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

Return type

- get_enrollment_api_key_deprecated_200_response + get_package_deprecated_200_response
@@ -3235,17 +3491,7 @@ Any modifications made to this file will be overwritten.

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"
-  }
-}
+ 
null

Produces

This API call produces the following media types according to the Accept request header; @@ -3257,19 +3503,25 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_enrollment_api_key_deprecated_200_response + get_package_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /enrollment_api_keys
-
Enrollment API Keys - List (getEnrollmentApiKeys)
+ 
get /epm/packages/{pkgName}/stats
+
Get package stats (getPackageStats)
+

Path parameters

+
+
pkgName (required)
+ +
Path Parameter — default: null
+
@@ -3278,7 +3530,7 @@ Any modifications made to this file will be overwritten.

Return type

- get_enrollment_api_keys_deprecated_200_response + get_package_stats_200_response
@@ -3287,43 +3539,9 @@ Any modifications made to this file will be overwritten.

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"
-  } ]
+  "response" : {
+    "agent_policy_count" : 0
+  }
 }

Produces

@@ -3336,28 +3554,65 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_enrollment_api_keys_deprecated_200_response + get_package_stats_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /enrollment-api-keys
-
Enrollment API Keys - List (getEnrollmentApiKeysDeprecated)
+ 
post /epm/packages/{pkgName}/{pkgVersion}
+
Install package (installPackage)
+

Path parameters

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

Consumes

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

Request body

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

Request headers

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

Query parameters

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

Return type

- get_enrollment_api_keys_deprecated_200_response + install_package_200_response
@@ -3366,42 +3621,13 @@ Any modifications made to this file will be overwritten.

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"
-  } ],
+  "_meta" : {
+    "install_source" : "registry"
+  },
   "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"
+    "id" : "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"
+    "id" : "id"
   } ]
 }
@@ -3415,28 +3641,48 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_enrollment_api_keys_deprecated_200_response + install_package_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /proxies
-
Fleet Proxies - List (getFleetProxies)
-
Return a list of Proxies
+ 
post /epm/packages
+
Install by package by direct upload (installPackageByUpload)
+
+ + +

Consumes

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

Request body

+
+
body file (optional)
+ +
Body Parameter —
+
+

Request headers

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

Return type

- get_fleet_proxies_200_response + install_package_by_upload_200_response
@@ -3445,25 +3691,13 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
{
-  "total" : 0,
-  "perPage" : 1,
-  "page" : 6,
+  "_meta" : {
+    "install_source" : "upload"
+  },
   "items" : [ {
-    "proxy_headers" : "{}",
-    "certificate_authorities" : "certificate_authorities",
-    "certificate_key" : "certificate_key",
-    "name" : "name",
-    "certificate" : "certificate",
-    "id" : "id",
-    "url" : "url"
+    "id" : "id"
   }, {
-    "proxy_headers" : "{}",
-    "certificate_authorities" : "certificate_authorities",
-    "certificate_key" : "certificate_key",
-    "name" : "name",
-    "certificate" : "certificate",
-    "id" : "id",
-    "url" : "url"
+    "id" : "id"
   } ]
 }
@@ -3477,28 +3711,53 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_fleet_proxies_200_response + install_package_by_upload_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /fleet_server_hosts
-
Fleet Server Hosts - List (getFleetServerHosts)
-
Return a list of Fleet server hosts
+ 
post /epm/packages/{pkgkey}
+
Install package (installPackageDeprecated)
+
+ +

Path parameters

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

Consumes

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

Request body

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

Request headers

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

Return type

- get_fleet_server_hosts_200_response + install_package_deprecated_200_response
@@ -3507,21 +3766,10 @@ Any modifications made to this file will be overwritten.

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
+  "response" : [ {
+    "id" : "id"
   }, {
-    "host_urls" : [ "host_urls", "host_urls" ],
-    "is_preconfigured" : true,
-    "name" : "name",
-    "id" : "id",
-    "is_default" : true
+    "id" : "id"
   } ]
 }
@@ -3535,17 +3783,17 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_fleet_server_hosts_200_response + install_package_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /kubernetes
-
Get K8s Full Agent Manifest (getFullK8sManifest)
+ 
get /epm/packages
+
List packages (listAllPackages)
@@ -3554,11 +3802,13 @@ Any modifications made to this file will be overwritten.

Query parameters

-
download (optional)
+
excludeInstallStatus (optional)
-
Query Parameter — default: null
fleetServer (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 — default: null
enrolToken (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
@@ -3566,7 +3816,7 @@ Any modifications made to this file will be overwritten.

Return type

- agent_policy_download_200_response + get_packages_response
@@ -3575,7 +3825,52 @@ Any modifications made to this file will be overwritten.

Example data

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

@@ -3588,25 +3883,19 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - agent_policy_download_200_response + get_packages_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /agent_download_sources/{sourceId}
-
Agent Download Sources - Info (getOneDownloadSource)
+ 
get /epm/packages/limited
+
Get limited package list (listLimitedPackages)
-

Path parameters

-
-
sourceId (required)
- -
Path Parameter — default: null
-
@@ -3615,7 +3904,7 @@ Any modifications made to this file will be overwritten.

Return type

- get_one_download_source_200_response + list_limited_packages_200_response
@@ -3624,12 +3913,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -3642,22 +3926,26 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_one_download_source_200_response + list_limited_packages_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /proxies/{itemId}
-
Fleet Proxies - Info (getOneFleetProxies)
+ 
get /epm/packages/{pkgName}/{pkgVersion}/{filePath}
+
Get package file (packagesGetFile)

Path parameters

-
itemId (required)
+
pkgName (required)
+ +
Path Parameter — default: null
pkgVersion (required)
+ +
Path Parameter — default: null
filePath (required)
Path Parameter — default: null
@@ -3669,24 +3957,18 @@ Any modifications made to this file will be overwritten.

Return type

- get_one_fleet_proxies_200_response + packages_get_file_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"
-  }
+    
Example data

+    
Content-Type: application/json

+    
{
+  "headers" : "{}",
+  "body" : "{}",
+  "statusCode" : 0.8008281904610115
 }

 
     
Produces

@@ -3699,25 +3981,19 @@ Any modifications made to this file will be overwritten.
     
Responses

     
200

     OK
-        get_one_fleet_proxies_200_response
+        packages_get_file_200_response
     
400

     Generic Error
-        setup_400_response
+        fleet_server_health_check_400_response
-
+
Up - 
get /fleet_server_hosts/{itemId}
-
Fleet Server Hosts - Info (getOneFleetServerHosts)
+ 
get /epm/verification_key_id
+
Get package signature verification key ID (packagesGetVerificationKeyId)
-

Path parameters

-
-
itemId (required)
- -
Path Parameter — default: null
-
@@ -3726,7 +4002,7 @@ Any modifications made to this file will be overwritten.

Return type

- get_one_fleet_server_hosts_200_response + packages_get_verification_key_id_200_response
@@ -3735,13 +4011,11 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -3754,34 +4028,58 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_one_fleet_server_hosts_200_response + packages_get_verification_key_id_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /outputs/{outputId}
-
Output - Info (getOutput)
+ 
put /epm/packages/{pkgName}/{pkgVersion}
+
Update package settings (updatePackage)

Path parameters

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

Consumes

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

Request body

+
+
update_package_request update_package_request (optional)
+ +
Body Parameter —
+ +
+ + +

Query parameters

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

Return type

- get_output_200_response + update_package_200_response
@@ -3790,33 +4088,11 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -3829,28 +4105,36 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_output_200_response + update_package_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

EnrollmentAPIKeys

+
Up - 
get /outputs
-
Outputs (getOutputs)
+ 
post /enrollment_api_keys
+
Create enrollment API key (createEnrollmentApiKeys)
+

Request headers

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

Return type

- get_outputs_200_response + create_enrollment_api_keys_deprecated_200_response
@@ -3859,62 +4143,16 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -3927,46 +4165,35 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_outputs_200_response + create_enrollment_api_keys_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /epm/packages/{pkgName}/{pkgVersion}
-
Packages - Info (getPackage)
+ 
post /enrollment-api-keys
+
Create enrollment API key (createEnrollmentApiKeysDeprecated)
-

Path parameters

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

Query parameters

+

Request headers

-
ignoreUnverified (optional)
- -
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
+
kbn-xsrf (required)
-
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
+
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
-
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
+

Return type

- get_package_200_response + create_enrollment_api_keys_deprecated_200_response
@@ -3974,7 +4201,18 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
- 
null
+ 
{
+  "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; @@ -3986,64 +4224,50 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_package_200_response + create_enrollment_api_keys_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /epm/categories
-
Package categories (getPackageCategories)
+ 
delete /enrollment_api_keys/{keyId}
+
Delete enrollment API key by ID (deleteEnrollmentApiKey)
+

Path parameters

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

Query parameters

+

Request headers

-
prerelease (optional)
- -
Query Parameter — Whether to include prerelease packages in categories count (e.g. beta, rc, preview) default: false
experimental (optional)
+
kbn-xsrf (required)
-
Query Parameter — default: false
include_policy_templates (optional)
+
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
-
Query Parameter — default: false
+

Return type

- get_categories_response + delete_agent_200_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"
-  } ]
+
+    
Example data

+    
Content-Type: application/json

+    
{
+  "action" : "deleted"
 }

 
     
Produces

@@ -4056,40 +4280,41 @@ Any modifications made to this file will be overwritten.
     
Responses

     
200

     OK
-        get_categories_response
+        delete_agent_200_response
     
400

     Generic Error
-        setup_400_response
+        fleet_server_health_check_400_response
-
+
Up - 
get /epm/packages/{pkgkey}
-
Packages - Info (getPackageDeprecated)
+ 
delete /enrollment-api-keys/{keyId}
+
Delete enrollment API key by ID (deleteEnrollmentApiKeyDeprecated)

Path parameters

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

Query parameters

+

Request headers

-
prerelease (optional)
+
kbn-xsrf (required)
+ +
Header Parameter — Kibana's anti Cross-Site Request Forgery token. Can be any string value. default: null
-
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
+

Return type

- get_package_deprecated_200_response + delete_agent_200_response
@@ -4097,7 +4322,9 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -4109,19 +4336,25 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_package_deprecated_200_response + delete_agent_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /package_policies
-
Package policies - List (getPackagePolicies)
+ 
get /enrollment_api_keys/{keyId}
+
Get enrollment API key by ID (getEnrollmentApiKey)
+

Path parameters

+
+
keyId (required)
+ +
Path Parameter — default: null
+
@@ -4130,7 +4363,7 @@ Any modifications made to this file will be overwritten.

Return type

- get_package_policies_200_response + get_enrollment_api_key_deprecated_200_response
@@ -4139,10 +4372,15 @@ Any modifications made to this file will be overwritten.

Example data

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

@@ -4155,22 +4393,22 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_package_policies_200_response + get_enrollment_api_key_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /package_policies/{packagePolicyId}
-
Package policy - Info (getPackagePolicy)
+ 
get /enrollment-api-keys/{keyId}
+
Get enrollment API key by ID (getEnrollmentApiKeyDeprecated)

Path parameters

-
packagePolicyId (required)
+
keyId (required)
Path Parameter — default: null
@@ -4182,7 +4420,7 @@ Any modifications made to this file will be overwritten.

Return type

- create_package_policy_200_response + get_enrollment_api_key_deprecated_200_response
@@ -4190,7 +4428,17 @@ Any modifications made to this file will be overwritten.

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; @@ -4202,25 +4450,19 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - create_package_policy_200_response + get_enrollment_api_key_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /epm/packages/{pkgName}/stats
-
Get stats for a package (getPackageStats)
+ 
get /enrollment_api_keys
+
List enrollment API keys (getEnrollmentApiKeys)
-

Path parameters

-
-
pkgName (required)
- -
Path Parameter — default: null
-
@@ -4229,7 +4471,7 @@ Any modifications made to this file will be overwritten.

Return type

- get_package_stats_200_response + get_enrollment_api_keys_deprecated_200_response
@@ -4238,9 +4480,43 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
{
-  "response" : {
-    "agent_policy_count" : 0
-  }
+  "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

@@ -4253,17 +4529,17 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_package_stats_200_response + get_enrollment_api_keys_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /settings
-
Settings (getSettings)
+ 
get /enrollment-api-keys
+
List enrollment API keys (getEnrollmentApiKeysDeprecated)
@@ -4274,7 +4550,7 @@ Any modifications made to this file will be overwritten.

Return type

- fleet_settings_response + get_enrollment_api_keys_deprecated_200_response
@@ -4283,12 +4559,43 @@ Any modifications made to this file will be overwritten.

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

@@ -4301,27 +4608,20 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - fleet_settings_response + get_enrollment_api_keys_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

FleetInternals

+
Up - 
post /epm/packages/{pkgName}/{pkgVersion}
-
Packages - Install (installPackage)
+ 
post /health_check
+
Fleet Server health check (fleetServerHealthCheck)
-

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: @@ -4331,7 +4631,7 @@ Any modifications made to this file will be overwritten.

Request body

-
install_package_request install_package_request (optional)
+
fleet_server_health_check_request fleet_server_health_check_request (required)
Body Parameter —
@@ -4345,21 +4645,56 @@ Any modifications made to this file will be overwritten.
-

Query parameters

-
-
ignoreUnverified (optional)
-
Query Parameter — Ignore if the package is fails signature verification default: null
full (optional)
-
Query Parameter — Return all fields from the package manifest, not just those supported by the Elastic Package Registry default: null
prerelease (optional)
+

Return type

+
+ fleet_server_health_check_200_response + +
+ + + +

Example data

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

Produces

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

Responses

+

200

+ OK + fleet_server_health_check_200_response +

400

+ Generic Error + fleet_server_health_check_400_response +
+
+
+
+ Up + 
get /settings
+
Get settings (getSettings)
+
+ + + + -
Query Parameter — Whether to return prerelease versions of packages (e.g. beta, rc, preview) default: false
-

Return type

- install_package_200_response + fleet_settings_response
@@ -4368,14 +4703,12 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -4388,34 +4721,21 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - install_package_200_response + fleet_settings_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /epm/packages
-
Packages - Install by upload (installPackageByUpload)
+ 
post /setup
+
Initiate Fleet setup (setup)
-

Consumes

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

Request body

-
-
body file (optional)
- -
Body Parameter —
-

Request headers

@@ -4429,7 +4749,7 @@ Any modifications made to this file will be overwritten.

Return type

- install_package_by_upload_200_response + fleet_setup_response
@@ -4438,13 +4758,13 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
{
-  "_meta" : {
-    "install_source" : "upload"
-  },
-  "items" : [ {
-    "id" : "id"
+  "isInitialized" : true,
+  "nonFatalErrors" : [ {
+    "name" : "name",
+    "message" : "message"
   }, {
-    "id" : "id"
+    "name" : "name",
+    "message" : "message"
   } ]
 }
@@ -4458,25 +4778,22 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - install_package_by_upload_200_response + fleet_setup_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response +

500

+ Internal Server Error + setup_500_response
-
+
Up - 
post /epm/packages/{pkgkey}
-
Packages - Install (installPackageDeprecated)
+ 
put /settings
+
Update settings (updateSettings)
-

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -4486,25 +4803,18 @@ Any modifications made to this file will be overwritten.

Request body

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

Request headers

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

Return type

- install_package_deprecated_200_response + fleet_settings_response
@@ -4513,11 +4823,12 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -4530,34 +4841,42 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - install_package_deprecated_200_response + fleet_settings_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

FleetServerHosts

+
Up - 
get /agents/{agentId}/uploads
-
List agent uploads (listAgentUploads)
+ 
delete /fleet_server_hosts/{itemId}
+
Delete Fleet Server host by ID (deleteFleetServerHosts)

Path parameters

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

Request headers

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

Return type

- list_agent_uploads_200_response + delete_package_policy_200_response
@@ -4566,23 +4885,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -4595,40 +4898,28 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - list_agent_uploads_200_response + delete_package_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /epm/packages
-
Packages - List (listAllPackages)
+ 
get /fleet_server_hosts
+
List Fleet Server hosts (getFleetServerHosts)
-

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 + get_fleet_server_hosts_200_response
@@ -4637,51 +4928,21 @@ Any modifications made to this file will be overwritten.

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"
-  } ],
+  "total" : 0,
+  "perPage" : 1,
+  "page" : 6,
   "items" : [ {
-    "savedObject" : "{}",
-    "path" : "path",
-    "download" : "download",
+    "host_urls" : [ "host_urls", "host_urls" ],
+    "is_preconfigured" : true,
     "name" : "name",
-    "description" : "description",
-    "icons" : "icons",
-    "title" : "title",
-    "type" : "type",
-    "version" : "version",
-    "status" : "status"
+    "id" : "id",
+    "is_default" : true
   }, {
-    "savedObject" : "{}",
-    "path" : "path",
-    "download" : "download",
+    "host_urls" : [ "host_urls", "host_urls" ],
+    "is_preconfigured" : true,
     "name" : "name",
-    "description" : "description",
-    "icons" : "icons",
-    "title" : "title",
-    "type" : "type",
-    "version" : "version",
-    "status" : "status"
+    "id" : "id",
+    "is_default" : true
   } ]
 }
@@ -4695,19 +4956,25 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_packages_response + get_fleet_server_hosts_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /epm/packages/limited
-
Packages - Get limited list (listLimitedPackages)
+ 
get /fleet_server_hosts/{itemId}
+
Get Fleet Server host by ID (getOneFleetServerHosts)
+

Path parameters

+
+
itemId (required)
+ +
Path Parameter — default: null
+
@@ -4716,7 +4983,7 @@ Any modifications made to this file will be overwritten.

Return type

- list_limited_packages_200_response + get_one_fleet_server_hosts_200_response
@@ -4725,7 +4992,13 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -4738,25 +5011,19 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - list_limited_packages_200_response + get_one_fleet_server_hosts_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/{agentId}/actions
-
Agent - Actions (newAgentAction)
+ 
post /fleet_server_hosts
+
Create Fleet Server host (postFleetServerHosts)
-

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -4766,25 +5033,18 @@ Any modifications made to this file will be overwritten.

Request body

-
new_agent_action_request new_agent_action_request (required)
+
post_fleet_server_hosts_request post_fleet_server_hosts_request (optional)
Body Parameter —
-

Request headers

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

Return type

- new_agent_action_200_response + post_fleet_server_hosts_200_response
@@ -4793,9 +5053,13 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -4808,38 +5072,53 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - new_agent_action_200_response + post_fleet_server_hosts_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
get /epm/packages/{pkgName}/{pkgVersion}/{filePath}
-
Packages - Get file from registry (packagesGetFile)
+ 
put /fleet_server_hosts/{itemId}
+
Update Fleet Server host by ID (updateFleetServerHosts)

Path parameters

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

Consumes

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

Request body

+
+
update_fleet_server_hosts_request update_fleet_server_hosts_request (optional)
+ +
Body Parameter —
-
Path Parameter — default: null
+

Request headers

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

Return type

- packages_get_file_200_response + get_one_fleet_server_hosts_200_response
@@ -4848,9 +5127,13 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -4863,47 +5146,39 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - packages_get_file_200_response + get_one_fleet_server_hosts_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

Kubernetes

+
Up - 
post /package_policies/delete
-
Package policy - Delete (postDeletePackagePolicy)
+ 
get /kubernetes
+
Get full K8s agent manifest (getFullK8sManifest)
-

Consumes

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

Request body

-
-
post_delete_package_policy_request post_delete_package_policy_request (optional)
-
Body Parameter —
-
-

Request headers

+

Query parameters

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

Return type

- array[post_delete_package_policy_200_response_inner] + agent_policy_download_200_response
@@ -4911,15 +5186,9 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -4931,40 +5200,42 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - + agent_policy_download_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

Outputs

+
Up - 
post /agent_download_sources
-
Agent Download Sources (postDownloadSources)
-
Create a new agent download source
+ 
delete /outputs/{outputId}
+
Delete output by ID (deleteOutput)
+
+

Path parameters

+
+
outputId (required)
-

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
    • -
+
Path Parameter — default: null
+
-

Request body

+ + +

Request headers

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

Return type

- post_download_sources_200_response + delete_package_policy_200_response
@@ -4973,12 +5244,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -4991,40 +5257,35 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - post_download_sources_200_response + delete_package_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /proxies
-
Fleet Proxies - Create (postFleetProxies)
-
Create a new Fleet Server Host
+ 
post /logstash_api_keys
+
Generate Logstash API key (generateLogstashApiKey)
+
-

Consumes

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

Request body

+ +

Request headers

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

Return type

- post_fleet_proxies_200_response + generate_logstash_api_key_200_response
@@ -5033,15 +5294,7 @@ Any modifications made to this file will be overwritten.

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"
-  }
+  "api_key" : "api_key"
 }

Produces

@@ -5054,40 +5307,34 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - post_fleet_proxies_200_response + generate_logstash_api_key_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_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: -
    -
  • application/json
    • -
+ 
get /outputs/{outputId}
+
Get output by ID (getOutput)
+
-

Request body

+

Path parameters

-
post_fleet_server_hosts_request post_fleet_server_hosts_request (optional)
- -
Body Parameter —
+
outputId (required)
+
Path Parameter — default: null
+ +

Return type

- post_fleet_server_hosts_200_response + get_output_200_response
@@ -5097,11 +5344,31 @@ Any modifications made to this file will be overwritten.
Content-Type: application/json
{
   "item" : {
-    "host_urls" : [ "host_urls", "host_urls" ],
-    "is_preconfigured" : true,
+    "shipper" : {
+      "disk_queue_max_size" : 0.8008281904610115,
+      "disk_queue_compression_enabled" : true,
+      "disk_queue_enabled" : true,
+      "disk_queue_path" : "disk_queue_path",
+      "disk_queue_encryption_enabled" : true,
+      "compression_level" : 6.027456183070403,
+      "loadbalance" : true
+    },
+    "hosts" : [ "hosts", "hosts" ],
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "proxy_id" : "proxy_id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "key"
+    },
+    "ca_sha256" : "ca_sha256",
     "name" : "name",
     "id" : "id",
-    "is_default" : true
+    "config" : "{}"
   }
 }
@@ -5115,40 +5382,28 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - post_fleet_server_hosts_200_response + get_output_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_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: -
    -
  • application/json
    • -
+ 
get /outputs
+
List outputs (getOutputs)
+
-

Request body

-
-
post_outputs_request post_outputs_request (optional)
-
Body Parameter —
-

Return type

- post_outputs_200_response + get_outputs_200_response
@@ -5157,7 +5412,10 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
{
-  "item" : {
+  "total" : 1,
+  "perPage" : 5,
+  "page" : 5,
+  "items" : [ {
     "shipper" : {
       "disk_queue_max_size" : 0.8008281904610115,
       "disk_queue_compression_enabled" : true,
@@ -5183,7 +5441,33 @@ Any modifications made to this file will be overwritten.
     "name" : "name",
     "id" : "id",
     "config" : "{}"
-  }
+  }, {
+    "shipper" : {
+      "disk_queue_max_size" : 0.8008281904610115,
+      "disk_queue_compression_enabled" : true,
+      "disk_queue_enabled" : true,
+      "disk_queue_path" : "disk_queue_path",
+      "disk_queue_encryption_enabled" : true,
+      "compression_level" : 6.027456183070403,
+      "loadbalance" : true
+    },
+    "hosts" : [ "hosts", "hosts" ],
+    "ca_trusted_fingerprint" : "ca_trusted_fingerprint",
+    "is_default_monitoring" : true,
+    "config_yaml" : "config_yaml",
+    "proxy_id" : "proxy_id",
+    "is_default" : true,
+    "type" : "elasticsearch",
+    "ssl" : {
+      "certificate_authorities" : [ "certificate_authorities", "certificate_authorities" ],
+      "certificate" : "certificate",
+      "key" : "key"
+    },
+    "ca_sha256" : "ca_sha256",
+    "name" : "name",
+    "id" : "id",
+    "config" : "{}"
+  } ]
 }

Produces

@@ -5196,25 +5480,19 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - post_outputs_200_response + get_outputs_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /agents/{agentId}/reassign
-
Agent - Reassign (reassignAgent)
+ 
post /outputs
+
Create output (postOutputs)
-

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -5224,30 +5502,54 @@ Any modifications made to this file will be overwritten.

Request body

-
reassign_agent_request reassign_agent_request (required)
+
post_outputs_request post_outputs_request (optional)
Body Parameter —
-

Request headers

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

Return type

+ post_outputs_200_response - Object
+

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -5259,27 +5561,39 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - Object + post_outputs_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/{agentId}/request_diagnostics
-
Agent - Request Diagnostics (requestDiagnosticsAgent)
+ 
put /outputs/{outputId}
+
Update output by ID (updateOutput)

Path parameters

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

Consumes

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

Request body

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

Request headers

@@ -5293,7 +5607,7 @@ Any modifications made to this file will be overwritten.

Return type

- bulk_upgrade_agents_200_response + get_output_200_response
@@ -5302,7 +5616,33 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -5315,35 +5655,41 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - bulk_upgrade_agents_200_response + get_output_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

PackagePolicies

+
Up - 
post /setup
-
Setup (setup)
+ 
post /package_policies/_bulk_get
+
Bulk get package policies (bulkGetPackagePolicies)
+

Consumes

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

Request headers

+

Request body

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

Return type

- fleet_setup_response + bulk_get_package_policies_200_response
@@ -5352,14 +5698,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -5372,20 +5711,17 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - fleet_setup_response + bulk_get_package_policies_200_response

400

Generic Error - setup_400_response -

500

- Internal Server Error - setup_500_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/setup
-
Agents setup - Create (setupAgents)
+ 
post /package_policies
+
Create package policy (createPackagePolicy)
@@ -5397,7 +5733,7 @@ Any modifications made to this file will be overwritten.

Request body

-
setup_agents_request setup_agents_request (optional)
+
package_policy_request package_policy_request (optional)
Body Parameter —
@@ -5415,7 +5751,7 @@ Any modifications made to this file will be overwritten.

Return type

- fleet_setup_response + create_package_policy_200_response
@@ -5423,16 +5759,7 @@ Any modifications made to this file will be overwritten.

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; @@ -5444,58 +5771,50 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - fleet_setup_response + create_package_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/{agentId}/unenroll
-
Agent - Unenroll (unenrollAgent)
+ 
delete /package_policies/{packagePolicyId}
+
Delete package policy by ID (deletePackagePolicy)

Path parameters

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

Consumes

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

Request body

-
-
unenroll_agent_request unenroll_agent_request (optional)
-
Body Parameter —
-
-

Request headers

+

Query parameters

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

Return type

+ delete_package_policy_200_response - Object
+

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -5507,108 +5826,40 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - Object + delete_package_policy_200_response

400

- BAD REQUEST - unenroll_agent_400_response + Generic Error + fleet_server_health_check_400_response
-
+
Up - 
put /agents/{agentId}
-
Agent - Update (updateAgent)
+ 
get /package_policies
+
List package policies (getPackagePolicies)
-

Path parameters

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

Consumes

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

Request body

-
-
update_agent_request update_agent_request (required)
- -
Body Parameter —
- -
-

Request headers

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

Return type

- get_agent_200_response + get_package_policies_200_response
- - -

Example data

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

+    
Content-Type: application/json

+    
{
+  "total" : 0.8008281904610115,
+  "perPage" : 1.4658129805029452,
+  "page" : 6.027456183070403,
+  "items" : [ null, null ]
 }

 
     
Produces

@@ -5621,53 +5872,34 @@ Any modifications made to this file will be overwritten.
     
Responses

     
200

     OK
-        get_agent_200_response
+        get_package_policies_200_response
     
400

     Generic Error
-        setup_400_response
+        fleet_server_health_check_400_response
-
+
Up - 
put /agent_policies/{agentPolicyId}
-
Agent policy - Update (updateAgentPolicy)
+ 
get /package_policies/{packagePolicyId}
+
Get package policy by ID (getPackagePolicy)

Path parameters

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

Consumes

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

Request body

-
-
agent_policy_update_request agent_policy_update_request (optional)
- -
Body Parameter —
- -
- -

Request headers

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

Return type

- agent_policy_info_200_response + create_package_policy_200_response
@@ -5675,33 +5907,7 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -5713,25 +5919,19 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - agent_policy_info_200_response + create_package_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /agent_download_sources/{sourceId}
-
Agent Download Sources - Update (updateDownloadSource)
+ 
post /package_policies/delete
+
Delete package policy (postDeletePackagePolicy)
-

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -5741,7 +5941,7 @@ Any modifications made to this file will be overwritten.

Request body

-
update_download_source_request update_download_source_request (optional)
+
post_delete_package_policy_request post_delete_package_policy_request (optional)
Body Parameter —
@@ -5759,7 +5959,7 @@ Any modifications made to this file will be overwritten.

Return type

- get_one_download_source_200_response + array[post_delete_package_policy_200_response_inner]
@@ -5767,14 +5967,15 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -5786,22 +5987,22 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_one_download_source_200_response +

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /proxies/{itemId}
-
Fleet Proxies - Update (updateFleetProxies)
+ 
put /package_policies/{packagePolicyId}
+
Update package policy by ID (updatePackagePolicy)

Path parameters

-
itemId (required)
+
packagePolicyId (required)
Path Parameter — default: null
@@ -5814,7 +6015,7 @@ Any modifications made to this file will be overwritten.

Request body

-
update_fleet_proxies_request update_fleet_proxies_request (optional)
+
package_policy_request package_policy_request (optional)
Body Parameter —
@@ -5832,7 +6033,7 @@ Any modifications made to this file will be overwritten.

Return type

- get_one_fleet_proxies_200_response + update_package_policy_200_response
@@ -5841,15 +6042,7 @@ Any modifications made to this file will be overwritten.

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"
-  }
+  "sucess" : true
 }

Produces

@@ -5862,25 +6055,19 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_one_fleet_proxies_200_response + update_package_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /fleet_server_hosts/{itemId}
-
Fleet Server Hosts - Update (updateFleetServerHosts)
+ 
post /package_policies/upgrade
+
Upgrade package policy to a newer package version (upgradePackagePolicy)
-

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -5890,25 +6077,18 @@ Any modifications made to this file will be overwritten.

Request body

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

Request headers

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

Return type

- get_one_fleet_server_hosts_200_response + array[post_delete_package_policy_200_response_inner]
@@ -5916,15 +6096,15 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -5936,25 +6116,19 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_one_fleet_server_hosts_200_response +

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /outputs/{outputId}
-
Output - Update (updateOutput)
+ 
post /package_policies/upgrade/dryrun
+
Dry run package policy upgrade (upgradePackagePolicyDryRun)
-

Path parameters

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

Consumes

This API call consumes the following media types via the Content-Type request header: @@ -5964,25 +6138,18 @@ Any modifications made to this file will be overwritten.

Request body

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

Request headers

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

Return type

- get_output_200_response + array[upgrade_package_policy_dry_run_200_response_inner]
@@ -5990,34 +6157,71 @@ Any modifications made to this file will be overwritten.

Example data

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

+
+    
Produces

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

+
+    
Responses

+    
200

+    OK
+        
+    
400

+    Generic Error
+        fleet_server_health_check_400_response
+
+
+

Proxies

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

Path parameters

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

Request headers

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

Return type

+
+ delete_package_policy_200_response + +
+ + + +

Example data

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

Produces

@@ -6030,58 +6234,28 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - get_output_200_response + delete_package_policy_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /epm/packages/{pkgName}/{pkgVersion}
-
Packages - Update (updatePackage)
+ 
get /proxies
+
List proxies (getFleetProxies)
-

Path parameters

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

Consumes

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

Request body

-
-
update_package_request update_package_request (optional)
- -
Body Parameter —
- -
- -

Query parameters

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

Return type

- update_package_200_response + get_fleet_proxies_200_response
@@ -6090,10 +6264,25 @@ Any modifications made to this file will be overwritten.

Example data

Content-Type: application/json
{
+  "total" : 0,
+  "perPage" : 1,
+  "page" : 6,
   "items" : [ {
-    "id" : "id"
+    "proxy_headers" : "{}",
+    "certificate_authorities" : "certificate_authorities",
+    "certificate_key" : "certificate_key",
+    "name" : "name",
+    "certificate" : "certificate",
+    "id" : "id",
+    "url" : "url"
   }, {
-    "id" : "id"
+    "proxy_headers" : "{}",
+    "certificate_authorities" : "certificate_authorities",
+    "certificate_key" : "certificate_key",
+    "name" : "name",
+    "certificate" : "certificate",
+    "id" : "id",
+    "url" : "url"
   } ]
 }
@@ -6107,53 +6296,34 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - update_package_200_response + get_fleet_proxies_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /package_policies/{packagePolicyId}
-
Package policy - Update (updatePackagePolicy)
+ 
get /proxies/{itemId}
+
Get proxy by ID (getOneFleetProxies)

Path parameters

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

Consumes

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

Request body

-
-
package_policy_request package_policy_request (optional)
- -
Body Parameter —
- -
- -

Request headers

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

Return type

- update_package_policy_200_response + get_one_fleet_proxies_200_response
@@ -6162,7 +6332,15 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -6175,17 +6353,17 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - update_package_policy_200_response + get_one_fleet_proxies_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
put /settings
-
Settings - Update (updateSettings)
+ 
post /proxies
+
Create proxy (postFleetProxies)
@@ -6197,7 +6375,7 @@ Any modifications made to this file will be overwritten.

Request body

-
update_settings_request update_settings_request (optional)
+
post_fleet_proxies_request post_fleet_proxies_request (optional)
Body Parameter —
@@ -6208,7 +6386,7 @@ Any modifications made to this file will be overwritten.

Return type

- fleet_settings_response + post_fleet_proxies_200_response
@@ -6218,10 +6396,13 @@ Any modifications made to this file will be overwritten.
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"
+    "proxy_headers" : "{}",
+    "certificate_authorities" : "certificate_authorities",
+    "certificate_key" : "certificate_key",
+    "name" : "name",
+    "certificate" : "certificate",
+    "id" : "id",
+    "url" : "url"
   }
 }
@@ -6235,22 +6416,22 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - fleet_settings_response + post_fleet_proxies_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /agents/{agentId}/upgrade
-
Agent - Upgrade (upgradeAgent)
+ 
put /proxies/{itemId}
+
Update proxy by ID (updateFleetProxies)

Path parameters

-
agentId (required)
+
itemId (required)
Path Parameter — default: null
@@ -6263,7 +6444,7 @@ Any modifications made to this file will be overwritten.

Request body

-
upgrade_agent upgrade_agent (required)
+
update_fleet_proxies_request update_fleet_proxies_request (optional)
Body Parameter —
@@ -6281,7 +6462,7 @@ Any modifications made to this file will be overwritten.

Return type

- upgrade_agent + get_one_fleet_proxies_200_response
@@ -6290,9 +6471,15 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

@@ -6305,40 +6492,36 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - upgrade_agent + get_one_fleet_proxies_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+

ServiceTokens

+
Up - 
post /package_policies/upgrade
-
Package policy - Upgrade (upgradePackagePolicy)
+ 
post /service_tokens
+
Create service token (generateServiceToken)
-

Consumes

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

Request body

+ +

Request headers

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

Return type

- array[post_delete_package_policy_200_response_inner] + generate_service_token_deprecated_200_response
@@ -6346,15 +6529,10 @@ Any modifications made to this file will be overwritten.

Example data

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

+  "value" : "value"
+}

Produces

This API call produces the following media types according to the Accept request header; @@ -6366,40 +6544,35 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - + generate_service_token_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
-
+
Up - 
post /package_policies/upgrade/dryrun
-
Package policy - Upgrade Dry run (upgradePackagePolicyDryRun)
+ 
post /service-tokens
+
Create service token (generateServiceTokenDeprecated)
-

Consumes

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

Request body

+ +

Request headers

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

Return type

- array[upgrade_package_policy_dry_run_200_response_inner] + generate_service_token_deprecated_200_response
@@ -6407,15 +6580,10 @@ Any modifications made to this file will be overwritten.

Example data

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

Produces

This API call produces the following media types according to the Accept request header; @@ -6427,10 +6595,10 @@ Any modifications made to this file will be overwritten.

Responses

200

OK - + generate_service_token_deprecated_200_response

400

Generic Error - setup_400_response + fleet_server_health_check_400_response
@@ -6499,6 +6667,7 @@ Any modifications made to this file will be overwritten.
  • elasticsearch_asset_type - Elasticsearch asset type
  • enrollment_api_key - Enrollment API key
  • fleet_server_health_check_200_response -
    • +
  • fleet_server_health_check_400_response -
  • fleet_server_health_check_request -
  • fleet_server_host - Fleet Server Host
  • fleet_settings_response - Fleet settings response
    • @@ -6594,6 +6763,8 @@ Any modifications made to this file will be overwritten.
  • package_policy_request_package -
  • package_usage_stats - Package usage stats
  • packages_get_file_200_response -
    • +
  • packages_get_verification_key_id_200_response -
    • +
  • packages_get_verification_key_id_200_response_body -
  • post_delete_package_policy_200_response_inner -
  • post_delete_package_policy_request -
  • post_download_sources_200_response -
    • @@ -6605,10 +6776,9 @@ Any modifications made to this file will be overwritten.
  • post_outputs_200_response -
  • post_outputs_request -
  • proxies - Fleet Proxy
    • -
  • reassign_agent_request -
    • +
  • reassign_agent_deprecated_request -
  • search_result - Search result
  • settings - Settings
    • -
  • setup_400_response -
  • setup_500_response -
  • setup_agents_request -
  • unenroll_agent_400_response -
    • @@ -7199,6 +7369,15 @@ Any modifications made to this file will be overwritten.
    host (optional)
    String
    +
    +

    fleet_server_health_check_400_response - Up

    +
    +
    +
    statusCode (optional)
    BigDecimal
    +
    error (optional)
    String
    +
    message (optional)
    String
    +
    +

    fleet_server_health_check_request - Up

    @@ -8104,6 +8283,22 @@ Any modifications made to this file will be overwritten.
    headers (optional)
    Object
    +
    +

    packages_get_verification_key_id_200_response - Up

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

    packages_get_verification_key_id_200_response_body - Up

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

    post_delete_package_policy_200_response_inner - Up

    @@ -8212,7 +8407,7 @@ Any modifications made to this file will be overwritten.
    -

    reassign_agent_request - Up

    +

    reassign_agent_deprecated_request - Up

    policy_id
    String
    @@ -8244,15 +8439,6 @@ Any modifications made to this file will be overwritten.
    prerelease_integrations_enabled (optional)
    Boolean
    -
    -

    setup_400_response - Up

    -
    -
    -
    statusCode (optional)
    BigDecimal
    -
    error (optional)
    String
    -
    message (optional)
    String
    -
    -

    setup_500_response - Up

    From 7afe76c480145d5e67fbb2dab8d76368add08198 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Tue, 28 Feb 2023 15:56:07 -0500 Subject: [PATCH 11/11] Update mustache file and output --- .../rules/fleet-apis-passthru.asciidoc | 30 +++++++++---------- .../api-generated/template/index.mustache | 2 +- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc b/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc index 6ac53c5b41..56ecf1c87c 100644 --- a/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc +++ b/docs/en/ingest-management/fleet/api-generated/rules/fleet-apis-passthru.asciidoc @@ -20,13 +20,13 @@ Any modifications made to this file will be overwritten.

    Table of Contents

    - +

    AgentActions

    - +

    AgentBinaryDownloadSources

    - +

    AgentPolicies

    - +

    AgentStatus

    - +

    Agents

    - +

    DataStreams

    - +

    ElasticPackageManagerEPM

    - +

    EnrollmentAPIKeys

    - +

    FleetInternals

    - +

    FleetServerHosts

    - +

    Kubernetes

    - +

    Outputs

    - +

    PackagePolicies

    - +

    Proxies

    - +

    ServiceTokens

    • post /service_tokens
    • post /service-tokens
      • diff --git a/docs/en/ingest-management/fleet/api-generated/template/index.mustache b/docs/en/ingest-management/fleet/api-generated/template/index.mustache index e6f8fc4bc8..2301341570 100644 --- a/docs/en/ingest-management/fleet/api-generated/template/index.mustache +++ b/docs/en/ingest-management/fleet/api-generated/template/index.mustache @@ -26,7 +26,7 @@ Any modifications made to this file will be overwritten. {{#apiInfo}} {{#apis}} {{#operations}} - +

      {{baseName}}