Sample Request
curl -X GET https://console.jumpcloud.com/api/v2/policies \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
Basic Parameters
| Parameter | Description |
|---|---|
| Fields | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. |
| Filter | A filter to apply to the query. Filter structure: <field>:<operator>:<value>.field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: GET /api/v2/groups?filter=name:eq:Test+Group. |
| Limit | The number of records to return at once. Limited to 100. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Organization ID | Organization identifier that can be obtained from console settings. |
| Skip | The offset into the records to return. |
| Sort | The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending. |
Example Output
[
{
"id": "ObjectId uniquely identifying a Policy.",
"name": "The description for this specific Policy.",
"template": {
"activation": "Requirements before the policy can be activated.",
"alert": "Text to describe any risk associated with this policy.",
"behavior": "Specifics about the behavior of the policy.",
"deliveryTypes": [
"agent"
],
"description": "The default description for the Policy.",
"displayName": "The default display name for the Policy.",
"id": "ObjectId uniquely identifying a Policy Template.",
"name": "The unique name for the Policy Template.",
"osMetaFamily": "string",
"osRestrictions": [
{
"with-apple-restrictions": {
"appleRestrictions": {
"requiresSupervision": false,
"supportedEnrollmentTypes": [
"automated",
"device",
"user"
]
},
"deprecatedVersion": "16.2",
"earliestVersion": "14.1",
"osName": "iPadOS"
}
}
],
"reference": "URL to visit for further information.",
"state": ""
}
}
]
Workflow Library Example
Scan and Enforce Full Disk Encryption Jumpcloud Policy Daily