fleet/server/api_endpoints/api_endpoints.yml

669 lines
21 KiB
YAML
Raw Normal View History

- 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"
- method: "POST"
path: "/api/v1/fleet/certificates"
display_name: "Create 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/spec/certificates"
display_name: "Apply certificate template specs"
- 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"
- 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/hosts/:id/macadmins"
display_name: "Get host macadmins data"
- method: "GET"
path: "/api/v1/fleet/macadmins"
display_name: "Get aggregated macadmins data"
- method: "GET"
path: "/api/v1/fleet/status/result_store"
display_name: "Get result store status"
- method: "GET"
path: "/api/v1/fleet/status/live_query"
display_name: "Get live query status"
- 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"
- 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"
- 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"
- 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: "POST"
path: "/api/v1/fleet/hosts/:id/clear_passcode"
display_name: "Clear host passcode"
- method: "POST"
path: "/api/v1/fleet/hosts/:id/recovery_lock_password/rotate"
display_name: "Rotate host recovery lock password"
- method: "POST"
path: "/api/v1/fleet/autofill/policy"
display_name: "Autofill policy"
- method: "PUT"
path: "/api/v1/fleet/spec/secret_variables"
display_name: "Create secret variables"
- method: "POST"
path: "/api/v1/fleet/custom_variables"
display_name: "Create custom variable"
- method: "GET"
path: "/api/v1/fleet/custom_variables"
display_name: "List custom variables"
- 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"