Target

Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).

Operations

Method	Endpoint	Description
GET	/space/{space_id}/target	List Targets
GET	/target	List of Targets across spaces
GET	/space/{space_id}/target/{target_id}	Get Target
POST	/space/{space_id}/target	Create Target
PATCH	/space/{space_id}/target/{target_id}	Patch Target
PUT	/space/{space_id}/target/{target_id}	Update Target
PATCH	/target	Bulk patch multiple targets
DELETE	/space/{space_id}/target/{target_id}	Delete Target
DELETE	/target	Bulk delete multiple targets

---

List Targets

GET /space/{space_id}/target

List Targets

Operation ID: ListTargets

Parameters

Path Parameters

Parameter	Type	Required	Description
space_id	string	✓	Unique identifier for a space_id

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Targets returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Target: BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Target list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Target). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Target include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include	string		Include clause for expanding related entities in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Target are BridgeWorkerID, OrganizationID, SpaceID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of ExtendedTarget
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default		application/json	Array of ExtendedTarget

---

List of Targets across spaces

GET /target

Retrieves a list of Targets across spaces in the Organization

Operation ID: ListAllTargets

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Targets returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Target: BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Target list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Target). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Target include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include	string		Include clause for expanding related entities in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Target are BridgeWorkerID, OrganizationID, SpaceID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of ExtendedTarget
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default		application/json	Array of ExtendedTarget

---

Get Target

GET /space/{space_id}/target/{target_id}

Get Target

Operation ID: GetTarget

Parameters

Path Parameters

Parameter	Type	Required	Description
space_id	string	✓	Unique identifier for a space_id
target_id	string	✓	Unique identifier for a target_id

Query Parameters

Parameter	Type	Required	Description
include	string		Include clause for expanding related entities in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Target are BridgeWorkerID, OrganizationID, SpaceID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	ExtendedTarget
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default		application/json	ExtendedTarget

---

Create Target

POST /space/{space_id}/target

Create Target

Operation ID: CreateTarget

Parameters

Path Parameters

Parameter	Type	Required	Description
space_id	string	✓	Unique identifier for a space_id

Query Parameters

Parameter	Type	Required	Description
allow_exists	string		Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity

Request Body

Content-Type: application/json

Schema: Target

Responses

Status	Description	Content-Type	Schema
200	Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).	application/json	Target
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default	Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).	application/json	Target

---

Patch Target

PATCH /space/{space_id}/target/{target_id}

Patch Target

Operation ID: PatchTarget

Parameters

Path Parameters

Parameter	Type	Required	Description
space_id	string	✓	Unique identifier for a space_id
target_id	string	✓	Unique identifier for a target_id

Request Body

Content-Type: application/merge-patch+json

Responses

Status	Description	Content-Type	Schema
200	Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).	application/json	Target
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default	Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).	application/json	Target

---

Update Target

PUT /space/{space_id}/target/{target_id}

Update Target

Operation ID: UpdateTarget

Parameters

Path Parameters

Parameter	Type	Required	Description
space_id	string	✓	Unique identifier for a space_id
target_id	string	✓	Unique identifier for a target_id

Request Body

Content-Type: application/json

Schema: Target

Responses

Status	Description	Content-Type	Schema
200	Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).	application/json	Target
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
409	Target data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default	Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).	application/json	Target

---

Bulk patch multiple targets

PATCH /target

Apply JSON merge patch to multiple targets selected by query parameters

Operation ID: BulkPatchTargets

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Targets returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Target: BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Target list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Target). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Target include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include	string		Include clause for expanding related entities in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Target are BridgeWorkerID, OrganizationID, SpaceID. The whole string must be query-encoded.

Request Body

Content-Type: application/merge-patch+json

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of TargetCreateOrUpdateResponse
207	Multi-Status: Mixed success and failure results	application/json	Array of TargetCreateOrUpdateResponse
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default		application/json	Array of TargetCreateOrUpdateResponse

---

Delete Target

DELETE /space/{space_id}/target/{target_id}

Delete Target

Operation ID: DeleteTarget

Parameters

Path Parameters

Parameter	Type	Required	Description
space_id	string	✓	Unique identifier for a space_id
target_id	string	✓	Unique identifier for a target_id

Responses

Status	Description	Content-Type	Schema
200	Response for successful delete operation	application/json	DeleteResponse
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
422	Target could not be deleted.	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default	Response for successful delete operation	application/json	DeleteResponse

---

Bulk delete multiple targets

DELETE /target

Delete multiple targets selected by query parameters

Operation ID: BulkDeleteTargets

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Targets returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Target: BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Target list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Target). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Target include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include	string		Include clause for expanding related entities in the response for Target. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Target are BridgeWorkerID, OrganizationID, SpaceID. The whole string must be query-encoded.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of DeleteResponse
207	Multi-Status: Mixed success and failure results	application/json	Array of DeleteResponse
400	Target request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Target not found.	application/json	StandardErrorResponse
422	Unable to delete entity	application/json	StandardErrorResponse
500	Something went wrong while processing Target.	application/json	StandardErrorResponse
default		application/json	Array of DeleteResponse

---

Schemas

DeleteResponse

Response for successful delete operation

Properties

Property	Type	Required	Description
Error	ResponseError
Message	string		Response message.

ExtendedTarget

Properties

Property	Type	Required	Description
BridgeWorker	BridgeWorker
Error	ResponseError
Organization	Organization
Space	Space
Target	Target

StandardErrorResponse

Error response details.

Properties

Property	Type	Required	Description
Code	string		HTTP status code of the response.
Message	string		Message returned with the response.

Target

Target represents a deployment target in ConfigHub. It defines where configuration should be applied, including the toolchain type (e.g., Kubernetes/YAML, OpenTofu/HCL, AppConfig/Properties) and provider (e.g., Kubernetes, AWS, ConfigMap). Each Target is associated with a specific BridgeWorker that handles the actual deployment actions (e.g. Apply, Destroy).

Properties

Property	Type	Required	Description
Annotations	object		An optional map of Annotation key/value pairs for tools to attach information to entities.
BridgeWorkerID	string (uuid)	✓	Unique identifier for a Bridge Worker associated with the Target.
CreatedAt	string (date-time)		The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
CursorID	integer (int64)		An auto-incrementing sequence number used for pagination.
DeleteGates	object		An optional set of gates that, if any is present, will block deletion.
DisplayName	string		Friendly name for the entity.
EntityType	string		The type of entity.
Labels	object		An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
OrganizationID	string (uuid)		Unique identifier for an organization.
Parameters	string		Parameters contains toolchain-type and/or provider-type-specific parameters in JSON format. For ProviderType: Kubernetes (ToolchainType: Kubernetes/YAML) The Parameters object may contain the following fields: - "KubeContext" (string): The name of the Kubernetes context (from "~/.kube/config") to use. (Not typically needed if running in-cluster). - "WaitTimeout" (string): A duration string (e.g., "5m", "2m30s") specifying how long to wait for resources to reach a ready state. Defaults to "2m0s".
ProviderType	string	✓	ProviderType specifies the cloud or infrastructure provider for this target, such as "Kubernetes" or "AWS".
Slug	string	✓	Unique URL-safe identifier for the entity.
SpaceID	string (uuid)		Unique identifier for a space.
TargetID	string (uuid)		Unique identifier for a Target.
ToolchainType	string	✓	ToolchainType specifies the type of toolchain supported by this Target. Possible values include "Kubernetes/YAML", "OpenTofu/HCL", "AppConfig/Properties".
UpdatedAt	string (date-time)		The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
Version	integer (int64)		An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.

TargetCreateOrUpdateResponse

Properties

Property	Type	Required	Description
Error	ResponseError
Target	Target