Boundary controller HTTP API

Policy Service

List PoliciesGET/v1/policies

Lists all policies.

Query Parameters

scope_id string

recursive boolean

filter string

list_token string

An opaque token that Boundary uses to continue an existing iteration or request updated items. If you do not specify a token, pagination starts from the beginning. To learn more about list pagination in Boundary, refer to list pagination.

page_size integer

The maximum size of a page in this iteration. If unset, the default page size configured will be used. If the page_size is greater than the default page configured, the page size will be truncated to this number..

Successful Response

items object[]

id string

Output only. The id of the storage policy.

scope_id string

The scope id of this policy. This must be defined for policy creation, but is otherwise output only.

scope object

Output only. Scope information for this resource.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

type string

The policy's type.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

attributes object

authorized_actions string[]

response_type string

The type of response, either "delta" or "complete". Delta signifies that this is part of a paginated result or an update to a previously completed pagination. Complete signifies that it is the last page.

list_token string

An opaque token used to continue an existing pagination or request updated items. Use this token in the next list request to request the next page.

sort_by string

The name of the field which the items are sorted by.

sort_dir string

The direction of the sort, either "asc" or "desc".

removed_ids string[]

est_item_count integer

An estimate at the total items available. This may change during pagination.

Create PolicyPOST/v1/policies

Creates a single policy.

Body Parameters

scope_id string

The scope id of this policy. This must be defined for policy creation, but is otherwise output only.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

type string

The policy's type.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

attributes object

Successful Response

id string

Output only. The id of the storage policy.

scope_id string

The scope id of this policy. This must be defined for policy creation, but is otherwise output only.

scope object

Output only. Scope information for this resource.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

type string

The policy's type.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

attributes object

authorized_actions string[]

Get PolicyGET/v1/policies/{id}

Gets a single policy with the given id.

Path Parameters

id string

Successful Response

id string

Output only. The id of the storage policy.

scope_id string

The scope id of this policy. This must be defined for policy creation, but is otherwise output only.

scope object

Output only. Scope information for this resource.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

type string

The policy's type.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

attributes object

authorized_actions string[]

Delete PolicyDELETE/v1/policies/{id}

Deletes an existing policy.

Path Parameters

id string

Update PolicyPATCH/v1/policies/{id}

Updates an existing policy.

Path Parameters

id string

Body Parameters

scope_id string

The scope id of this policy. This must be defined for policy creation, but is otherwise output only.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

type string

The policy's type.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

attributes object

Successful Response

id string

Output only. The id of the storage policy.

scope_id string

The scope id of this policy. This must be defined for policy creation, but is otherwise output only.

scope object

Output only. Scope information for this resource.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

type string

The policy's type.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

attributes object

authorized_actions string[]