Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 18 Packages Projects Releases Wiki Activity

Docs: Mark remaining experimental endpoints/parameters as stable (#47848)

Browse Source 
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Summary by CodeRabbit

* **`api_endpoints.yml`**
* Added new Fleet API documentation entries for creating configuration
profiles and updating setup experience.
  * Added documentation for creating Android web apps.
* Expanded Android Enterprise coverage by adding a new “Get Android
Enterprise” entry (kept disabled).
* Added complete documentation for certificate authority management,
including list, retrieve, update, and delete.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Rachael Shaw
2026-06-18 13:48:07 -05:00
committed by GitHub
parent 651d591b53
commit ad22a31d96
2 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST API/rest-api.md
-16
View File
@@ -797,8 +797,6 @@ Add a certificate template to deploy a certificate to all hosts on the fleet. Fl
### Update certificate authority (CA)
> **Experimental feature**. This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
`PATCH /api/v1/fleet/certificate_authorities/:id`
When editing a CA, specify one object and only its fields that you want to update.
@@ -837,8 +835,6 @@ See [Connect certificate authority](#connect-certificate-authority-ca) above for
### List certificate authorities (CAs)
> **Experimental feature**. This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
`GET /api/v1/fleet/certificate_authorities`
#### Example
@@ -893,8 +889,6 @@ See [Connect certificate authority](#connect-certificate-authority-ca) above for
### Get certificate authority (CA)
> **Experimental feature**. This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
Get details of the certificate authority.
`GET /api/v1/fleet/certificate_authorities/:id`
@@ -1081,8 +1075,6 @@ Authorization: Bearer sunVIQ+wqYQvJlXf1aqYTt8LrlUGKBigNdWmdH5bhT1MH
### Delete certificate authority (CA)
> **Experimental feature**. This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
When the CA is deleted, the issued certificates will remain on existing hosts.
`DELETE /api/v1/fleet/certificate_authorities/:id`
@@ -6563,8 +6555,6 @@ Deletes the label specified by ID.
### Create configuration profile
> **Experimental feature**. Deploying Windows SCEP profile is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
> [Add custom macOS setting](https://github.com/fleetdm/fleet/blob/fleet-v4.40.0/docs/REST%20API/rest-api.md#add-custom-macos-setting-configuration-profile) (`POST /api/v1/fleet/mdm/apple/profiles`) API endpoint is deprecated as of Fleet 4.41. It is maintained for backwards compatibility. Please use the below API endpoint instead.
Add a configuration profile to enforce custom settings on macOS and Windows hosts.
@@ -7497,8 +7487,6 @@ The summary can optionally be filtered by fleet ID.
### Update setup experience
> **Experimental feature.** The `manual_agent_install` feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
_Available in Fleet Premium_
`PATCH /api/v1/fleet/setup_experience`
@@ -8291,8 +8279,6 @@ None.
### Get Android Enterprise
> **Experimental feature.** This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
Get info about Android Enterprise that's connected to Fleet.
`GET /api/v1/fleet/android_enterprise`
@@ -11911,8 +11897,6 @@ Add the `X-Fleet-Scripts-Encoded: base64` header line to parse `install_script`,
### Create Android web app
> **Experimental feature**. This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.
_Available in Fleet Premium._
Creates web app (web clip). This endpoint returns the application ID that can be used to [add an Android app](#add-app-store-app) to Fleet.
server/api_endpoints/api_endpoints.yml
+24
View File
@@ -637,3 +637,27 @@
- method: "DELETE"
path: "/api/v1/fleet/software/titles/:software_title_id/available_for_install"
display_name: "Delete software"
- method: "POST"
path: "/api/v1/fleet/configuration_profiles"
display_name: "Create configuration profile"
- method: "PATCH"
path: "/api/v1/fleet/setup_experience"
display_name: "Update setup experience"
# - method: "GET"
# path: "/api/v1/fleet/android_enterprise"
# display_name: "Get Android Enterprise"
- method: "POST"
path: "/api/v1/fleet/software/web_apps"
display_name: "Create Android web app"
- method: "PATCH"
path: "/api/v1/fleet/certificate_authorities/:id"
display_name: "Update certificate authority (CA)"
- method: "GET"
path: "/api/v1/fleet/certificate_authorities"
display_name: "List certificate authorities (CAs)"
- method: "GET"
path: "/api/v1/fleet/certificate_authorities/:id"
display_name: "Get certificate authority (CA)"
- method: "DELETE"
path: "/api/v1/fleet/certificate_authorities/:id"
display_name: "Delete certificate authority (CA)"