List rules
Returns a list of policy rules.
Query Parameters
- limit int64
Limits the size of the response on each page to the specified number of items.
- start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.
- organizational_unit_id string
The Clumio-assigned ID of the organizational unit (OU) for which to retrieve rules. Only ancestor OU IDs or OU IDs accessible to the current OU or the current OU ID itself are allowed.
- sort string
Returns the list of rules in the order specified. Set
sort
to the name of the sort field by which to sort in ascending order. To sort the list in reverse order, prefix the field name with a minus sign (-
). Only one field may be sorted at a time.The following table lists the supported sort fields for this resource:
If a sort order is not specified, the individual rules are sorted by "priority" in descending priority (highest first) order.Sort Field Description priority Sorts the rules in ascending priority (lowest first) order. For example, ?sort=priority
- filter string
Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:
For more information about filtering, refer to the Filtering section of this guide.Field Filter Condition Description id $in Denotes the specific Rule IDs to retrieve, up to 100 ids {"rule_id":{"$in":["1", "2"]}}
- 200
- default
Success
- application/api.clumio.policy-rules=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- current_count int64
The number of items listed on the current page.
- limit int64
The maximum number of items displayed per page in the response.
- start string
The page token used to get this response.
{
"_embedded": {
"items": [
{
"_embedded": {},
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"delete-policy-rule": {
"href": "string",
"templated": true,
"type": "string"
},
"read-policy-definition": {
"href": "string",
"templated": true,
"type": "string"
},
"update-policy-rule": {
"href": "string",
"templated": true,
"type": "string"
}
},
"action": {
"assign_policy": {
"policy_id": "string"
}
},
"condition": "string",
"id": "string",
"name": "string",
"organizational_unit_id": "string",
"priority": {
"before_rule_id": "string"
}
}
]
},
"_links": {
"_first": {
"href": "string",
"templated": true,
"type": "string"
},
"_next": {
"href": "string",
"templated": true,
"type": "string"
},
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"create-policy-rule": {
"href": "string",
"templated": true,
"type": "string"
}
},
"current_count": 0,
"limit": 0,
"start": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /policies/rules
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/rules' \
-H 'Accept: application/api.clumio.policy-rules=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/rules' \
-H 'Accept: application/api.clumio.policy-rules=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/rules' \
-H 'Accept: application/api.clumio.policy-rules=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/rules' \
-H 'Accept: application/api.clumio.policy-rules=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/rules' \
-H 'Accept: application/api.clumio.policy-rules=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/rules' \
-H 'Accept: application/api.clumio.policy-rules=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/policies/rules' \
-H 'Accept: application/api.clumio.policy-rules=v1+json' \
-H 'Authorization: Bearer <TOKEN>'