Fleet API

编辑

此功能处于技术预览阶段,可能会在未来的版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 约束。

方法

[ 跳转至 模型 ]

目录

Agent 操作

Agent 二进制下载源

Agent 策略

Agent 状态

Agent

数据流

Elastic Package Manager EPM

注册 API 密钥

Fleet 内部

Fleet Server 主机

Kubernetes

输出

软件包策略

代理

服务令牌

Agent 操作

编辑
向上
post /agents/{agentId}/actions/{actionId}/cancel
取消 Agent 操作 (agentActionCancel)

路径参数

agentId (必需)
路径参数 — 默认值:null
actionId (必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

Content-Type: application/json
{ }

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_action_cancel_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agents/action_status
获取 Agent 操作状态 (agentsActionStatus)

查询参数

perPage (可选)
查询参数 — 返回的项数 默认值:20
page (可选)
查询参数 — 默认值:1
errorSize (可选)
查询参数 — 默认值:5

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agents_action_status_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/{agentId}/actions
创建 Agent 操作 (newAgentAction)

路径参数

agentId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

new_agent_action_request new_agent_action_request (必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 new_agent_action_200_response

400

通用错误 fleet_server_health_check_400_response

Agent 二进制下载源

编辑
向上
delete /agent_download_sources/{sourceId}
通过 ID 删除 Agent 二进制下载源 (deleteDownloadSource)

路径参数

sourceId (必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent_download_sources
列出 Agent 二进制下载源 (getDownloadSources)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_download_sources_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent_download_sources/{sourceId}
通过 ID 获取 Agent 二进制下载源 (getOneDownloadSource)

路径参数

sourceId (必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_one_download_source_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agent_download_sources
创建 Agent 二进制下载源 (postDownloadSources)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

post_download_sources_request post_download_sources_request (可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 post_download_sources_200_response

400

通用错误 fleet_server_health_check_400_response

向上
put /agent_download_sources/{sourceId}
通过 ID 更新 Agent 二进制下载源 (updateDownloadSource)

路径参数

sourceId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

update_download_source_request update_download_source_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_one_download_source_200_response

400

通用错误 fleet_server_health_check_400_response

Agent 策略

编辑
向上
post /agent_policies/{agentPolicyId}/copy
通过 ID 复制 Agent 策略 (agentPolicyCopy)

路径参数

agentPolicyId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

agent_policy_copy_request agent_policy_copy_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_policy_info_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent_policies/{agentPolicyId}/download
通过 ID 下载 Agent 策略 (agentPolicyDownload)

路径参数

agentPolicyId (必需)
路径参数 — 默认值:null

查询参数

download (可选)
查询参数 — 默认值:null
standalone (可选)
查询参数 — 默认值:null
kubernetes (可选)
查询参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_policy_download_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent_policies/{agentPolicyId}/full
通过 ID 获取完整 Agent 策略 (agentPolicyFull)

路径参数

agentPolicyId (必需)
路径参数 — 默认值:null

查询参数

download (可选)
查询参数 — 默认值:null
standalone (可选)
查询参数 — 默认值:null
kubernetes (可选)
查询参数 — 默认值:null

返回类型

示例数据

Content-Type: application/json
{ }

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_policy_full_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent_policies/{agentPolicyId}
通过 ID 获取 Agent 策略 (agentPolicyInfo)
获取一个 Agent 策略

路径参数

agentPolicyId (必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_policy_info_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent_policies
列出 Agent 策略 (agentPolicyList)

查询参数

perPage (可选)
查询参数 — 返回的项数 默认值:20
page (可选)
查询参数 — 默认值:1
kuery (可选)
查询参数 — 默认值:null
full (可选)
查询参数 — 设置为 true 时,检索每个 Agent 策略的相关软件包策略。默认值:null
noAgentCount (可选)
查询参数 — 设置为 true 时,不计算 Agent 策略中有多少 Agent,如果你正在搜索大量 Agent 策略,这可以提高性能。"agents" 属性如果设置为 true,则始终为 0。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_policy_list_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agent_policies/_bulk_get
批量获取 Agent 策略 (bulkGetAgentPolicies)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_get_agent_policies_request bulk_get_agent_policies_request (可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_get_agent_policies_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agent_policies
创建 Agent 策略 (createAgentPolicy)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

agent_policy_create_request agent_policy_create_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 create_agent_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agent_policies/delete
通过 ID 删除 Agent 策略 (deleteAgentPolicy)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

delete_agent_policy_request delete_agent_policy_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_agent_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
put /agent_policies/{agentPolicyId}
通过 ID 更新代理策略 (updateAgentPolicy)

路径参数

agentPolicyId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

agent_policy_update_request agent_policy_update_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_policy_info_200_response

400

通用错误 fleet_server_health_check_400_response

Agent 状态

编辑
向上
get /agent_status/data
获取传入的代理数据 (getAgentData)

查询参数

agentsIds (必需)
查询参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agent_data_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent_status
获取代理状态摘要 (getAgentStatus)

查询参数

policyId (可选)
查询参数 — 默认值:null
kuery (可选)
查询参数 — 默认值:null

返回类型

示例数据

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
}

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agent_status_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agent-status
获取代理状态摘要 (getAgentStatusDeprecated)

查询参数

policyId (可选)
查询参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agent_status_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

Agent

编辑
向上
post /agents/bulk_reassign
批量重新分配代理 (bulkReassignAgents)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_reassign_agents_request bulk_reassign_agents_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_upgrade_agents_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/bulk_request_diagnostics
批量从代理请求诊断 (bulkRequestDiagnostics)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_request_diagnostics_request bulk_request_diagnostics_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_upgrade_agents_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/bulk_unenroll
批量取消注册代理 (bulkUnenrollAgents)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_unenroll_agents_request bulk_unenroll_agents_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_upgrade_agents_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/bulk_update_agent_tags
批量更新代理标签 (bulkUpdateAgentTags)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_update_agent_tags_request bulk_update_agent_tags_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_upgrade_agents_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/bulk_upgrade
批量升级代理 (bulkUpgradeAgents)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_upgrade_agents bulk_upgrade_agents (必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_upgrade_agents_200_response

400

通用错误 fleet_server_health_check_400_response

向上
delete /agents/{agentId}
通过 ID 删除代理 (deleteAgent)

路径参数

agentId (必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_agent_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agents/{agentId}
通过 ID 获取代理 (getAgent)

路径参数

agentId (必需)
路径参数 — 默认值:null

查询参数

withMetrics (可选)
查询参数 — 返回代理指标,默认为 false,默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agent_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agents/tags
列出代理标签 (getAgentTags)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agent_tags_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agents/files@{fileId}@{fileName}
获取代理上传的文件 (getAgentUploadFile)

路径参数

fileId (必需)
路径参数 — 默认值:null
fileName (必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agent_upload_file_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agents
列出代理 (getAgents)

查询参数

perPage (可选)
查询参数 — 返回的项数 默认值:20
page (可选)
查询参数 — 默认值:1
kuery (可选)
查询参数 — 默认值:null
showInactive (可选)
查询参数 — 默认值:null
showUpgradeable (可选)
查询参数 — 默认值:null
sortField (可选)
查询参数 — 默认值:null
sortOrder (可选)
查询参数 — 默认值:null
withMetrics (可选)
查询参数 — 返回代理指标,默认为 false,默认值:null
getStatusSummary (可选)
查询参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agents_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents
按操作 ID 列出代理 (getAgentsByActions)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

get_agents_by_actions_request get_agents_by_actions_request (必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

array[array[String]]

示例数据

Content-Type: application/json
[ [ "", "" ], [ "", "" ] ]

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定

400

通用错误 fleet_server_health_check_400_response

向上
get /agents/setup
获取代理设置信息 (getAgentsSetupStatus)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 fleet_status_response

400

通用错误 fleet_server_health_check_400_response

向上
get /agents/{agentId}/uploads
列出代理上传 (listAgentUploads)

路径参数

agentId (必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 list_agent_uploads_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/{agentId}/reassign
重新分配代理 (reassignAgent)

路径参数

agentId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

reassign_agent_deprecated_request reassign_agent_deprecated_request (必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

对象

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 对象

400

通用错误 fleet_server_health_check_400_response

向上
put /agents/{agentId}/reassign
重新分配代理 (reassignAgentDeprecated)

路径参数

agentId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

reassign_agent_deprecated_request reassign_agent_deprecated_request (必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

对象

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 对象

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/{agentId}/request_diagnostics
请求代理诊断 (requestDiagnosticsAgent)

路径参数

agentId (必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_upgrade_agents_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/setup
启动代理设置 (setupAgents)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

setup_agents_request setup_agents_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 fleet_setup_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/{agentId}/unenroll
取消注册代理 (unenrollAgent)

路径参数

agentId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

unenroll_agent_request unenroll_agent_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

对象

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 对象

400

错误的请求 unenroll_agent_400_response

向上
put /agents/{agentId}
通过 ID 更新代理 (updateAgent)

路径参数

agentId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

update_agent_request update_agent_request (必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_agent_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /agents/{agentId}/upgrade
升级代理 (upgradeAgent)

路径参数

agentId (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

upgrade_agent upgrade_agent (必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 upgrade_agent

400

通用错误 fleet_server_health_check_400_response

数据流

编辑
向上
get /data_streams
列出数据流 (dataStreamsList)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 data_streams_list_200_response

400

通用错误 fleet_server_health_check_400_response

Elastic Package Manager EPM

编辑
向上
post /epm/bulk_assets
批量获取资产 (bulkGetAssets)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_get_assets_request bulk_get_assets_request (可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_bulk_assets_response

400

通用错误 fleet_server_health_check_400_response

向上
post /epm/packages/_bulk
批量安装软件包 (bulkInstallPackages)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_install_packages_request bulk_install_packages_request (可选)
正文参数

查询参数

prerelease (可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、预览),默认值:false

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_install_packages_response

400

通用错误 fleet_server_health_check_400_response

向上
delete /epm/packages/{pkgName}/{pkgVersion}
删除软件包 (deletePackage)

路径参数

pkgName (必需)
路径参数 — 默认值:null
pkgVersion (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

install_package_deprecated_request install_package_deprecated_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

查询参数

ignoreUnverified (可选)
查询参数 — 如果软件包签名验证失败,则忽略,默认值:null
full (可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic 软件包注册表支持的字段,默认值:null
prerelease (可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、预览),默认值:false

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 update_package_200_response

400

通用错误 fleet_server_health_check_400_response

向上
delete /epm/packages/{pkgkey}
删除软件包 (deletePackageDeprecated)

路径参数

pkgkey (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

install_package_deprecated_request install_package_deprecated_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 install_package_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/packages/{pkgName}/{pkgVersion}
获取软件包 (getPackage)

路径参数

pkgName (必需)
路径参数 — 默认值:null
pkgVersion (必需)
路径参数 — 默认值:null

查询参数

ignoreUnverified (可选)
查询参数 — 如果软件包签名验证失败,则忽略,默认值:null
full (可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic 软件包注册表支持的字段,默认值:null
prerelease (可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、预览),默认值:false

返回类型

示例数据

Content-Type: application/json
null

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_package_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/categories
列出软件包类别 (getPackageCategories)

查询参数

prerelease (可选)
查询参数 — 是否在类别计数中包含预发布软件包(例如 beta、rc、预览),默认值:false
experimental (可选)
查询参数 — 默认值:false
include_policy_templates (可选)
查询参数 — 默认值:false

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_categories_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/packages/{pkgkey}
获取软件包 (getPackageDeprecated)

路径参数

pkgkey (必需)
路径参数 — 默认值:null

查询参数

prerelease (可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、预览),默认值:false

返回类型

示例数据

Content-Type: application/json
null

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_package_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/packages/{pkgName}/stats
获取软件包统计信息 (getPackageStats)

路径参数

pkgName (必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_package_stats_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /epm/packages/{pkgName}/{pkgVersion}
安装软件包 (installPackage)

路径参数

pkgName (必需)
路径参数 — 默认值:null
pkgVersion (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

install_package_request install_package_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

查询参数

ignoreUnverified (可选)
查询参数 — 如果软件包签名验证失败,则忽略,默认值:null
full (可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic 软件包注册表支持的字段,默认值:null
prerelease (可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、预览),默认值:false

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 install_package_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /epm/packages
通过直接上传安装软件包 (installPackageByUpload)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/zip
  • application/gzip

请求体

body file (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 install_package_by_upload_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /epm/packages/{pkgkey}
安装软件包 (installPackageDeprecated)

路径参数

pkgkey (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

install_package_deprecated_request install_package_deprecated_request (可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 install_package_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/packages
列出软件包 (listAllPackages)

查询参数

excludeInstallStatus (可选)
查询参数 — 是否排除每个软件包的安装状态。启用此选项将通过 cache-control 标头选择缓存响应。如果您不需要软件包的最新安装信息,并且正在查询可用软件包列表,则提供此标志可以显著提高性能。默认值:false
prerelease (可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、预览),默认值:false
experimental (可选)
查询参数 — 默认值:false
category (可选)
查询参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_packages_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/packages/limited
获取有限的软件包列表 (listLimitedPackages)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 list_limited_packages_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/packages/{pkgName}/{pkgVersion}/{filePath}
获取软件包文件 (packagesGetFile)

路径参数

pkgName (必需)
路径参数 — 默认值:null
pkgVersion (必需)
路径参数 — 默认值:null
filePath (必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 packages_get_file_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /epm/verification_key_id
获取软件包签名验证密钥 ID (packagesGetVerificationKeyId)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 packages_get_verification_key_id_200_response

400

通用错误 fleet_server_health_check_400_response

向上
put /epm/packages/{pkgName}/{pkgVersion}
更新软件包设置 (updatePackage)

路径参数

pkgName (必需)
路径参数 — 默认值:null
pkgVersion (必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

update_package_request update_package_request (可选)
正文参数

查询参数

ignoreUnverified (可选)
查询参数 — 如果软件包签名验证失败,则忽略,默认值:null
full (可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic 软件包注册表支持的字段,默认值:null
prerelease (可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、预览),默认值:false

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 update_package_200_response

400

通用错误 fleet_server_health_check_400_response

注册 API 密钥

编辑
向上
post /enrollment_api_keys
创建注册 API 密钥 (createEnrollmentApiKeys)

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 create_enrollment_api_keys_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /enrollment-api-keys
创建注册 API 密钥 (createEnrollmentApiKeysDeprecated)

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 create_enrollment_api_keys_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
delete /enrollment_api_keys/{keyId}
按 ID 删除注册 API 密钥 (deleteEnrollmentApiKey)

路径参数

keyId(必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_agent_200_response

400

通用错误 fleet_server_health_check_400_response

向上
delete /enrollment-api-keys/{keyId}
按 ID 删除注册 API 密钥 (deleteEnrollmentApiKeyDeprecated)

路径参数

keyId(必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_agent_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /enrollment_api_keys/{keyId}
按 ID 获取注册 API 密钥 (getEnrollmentApiKey)

路径参数

keyId(必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_enrollment_api_key_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /enrollment-api-keys/{keyId}
按 ID 获取注册 API 密钥 (getEnrollmentApiKeyDeprecated)

路径参数

keyId(必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_enrollment_api_key_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /enrollment_api_keys
列出注册 API 密钥 (getEnrollmentApiKeys)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_enrollment_api_keys_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /enrollment-api-keys
列出注册 API 密钥 (getEnrollmentApiKeysDeprecated)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_enrollment_api_keys_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

Fleet 内部

编辑
向上
post /health_check
Fleet Server 运行状况检查 (fleetServerHealthCheck)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

fleet_server_health_check_request fleet_server_health_check_request(必需)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 fleet_server_health_check_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /settings
获取设置 (getSettings)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 fleet_settings_response

400

通用错误 fleet_server_health_check_400_response

向上
post /setup
启动 Fleet 设置 (setup)

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 fleet_setup_response

400

通用错误 fleet_server_health_check_400_response

500

内部服务器错误 setup_500_response

向上
put /settings
更新设置 (updateSettings)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

update_settings_request update_settings_request(可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 fleet_settings_response

400

通用错误 fleet_server_health_check_400_response

Fleet Server 主机

编辑
向上
delete /fleet_server_hosts/{itemId}
按 ID 删除 Fleet Server 主机 (deleteFleetServerHosts)

路径参数

itemId(必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /fleet_server_hosts
列出 Fleet Server 主机 (getFleetServerHosts)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_fleet_server_hosts_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /fleet_server_hosts/{itemId}
按 ID 获取 Fleet Server 主机 (getOneFleetServerHosts)

路径参数

itemId(必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_one_fleet_server_hosts_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /fleet_server_hosts
创建 Fleet Server 主机 (postFleetServerHosts)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

post_fleet_server_hosts_request post_fleet_server_hosts_request(可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 post_fleet_server_hosts_200_response

400

通用错误 fleet_server_health_check_400_response

向上
put /fleet_server_hosts/{itemId}
按 ID 更新 Fleet Server 主机 (updateFleetServerHosts)

路径参数

itemId(必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

update_fleet_server_hosts_request update_fleet_server_hosts_request(可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_one_fleet_server_hosts_200_response

400

通用错误 fleet_server_health_check_400_response

Kubernetes

编辑
向上
get /kubernetes
获取完整的 K8s 代理清单 (getFullK8sManifest)

查询参数

download (可选)
查询参数 — 默认值:null
fleetServer(可选)
查询参数 — 默认值:null
enrolToken(可选)
查询参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 agent_policy_download_200_response

400

通用错误 fleet_server_health_check_400_response

输出

编辑
向上
delete /outputs/{outputId}
按 ID 删除输出 (deleteOutput)

路径参数

outputId(必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /logstash_api_keys
生成 Logstash API 密钥 (generateLogstashApiKey)

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 generate_logstash_api_key_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /outputs/{outputId}
按 ID 获取输出 (getOutput)

路径参数

outputId(必需)
路径参数 — 默认值:null

返回类型

示例数据

Content-Type: application/json
null

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 output_create_request

400

通用错误 fleet_server_health_check_400_response

向上
get /outputs
列出输出 (getOutputs)

返回类型

示例数据

Content-Type: application/json
{
  "total" : 0,
  "perPage" : 1,
  "page" : 6,
  "items" : [ null, null ]
}

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_outputs_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /outputs
创建输出 (postOutputs)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

output_create_request output_create_request(必需)
正文参数

返回类型

示例数据

Content-Type: application/json
{ }

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 post_outputs_200_response

400

通用错误 fleet_server_health_check_400_response

向上
put /outputs/{outputId}
按 ID 更新输出 (updateOutput)

路径参数

outputId(必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

output_update_request output_update_request(可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

Content-Type: application/json
null

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 output_update_request

400

通用错误 fleet_server_health_check_400_response

软件包策略

编辑
向上
post /package_policies/_bulk_get
批量获取程序包策略 (bulkGetPackagePolicies)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

bulk_get_package_policies_request bulk_get_package_policies_request(可选)
正文参数

查询参数

format(可选)
查询参数 — 程序包输入简化的或旧的格式,默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 bulk_get_package_policies_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /package_policies
创建程序包策略 (createPackagePolicy)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

package_policy_request package_policy_request(可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

查询参数

format(可选)
查询参数 — 程序包输入简化的或旧的格式,默认值:null

返回类型

示例数据

Content-Type: application/json
{ }

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 create_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

409

通用错误 fleet_server_health_check_400_response

向上
delete /package_policies/{packagePolicyId}
按 ID 删除程序包策略 (deletePackagePolicy)

路径参数

packagePolicyId(必需)
路径参数 — 默认值:null

查询参数

force(可选)
查询参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /package_policies
列出程序包策略 (getPackagePolicies)

查询参数

perPage (可选)
查询参数 — 返回的项数 默认值:20
page (可选)
查询参数 — 默认值:1
kuery (可选)
查询参数 — 默认值:null
format(可选)
查询参数 — 程序包输入简化的或旧的格式,默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_package_policies_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /package_policies/{packagePolicyId}
按 ID 获取程序包策略 (getPackagePolicy)

路径参数

packagePolicyId(必需)
路径参数 — 默认值:null

查询参数

format(可选)
查询参数 — 程序包输入简化的或旧的格式,默认值:null

返回类型

示例数据

Content-Type: application/json
{ }

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 create_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /package_policies/delete
删除程序包策略 (postDeletePackagePolicy)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

post_delete_package_policy_request post_delete_package_policy_request(可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定

400

通用错误 fleet_server_health_check_400_response

向上
put /package_policies/{packagePolicyId}
按 ID 更新程序包策略 (updatePackagePolicy)

路径参数

packagePolicyId(必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

package_policy_request package_policy_request(可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

查询参数

format(可选)
查询参数 — 程序包输入简化的或旧的格式,默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 update_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /package_policies/upgrade
将程序包策略升级到较新的程序包版本 (upgradePackagePolicy)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

upgrade_package_policy_request upgrade_package_policy_request(可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定

400

通用错误 fleet_server_health_check_400_response

409

通用错误 fleet_server_health_check_400_response

向上
post /package_policies/upgrade/dryrun
模拟运行程序包策略升级 (upgradePackagePolicyDryRun)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

upgrade_package_policy_dry_run_request upgrade_package_policy_dry_run_request(可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定

400

通用错误 fleet_server_health_check_400_response

代理

编辑
向上
delete /proxies/{itemId}
按 ID 删除代理 (deleteFleetProxies)

路径参数

itemId(必需)
路径参数 — 默认值:null

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 delete_package_policy_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /proxies
列出代理 (getFleetProxies)

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_fleet_proxies_200_response

400

通用错误 fleet_server_health_check_400_response

向上
get /proxies/{itemId}
按 ID 获取代理 (getOneFleetProxies)

路径参数

itemId(必需)
路径参数 — 默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_one_fleet_proxies_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /proxies
创建代理 (postFleetProxies)

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

post_fleet_proxies_request post_fleet_proxies_request(可选)
正文参数

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 post_fleet_proxies_200_response

400

通用错误 fleet_server_health_check_400_response

向上
put /proxies/{itemId}
按 ID 更新代理 (updateFleetProxies)

路径参数

itemId(必需)
路径参数 — 默认值:null

使用

此 API 调用通过 Content-Type 请求头使用以下媒体类型
  • application/json

请求体

update_fleet_proxies_request update_fleet_proxies_request(可选)
正文参数

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 get_one_fleet_proxies_200_response

400

通用错误 fleet_server_health_check_400_response

服务令牌

编辑
向上
post /service_tokens
创建服务令牌 (generateServiceToken)

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 generate_service_token_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

向上
post /service-tokens
创建服务令牌 (generateServiceTokenDeprecated)

请求头

kbn-xsrf (必需)
标头参数 — Kibana 的反跨站点请求伪造令牌。可以是任何字符串值。默认值:null

返回类型

示例数据

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

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。
  • application/json

响应

200

确定 generate_service_token_deprecated_200_response

400

通用错误 fleet_server_health_check_400_response

模型

[ 跳转到 方法 ]

目录

  1. Full_agent_policy_output_permissions -
  2. Full_agent_policy_output_permissions_data -
  3. Full_agent_policy_output_permissions_data_indices_inner -
  4. agent - 代理
  5. agent_action - 代理操作
  6. agent_action_cancel_200_response -
  7. agent_action_oneOf -
  8. agent_action_oneOf_1 -
  9. agent_action_oneOf_1_data -
  10. agent_component - 代理组件
  11. agent_component_status - 代理组件状态
  12. agent_component_unit - 代理组件单元
  13. agent_component_unit_type - 代理组件单元类型
  14. agent_diagnostics - 代理诊断
  15. agent_metrics -
  16. agent_policy - 代理策略
  17. agent_policy_agent_features_inner -
  18. agent_policy_copy_request -
  19. agent_policy_create_request - 创建代理策略请求
  20. agent_policy_download_200_response -
  21. agent_policy_full - 完整的代理策略响应
  22. agent_policy_full_200_response -
  23. agent_policy_full_200_response_item -
  24. agent_policy_full_oneOf -
  25. agent_policy_info_200_response -
  26. agent_policy_list_200_response -
  27. agent_policy_update_request - 更新代理策略请求
  28. agent_status - 代理状态
  29. agent_type - 代理类型
  30. agents_action_status_200_response -
  31. agents_action_status_200_response_items_inner -
  32. agents_action_status_200_response_items_inner_latestErrors_inner -
  33. bulk_get_agent_policies_200_response -
  34. bulk_get_agent_policies_request -
  35. bulk_get_assets_request -
  36. bulk_get_assets_request_assetIds_inner -
  37. bulk_get_package_policies_200_response -
  38. bulk_get_package_policies_request -
  39. bulk_install_packages_request -
  40. bulk_install_packages_request_packages_inner -
  41. bulk_install_packages_request_packages_inner_oneOf -
  42. bulk_install_packages_response - 批量安装程序包响应
  43. bulk_install_packages_response_response_inner -
  44. bulk_reassign_agents_request -
  45. bulk_reassign_agents_request_agents -
  46. bulk_request_diagnostics_request -
  47. bulk_unenroll_agents_request -
  48. bulk_update_agent_tags_request -
  49. bulk_upgrade_agents - 批量升级代理
  50. bulk_upgrade_agents_200_response -
  51. create_agent_policy_200_response -
  52. create_enrollment_api_keys_deprecated_200_response -
  53. create_package_policy_200_response -
  54. data_stream - 数据流
  55. data_stream_dashboard_inner -
  56. data_streams_list_200_response -
  57. delete_agent_200_response -
  58. delete_agent_policy_200_response -
  59. delete_agent_policy_request -
  60. delete_package_policy_200_response -
  61. download_sources - 下载源
  62. elasticsearch_asset_type - Elasticsearch 资产类型
  63. enrollment_api_key - 注册 API 密钥
  64. fleet_server_health_check_200_response -
  65. fleet_server_health_check_400_response -
  66. fleet_server_health_check_request -
  67. fleet_server_host - Fleet Server 主机
  68. fleet_settings_response - Fleet 设置响应
  69. fleet_setup_response - Fleet 设置响应
  70. fleet_setup_response_nonFatalErrors_inner -
  71. fleet_status_response - Fleet 状态响应
  72. full_agent_policy - 完整的代理策略
  73. full_agent_policy_fleet -
  74. full_agent_policy_fleet_oneOf -
  75. full_agent_policy_fleet_oneOf_1 -
  76. full_agent_policy_fleet_oneOf_1_kibana -
  77. full_agent_policy_fleet_oneOf_ssl -
  78. full_agent_policy_input - 完整的代理策略输入
  79. full_agent_policy_input_allOf -
  80. full_agent_policy_input_allOf_data_stream -
  81. full_agent_policy_input_allOf_meta -
  82. full_agent_policy_input_allOf_meta_package -
  83. full_agent_policy_input_stream - 完整的代理策略输入流
  84. full_agent_policy_input_stream_allOf -
  85. full_agent_policy_input_stream_allOf_data_stream -
  86. full_agent_policy_output - 完整的代理策略
  87. full_agent_policy_output_additionalProperties -
  88. full_agent_policy_output_permissions_1_value -
  89. full_agent_policy_secret_references_inner -
  90. generate_logstash_api_key_200_response -
  91. generate_service_token_deprecated_200_response -
  92. get_agent_200_response -
  93. get_agent_data_200_response -
  94. get_agent_data_200_response_items_inner_value -
  95. get_agent_status_200_response -
  96. get_agent_status_deprecated_200_response -
  97. get_agent_tags_response - 获取代理标记响应
  98. get_agent_upload_file_200_response -
  99. get_agent_upload_file_200_response_body -
  100. get_agent_upload_file_200_response_body_items -
  101. get_agents_by_actions_request -
  102. get_agents_response - 获取代理响应
  103. get_agents_response_statusSummary -
  104. get_bulk_assets_response - 批量获取资产响应
  105. get_bulk_assets_response_response_inner_inner -
  106. get_bulk_assets_response_response_inner_inner_attributes -
  107. get_categories_response - 获取类别响应
  108. get_categories_response_items_inner -
  109. get_categories_response_response_inner -
  110. get_download_sources_200_response -
  111. get_enrollment_api_key_deprecated_200_response -
  112. get_enrollment_api_keys_deprecated_200_response -
  113. get_fleet_proxies_200_response -
  114. get_fleet_server_hosts_200_response -
  115. get_one_download_source_200_response -
  116. get_one_fleet_proxies_200_response -
  117. get_one_fleet_server_hosts_200_response -
  118. get_outputs_200_response -
  119. get_package_200_response -
  120. get_package_200_response_allOf -
  121. get_package_200_response_allOf_1 -
  122. get_package_deprecated_200_response -
  123. get_package_deprecated_200_response_allOf -
  124. get_package_deprecated_200_response_allOf_1 -
  125. get_package_policies_200_response -
  126. get_package_stats_200_response -
  127. get_packages_response - 获取程序包响应
  128. install_package_200_response -
  129. install_package_200_response__meta -
  130. install_package_by_upload_200_response -
  131. install_package_by_upload_200_response__meta -
  132. install_package_by_upload_200_response_items_inner -
  133. install_package_by_upload_200_response_items_inner_type -
  134. install_package_deprecated_200_response -
  135. install_package_deprecated_request -
  136. install_package_request -
  137. installation_info - 安装信息对象
  138. installation_info_installed_es -
  139. installation_info_installed_kibana -
  140. kibana_saved_object_type - Kibana 保存的对象资产类型
  141. list_agent_uploads_200_response -
  142. list_agent_uploads_200_response_body -
  143. list_limited_packages_200_response -
  144. new_agent_action_200_response -
  145. new_agent_action_request -
  146. new_package_policy - 新的包策略
  147. new_package_policy_inputs_inner -
  148. new_package_policy_package -
  149. output_create_request - 输出
  150. output_create_request_elasticsearch - elasticsearch
  151. output_create_request_elasticsearch_shipper -
  152. output_create_request_elasticsearch_ssl -
  153. output_create_request_kafka - kafka
  154. output_create_request_kafka_headers_inner -
  155. output_create_request_kafka_random -
  156. output_create_request_kafka_sasl -
  157. output_create_request_kafka_topics_inner -
  158. output_create_request_kafka_topics_inner_when -
  159. output_create_request_logstash - logstash
  160. output_update_request - 输出
  161. output_update_request_elasticsearch - elasticsearch
  162. output_update_request_kafka - kafka
  163. output_update_request_logstash - logstash
  164. package_info - 包信息
  165. package_info_conditions -
  166. package_info_conditions_elasticsearch -
  167. package_info_conditions_kibana -
  168. package_info_data_streams_inner -
  169. package_info_data_streams_inner_vars_inner -
  170. package_info_elasticsearch -
  171. package_info_elasticsearch_privileges -
  172. package_info_screenshots_inner -
  173. package_info_source -
  174. package_policy - 包策略
  175. package_policy_allOf -
  176. package_policy_allOf_inputs -
  177. package_policy_request - 包策略请求
  178. package_policy_request_inputs_value -
  179. package_policy_request_inputs_value_streams_value -
  180. package_policy_request_package -
  181. package_usage_stats - 包使用统计信息
  182. packages_get_file_200_response -
  183. packages_get_verification_key_id_200_response -
  184. packages_get_verification_key_id_200_response_body -
  185. post_delete_package_policy_200_response_inner -
  186. post_delete_package_policy_request -
  187. post_download_sources_200_response -
  188. post_download_sources_request -
  189. post_fleet_proxies_200_response -
  190. post_fleet_proxies_request -
  191. post_fleet_server_hosts_200_response -
  192. post_fleet_server_hosts_request -
  193. post_outputs_200_response -
  194. proxies - Fleet 代理
  195. reassign_agent_deprecated_request -
  196. saved_object_type - 保存的对象类型
  197. search_result - 搜索结果
  198. settings - 设置
  199. setup_500_response -
  200. setup_agents_request -
  201. unenroll_agent_400_response -
  202. unenroll_agent_request -
  203. update_agent_request -
  204. update_download_source_request -
  205. update_fleet_proxies_request -
  206. update_fleet_server_hosts_request -
  207. update_package_200_response -
  208. update_package_policy_200_response -
  209. update_package_request -
  210. update_settings_request -
  211. upgrade_agent - 升级代理
  212. upgrade_diff_inner -
  213. upgrade_diff_inner_allOf -
  214. upgrade_diff_inner_allOf_allOf -
  215. upgrade_diff_inner_allOf_allOf_errors_inner -
  216. upgrade_package_policy_dry_run_200_response_inner -
  217. upgrade_package_policy_dry_run_request -
  218. upgrade_package_policy_request -

agent - 代理 向上

类型
激活
注册时间
取消注册时间 (可选)
开始取消注册时间 (可选)
访问 API 密钥 ID (可选)
默认 API 密钥 ID (可选)
策略 ID (可选)
策略修订版本 (可选)
上次签入时间 (可选)
用户提供的元数据 (可选)
本地元数据 (可选)
ID
访问 API 密钥 (可选)
状态
默认 API 密钥 (可选)
组件 (可选)
指标 (可选)

agent_action - 代理操作 向上

数据 (可选)
确认数据 (可选)
类型 (可选)

agent_action_oneOf - 向上

数据 (可选)
确认数据 (可选)
类型 (可选)
枚举
取消注册
升级
策略重新分配

agent_action_oneOf_1_data - 向上

日志级别 (可选)
枚举
调试
信息
警告
错误

agent_component - 代理组件 向上

ID (可选)
类型 (可选)
状态 (可选)
消息 (可选)
单元 (可选)

agent_component_unit - 代理组件单元 向上

ID (可选)
类型 (可选)
状态 (可选)
消息 (可选)
负载 (可选)

agent_diagnostics - 代理诊断信息 向上

ID
名称
创建时间
文件路径
操作 ID
状态
枚举
就绪
等待上传
已删除
进行中

agent_metrics - 向上

cpu_avg (可选)
BigDecimal 过去 5 分钟内代理 CPU 的平均使用率,介于 0-1 之间的数字
memory_size_byte_avg (可选)
BigDecimal 过去 5 分钟内代理的平均内存消耗

agent_policy - 代理策略 向上

ID
名称
命名空间
描述 (可选)
启用监控 (可选)
枚举
数据输出 ID (可选)
监控输出 ID (可选)
Fleet 服务器主机 ID (可选)
下载源 ID (可选)
取消注册超时 (可选)
非活动超时 (可选)
包策略 (可选)
package_policy 数组 仅在检索单个代理策略时,或者在检索带有 ?full=true 参数的代理策略列表时,才显示此字段
更新时间 (可选)
日期 格式:日期时间
更新者 (可选)
修订版本 (可选)
代理 (可选)
代理功能 (可选)
是否受保护 (可选)
布尔值 指示是否启用了代理策略的防篡改保护。默认为 false。
覆盖 (可选)
对象 代理策略中定义的覆盖设置。输入设置无法覆盖。覆盖选项应仅在特殊情况下使用,而不是作为常规过程。

agent_policy_create_request - 创建代理策略请求 向上

ID (可选)
名称
命名空间
描述 (可选)
启用监控 (可选)
枚举
数据输出 ID (可选)
监控输出 ID (可选)
Fleet 服务器主机 ID (可选)
下载源 ID (可选)
取消注册超时 (可选)
非活动超时 (可选)
代理功能 (可选)
是否受保护 (可选)

agent_policy_update_request - 更新代理策略请求 向上

名称
命名空间
描述 (可选)
启用监控 (可选)
枚举
数据输出 ID (可选)
监控输出 ID (可选)
Fleet 服务器主机 ID (可选)
下载源 ID (可选)
取消注册超时 (可选)
非活动超时 (可选)
代理功能 (可选)
是否受保护 (可选)

agents_action_status_200_response_items_inner - 向上

操作 ID
状态
枚举
已完成
已过期
已取消
失败
进行中
滚动发布通过
已执行操作的代理数
BigDecimal 已执行操作的代理数
已创建操作的代理数
BigDecimal 从 Kibana 包含在操作中的代理数
已确认的代理数
BigDecimal 已确认操作的代理数
失败的代理数
BigDecimal 未能执行操作的代理数
版本 (可选)
字符串 代理版本号 (升级操作)
开始时间 (可选)
字符串 操作的开始时间(计划操作)
类型
枚举
策略重新分配
升级
取消注册
强制取消注册
更新标签
取消
请求诊断信息
设置
策略更改
输入操作
过期 (可选)
完成时间 (可选)
取消时间 (可选)
新策略 ID (可选)
字符串 新策略 ID(策略重新分配操作)
policyId (可选)
字符串 策略 ID(策略更改操作)
修订版本 (可选)
字符串 新策略修订版本(策略更改操作)
创建时间
字符串 操作的创建时间
最新错误 (可选)

bulk_get_agent_policies_request - 向上

ID
字符串数组 代理策略 ID 列表
full (可选)
布尔值 获取填充了包策略的完整策略
忽略缺失项 (可选)

bulk_get_package_policies_request - 向上

ID
字符串数组 包策略 ID 列表
忽略缺失项 (可选)

bulk_install_packages_request - 返回上一级

packages
force(可选)
Boolean 强制安装以忽略软件包验证错误

bulk_install_packages_request_packages_inner - 返回上一级

name (可选)
String 软件包名称
版本 (可选)
String 软件包版本

bulk_install_packages_request_packages_inner_oneOf - 返回上一级

name (可选)
String 软件包名称
版本 (可选)
String 软件包版本

bulk_unenroll_agents_request - 返回上一级

revoke (可选)
Boolean 撤销代理的 API 密钥
force(可选)
Boolean 也取消注册托管代理
agents

bulk_upgrade_agents - 批量升级代理 返回上一级

version
String 要升级到的版本
source_uri (可选)
String 备用升级二进制文件下载 URL
rollout_duration_seconds (可选)
Big Decimal 滚动升级窗口持续时间(秒)
start_time (可选)
String 升级的开始时间,格式为 ISO 8601
agents
force(可选)
Boolean 强制升级,跳过验证(应谨慎使用)

data_stream - 数据流 返回上一级

index (可选)
dataset (可选)
namespace (可选)
类型 (可选)
package (可选)
package_version (可选)
last_activity_ms (可选)
size_in_bytes (可选)
size_in_bytes_formatted (可选)
dashboard (可选)

fleet_status_response - Fleet 状态响应 返回上一级

isReady
missing_requirements
枚举
missing_optional_features
枚举
package_verification_key_id (可选)

full_agent_policy_fleet_oneOf_ssl - 返回上一级

verification_mode (可选)
certificate (可选)
key (可选)
certificate_authorities (可选)
renegotiation (可选)

get_agent_status_200_response - 返回上一级

错误
events
inactive
unenrolled (可选)
offline
online
other
总计
updating
all
激活

get_agents_response_statusSummary - 返回上一级

offline (可选)
错误 (可选)
online (可选)
inactive (可选)
enrolling (可选)
unenrolling (可选)
unenrolled (可选)
updating (可选)
degradedQuote (可选)

get_fleet_proxies_200_response - 返回上一级

items (可选)
total (可选)
page (可选)
perPage (可选)

get_outputs_200_response - 向上

items (可选)
total (可选)
page (可选)
perPage (可选)

get_package_200_response - 向上

项目 (可选)
状态
枚举
已安装
正在安装
安装失败
未安装
savedObject
latestVersion (可选)
keepPoliciesUpToDate (可选)
notice (可选)
licensePath (可选)

get_package_200_response_allOf_1 - 向上

状态
枚举
已安装
正在安装
安装失败
未安装
savedObject
latestVersion (可选)
keepPoliciesUpToDate (可选)
notice (可选)
licensePath (可选)

get_package_deprecated_200_response - 向上

response (可选)
状态
枚举
已安装
正在安装
安装失败
未安装
savedObject

get_package_deprecated_200_response_allOf_1 - 向上

状态
枚举
已安装
正在安装
安装失败
未安装
savedObject

install_package_200_response__meta - 向上

install_source (可选)
枚举
注册表
上传
捆绑

install_package_by_upload_200_response__meta - 向上

install_source (可选)
枚举
上传
注册表
捆绑

install_package_request - 向上

force(可选)
ignore_constraints (可选)

installation_info - 安装信息对象 向上

类型 (可选)
created_at (可选)
updated_at (可选)
namespaces (可选)
installed_kibana
installed_es
名称
version
install_status
枚举
已安装
正在安装
安装失败
install_source
枚举
注册表
上传
捆绑
install_kibana_space_id (可选)
install_format_schema_version (可选)
verification_status
枚举
已验证
未验证
未知
verification_key_id (可选)
experimental_data_stream_features (可选)

new_agent_action_200_response - 向上

body (可选)
statusCode (可选)
headers (可选)

new_package_policy - 新软件包策略 向上

enabled (可选)
package (可选)
namespace (可选)
output_id (可选)
inputs
策略 ID (可选)
名称
描述 (可选)

new_package_policy_inputs_inner - 向上

类型
已启用
processors (可选)
streams (可选)
config (可选)
vars (可选)

output_create_request - 输出 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
logstash
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)
版本 (可选)
key (可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics
headers (可选)
timeout (可选)
broker_timeout (可选)
broker_buffer_size (可选)
broker_ack_reliability (可选)

output_create_request_elasticsearch - elasticsearch 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型 (可选)
枚举
elasticsearch
hosts (可选)
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)

output_create_request_elasticsearch_shipper - 向上

disk_queue_enabled (可选)
disk_queue_path (可选)
disk_queue_max_size (可选)
disk_queue_encryption_enabled (可选)
disk_queue_compression_enabled (可选)
compression_level (可选)
loadbalance (可选)

output_create_request_elasticsearch_ssl - 向上

certificate_authorities (可选)
certificate (可选)
key (可选)

output_create_request_kafka - kafka 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
kafka
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)
版本 (可选)
key (可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics
headers (可选)
timeout (可选)
broker_timeout (可选)
broker_buffer_size (可选)
broker_ack_reliability (可选)

output_create_request_logstash - logstash 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
logstash
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)

output_update_request - 输出 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
logstash
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)
版本 (可选)
key (可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type (可选)
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics (可选)
headers (可选)
timeout (可选)
broker_timeout (可选)
broker_ack_reliability (可选)
broker_buffer_size (可选)

output_update_request_elasticsearch - elasticsearch 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
elasticsearch
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)

output_update_request_kafka - kafka 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型 (可选)
枚举
kafka
hosts (可选)
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)
版本 (可选)
key (可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type (可选)
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics (可选)
headers (可选)
timeout (可选)
broker_timeout (可选)
broker_ack_reliability (可选)
broker_buffer_size (可选)

output_update_request_logstash - logstash 向上

ID (可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型 (可选)
枚举
logstash
hosts (可选)
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl (可选)
proxy_id (可选)
shipper (可选)

package_info - 软件包信息 向上

名称
title
version
release (可选)
字符串 release 标签已弃用,请从版本中派生 (软件包遵循 semver)
枚举
实验性
beta
ga
source (可选)
readme (可选)
description
类型
categories
conditions
screenshots (可选)
icons (可选)
assets
internal (可选)
format_version
data_streams (可选)
download
path
elasticsearch (可选)

package_info_conditions_elasticsearch - 向上

subscription (可选)
枚举
basic
gold
platinum
enterprise

package_info_screenshots_inner - 向上

src
path
title (可选)
size (可选)
类型 (可选)

package_info_source - 向上

license (可选)
枚举
Apache-2.0
Elastic-2.0

package_policy - 软件包策略 向上

ID
revision
inputs
enabled (可选)
package (可选)
namespace (可选)
output_id (可选)
策略 ID (可选)
名称
描述 (可选)

package_policy_request - 软件包策略请求 向上

ID (可选)
字符串 软件包策略唯一标识符
名称
字符串 软件包策略名称(应唯一)
描述 (可选)
字符串 软件包策略描述
namespace (可选)
字符串 默认命名空间为“default”
policy_id
字符串 将添加软件包策略的代理策略 ID
package
vars (可选)
对象 软件包根级别变量(有关详细信息,请参阅集成文档)
inputs (可选)
map[String, package_policy_request_inputs_value] 软件包策略输入(请参阅集成文档以了解可用的输入)
force(可选)
布尔值 强制创建软件包策略,即使软件包未验证或代理策略为托管策略。

package_policy_request_inputs_value - 向上

enabled (可选)
布尔值 启用或禁用该输入,(默认为 true)
vars (可选)
对象 输入级别变量(有关详细信息,请参阅集成文档)
streams (可选)
map[String, package_policy_request_inputs_value_streams_value] 输入流(请参阅集成文档以了解可用的流)

package_policy_request_inputs_value_streams_value - 向上

enabled (可选)
布尔值 启用或禁用该流,(默认为 true)
vars (可选)
对象 流级别变量(有关详细信息,请参阅集成文档)

package_policy_request_package - 向上

名称
字符串 软件包名称
version
字符串 软件包版本

packages_get_file_200_response - 向上

body (可选)
statusCode (可选)
headers (可选)

packages_get_verification_key_id_200_response_body - 向上

ID (可选)
字符串 用于验证软件包签名的 GPG 密钥的密钥 ID

post_fleet_proxies_request - 向上

ID (可选)
名称
url
proxy_headers (可选)
certificate_authorities (可选)
certificate (可选)
certificate_key (可选)

proxies - Fleet 代理 向上

ID (可选)
名称
url
proxy_headers (可选)
certificate_authorities (可选)
certificate (可选)
certificate_key (可选)

search_result - 搜索结果 向上

description
download
icons
名称
path
title
类型
version
状态
installationInfo (可选)
savedObject (可选)

settings - 设置 向上

ID
has_seen_add_data_notice (可选)
fleet_server_hosts
prerelease_integrations_enabled (可选)

setup_agents_request - 向上

admin_username
admin_password

unenroll_agent_400_response - 向上

错误 (可选)
消息 (可选)
statusCode (可选)
枚举
400

unenroll_agent_request - 向上

revoke (可选)
force(可选)

update_agent_request - 向上

用户提供的元数据 (可选)
tags (可选)

update_fleet_proxies_request - 向上

name (可选)
url (可选)
proxy_headers (可选)
certificate_authorities (可选)
certificate (可选)
certificate_key (可选)

update_fleet_server_hosts_request - 向上

name (可选)
is_default (可选)
host_urls (可选)

update_package_request - 向上

keepPoliciesUpToDate (可选)

update_settings_request - 向上

fleet_server_hosts (可选)
array[String] 对于每个 URL,协议和路径必须相同
has_seen_add_data_notice (可选)
additional_yaml_config (可选)

upgrade_agent - 升级代理 向上

version
source_uri (可选)
force(可选)
Boolean 强制升级,跳过验证(应谨慎使用)

upgrade_diff_inner - 向上

ID
revision
inputs
enabled (可选)
package (可选)
namespace (可选)
output_id (可选)
策略 ID (可选)
名称
描述 (可选)
errors (可选)
missingVars (可选)

upgrade_diff_inner_allOf - 向上

enabled (可选)
package (可选)
namespace (可选)
output_id (可选)
inputs
策略 ID (可选)
名称
描述 (可选)
errors (可选)
missingVars (可选)