/sandboxes
Mount Point: /auth/api/v1/sandboxes/
GET
Retrieve a list of Policy Sandboxes from the entire set of defined Policy Sandboxes.
Parameters
name | description | type | default |
---|---|---|---|
startIndex | The index number of the first item to be provided in the results. A null value is equivalent to 0. | query | |
count | The maximum number of items to be provided in the results. A null value signifies no maximum. | query | |
sortBy | Specifies how the results should be sorted. Allowed values are defined by com.unboundid.policy.models.PolicySandbox#getSortsByEnumValues(). A null value returns items in an unspecified order. | query | NAME_ASCENDING |
filterBy | Specifies how filtering will occur. Allowed values are defined in com.unboundid.policy.models.PolicySandbox#getFiltersByEnumValues(). | query | |
filter | user-supplied input used for filtering. | query | |
excludesList | comma-separated list of ids to exclude from results. | query |
Response Body
result: | policySandbox |
media types: | application/json |
Paged results of all requested Policy Sandboxes.
Status Codes
code | description |
---|---|
200 | Success |
POST
Create a new policy sandbox.
Request Body
element: | policySandbox |
media types: | application/json |
Policy Sandbox specification.
Response Body
result: | policySandbox |
media types: | application/json |
A response containing the created policy sandbox and a URI path to the policy sandbox.
Status Codes
code | description |
---|---|
201 | Success |
400 | Bad Request |