Boundary Controller HTTP API

Worker Service

List WorkersGET/v1/workers

Lists all Workers.

Query Parameters

scope_id string

recursive boolean

filter string

Successful Response

items object[]

Worker contains all fields related to a Worker resource

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

worker_generated_auth_token is input only. Supports the worker led node enrollment flow where this credentials token is produced by a worker. This token is a base58 encoded types.FetchNodeCredentialsRequest from https://github.com/hashicorp/nodeenrollment

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Get WorkerGET/v1/workers/{id}

Gets a single Worker.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Delete WorkerDELETE/v1/workers/{id}

Deletes a Worker.

Path Parameters

id string

Update WorkerPATCH/v1/workers/{id}

Updates a Worker.

Path Parameters

id string

Body Parameters

scope_id string

The ID of the Scope this resource is in.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

worker_generated_auth_token string

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Add Worker TagsPOST/v1/workers/{id}:add-worker-tags

Adds api tags to an existing Worker.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

api_tags object

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Remove Worker TagsPOST/v1/workers/{id}:remove-worker-tags

Removes api tags from an existing Worker.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

api_tags object

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Set Worker TagsPOST/v1/workers/{id}:set-worker-tags

Sets api tags for an existing Worker.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

api_tags object

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Create Controller LedPOST/v1/workers:create:controller-led

Creates a single Worker.

Body Parameters

scope_id string

The ID of the Scope this resource is in.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

worker_generated_auth_token string

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Create Worker LedPOST/v1/workers:create:worker-led

Creates a single Worker.

Body Parameters

scope_id string

The ID of the Scope this resource is in.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

worker_generated_auth_token string

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

description string

Optional user-set description for identification purposes. Can only be set through the API for pki-type workers; read-only for kms-type workers.

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.

address string

Output only. The address that this worker is reachable at, as sourced from the worker's configuration file.

canonical_tags object

Output only. The deduplicated union of the tags reported by the worker from its configuration and any tags added through other means. This is used when applying worker filters.

config_tags object

Output only. The tags set in the worker's configuration file.

last_status_time string

Output only. The time this worker daemon last reported its status.

worker_generated_auth_token string

controller_generated_activation_token string

Output only. An activation token that can be given to a worker to correlate it to the created resource.

active_connection_count integer

Output only. The number of connections that this worker is currently handling.

type string

Output only. The type of the worker, denoted by how it authenticates: pki or kms.

api_tags object

Output only. The api tags set for the worker.

release_version string

Output only. The version of the Boundary binary the worker is running.

directly_connected_downstream_workers string[]

authorized_actions string[]

Read Certificate AuthorityGET/v1/workers:read-certificate-authority

Retrieves root certificates used for worker authentication.

Query Parameters

scope_id string

Reinitialize Certificate AuthorityPOST/v1/workers:reinitialize-certificate-authority

Reinitializes root certificates used for worker authentication.

Query Parameters

scope_id string