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

API reference docs: clarify profiles and labels (#21162)

Browse Source 
- Only one of either `labels_include_all` or `labels_exclude_any` can be
included in the request.
- Add missing labels `id` in `GET /configuration_profiles` and `GET
/configuration_profiles/:uuid`
This commit is contained in:
Noah Talerman
2024-08-07 16:25:31 -07:00
committed by GitHub
parent 3ae4b3d94e
commit d5c9caa5b9
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST API/rest-api.md
+11 -6
View File
@@ -5393,8 +5393,8 @@ Add a configuration profile to enforce custom settings on macOS and Windows host
| ------------------------- | -------- | ---- | ------------------------------------------------------------------------------------------------------------- |
| profile | file | form | **Required.** The .mobileconfig and JSON for macOS or XML for Windows file containing the profile. |
| team_id | string | form | _Available in Fleet Premium_. The team ID for the profile. If specified, the profile is applied to only hosts that are assigned to the specified team. If not specified, the profile is applied to only to hosts that are not assigned to any team. |
| labels_include_all | array | form | _Available in Fleet Premium_. Profile will only be applied to hosts that have all of these labels. |
| labels_exclude_any | array | form | _Available in Fleet Premium_. Profile will be applied to hosts that don’t have any of these labels. |
| labels_include_all | array | form | _Available in Fleet Premium_. Profile will only be applied to hosts that have all of these labels. Only one of either `labels_include_all` or `labels_exclude_any` can be included in the request. |
| labels_exclude_any | array | form | _Available in Fleet Premium_. Profile will be applied to hosts that don’t have any of these labels. Only one of either `labels_include_all` or `labels_exclude_any` can be included in the request. |
#### Example
@@ -5511,7 +5511,8 @@ List all configuration profiles for macOS and Windows hosts enrolled to Fleet's
"checksum": "dGVzdAo=",
"labels_exclude_any": [
{
"name": "Label name 1"
"name": "Label name 1",
"id": 1
}
]
},
@@ -5525,11 +5526,13 @@ List all configuration profiles for macOS and Windows hosts enrolled to Fleet's
"checksum": "aCLemVr)",
"labels_include_all": [
{
"name": "Label name 1",
"broken": true
"name": "Label name 2",
"broken": true,
"id": 2
},
{
"name": "Label name 2"
"name": "Label name 3",
"id": 3
}
]
}
@@ -5577,10 +5580,12 @@ If one or more assigned labels are deleted the profile is considered broken (`br
"labels_include_all": [
{
"name": "Label name 1",
"id": 1
"broken": true
},
{
"name": "Label name 2",
"id": 2
}
]
}