fleet/server/api_endpoints/api_endpoints.yml

- method: "GET"
  path: "/api/v1/fleet/activities"
  display_name: "List activities"
- method: "POST"
  path: "/api/v1/fleet/certificate_authorities"
  display_name: "Connect certificate authority (CA)"
- method: "POST"
  path: "/api/v1/fleet/certificates"
  display_name: "Add certificate template"
- method: "GET"
  path: "/api/v1/fleet/certificates"
  display_name: "List certificate templates"
- method: "GET"
  path: "/api/v1/fleet/certificates/:id"
  display_name: "Get certificate template"
- method: "DELETE"
  path: "/api/v1/fleet/certificates/:id"
  display_name: "Delete certificate template"
- method: "POST"
  path: "/api/v1/fleet/certificate_authorities/:id/request_certificate"
  display_name: "Request certificate"
- method: "GET"
  path: "/api/v1/fleet/conditional_access/idp/signing_cert"
  display_name: "Get Okta certificate"
- method: "GET"
  path: "/api/v1/fleet/conditional_access/idp/apple/profile"
  display_name: "Get Okta configuration profile"
- method: "DELETE"
  path: "/api/v1/fleet/conditional-access/microsoft"
  display_name: "Delete Microsoft Entra ID integration"
- method: "GET"
  path: "/api/v1/fleet/carves"
  display_name: "List carves"
- method: "GET"
  path: "/api/v1/fleet/carves/:id"
  display_name: "Get carve"
- method: "GET"
  path: "/api/v1/fleet/carves/:id/block/:block_id"
  display_name: "Get carve block"
- method: "GET"
  path: "/api/v1/fleet/config/certificate"
  display_name: "Get Fleet certificate"
- method: "PATCH"
  path: "/api/v1/fleet/config"
  display_name: "Updates Fleet configuration"
- method: "GET"
  path: "/api/v1/fleet/config"
  display_name: "Get Fleet configuration"
- method: "GET"
  path: "/api/v1/fleet/spec/enroll_secret"
  display_name: "Get global enroll secrets"
- method: "POST"
  path: "/api/v1/fleet/spec/enroll_secret"
  display_name: "Update global enroll secrets"
- method: "GET"
  path: "/api/v1/fleet/fleets/:id/secrets"
  display_name: "Get a fleet's enroll secrets"
- method: "PATCH"
  path: "/api/v1/fleet/fleets/:id/secrets"
  display_name: "Update a fleet's enroll secrets"
- method: "GET"
  path: "/api/v1/fleet/version"
  display_name: "Get Fleet version"
- method: "GET"
  path: "/api/v1/fleet/hosts"
  display_name: "List hosts"
- method: "GET"
  path: "/api/v1/fleet/hosts/count"
  display_name: "Count hosts"
- method: "GET"
  path: "/api/v1/fleet/host_summary"
  display_name: "Get hosts summary"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id"
  display_name: "Get host"
- method: "GET"
  path: "/api/v1/fleet/hosts/identifier/:identifier"
  display_name: "Get host by identifier"
- method: "GET"
  path: "/api/v1/fleet/device/:token"
  display_name: "Get host by Fleet Desktop token"
- method: "DELETE"
  path: "/api/v1/fleet/hosts/:id"
  display_name: "Delete host"
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/refetch"
  display_name: "Refetch host"
- method: "POST"
  path: "/api/v1/fleet/device/:token/refetch"
  display_name: "Refetch host by Fleet Desktop token"
- method: "POST"
  path: "/api/v1/fleet/hosts/transfer"
  display_name: "Update hosts' fleet"
- method: "POST"
  path: "/api/v1/fleet/hosts/transfer/filter"
  display_name: "Update hosts' fleet by filter"
- method: "DELETE"
  path: "/api/v1/fleet/hosts/:id/mdm"
  display_name: "Turn off host's MDM"
- method: "POST"
  path: "/api/v1/fleet/hosts/delete"
  display_name: "Batch-delete hosts"
- method: "PUT"
  path: "/api/v1/fleet/hosts/:id/device_mapping"
  display_name: "Update human-device mapping"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/health"
  display_name: "Get host's device health report"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/mdm"
  display_name: "Get host's mobile device management (MDM) information"
- method: "GET"
  path: "/api/v1/fleet/hosts/summary/mdm"
  display_name: "Get mobile device management (MDM) status"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/macadmins"
  display_name: "Get host's mobile device management (MDM) and Munki information"
- method: "GET"
  path: "/api/v1/fleet/macadmins"
  display_name: "Get hosts' aggregate mobile device management (MDM) and Munki information"
- method: "GET"
  path: "/api/v1/fleet/hosts/report"
  display_name: "Get hosts report in CSV"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/encryption_key"
  display_name: "Get host's disk encryption key"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/recovery_lock_password"
  display_name: "Get host's Recovery Lock password"
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/recovery_lock_password/rotate"
  display_name: "Rotate host's Recovery Lock password"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/certificates"
  display_name: "Get host's certificates"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/configuration_profiles"
  display_name: "Get host's OS settings (configuration profiles)"
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/lock"
  display_name: "Lock host"
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/unlock"
  display_name: "Unlock host"
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/wipe"
  display_name: "Wipe host"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/activities"
  display_name: "Get host's past activity"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/activities/upcoming"
  display_name: "Get host's upcoming activity"
- method: "DELETE"
  path: "/api/v1/fleet/hosts/:id/activities/upcoming/:activity_id"
  display_name: "Cancel host's upcoming activity"
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/labels"
  display_name: "Add labels to host"
- method: "DELETE"
  path: "/api/v1/fleet/hosts/:id/labels"
  display_name: "Remove labels from host"
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/query"
  display_name: "Run live query on host (ad hoc)"
- method: "POST"
  path: "/api/v1/fleet/hosts/identifier/:identifier/query"
  display_name: "Run live query on host by identifier (ad hoc)"
- method: "POST"
  path: "/api/v1/fleet/device/:token/bypass_conditional_access"
  display_name: "Bypass host's conditional access"
- method: "POST"
  path: "/api/v1/fleet/labels"
  display_name: "Create label"
- method: "PATCH"
  path: "/api/v1/fleet/labels/:id"
  display_name: "Update label"
- method: "GET"
  path: "/api/v1/fleet/labels/:id"
  display_name: "Get label"
- method: "GET"
  path: "/api/v1/fleet/labels/summary"
  display_name: "Get labels summary"
- method: "GET"
  path: "/api/v1/fleet/labels"
  display_name: "List labels"
- method: "GET"
  path: "/api/v1/fleet/labels/:id/hosts"
  display_name: "List label's hosts"
- method: "DELETE"
  path: "/api/v1/fleet/labels/:name"
  display_name: "Delete label by name"
- method: "DELETE"
  path: "/api/v1/fleet/labels/id/:id"
  display_name: "Delete label by ID"
- method: "GET"
  path: "/api/v1/fleet/configuration_profiles"
  display_name: "List configuration profiles"
- method: "GET"
  path: "/api/v1/fleet/mdm/apple/profiles"
  display_name: "List custom macOS settings (configuration profiles)"
  deprecated: true
- method: "GET"
  path: "/api/v1/fleet/configuration_profiles/:profile_uuid"
  display_name: "Get or download configuration profile"
- method: "GET"
  path: "/api/v1/fleet/mdm/apple/profiles/:profile_id"
  display_name: "Download custom macOS setting (configuration profile)"
  deprecated: true
- method: "DELETE"
  path: "/api/v1/fleet/configuration_profiles/:profile_uuid"
  display_name: "Delete configuration profile"
- method: "DELETE"
  path: "/api/v1/fleet/mdm/apple/profiles/:profile_id"
  display_name: "Delete custom macOS setting (configuration profile)"
  deprecated: true
- method: "POST"
  path: "/api/v1/fleet/hosts/:id/configuration_profiles/:profile_uuid/resend"
  display_name: "Resend configuration profile"
- method: "POST"
  path: "/api/v1/fleet/configuration_profiles/batch"
  display_name: "Batch-update configuration profiles"
- method: "POST"
  path: "/api/v1/fleet/device/:token/configuration_profiles/:profile_uuid/resend"
  display_name: "Resend configuration profile by Fleet Desktop token"
- method: "POST"
  path: "/api/v1/fleet/configuration_profiles/resend/batch"
  display_name: "Batch-resend configuration profile"
- method: "POST"
  path: "/api/v1/fleet/disk_encryption"
  display_name: "Update disk encryption enforcement"
- method: "PATCH"
  path: "/api/v1/fleet/mdm/apple/settings"
  display_name: "Update disk encryption enforcement"
  deprecated: true
- method: "GET"
  path: "/api/v1/fleet/disk_encryption"
  display_name: "Get disk encryption status"
- method: "GET"
  path: "/api/v1/fleet/configuration_profiles/summary"
  display_name: "Get OS settings (configuration profiles) status"
- method: "GET"
  path: "/api/v1/fleet/mdm/apple/profiles/summary"
  display_name: "Get macOS settings statistics"
  deprecated: true
- method: "POST"
  path: "/api/v1/fleet/enrollment_profiles/automatic"
  display_name: "Update custom MDM setup enrollment profile"
- method: "GET"
  path: "/api/v1/fleet/enrollment_profiles/automatic"
  display_name: "Get custom MDM setup enrollment profile"
- method: "DELETE"
  path: "/api/v1/fleet/enrollment_profiles/automatic"
  display_name: "Delete custom MDM setup enrollment profile"
- method: "GET"
  path: "/api/v1/fleet/enrollment_profiles/automatic/default"
  display_name: "Get default MDM setup enrollment profile"
- method: "GET"
  path: "/api/v1/fleet/enrollment_profiles/ota"
  display_name: "Get Over-the-Air (OTA) enrollment profile"
- method: "GET"
  path: "/api/v1/fleet/enrollment_profiles/manual"
  display_name: "Get manual enrollment profile"
- method: "POST"
  path: "/api/v1/fleet/bootstrap"
  display_name: "Create bootstrap package"
- method: "GET"
  path: "/api/v1/fleet/bootstrap/:fleet_id/metadata"
  display_name: "Get bootstrap package metadata"
- method: "DELETE"
  path: "/api/v1/fleet/bootstrap/:fleet_id"
  display_name: "Delete bootstrap package"
- method: "GET"
  path: "/api/v1/fleet/bootstrap"
  display_name: "Download bootstrap package"
- method: "GET"
  path: "/api/v1/fleet/bootstrap/summary"
  display_name: "Get bootstrap package status"
- method: "POST"
  path: "/api/v1/fleet/setup_experience/eula"
  display_name: "Create EULA"
- method: "GET"
  path: "/api/v1/fleet/setup_experience/eula/metadata"
  display_name: "Get EULA metadata"
- method: "DELETE"
  path: "/api/v1/fleet/setup_experience/eula/:token"
  display_name: "Delete EULA"
- method: "GET"
  path: "/api/v1/fleet/setup_experience/eula/:token"
  display_name: "Download EULA"
- method: "GET"
  path: "/api/v1/fleet/setup_experience/software"
  display_name: "List setup experience software"
- method: "PUT"
  path: "/api/v1/fleet/setup_experience/software"
  display_name: "Update setup experience software"
- method: "POST"
  path: "/api/v1/fleet/setup_experience/script"
  display_name: "Create setup experience script"
- method: "GET"
  path: "/api/v1/fleet/setup_experience/script"
  display_name: "Get or download setup experience script"
- method: "DELETE"
  path: "/api/v1/fleet/setup_experience/script"
  display_name: "Delete setup experience script"
- method: "POST"
  path: "/api/v1/fleet/commands/run"
  display_name: "Run MDM command"
- method: "POST"
  path: "/api/v1/fleet/mdm/apple/enqueue"
  display_name: "Run custom MDM command"
  deprecated: true
- method: "GET"
  path: "/api/v1/fleet/commands/results"
  display_name: "Get MDM command results"
- method: "GET"
  path: "/api/v1/fleet/mdm/apple/commandresults"
  display_name: "Get custom MDM command results"
  deprecated: true
- method: "GET"
  path: "/api/v1/fleet/commands"
  display_name: "List MDM commands"
- method: "GET"
  path: "/api/v1/fleet/mdm/apple/commands"
  display_name: "List custom MDM commands"
  deprecated: true
- method: "GET"
  path: "/api/v1/fleet/apns"
  display_name: "Get APNs certificate"
- method: "GET"
  path: "/api/v1/fleet/abm_tokens"
  display_name: "List Apple Business Manager (ABM) tokens"
- method: "GET"
  path: "/api/v1/fleet/vpp_tokens"
  display_name: "List Volume Purchasing Program (VPP) tokens"
- method: "GET"
  path: "/api/v1/fleet/scim/details"
  display_name: "Get identity provider (IdP) details"
- method: "GET"
  path: "/api/v1/fleet/global/policies"
  display_name: "List policies"
- method: "GET"
  path: "/api/v1/fleet/fleets/:id/policies"
  display_name: "List a fleet's policies"
- method: "GET"
  path: "/api/v1/fleet/policies/count"
  display_name: "Get policies count"
- method: "GET"
  path: "/api/v1/fleet/fleets/:fleet_id/policies/count"
  display_name: "Get a fleet's policies count"
- method: "GET"
  path: "/api/v1/fleet/global/policies/:id"
  display_name: "Get policy"
- method: "GET"
  path: "/api/v1/fleet/fleets/:fleet_id/policies/:policy_id"
  display_name: "Get a fleet's policy"
- method: "POST"
  path: "/api/v1/fleet/global/policies"
  display_name: "Create policy"
- method: "POST"
  path: "/api/v1/fleet/global/policies/delete"
  display_name: "Delete policies"
- method: "POST"
  path: "/api/v1/fleet/fleets/:fleet_id/policies/delete"
  display_name: "Delete a fleet's policies"
- method: "PATCH"
  path: "/api/v1/fleet/global/policies/:id"
  display_name: "Update policy"
- method: "POST"
  path: "/api/v1/fleet/automations/reset"
  display_name: "Reset policy automations"
- method: "GET"
  path: "/api/v1/fleet/reports"
  display_name: "List reports"
- method: "GET"
  path: "/api/v1/fleet/reports/:id"
  display_name: "Get report"
- method: "GET"
  path: "/api/v1/fleet/reports/:id/report"
  display_name: "Get report data"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/reports/:report_id"
  display_name: "Get host's report data"
- method: "POST"
  path: "/api/v1/fleet/reports"
  display_name: "Create report"
- method: "PATCH"
  path: "/api/v1/fleet/reports/:id"
  display_name: "Update report"
- method: "DELETE"
  path: "/api/v1/fleet/reports/:name"
  display_name: "Delete report by name"
- method: "DELETE"
  path: "/api/v1/fleet/reports/id/:id"
  display_name: "Delete report by ID"
- method: "POST"
  path: "/api/v1/fleet/reports/delete"
  display_name: "Delete reports"
- method: "POST"
  path: "/api/v1/fleet/reports/:id/run"
  display_name: "Run live report"
- method: "GET"
  path: "/api/v1/fleet/queries/run"
  display_name: "Run live report"
  deprecated: true
- method: "POST"
  path: "/api/v1/fleet/scripts/run"
  display_name: "Run script"
- method: "GET"
  path: "/api/v1/fleet/scripts/results/:execution_id"
  display_name: "Get script result"
- method: "POST"
  path: "/api/v1/fleet/scripts/batch"
  display_name: "Batch-run script"
- method: "POST"
  path: "/api/v1/fleet/scripts/run/batch"
  display_name: "Batch-run script"
- method: "GET"
  path: "/api/v1/fleet/scripts/batch"
  display_name: "List batch scripts"
- method: "GET"
  path: "/api/v1/fleet/scripts/batch/:batch_execution_id"
  display_name: "Get batch script"
- method: "GET"
  path: "/api/v1/fleet/scripts/batch/:batch_execution_id/host_results"
  display_name: "List hosts targeted in batch script"
- method: "POST"
  path: "/api/v1/fleet/scripts"
  display_name: "Create script"
- method: "PATCH"
  path: "/api/v1/fleet/scripts/:id"
  display_name: "Update script"
- method: "DELETE"
  path: "/api/v1/fleet/scripts/:id"
  display_name: "Delete script"
- method: "GET"
  path: "/api/v1/fleet/scripts"
  display_name: "List scripts"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/software"
  display_name: "List host's software"
- method: "GET"
  path: "/api/v1/fleet/hosts/:id/scripts"
  display_name: "List host's scripts"
- method: "GET"
  path: "/api/v1/fleet/scripts/:id"
  display_name: "Get or download script"
- method: "GET"
  path: "/api/v1/fleet/sessions/:id"
  display_name: "Get session"
- method: "DELETE"
  path: "/api/v1/fleet/sessions/:id"
  display_name: "Delete session"
- method: "GET"
  path: "/api/v1/fleet/software/titles"
  display_name: "List software titles"
- method: "GET"
  path: "/api/v1/fleet/software/titles/:id"
  display_name: "Get software title"
- method: "GET"
  path: "/api/v1/fleet/software/versions"
  display_name: "List software versions"
- method: "GET"
  path: "/api/v1/fleet/os_versions"
  display_name: "List operating systems"
- method: "GET"
  path: "/api/v1/fleet/software/versions/:id"
  display_name: "Get software version"
- method: "GET"
  path: "/api/v1/fleet/os_versions/:id"
  display_name: "Get operating system version"
- method: "GET"
  path: "/api/v1/fleet/vulnerabilities"
  display_name: "List vulnerabilities"
- method: "GET"
  path: "/api/v1/fleet/vulnerabilities/:cve"
  display_name: "Get vulnerability"
- method: "POST"
  path: "/api/v1/fleet/targets"
  display_name: "Search targets"
- method: "GET"
  path: "/api/v1/fleet/fleets"
  display_name: "List fleets"
- method: "GET"
  path: "/api/v1/fleet/fleets/:id"
  display_name: "Get a fleet"
- method: "POST"
  path: "/api/v1/fleet/fleets"
  display_name: "Create a fleet"
- method: "PATCH"
  path: "/api/v1/fleet/fleets/:id"
  display_name: "Update a fleet"
- method: "POST"
  path: "/api/v1/fleet/fleets/:id/agent_options"
  display_name: "Update a fleet's agent options"
- method: "DELETE"
  path: "/api/v1/fleet/fleets/:id"
  display_name: "Delete a fleet"
- method: "POST"
  path: "/api/v1/fleet/translate"
  display_name: "Translate IDs"
- method: "GET"
  path: "/api/v1/fleet/users"
  display_name: "List users"
- method: "GET"
  path: "/api/v1/fleet/users/:id"
  display_name: "Get user"
- method: "GET"
  path: "/api/v1/fleet/custom_variables"
  display_name: "List custom variables"
- method: "POST"
  path: "/api/v1/fleet/custom_variables"
  display_name: "Create custom variable"
- method: "DELETE"
  path: "/api/v1/fleet/custom_variables/:id"
  display_name: "Delete custom variable"
- method: "GET"
  path: "/api/v1/fleet/configuration_profiles/:profile_uuid/status"
  display_name: "Get OS setting (configuration profile) status"
- method: "GET"
  path: "/api/v1/fleet/me"
  display_name: "Get current user"
- method: "GET"
  path: "/api/v1/fleet/spec/labels"
  display_name: "Get labels spec"
- method: "POST"
  path: "/api/v1/fleet/spec/labels"
  display_name: "Apply labels spec"
- method: "GET"
  path: "/api/v1/fleet/abm_tokens/count"
  display_name: "Count Apple Business Manager (ABM) tokens"
- method: "GET"
  path: "/api/v1/fleet/spec/certificate_authorities"
  display_name: "Get certificate authorities spec"
- method: "POST"
  path: "/api/v1/fleet/spec/certificate_authorities"
  display_name: "Batch-apply certificate authorities"
- method: "POST"
  path: "/api/v1/fleet/spec/certificates"
  display_name: "Apply certificate templates spec"
- method: "DELETE"
  path: "/api/v1/fleet/spec/certificates"
  display_name: "Delete certificate templates spec"
- method: "PUT"
  path: "/api/v1/fleet/spec/secret_variables"
  display_name: "Save secret variables"
- method: "POST"
  path: "/api/v1/fleet/spec/reports"
  display_name: "Apply reports spec"
- method: "POST"
  path: "/api/v1/fleet/spec/policies"
  display_name: "Apply policies spec"
- method: "POST"
  path: "/api/v1/fleet/spec/fleets"
  display_name: "Batch-apply fleets spec"
- method: "GET"
  path: "/api/v1/fleet/policies"
  display_name: "List policies"
- method: "POST"
  path: "/api/v1/fleet/policies/delete"
  display_name: "Delete policies"
- method: "POST"
  path: "/api/v1/fleet/mdm/profiles/batch"
  display_name: "Batch-apply MDM configuration profiles"
- method: "GET"
  path: "/api/v1/fleet/mdm/profiles/:profile_uuid"
  display_name: "Download MDM configuration profile"
  deprecated: true
- method: "GET"
  path: "/api/v1/fleet/mdm/bootstrap/:fleet_id/metadata"
  display_name: "Get MDM bootstrap package metadata"
- method: "DELETE"
  path: "/api/v1/fleet/mdm/bootstrap/:fleet_id"
  display_name: "Delete MDM bootstrap package"
- method: "POST"
  path: "/api/v1/fleet/software/batch"
  display_name: "Batch-apply software installers"
- method: "GET"
  path: "/api/v1/fleet/software/batch/:request_uuid"
  display_name: "Get batch software installers result"
- method: "POST"
  path: "/api/v1/fleet/software/app_store_apps/batch"
  display_name: "Batch-associate App Store apps"
- method: "GET"
  path: "/api/v1/fleet/software/fleet_maintained_apps"
  display_name: "List Fleet-maintained apps"
- method: "GET"
  path: "/api/v1/fleet/software/fleet_maintained_apps/:app_id"
  display_name: "Get Fleet-maintained app"
- method: "GET"
  path: "/api/v1/fleet/software/titles/:title_id/icon"
  display_name: "Get software title icon"
- method: "PUT"
  path: "/api/v1/fleet/software/titles/:title_id/icon"
  display_name: "Upload or update software title icon"
- method: "DELETE"
  path: "/api/v1/fleet/software/titles/:title_id/icon"
  display_name: "Delete software title icon"