Boundary controller HTTP API

Alias Service

List AliasesGET/v1/aliases

Lists all Aliases in a specific Scope.

Query Parameters

scope_id string

The id of the scope in which to list aliases

recursive boolean

Whether to recursively list aliases in child scopes of the provided scope.

filter string

Filter can be specified to only return items that match the filter. See filter expressions for more information.

list_token string

An opaque token used to continue an existing iteration or request updated items. If not specified, pagination will start 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[]

Alias contains all fields related to an Alias resource

id string

The ID of the Alias.

scope_id string

The ID of the scope of which this Alias is a part.

scope object

Scope information for this Alias.

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 will be empty if this is the "global" scope.

name string

Optional user-set name for identification purposes.

description string

Optional user-set descripton for identification purposes.

created_time string

The time this resource was created.

updated_time string

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. Not required when creating an alias.

value string

Required value of the alias. This is the value referenced by the user that is resolved to the destination id.

destination_id string

destination_id is the id of the resource that this Alias points to.

type string

type is the type of the alias.

attributes object

The attributes that are applicable for the specific alias type. The schema of this field depends on the type of resource that the alias is being created in. For target aliases, the parameters are:

{
  "authorize_session_arguments": {"host_id":"host_id"}
}

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 AliasPOST/v1/aliases

Creates a single Alias in the provided scope.

Body Parameters

scope_id string

The ID of the scope of which this Alias is a part.

name string

Optional user-set name for identification purposes.

description string

Optional user-set descripton for identification purposes.

version integer

value string

Required value of the alias. This is the value referenced by the user that is resolved to the destination id.

destination_id string

destination_id is the id of the resource that this Alias points to.

type string

type is the type of the alias.

attributes object

The attributes that are applicable for the specific alias type. The schema of this field depends on the type of resource that the alias is being created in. For target aliases, the parameters are:

{
  "authorize_session_arguments": {"host_id":"host_id"}
}

Successful Response

id string

The ID of the Alias.

scope_id string

The ID of the scope of which this Alias is a part.

scope object

Scope information for this Alias.

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 will be empty if this is the "global" scope.

name string

Optional user-set name for identification purposes.

description string

Optional user-set descripton for identification purposes.

created_time string

The time this resource was created.

updated_time string

The time this resource was last updated.

version integer

value string

Required value of the alias. This is the value referenced by the user that is resolved to the destination id.

destination_id string

destination_id is the id of the resource that this Alias points to.

type string

type is the type of the alias.

attributes object

The attributes that are applicable for the specific alias type. The schema of this field depends on the type of resource that the alias is being created in. For target aliases, the parameters are:

{
  "authorize_session_arguments": {"host_id":"host_id"}
}

authorized_actions string[]

Get AliasGET/v1/aliases/{id}

Gets a single Alias.

Path Parameters

id string

The id of the Alias to retrieve.

Successful Response

id string

The ID of the Alias.

scope_id string

The ID of the scope of which this Alias is a part.

scope object

Scope information for this Alias.

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 will be empty if this is the "global" scope.

name string

Optional user-set name for identification purposes.

description string

Optional user-set descripton for identification purposes.

created_time string

The time this resource was created.

updated_time string

The time this resource was last updated.

version integer

value string

Required value of the alias. This is the value referenced by the user that is resolved to the destination id.

destination_id string

destination_id is the id of the resource that this Alias points to.

type string

type is the type of the alias.

attributes object

The attributes that are applicable for the specific alias type. The schema of this field depends on the type of resource that the alias is being created in. For target aliases, the parameters are:

{
  "authorize_session_arguments": {"host_id":"host_id"}
}

authorized_actions string[]

Delete AliasDELETE/v1/aliases/{id}

Deletes an Alias.

Path Parameters

id string

The id of the alias to delete.

Update AliasPATCH/v1/aliases/{id}

Updates an Alias.

Path Parameters

id string

The id of the Alias to update.

Body Parameters

scope_id string

The ID of the scope of which this Alias is a part.

name string

Optional user-set name for identification purposes.

description string

Optional user-set descripton for identification purposes.

version integer

value string

Required value of the alias. This is the value referenced by the user that is resolved to the destination id.

destination_id string

destination_id is the id of the resource that this Alias points to.

type string

type is the type of the alias.

attributes object

The attributes that are applicable for the specific alias type. The schema of this field depends on the type of resource that the alias is being created in. For target aliases, the parameters are:

{
  "authorize_session_arguments": {"host_id":"host_id"}
}

Successful Response

id string

The ID of the Alias.

scope_id string

The ID of the scope of which this Alias is a part.

scope object

Scope information for this Alias.

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 will be empty if this is the "global" scope.

name string

Optional user-set name for identification purposes.

description string

Optional user-set descripton for identification purposes.

created_time string

The time this resource was created.

updated_time string

The time this resource was last updated.

version integer

value string

Required value of the alias. This is the value referenced by the user that is resolved to the destination id.

destination_id string

destination_id is the id of the resource that this Alias points to.

type string

type is the type of the alias.

attributes object

The attributes that are applicable for the specific alias type. The schema of this field depends on the type of resource that the alias is being created in. For target aliases, the parameters are:

{
  "authorize_session_arguments": {"host_id":"host_id"}
}

authorized_actions string[]