diff --git a/server/api_endpoints/api_endpoints.yml b/server/api_endpoints/api_endpoints.yml index bd75d3ba5d..c28d3287e1 100644 --- a/server/api_endpoints/api_endpoints.yml +++ b/server/api_endpoints/api_endpoints.yml @@ -1,153 +1,12 @@ +- method: "GET" + path: "/api/v1/fleet/activities" + display_name: "List activities" - method: "POST" - path: "/api/v1/fleet/trigger" - display_name: "Trigger scheduled tasks" -- method: "GET" - path: "/api/v1/fleet/me" - display_name: "Get current user" -- method: "GET" - path: "/api/v1/fleet/sessions/:id" - display_name: "Get session info" -- method: "DELETE" - path: "/api/v1/fleet/sessions/:id" - display_name: "Delete session" -- method: "GET" - path: "/api/v1/fleet/config/certificate" - display_name: "Get config certificate" -- method: "GET" - path: "/api/v1/fleet/config" - display_name: "Get app config" -- method: "PATCH" - path: "/api/v1/fleet/config" - display_name: "Modify app config" -- method: "POST" - path: "/api/v1/fleet/spec/enroll_secret" - display_name: "Apply enroll secret spec" -- method: "GET" - path: "/api/v1/fleet/spec/enroll_secret" - display_name: "Get enroll secret spec" -- method: "GET" - path: "/api/v1/fleet/version" - display_name: "Get version" -- method: "POST" - path: "/api/v1/fleet/translate" - display_name: "Translate" -- method: "POST" - path: "/api/v1/fleet/spec/fleets" - display_name: "Apply fleet specs" -- method: "PATCH" - path: "/api/v1/fleet/fleets/:fleet_id/secrets" - display_name: "Modify fleet enroll secrets" -- method: "POST" - path: "/api/v1/fleet/fleets" - display_name: "Create fleet" -- method: "GET" - path: "/api/v1/fleet/fleets" - display_name: "List fleets" -- method: "GET" - path: "/api/v1/fleet/fleets/:id" - display_name: "Get fleet" -- method: "PATCH" - path: "/api/v1/fleet/fleets/:id" - display_name: "Modify fleet" -- method: "DELETE" - path: "/api/v1/fleet/fleets/:id" - display_name: "Delete fleet" -- method: "POST" - path: "/api/v1/fleet/fleets/:id/agent_options" - display_name: "Modify fleet agent options" -- method: "GET" - path: "/api/v1/fleet/fleets/:id/users" - display_name: "List fleet users" -- method: "GET" - path: "/api/v1/fleet/users" - display_name: "List users" -- method: "GET" - path: "/api/v1/fleet/users/:id" - display_name: "Get user" -- method: "POST" - path: "/api/v1/fleet/targets" - display_name: "Search targets" - deprecated: true -- method: "POST" - path: "/api/v1/fleet/targets/count" - display_name: "Count targets" -- method: "POST" - path: "/api/v1/fleet/invites" - display_name: "Create invite" -- method: "GET" - path: "/api/v1/fleet/invites" - display_name: "List invites" -- method: "DELETE" - path: "/api/v1/fleet/invites/:id" - display_name: "Delete invite" -- method: "PATCH" - path: "/api/v1/fleet/invites/:id" - display_name: "Update invite" -- method: "POST" - path: "/api/v1/fleet/global/policies" - display_name: "Create global policy" - deprecated: true -- method: "POST" - path: "/api/v1/fleet/policies" - display_name: "Create policy" -- method: "GET" - path: "/api/v1/fleet/global/policies" - display_name: "List global policies" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/policies" - display_name: "List policies" -- method: "GET" - path: "/api/v1/fleet/policies/count" - display_name: "Count policies" -- method: "GET" - path: "/api/v1/fleet/global/policies/:policy_id" - display_name: "Get global policy" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/policies/:policy_id" - display_name: "Get policy" -- method: "POST" - path: "/api/v1/fleet/global/policies/delete" - display_name: "Delete global policies" - deprecated: true -- method: "POST" - path: "/api/v1/fleet/policies/delete" - display_name: "Delete policies" -- method: "PATCH" - path: "/api/v1/fleet/global/policies/:policy_id" - display_name: "Modify global policy" - deprecated: true -- method: "PATCH" - path: "/api/v1/fleet/policies/:policy_id" - display_name: "Modify policy" -- method: "POST" - path: "/api/v1/fleet/automations/reset" - display_name: "Reset automations" -- method: "POST" - path: "/api/v1/fleet/fleets/:fleet_id/policies" - display_name: "Create fleet policy" -- method: "GET" - path: "/api/v1/fleet/fleets/:fleet_id/policies" - display_name: "List fleet policies" -- method: "GET" - path: "/api/v1/fleet/fleets/:fleet_id/policies/count" - display_name: "Count fleet policies" -- method: "GET" - path: "/api/v1/fleet/fleets/:fleet_id/policies/:policy_id" - display_name: "Get fleet policy" -- method: "POST" - path: "/api/v1/fleet/fleets/:fleet_id/policies/delete" - display_name: "Delete fleet policies" -- method: "PATCH" - path: "/api/v1/fleet/fleets/:fleet_id/policies/:policy_id" - display_name: "Modify fleet policy" -- method: "POST" - path: "/api/v1/fleet/spec/policies" - display_name: "Apply policy specs" + path: "/api/v1/fleet/certificate_authorities" + display_name: "Connect certificate authority (CA)" - method: "POST" path: "/api/v1/fleet/certificates" - display_name: "Create certificate template" + display_name: "Add certificate template" - method: "GET" path: "/api/v1/fleet/certificates" display_name: "List certificate templates" @@ -158,379 +17,17 @@ path: "/api/v1/fleet/certificates/:id" display_name: "Delete certificate template" - method: "POST" - path: "/api/v1/fleet/spec/certificates" - display_name: "Apply certificate template specs" + 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/spec/certificates" - display_name: "Delete certificate template specs" -- method: "GET" - path: "/api/v1/fleet/reports/:id" - display_name: "Get report" -- method: "GET" - path: "/api/v1/fleet/reports" - display_name: "List reports" -- method: "GET" - path: "/api/v1/fleet/reports/:id/report" - display_name: "Get report results" -- method: "POST" - path: "/api/v1/fleet/reports" - display_name: "Create report" -- method: "PATCH" - path: "/api/v1/fleet/reports/:id" - display_name: "Modify report" -- method: "DELETE" - path: "/api/v1/fleet/reports/:name" - display_name: "Delete report" -- 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/spec/reports" - display_name: "Apply report specs" -- method: "GET" - path: "/api/v1/fleet/spec/reports" - display_name: "Get report specs" -- method: "GET" - path: "/api/v1/fleet/spec/reports/:name" - display_name: "Get report spec" -- method: "GET" - path: "/api/v1/fleet/packs/:id" - display_name: "Get pack" -- method: "POST" - path: "/api/v1/fleet/packs" - display_name: "Create pack" -- method: "PATCH" - path: "/api/v1/fleet/packs/:id" - display_name: "Modify pack" -- method: "GET" - path: "/api/v1/fleet/packs" - display_name: "List packs" -- method: "DELETE" - path: "/api/v1/fleet/packs/:name" - display_name: "Delete pack" -- method: "DELETE" - path: "/api/v1/fleet/packs/id/:id" - display_name: "Delete pack by ID" -- method: "POST" - path: "/api/v1/fleet/spec/packs" - display_name: "Apply pack specs" -- method: "GET" - path: "/api/v1/fleet/spec/packs" - display_name: "Get pack specs" -- method: "GET" - path: "/api/v1/fleet/spec/packs/:name" - display_name: "Get pack spec" -- method: "GET" - path: "/api/v1/fleet/software/versions" - display_name: "List software versions" -- method: "GET" - path: "/api/v1/fleet/software/versions/:id" - display_name: "Get software version" -- method: "GET" - path: "/api/v1/fleet/software" - display_name: "List software" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/software/:id" - display_name: "Get software" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/software/count" - display_name: "Count software" - deprecated: true -- 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: "POST" - path: "/api/v1/fleet/hosts/:host_id/software/:software_title_id/install" - display_name: "Install software" -- method: "POST" - path: "/api/v1/fleet/hosts/:host_id/software/:software_title_id/uninstall" - display_name: "Uninstall software" -- method: "GET" - path: "/api/v1/fleet/software/titles/:title_id/package" - display_name: "Get software installer" -- method: "POST" - path: "/api/v1/fleet/software/titles/:title_id/package/token" - display_name: "Get software installer token" -- method: "POST" - path: "/api/v1/fleet/software/package" - display_name: "Upload software installer" -- method: "PATCH" - path: "/api/v1/fleet/software/titles/:id/name" - display_name: "Update software name" -- method: "PATCH" - path: "/api/v1/fleet/software/titles/:id/package" - display_name: "Update software installer" -- method: "DELETE" - path: "/api/v1/fleet/software/titles/:title_id/available_for_install" - display_name: "Delete software installer" -- method: "GET" - path: "/api/v1/fleet/software/install/:install_uuid/results" - display_name: "Get software install results" -- method: "POST" - path: "/api/v1/fleet/software/batch" - display_name: "Batch set software installers" -- method: "GET" - path: "/api/v1/fleet/software/batch/:request_uuid" - display_name: "Get batch software installers result" -- 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: "Set software title icon" -- method: "DELETE" - path: "/api/v1/fleet/software/titles/:title_id/icon" - display_name: "Delete software title icon" -- method: "GET" - path: "/api/v1/fleet/software/app_store_apps" - display_name: "Get app store apps" -- method: "POST" - path: "/api/v1/fleet/software/app_store_apps" - display_name: "Add app store app" -- method: "PATCH" - path: "/api/v1/fleet/software/titles/:title_id/app_store_app" - display_name: "Update app store app" -- method: "PUT" - path: "/api/v1/fleet/setup_experience/software" - display_name: "Set setup experience software" -- method: "GET" - path: "/api/v1/fleet/setup_experience/software" - display_name: "Get setup experience software" -- method: "GET" - path: "/api/v1/fleet/setup_experience/script" - display_name: "Get setup experience script" -- method: "POST" - path: "/api/v1/fleet/setup_experience/script" - display_name: "Set setup experience script" -- method: "DELETE" - path: "/api/v1/fleet/setup_experience/script" - display_name: "Delete setup experience script" -- method: "POST" - path: "/api/v1/fleet/software/fleet_maintained_apps" - display_name: "Add fleet-maintained app" -- 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/vulnerabilities" - display_name: "List vulnerabilities" -- method: "GET" - path: "/api/v1/fleet/vulnerabilities/:cve" - display_name: "Get vulnerability" -- method: "GET" - path: "/api/v1/fleet/host_summary" - display_name: "Get host summary" -- method: "GET" - path: "/api/v1/fleet/hosts" - display_name: "List hosts" -- method: "POST" - path: "/api/v1/fleet/hosts/delete" - display_name: "Delete hosts" -- method: "GET" - path: "/api/v1/fleet/hosts/:id" - display_name: "Get host" -- method: "GET" - path: "/api/v1/fleet/hosts/count" - display_name: "Count hosts" -- method: "POST" - path: "/api/v1/fleet/hosts/search" - display_name: "Search hosts" -- method: "GET" - path: "/api/v1/fleet/hosts/identifier/:identifier" - display_name: "Get host by identifier" -- method: "POST" - path: "/api/v1/fleet/hosts/identifier/:identifier/query" - display_name: "Run live query on host by identifier" -- method: "POST" - path: "/api/v1/fleet/hosts/:id/query" - display_name: "Run live query on host" -- method: "DELETE" - path: "/api/v1/fleet/hosts/:id" - display_name: "Delete host" -- method: "POST" - path: "/api/v1/fleet/hosts/transfer" - display_name: "Transfer hosts to a team" -- method: "POST" - path: "/api/v1/fleet/hosts/transfer/filter" - display_name: "Transfer hosts to a team by filter" -- method: "POST" - path: "/api/v1/fleet/hosts/:id/refetch" - display_name: "Refetch host" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/device_mapping" - display_name: "List host device mapping" - deprecated: true -- method: "PUT" - path: "/api/v1/fleet/hosts/:id/device_mapping" - display_name: "Set host device mapping" -- method: "DELETE" - path: "/api/v1/fleet/hosts/:id/device_mapping/idp" - display_name: "Delete host IDP mapping" -- method: "GET" - path: "/api/v1/fleet/hosts/report" - display_name: "Get hosts report" -- method: "GET" - path: "/api/v1/fleet/os_versions" - display_name: "List OS versions" -- method: "GET" - path: "/api/v1/fleet/os_versions/:id" - display_name: "Get OS version" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/reports/:report_id" - display_name: "Get host report" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/reports" - display_name: "List host reports" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/queries" - display_name: "List host queries" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/hosts/:id/health" - display_name: "Get host health" -- 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: "GET" - path: "/api/v1/fleet/hosts/:id/software" - display_name: "Get host software" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/certificates" - display_name: "List host certificates" -- method: "POST" - path: "/api/v1/fleet/hosts/:id/certificates/:template_id/resend" - display_name: "Resend host certificate" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/recovery_lock_password" - display_name: "Get host recovery lock password" -- method: "GET" - path: "/api/v1/fleet/hosts/summary/mdm" - display_name: "Get host MDM summary" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/mdm" - display_name: "Get host MDM" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/dep_assignment" - display_name: "Get host DEP assignment" -- method: "POST" - path: "/api/v1/fleet/labels" - display_name: "Create label" -- method: "PATCH" - path: "/api/v1/fleet/labels/:id" - display_name: "Modify label" -- method: "GET" - path: "/api/v1/fleet/labels/:id" - display_name: "Get label" -- method: "GET" - path: "/api/v1/fleet/labels" - display_name: "List labels" -- method: "GET" - path: "/api/v1/fleet/labels/summary" - display_name: "Get labels summary" -- method: "GET" - path: "/api/v1/fleet/labels/:id/hosts" - display_name: "List hosts in label" -- method: "DELETE" - path: "/api/v1/fleet/labels/:name" - display_name: "Delete label" -- method: "DELETE" - path: "/api/v1/fleet/labels/id/:id" - display_name: "Delete label by ID" -- method: "POST" - path: "/api/v1/fleet/spec/labels" - display_name: "Apply label specs" -- method: "GET" - path: "/api/v1/fleet/spec/labels" - display_name: "Get label specs" -- method: "GET" - path: "/api/v1/fleet/spec/labels/:name" - display_name: "Get label spec" -- method: "POST" - path: "/api/v1/fleet/reports/:id/run" - display_name: "Run live query" -- method: "GET" - path: "/api/v1/fleet/reports/run" - display_name: "Run live query" - deprecated: true -- method: "POST" - path: "/api/v1/fleet/reports/run" - display_name: "Create distributed query campaign" -- method: "POST" - path: "/api/v1/fleet/reports/run_by_identifiers" - display_name: "Create distributed query campaign by identifier" -- method: "POST" - path: "/api/v1/fleet/reports/run_by_names" - display_name: "Create distributed query campaign by names" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/packs/:id/scheduled" - display_name: "Get scheduled queries in pack" -- method: "POST" - path: "/api/v1/fleet/packs/schedule" - display_name: "Schedule query" -- method: "GET" - path: "/api/v1/fleet/schedule/:id" - display_name: "Get scheduled query" -- method: "PATCH" - path: "/api/v1/fleet/packs/schedule/:id" - display_name: "Modify scheduled query" -- method: "DELETE" - path: "/api/v1/fleet/packs/schedule/:id" - display_name: "Delete scheduled query" -- method: "GET" - path: "/api/v1/fleet/schedule" - display_name: "Get global schedule" -- method: "POST" - path: "/api/v1/fleet/schedule" - display_name: "Add query to global schedule" -- method: "PATCH" - path: "/api/v1/fleet/schedule/:id" - display_name: "Modify global scheduled query" -- method: "DELETE" - path: "/api/v1/fleet/schedule/:id" - display_name: "Delete global scheduled query" -- method: "GET" - path: "/api/v1/fleet/global/schedule" - display_name: "Get global schedule" - deprecated: true -- method: "POST" - path: "/api/v1/fleet/global/schedule" - display_name: "Add query to global schedule" - deprecated: true -- method: "PATCH" - path: "/api/v1/fleet/global/schedule/:id" - display_name: "Modify global scheduled query" - deprecated: true -- method: "DELETE" - path: "/api/v1/fleet/global/schedule/:id" - display_name: "Delete global scheduled query" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/fleets/:fleet_id/schedule" - display_name: "Get fleet schedule" -- method: "POST" - path: "/api/v1/fleet/fleets/:fleet_id/schedule" - display_name: "Add query to fleet schedule" -- method: "PATCH" - path: "/api/v1/fleet/fleets/:fleet_id/schedule/:report_id" - display_name: "Modify fleet scheduled query" -- method: "DELETE" - path: "/api/v1/fleet/fleets/:fleet_id/schedule/:report_id" - display_name: "Delete fleet scheduled query" + 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" @@ -540,77 +37,102 @@ - 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: "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 macadmins data" + display_name: "Get host's mobile device management (MDM) and Munki information" - method: "GET" path: "/api/v1/fleet/macadmins" - display_name: "Get aggregated macadmins data" + display_name: "Get hosts' aggregate mobile device management (MDM) and Munki information" - method: "GET" - path: "/api/v1/fleet/status/result_store" - display_name: "Get result store status" + path: "/api/v1/fleet/hosts/report" + display_name: "Get hosts report in CSV" - method: "GET" - path: "/api/v1/fleet/status/live_query" - display_name: "Get live query status" + 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/scripts/run" - display_name: "Run script" -- method: "POST" - path: "/api/v1/fleet/scripts/run/sync" - display_name: "Run script sync" -- method: "POST" - path: "/api/v1/fleet/scripts/run/batch" - display_name: "Batch run scripts" + path: "/api/v1/fleet/hosts/:id/recovery_lock_password/rotate" + display_name: "Rotate host's Recovery Lock password" - method: "GET" - path: "/api/v1/fleet/scripts/results/:execution_id" - display_name: "Get script results" -- method: "POST" - path: "/api/v1/fleet/scripts" - display_name: "Create script" + path: "/api/v1/fleet/hosts/:id/certificates" + display_name: "Get host's certificates" - method: "GET" - path: "/api/v1/fleet/scripts" - display_name: "List scripts" -- method: "GET" - path: "/api/v1/fleet/scripts/:script_id" - display_name: "Get script" -- method: "PATCH" - path: "/api/v1/fleet/scripts/:script_id" - display_name: "Update script" -- method: "DELETE" - path: "/api/v1/fleet/scripts/:script_id" - display_name: "Delete script" -- method: "POST" - path: "/api/v1/fleet/scripts/batch" - display_name: "Batch set scripts" -- method: "POST" - path: "/api/v1/fleet/scripts/batch/:batch_execution_id/cancel" - display_name: "Cancel batch script execution" -- method: "GET" - path: "/api/v1/fleet/scripts/batch/summary/:batch_execution_id" - display_name: "Get batch script execution summary" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/scripts/batch/:batch_execution_id/host_results" - display_name: "Get batch script host results" -- method: "GET" - path: "/api/v1/fleet/scripts/batch/:batch_execution_id/host-results" - display_name: "Get batch script host results" - deprecated: true -- method: "GET" - path: "/api/v1/fleet/scripts/batch/:batch_execution_id" - display_name: "Get batch script execution status" -- method: "GET" - path: "/api/v1/fleet/scripts/batch" - display_name: "List batch script executions" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/scripts" - display_name: "Get host script details" -- method: "GET" - path: "/api/v1/fleet/hosts/:id/activities/upcoming" - display_name: "List host upcoming activities" -- method: "DELETE" - path: "/api/v1/fleet/hosts/:id/activities/upcoming/:activity_id" - display_name: "Cancel host upcoming activity" + 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" @@ -620,49 +142,366 @@ - 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/clear_passcode" - display_name: "Clear host passcode" + 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/recovery_lock_password/rotate" - display_name: "Rotate host recovery lock password" + path: "/api/v1/fleet/hosts/:id/query" + display_name: "Run live query on host (ad hoc)" - method: "POST" - path: "/api/v1/fleet/autofill/policy" - display_name: "Autofill policy" + 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: "POST" + path: "/api/v1/fleet/recovery_lock_password" + display_name: "Update Recovery Lock enforcement" +- 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: "GET" + path: "/api/v1/fleet/configuration_profile/:profile_uuid/status" + display_name: "Get OS setting (configuration profile) status" +- 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/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/spec/secret_variables" - display_name: "Create secret variables" + path: "/api/v1/fleet/setup_experience/software" + display_name: "Update setup experience software" - method: "POST" - path: "/api/v1/fleet/custom_variables" - display_name: "Create custom variable" + path: "/api/v1/fleet/setup_experience/script" + display_name: "Create setup experience script" +- method: "PUT" + path: "/api/v1/fleet/setup_experience/script" + display_name: "Update 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/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/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/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/scim/details" - display_name: "Get SCIM details" -- method: "POST" - path: "/api/v1/fleet/conditional-access/microsoft" - display_name: "Create Microsoft conditional access" -- method: "POST" - path: "/api/v1/fleet/conditional-access/microsoft/confirm" - display_name: "Confirm Microsoft conditional access" -- method: "DELETE" - path: "/api/v1/fleet/conditional-access/microsoft" - display_name: "Delete Microsoft conditional access" -- method: "GET" - path: "/api/v1/fleet/conditional_access/idp/signing_cert" - display_name: "Get IdP signing certificate" -- method: "GET" - path: "/api/v1/fleet/conditional_access/idp/apple/profile" - display_name: "Get IdP Apple profile" -- method: "PATCH" - path: "/api/v1/fleet/mdm/apple/setup" - display_name: "Update MDM Apple setup" - deprecated: true -- method: "PATCH" - path: "/api/v1/fleet/setup_experience" - display_name: "Update setup experience"