Boundary controller HTTP API

Storage Bucket Service

List Storage BucketsGET/v1/storage-buckets

Gets a list of Storage Buckets.

Query Parameters

scope_id string

recursive boolean

filter string

You can specify that the filter should only return items that match. Refer to filter expressions for more information.

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 you do not set a page size, Boundary uses the configured default page size. If the page_size is greater than the default page size configured, Boundary truncates the page size to this number.

Successful Response

items object[]

StorageBucket manages external object stores

id string

Output only. The ID of the storage bucket.

scope_id string

The ID of the Scope of which this storage bucket is a part.

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.

plugin_id string

The ID of the plugin of which this storage bucket is created.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

bucket_name string

The name of the bucket within the external object store service.

bucket_prefix string

The prefix used to organize the data held within the external object store.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

type string

The type of Storage Bucket (currently only plugin).

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the storage bucket type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Filters to the worker(s) that can handle requests for this storage bucket

storage_bucket_credential_id string

Internal use only. The storage bucket credential id for this storage bucket.

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 Storage BucketPOST/v1/storage-buckets

Creates a Storage Bucket

Query Parameters

plugin_name string

As an alternative to providing the plugin id in the provided StorageBucket, this field can be used to lookup the plugin using its name.

Body Parameters

scope_id string

The ID of the Scope of which this storage bucket is a part.

plugin_id string

The ID of the plugin of which this storage bucket is created.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

bucket_name string

The name of the bucket within the external object store service.

bucket_prefix string

The prefix used to organize the data held within the external object store.

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.

type string

The type of Storage Bucket (currently only plugin).

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the storage bucket type. These are never output.

worker_filter string

Filters to the worker(s) that can handle requests for this storage bucket

storage_bucket_credential_id string

Internal use only. The storage bucket credential id for this storage bucket.

Successful Response

id string

Output only. The ID of the storage bucket.

scope_id string

The ID of the Scope of which this storage bucket is a part.

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.

plugin_id string

The ID of the plugin of which this storage bucket is created.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

bucket_name string

The name of the bucket within the external object store service.

bucket_prefix string

The prefix used to organize the data held within the external object store.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

type string

The type of Storage Bucket (currently only plugin).

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the storage bucket type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Filters to the worker(s) that can handle requests for this storage bucket

storage_bucket_credential_id string

Internal use only. The storage bucket credential id for this storage bucket.

authorized_actions string[]

Get Storage BucketGET/v1/storage-buckets/{id}

Gets a single Storage Bucket.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the storage bucket.

scope_id string

The ID of the Scope of which this storage bucket is a part.

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.

plugin_id string

The ID of the plugin of which this storage bucket is created.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

bucket_name string

The name of the bucket within the external object store service.

bucket_prefix string

The prefix used to organize the data held within the external object store.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

type string

The type of Storage Bucket (currently only plugin).

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the storage bucket type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Filters to the worker(s) that can handle requests for this storage bucket

storage_bucket_credential_id string

Internal use only. The storage bucket credential id for this storage bucket.

authorized_actions string[]

Delete Storage BucketDELETE/v1/storage-buckets/{id}

Deletes a Storage Bucket

Path Parameters

id string

Update Storage BucketPATCH/v1/storage-buckets/{id}

Updates a Storage Bucket

Path Parameters

id string

Body Parameters

scope_id string

The ID of the Scope of which this storage bucket is a part.

plugin_id string

The ID of the plugin of which this storage bucket is created.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

bucket_name string

The name of the bucket within the external object store service.

bucket_prefix string

The prefix used to organize the data held within the external object store.

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.

type string

The type of Storage Bucket (currently only plugin).

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the storage bucket type. These are never output.

worker_filter string

Filters to the worker(s) that can handle requests for this storage bucket

storage_bucket_credential_id string

Internal use only. The storage bucket credential id for this storage bucket.

Successful Response

id string

Output only. The ID of the storage bucket.

scope_id string

The ID of the Scope of which this storage bucket is a part.

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.

plugin_id string

The ID of the plugin of which this storage bucket is created.

plugin object

Output only. Plugin information for this resource.

id string

Output only. The ID of the Plugin.

name string

Output only. The name of the plugin resource in boundary, if any.

description string

Output only. The description of the plugin in boundary, if any.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

bucket_name string

The name of the bucket within the external object store service.

bucket_prefix string

The prefix used to organize the data held within the external object store.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

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.

type string

The type of Storage Bucket (currently only plugin).

attributes object

Attributes specific to the catalog type.

secrets object

Secrets specific to the storage bucket type. These are never output.

secrets_hmac string

Output only. The HMAC of the last secrets supplied via the API, if any.

worker_filter string

Filters to the worker(s) that can handle requests for this storage bucket

storage_bucket_credential_id string

Internal use only. The storage bucket credential id for this storage bucket.

authorized_actions string[]