openapi: 3.0.0
tags: []
info:
  title: Fleet
  description: OpenAPI schema for Fleet API endpoints
  version: '0.2'
  contact:
    name: Fleet Team
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: 'http://localhost:5601/api/fleet'
    description: local
paths:
  # Fleet internals
  /health_check:
    $ref: paths/health_check.yaml
  /setup:
    $ref: paths/setup.yaml
  /settings:
    $ref: paths/settings.yaml
  /service-tokens:
    $ref: paths/service_tokens_deprecated.yaml
  /service_tokens:
    $ref: paths/service_tokens.yaml

  # EPM / integrations endpoints
  /epm/verification_key_id:
    $ref: paths/epm@verification_key_id.yaml
  /epm/bulk_assets:
    $ref: paths/epm@bulk_assets.yaml
  /epm/categories:
    $ref: paths/epm@categories.yaml
  /epm/packages/limited:
    $ref: paths/epm@limited_list.yaml
  /epm/packages:
    $ref: paths/epm@packages.yaml
  /epm/packages/_bulk:
    $ref: paths/epm@packages_bulk.yaml
  '/epm/packages/{pkgkey}':
    $ref: 'paths/epm@packages@{pkgkey}_deprecated.yaml'
  '/epm/packages/{pkgName}/{pkgVersion}':
    $ref: 'paths/epm@packages@{pkg_name}@{pkg_version}.yaml'
  '/epm/packages/{pkgName}/{pkgVersion}/{filePath}':
    $ref: paths/epm@get_file.yaml
  '/epm/packages/{pkgName}/stats':
    $ref: 'paths/epm@packages@{pkg_name}@stats.yaml'

  # Agent endpoints
  /agents/setup:
    $ref: paths/agents@setup.yaml
  /agent-status:
    $ref: paths/agent_status_deprecated.yaml
  /agent_status:
    $ref: paths/agent_status.yaml
  /agent_status/data:
    $ref: paths/agent_status@data.yaml
  /agents:
    $ref: paths/agents.yaml
  /agents/bulk_upgrade:
    $ref: paths/agents@bulk_upgrade.yaml
  /agents/action_status:
    $ref: paths/agents@action_status.yaml
  '/agents/{agentId}':
    $ref: 'paths/agents@{agent_id}.yaml'
  '/agents/{agentId}/actions':
    $ref: 'paths/agents@{agent_id}@actions.yaml'
  '/agents/{agentId}/actions/{actionId}/cancel':
    $ref: 'paths/agents@{agent_id}@actions@{action_id}@cancel.yaml'
  '/agents/files@{fileId}@{fileName}':
    $ref: 'paths/agents@files@{file_id}@{file_name}.yaml'
  '/agents/{agentId}/reassign':
    $ref: 'paths/agents@{agent_id}@reassign.yaml'
  '/agents/{agentId}/unenroll':
    $ref: 'paths/agents@{agent_id}@unenroll.yaml'
  '/agents/{agentId}/upgrade':
    $ref: 'paths/agents@{agent_id}@upgrade.yaml'
  '/agents/{agentId}/uploads':
    $ref: 'paths/agents@{agent_id}@uploads.yaml'
  '/agents/bulk_reassign':
    $ref: 'paths/agents@bulk_reassign.yaml'
  '/agents/bulk_unenroll':
    $ref: 'paths/agents@bulk_unenroll.yaml'
  '/agents/bulk_update_agent_tags':
    $ref: 'paths/agents@bulk_update_tags.yaml'
  /agents/tags:
    $ref: paths/agent_tags.yaml
  '/agents/{agentId}/request_diagnostics':
    $ref: 'paths/agents@{agent_id}@request_diagnostics.yaml'
  /agents/bulk_request_diagnostics:
    $ref: 'paths/agents@bulk_request_diagnostics.yaml'

  #  Agent policies endpoints
  /agent_policies:
    $ref: paths/agent_policies.yaml
  '/agent_policies/{agentPolicyId}':
    $ref: 'paths/agent_policies@{agent_policy_id}.yaml'
  '/agent_policies/{agentPolicyId}/copy':
    $ref: 'paths/agent_policies@{agent_policy_id}@copy.yaml'
  '/agent_policies/{agentPolicyId}/full':
    $ref: 'paths/agent_policies@{agent_policy_id}@full.yaml'
  '/agent_policies/{agentPolicyId}/download':
    $ref: 'paths/agent_policies@{agent_policy_id}@download.yaml'
  /agent_policies/_bulk_get:
    $ref: paths/agent_policies@_bulk_get.yaml
  /agent_policies/delete:
    $ref: paths/agent_policies@delete.yaml

  # Data streams endpoints
  /data_streams:
    $ref: paths/data_streams.yaml

  #  Enrollment endpoints
  /enrollment-api-keys:
    $ref: paths/enrollment_api_keys_deprecated.yaml
  '/enrollment-api-keys/{keyId}':
    $ref: 'paths/enrollment_api_keys@{key_id}_deprecated.yaml'
  /enrollment_api_keys:
    $ref: paths/enrollment_api_keys.yaml
  '/enrollment_api_keys/{keyId}':
    $ref: 'paths/enrollment_api_keys@{key_id}.yaml'

  #  Package policies endpoints
  /package_policies:
    $ref: paths/package_policies.yaml
  /package_policies/_bulk_get:
    $ref: paths/package_policies@_bulk_get.yaml
  /package_policies/delete:
    $ref: paths/package_policies@delete.yaml
  /package_policies/upgrade:
    $ref: paths/package_policies@upgrade.yaml
  /package_policies/upgrade/dryrun:
    $ref: paths/package_policies@upgrade_dryrun.yaml
  '/package_policies/{packagePolicyId}':
    $ref: 'paths/package_policies@{package_policy_id}.yaml'

  # Outputs
  /outputs:
    $ref: paths/outputs.yaml
  /outputs/{outputId}:
    $ref: paths/outputs@{output_id}.yaml
  /logstash_api_keys:
    $ref: paths/logstash_api_keys.yaml

  # Agent binary download sources
  /agent_download_sources:
    $ref: paths/agent_download_sources.yaml
  /agent_download_sources/{sourceId}:
    $ref: paths/agent_download_sources@{source_id}.yaml

  # Fleet server hosts
  /fleet_server_hosts:
    $ref: paths/fleet_server_hosts.yaml
  /fleet_server_hosts/{itemId}:
    $ref: paths/fleet_server_hosts@{item_id}.yaml

  # Fleet proxies
  /proxies:
    $ref: paths/proxies.yaml
  /proxies/{itemId}:
    $ref: paths/proxies@{item_id}.yaml

  # K8s
  /kubernetes:
    $ref: paths/kubernetes.yaml
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    Enrollment_API_Key:
      name: Authorization
      type: apiKey
      in: header
      description: 'e.g. Authorization: ApiKey base64EnrollmentApiKey'
    Access_API_Key:
      name: Authorization
      type: apiKey
      in: header
      description: 'e.g. Authorization: ApiKey base64AccessApiKey'
security:
  - basicAuth: []