Skip to content

Commit

Permalink
Update rest-api.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rachaelshaw committed Nov 11, 2024
1 parent c6f57b5 commit 0c447d2
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2429,6 +2429,7 @@ None.
- [Get aggregated host's mobile device management (MDM) and Munki information](#get-aggregated-hosts-macadmin-mobile-device-management-mdm-and-munki-information)
- [Get host's scripts](#get-hosts-scripts)
- [Get host's software](#get-hosts-software)
- [Get host's certificates](#get-hosts-certificates)
- [Get hosts report in CSV](#get-hosts-report-in-csv)
- [Get host's disk encryption key](#get-hosts-disk-encryption-key)
- [Lock host](#lock-host)
Expand Down Expand Up @@ -4327,6 +4328,43 @@ Resends a configuration profile for the specified host.
}
```

### Get host's certificates

`GET /api/v1/fleet/hosts/:id/certificates`

#### Parameters

| Name | Type | In | Description |
| ---- | ------- | ---- | ---------------------------- |
| id | integer | path | **Required**. The host's ID. |
| query | string | query | Search query keywords. Searchable fields include `name`. |
| page | integer | query | Page number of the results to fetch.|
| per_page | integer | query | Results per page.|

#### Example

`GET /api/v1/fleet/hosts/123/certificates`

##### Default response

`Status: 200`

```json
{
"count": 297,
"certificates": [
{
"TODO": "TODO"
},
],
"meta": {
"has_next_results": true,
"has_previous_results": false
}
}
```


### Get hosts report in CSV

Returns the list of hosts corresponding to the search criteria in CSV format, ready for download when
Expand Down

0 comments on commit 0c447d2

Please sign in to comment.