HashiDays One conference. Three cities. Find a city near you

HCP Waypoint

Service for managing applications.

Operations

GetActionRun

/waypoint/namespace/{namespace.id}/action

GetActionRun


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/action

Request

Path Parameters

namespace.idstring

Query Parameters

action_idstring

The id of the action config being requested

action_namestring

The name of the action being requested (will only be used if id not provided)

sequencestring

The sequence number of the action run (required)

Response

200 - OK

action_runobject

namespaceobject
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
- idstring
sequencestring
action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
created_atstring
completed_atstring
run_bystring
NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
response_statusstring
This is the status of the request that the action ran.

NONE: default/zero value; we have no status yet

UNKNOWN: a status we didn't understand

SUCCESS: action submitted successfully

ERROR: it did not work
status_logobject[]
- emitted_atstring
- logstring
- metadataobject
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
scopeobject
- globalobject
- applicationobject
  idstring
  namestring
background_jobobject
This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
- statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
- detailsstring
idstring
action_config_refobject
- idstring
- namestring
variablesobject[]
NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
- namestring
- valuestring
- sensitiveboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

RunAction

/waypoint/namespace/{namespace.id}/action

RunAction


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/action

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

action_refobject

idstring
namestring

scopeobject

globalobject
applicationobject
- idstring
- namestring

variable_overridesobject[]

keystring
The ref key of the variable to override i.e. var.option or application.outputs.key This is a loose association to support local Waypoint vars and TF Outputs.
valuestring
The value to use for the override. Cannot be blank.
sensitiveboolean
saveboolean
Whether or not to save this variable's override value in the database for future invocations. Not all variable types are allowed to be saved like built-in Waypoint variables action.name or application.name.

Response

200 - OK

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

idstring

action_runobject

namespaceobject
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
- idstring
sequencestring
action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
created_atstring
completed_atstring
run_bystring
NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
response_statusstring
This is the status of the request that the action ran.

NONE: default/zero value; we have no status yet

UNKNOWN: a status we didn't understand

SUCCESS: action submitted successfully

ERROR: it did not work
status_logobject[]
- emitted_atstring
- logstring
- metadataobject
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
scopeobject
- globalobject
- applicationobject
  idstring
  namestring
background_jobobject
This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
- statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
- detailsstring
idstring
action_config_refobject
- idstring
- namestring
variablesobject[]
NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
- namestring
- valuestring
- sensitiveboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListActionRunsByNamespace

/waypoint/namespace/{namespace.id}/action-runs

ListActionRunsByNamespace


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/action-runs

Request

Path Parameters

namespace.idstring

Query Parameters

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

scope.application.idstring

scope.application.namestring

Response

200 - OK

action_runsobject[]

namespaceobject
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
- idstring
sequencestring
action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
created_atstring
completed_atstring
run_bystring
NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
response_statusstring
This is the status of the request that the action ran.

NONE: default/zero value; we have no status yet

UNKNOWN: a status we didn't understand

SUCCESS: action submitted successfully

ERROR: it did not work
status_logobject[]
- emitted_atstring
- logstring
- metadataobject
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
scopeobject
- globalobject
- applicationobject
  idstring
  namestring
background_jobobject
This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
- statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
- detailsstring
idstring
action_config_refobject
- idstring
- namestring
variablesobject[]
NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
- namestring
- valuestring
- sensitiveboolean

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListActionRuns2

/waypoint/namespace/{namespace.id}/action/by-name/{action_name}/runs

ListActionRuns2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/action/by-name/{action_name}/runs

Request

Path Parameters

namespace.idstring

action_namestring

The name of the action being listed (will only be used if id not provided)

Query Parameters

action_idstring

The id of the action config being listed

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

scope.application.idstring

scope.application.namestring

Response

200 - OK

action_runsobject[]

namespaceobject
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
- idstring
sequencestring
action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
created_atstring
completed_atstring
run_bystring
NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
response_statusstring
This is the status of the request that the action ran.

NONE: default/zero value; we have no status yet

UNKNOWN: a status we didn't understand

SUCCESS: action submitted successfully

ERROR: it did not work
status_logobject[]
- emitted_atstring
- logstring
- metadataobject
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
scopeobject
- globalobject
- applicationobject
  idstring
  namestring
background_jobobject
This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
- statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
- detailsstring
idstring
action_config_refobject
- idstring
- namestring
variablesobject[]
NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
- namestring
- valuestring
- sensitiveboolean

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

SendStatusLog

/waypoint/namespace/{namespace.id}/action/{action_config.id}/action-runs/{action_run_seq}/status-log

SendStatusLog


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/action/{action_config.id}/action-runs/{action_run_seq}/status-log

Request

Path Parameters

namespace.idstring

action_config.idstring

ULID of the action config id

action_run_seqstring

The run sequence to attach this run to

Body Parameters

namespaceobject

status_logobject

emitted_atstring
logstring
metadataobject

action_configobject

The action config ID to send this to

action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListActionRuns

/waypoint/namespace/{namespace.id}/action/{action_id}/runs

ListActionRuns


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/action/{action_id}/runs

Request

Path Parameters

namespace.idstring

action_idstring

The id of the action config being listed

Query Parameters

action_namestring

The name of the action being listed (will only be used if id not provided)

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

scope.application.idstring

scope.application.namestring

Response

200 - OK

action_runsobject[]

namespaceobject
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
- idstring
sequencestring
action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
created_atstring
completed_atstring
run_bystring
NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
response_statusstring
This is the status of the request that the action ran.

NONE: default/zero value; we have no status yet

UNKNOWN: a status we didn't understand

SUCCESS: action submitted successfully

ERROR: it did not work
status_logobject[]
- emitted_atstring
- logstring
- metadataobject
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
scopeobject
- globalobject
- applicationobject
  idstring
  namestring
background_jobobject
This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
- statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
- detailsstring
idstring
action_config_refobject
- idstring
- namestring
variablesobject[]
NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
- namestring
- valuestring
- sensitiveboolean

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetActionConfig

/waypoint/namespace/{namespace.id}/actionconfig

GetActionConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/actionconfig

Request

Path Parameters

namespace.idstring

Query Parameters

action_idstring

The id of the action config being requested

action_namestring

The name of the action being requested (will only be used if id not provided)

Response

200 - OK

action_configobject

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

total_runsobject

runsstring
last_daystring
last_monthstring

latest_runobject

namespaceobject
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
- idstring
sequencestring
action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
created_atstring
completed_atstring
run_bystring
NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
response_statusstring
This is the status of the request that the action ran.

NONE: default/zero value; we have no status yet

UNKNOWN: a status we didn't understand

SUCCESS: action submitted successfully

ERROR: it did not work
status_logobject[]
- emitted_atstring
- logstring
- metadataobject
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
scopeobject
- globalobject
- applicationobject
  idstring
  namestring
background_jobobject
This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
- statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
- detailsstring
idstring
action_config_refobject
- idstring
- namestring
variablesobject[]
NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
- namestring
- valuestring
- sensitiveboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteActionConfig

/waypoint/namespace/{namespace.id}/actionconfig

DeleteActionConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/actionconfig

Request

Path Parameters

namespace.idstring

Query Parameters

action_idstring

The id of the action config being deleted

action_namestring

The name of the action being deleted (will only be used if id not provided)

forceboolean

Force, if set to true, will auto-unassign the action from all apps and templates

Response

200 - OK

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateActionConfig

/waypoint/namespace/{namespace.id}/actionconfig

CreateActionConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/actionconfig

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

action_configobject

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Response

200 - OK

action_configobject

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateActionConfig

/waypoint/namespace/{namespace.id}/actionconfig

UpdateActionConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/actionconfig

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

action_configobject

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Response

200 - OK

action_configobject

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListActionConfigs

/waypoint/namespace/{namespace.id}/actionconfigs

ListActionConfigs


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/actionconfigs

Request

Path Parameters

namespace.idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

action_configsobject[]

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateAddOn

/waypoint/namespace/{namespace.id}/add-on

CreateAddOn


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

applicationobject

idstring
namestring

definitionobject

idstring
namestring

namestring

variablesobject[]

InputVariable is a variable whose value has been set.

namestring
name is the name of the Terraform variable.
valuestring
value is the value set for the Terraform variable.
variable_typestring
variable_type is the type of Terraform variable.

Response

200 - OK

add_onobject

idstring
namestring
applicationobject
- idstring
- namestring
definitionobject
- idstring
- namestring
readme_markdownstring
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
labelsstring[]
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
created_bystring
created_atstring
countstring
The count of other instances of the same add-on definition for the same application.
statusstring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
module_sourcestring
module_source is where to find the source code for the desired child module.
terraform_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateAddOnDefinition

/waypoint/namespace/{namespace.id}/add-on-definition

CreateAddOnDefinition


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definition

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

namestring

terraform_nocode_moduleobject

sourcestring
versionstring
The version of the Terraform no-code module.
module_idstring

summarystring

descriptionstring

readme_markdown_templatestring

readme_templatestring

readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.

labelsstring[]

variable_optionsobject[]

TFModuleVariable represents a Terraform module variable.

namestring
name is the name of the variable.
variable_typestring
optionsstring[]
user_editableboolean
indicates if the variable may be set by the app developer.
descriptionstring
description is the description of the variable.

terraform_cloud_workspace_detailsobject

namestring
The project name for the Terraform Cloud project.
project_idstring
The id of the Terraform Cloud project.

module_sourcestring

module_source is where to find the source code for the desired child module.

Response

200 - OK

add_on_definitionobject

idstring
namestring
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
readme_markdown_templatestring
readme_templatestring
readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.
labelsstring[]
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetAddOnDefinition2

/waypoint/namespace/{namespace.id}/add-on-definition/by-name/{add_on_definition.name}

GetAddOnDefinition2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definition/by-name/{add_on_definition.name}

Request

Path Parameters

namespace.idstring

add_on_definition.namestring

Query Parameters

add_on_definition.idstring

Response

200 - OK

add_on_definitionobject

idstring
namestring
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
readme_markdown_templatestring
readme_templatestring
readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.
labelsstring[]
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteAddOnDefinition2

/waypoint/namespace/{namespace.id}/add-on-definition/by-name/{add_on_definition.name}

DeleteAddOnDefinition2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definition/by-name/{add_on_definition.name}

Request

Path Parameters

namespace.idstring

add_on_definition.namestring

Query Parameters

add_on_definition.idstring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateAddOnDefinition2

/waypoint/namespace/{namespace.id}/add-on-definition/by-name/{existing_add_on_definition.name}

UpdateAddOnDefinition2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definition/by-name/{existing_add_on_definition.name}

Request

Path Parameters

namespace.idstring

existing_add_on_definition.namestring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

existing_add_on_definitionobject

Reference to an existing Add-on

idstring

namestring

terraform_nocode_moduleobject

sourcestring
versionstring
The version of the Terraform no-code module.
module_idstring

summarystring

descriptionstring

readme_markdown_templatestring

readme_templatestring

labelsstring[]

terraform_cloud_workspace_detailsobject

namestring
The project name for the Terraform Cloud project.
project_idstring
The id of the Terraform Cloud project.

variable_optionsobject[]

TFModuleVariable represents a Terraform module variable.

namestring
name is the name of the variable.
variable_typestring
optionsstring[]
user_editableboolean
indicates if the variable may be set by the app developer.
descriptionstring
description is the description of the variable.

module_sourcestring

module_source is where to find the source code for the desired child module.

Response

200 - OK

add_on_definitionobject

idstring
namestring
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
readme_markdown_templatestring
readme_templatestring
readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.
labelsstring[]
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetAddOnDefinition

/waypoint/namespace/{namespace.id}/add-on-definition/{add_on_definition.id}

GetAddOnDefinition


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definition/{add_on_definition.id}

Request

Path Parameters

namespace.idstring

add_on_definition.idstring

Query Parameters

add_on_definition.namestring

Response

200 - OK

add_on_definitionobject

idstring
namestring
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
readme_markdown_templatestring
readme_templatestring
readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.
labelsstring[]
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteAddOnDefinition

/waypoint/namespace/{namespace.id}/add-on-definition/{add_on_definition.id}

DeleteAddOnDefinition


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definition/{add_on_definition.id}

Request

Path Parameters

namespace.idstring

add_on_definition.idstring

Query Parameters

add_on_definition.namestring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateAddOnDefinition

/waypoint/namespace/{namespace.id}/add-on-definition/{existing_add_on_definition.id}

UpdateAddOnDefinition


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definition/{existing_add_on_definition.id}

Request

Path Parameters

namespace.idstring

existing_add_on_definition.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

existing_add_on_definitionobject

Reference to an existing Add-on

idstring

namestring

terraform_nocode_moduleobject

sourcestring
versionstring
The version of the Terraform no-code module.
module_idstring

summarystring

descriptionstring

readme_markdown_templatestring

readme_templatestring

labelsstring[]

terraform_cloud_workspace_detailsobject

namestring
The project name for the Terraform Cloud project.
project_idstring
The id of the Terraform Cloud project.

variable_optionsobject[]

TFModuleVariable represents a Terraform module variable.

namestring
name is the name of the variable.
variable_typestring
optionsstring[]
user_editableboolean
indicates if the variable may be set by the app developer.
descriptionstring
description is the description of the variable.

module_sourcestring

module_source is where to find the source code for the desired child module.

Response

200 - OK

add_on_definitionobject

idstring
namestring
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
readme_markdown_templatestring
readme_templatestring
readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.
labelsstring[]
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListAddOnDefinitions

/waypoint/namespace/{namespace.id}/add-on-definitions

ListAddOnDefinitions


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on-definitions

Request

Path Parameters

namespace.idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

with_total_countboolean

If set to false or not provided, response will not include a total_count value

Response

200 - OK

add_on_definitionsobject[]

idstring
namestring
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
readme_markdown_templatestring
readme_templatestring
readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.
labelsstring[]
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

total_countstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetAddOn2

/waypoint/namespace/{namespace.id}/add-on/by-name/{add_on.name}

GetAddOn2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on/by-name/{add_on.name}

Request

Path Parameters

namespace.idstring

add_on.namestring

Query Parameters

add_on.idstring

Response

200 - OK

add_onobject

idstring
namestring
applicationobject
- idstring
- namestring
definitionobject
- idstring
- namestring
readme_markdownstring
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
labelsstring[]
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
created_bystring
created_atstring
countstring
The count of other instances of the same add-on definition for the same application.
statusstring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
module_sourcestring
module_source is where to find the source code for the desired child module.
terraform_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DestroyAddOn2

/waypoint/namespace/{namespace.id}/add-on/by-name/{add_on.name}

DestroyAddOn2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on/by-name/{add_on.name}

Request

Path Parameters

namespace.idstring

add_on.namestring

Query Parameters

add_on.idstring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFWorkspaceInfo3

/waypoint/namespace/{namespace.id}/add-on/by-name/{add_on.name}/workspace

GetTFWorkspaceInfo3


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on/by-name/{add_on.name}/workspace

Request

Path Parameters

namespace.idstring

add_on.namestring

Query Parameters

application.idstring

application.namestring

add_on.idstring

Response

200 - OK

workspace_infoobject

upgrade_availableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetAddOn

/waypoint/namespace/{namespace.id}/add-on/{add_on.id}

GetAddOn


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on/{add_on.id}

Request

Path Parameters

namespace.idstring

add_on.idstring

Query Parameters

add_on.namestring

Response

200 - OK

add_onobject

idstring
namestring
applicationobject
- idstring
- namestring
definitionobject
- idstring
- namestring
readme_markdownstring
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
labelsstring[]
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
created_bystring
created_atstring
countstring
The count of other instances of the same add-on definition for the same application.
statusstring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
module_sourcestring
module_source is where to find the source code for the desired child module.
terraform_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DestroyAddOn

/waypoint/namespace/{namespace.id}/add-on/{add_on.id}

DestroyAddOn


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on/{add_on.id}

Request

Path Parameters

namespace.idstring

add_on.idstring

Query Parameters

add_on.namestring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFWorkspaceInfo4

/waypoint/namespace/{namespace.id}/add-on/{add_on.id}/workspace

GetTFWorkspaceInfo4


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on/{add_on.id}/workspace

Request

Path Parameters

namespace.idstring

add_on.idstring

Query Parameters

application.idstring

application.namestring

add_on.namestring

Response

200 - OK

workspace_infoobject

upgrade_availableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateAddOn

/waypoint/namespace/{namespace.id}/add-on/{existing_add_on.id}

UpdateAddOn


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-on/{existing_add_on.id}

Request

Path Parameters

namespace.idstring

existing_add_on.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

existing_add_onobject

The add-on to be updated

namestring

namestring

The new name of the Add-on.

Response

200 - OK

add_onobject

idstring
namestring
applicationobject
- idstring
- namestring
definitionobject
- idstring
- namestring
readme_markdownstring
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
labelsstring[]
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
created_bystring
created_atstring
countstring
The count of other instances of the same add-on definition for the same application.
statusstring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
module_sourcestring
module_source is where to find the source code for the desired child module.
terraform_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListAddOns

/waypoint/namespace/{namespace.id}/add-ons

ListAddOns


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/add-ons

Request

Path Parameters

namespace.idstring

Query Parameters

application.idstring

application.namestring

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

with_total_countboolean

If set to false or not provided, response will not include a total_count value

Response

200 - OK

add_onsobject[]

idstring
namestring
applicationobject
- idstring
- namestring
definitionobject
- idstring
- namestring
readme_markdownstring
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
labelsstring[]
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
summarystring
descriptionstring
created_bystring
created_atstring
countstring
The count of other instances of the same add-on definition for the same application.
statusstring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
module_sourcestring
module_source is where to find the source code for the desired child module.
terraform_workspace_idstring

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

total_countstring

Will return -1 if request has a with_total_count = false or is with_total_count parameter is omitted.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListAgentGroups

/waypoint/namespace/{namespace.id}/agent/group

ListAgentGroups


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/group

Request

Path Parameters

namespace.idstring

Response

200 - OK

groupsobject[]

namestring
descriptionstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateAgentGroup

/waypoint/namespace/{namespace.id}/agent/group

CreateAgentGroup


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/group

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

groupobject

namestring
descriptionstring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetAgentGroup

/waypoint/namespace/{namespace.id}/agent/group/{name}

GetAgentGroup


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/group/{name}

Request

Path Parameters

namespace.idstring

namestring

The name of the group to retrieve the information about

Response

200 - OK

groupobject

namestring
descriptionstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteAgentGroup

/waypoint/namespace/{namespace.id}/agent/group/{name}

DeleteAgentGroup


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/group/{name}

Request

Path Parameters

namespace.idstring

namestring

The name of the group to delete

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateAgentGroup

/waypoint/namespace/{namespace.id}/agent/group/{name}

UpdateAgentGroup


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/group/{name}

Request

Path Parameters

namespace.idstring

namestring

The name of the group to update We don’t allow groups to be renamed so this is a stable identifier.

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

descriptionstring

Response

200 - OK

groupobject

namestring
descriptionstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ValidateAgentGroups

/waypoint/namespace/{namespace.id}/agent/group:validate

ValidateAgentGroups


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/group:validate

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

groupsstring[]

Response

200 - OK

known_groupsstring[]

unknown_groupsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

EndingAction

/waypoint/namespace/{namespace.id}/agent/operation:endAction

EndingAction


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/operation:endAction

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

action_run_idstring

status_codeinteger

The status code for the operation. Follows general unix and http status code semantics.

final_statusstring

A status log message to add to the run as it's finished. If empty, no status log entry is created.

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

QueueAgentOperation

/waypoint/namespace/{namespace.id}/agent/operation:queue

QueueAgentOperation


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/operation:queue

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

operationobject

idstring
bodystring
action_run_idstring
groupstring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

RetrieveAgentOperation

/waypoint/namespace/{namespace.id}/agent/operation:retrieve

RetrieveAgentOperation


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/operation:retrieve

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

groupsstring[]

Response

200 - OK

operationobject

idstring
bodystring
action_run_idstring
groupstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

StartingAction

/waypoint/namespace/{namespace.id}/agent/operation:startAction

StartingAction


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/agent/operation:startAction

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

action_run_idstring

group_namestring

Response

200 - OK

action_run_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListApplicationTemplates

/waypoint/namespace/{namespace.id}/application-templates

ListApplicationTemplates


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates

Request

Path Parameters

namespace.idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

with_total_countboolean

If set to false or not provided, response will not include a total_count value

Response

200 - OK

application_templatesobject[]

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

total_countstring

Will return -1 if request has a with_total_count = false or is with_total_count parameter is omitted.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateApplicationTemplate

/waypoint/namespace/{namespace.id}/application-templates

CreateApplicationTemplate


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetApplicationTemplate2

/waypoint/namespace/{namespace.id}/application-templates/by-name/{application_template.name}

GetApplicationTemplate2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates/by-name/{application_template.name}

Request

Path Parameters

namespace.idstring

application_template.namestring

Name of the ApplicationTemplate

Query Parameters

application_template.idstring

ID of the ApplicationTemplate

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteApplicationTemplate2

/waypoint/namespace/{namespace.id}/application-templates/by-name/{application_template.name}

DeleteApplicationTemplate2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates/by-name/{application_template.name}

Request

Path Parameters

namespace.idstring

application_template.namestring

Name of the ApplicationTemplate

Query Parameters

application_template.idstring

ID of the ApplicationTemplate

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplicationTemplate2

/waypoint/namespace/{namespace.id}/application-templates/by-name/{existing_application_template.name}

UpdateApplicationTemplate2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates/by-name/{existing_application_template.name}

Request

Path Parameters

namespace.idstring

existing_application_template.namestring

Name of the ApplicationTemplate

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

existing_application_templateobject

existing_application_template refers to the application template being updated.

idstring

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

update_maskstring

Field mask to update only specific fields. I.e. if you want a field updated, you must include it in the field mask. For now, we only use this for ActionConfigRefs inside application_template for clearing assignments.

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetApplicationTemplate

/waypoint/namespace/{namespace.id}/application-templates/{application_template.id}

GetApplicationTemplate


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates/{application_template.id}

Request

Path Parameters

namespace.idstring

application_template.idstring

ID of the ApplicationTemplate

Query Parameters

application_template.namestring

Name of the ApplicationTemplate

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteApplicationTemplate

/waypoint/namespace/{namespace.id}/application-templates/{application_template.id}

DeleteApplicationTemplate


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates/{application_template.id}

Request

Path Parameters

namespace.idstring

application_template.idstring

ID of the ApplicationTemplate

Query Parameters

application_template.namestring

Name of the ApplicationTemplate

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplicationTemplate

/waypoint/namespace/{namespace.id}/application-templates/{existing_application_template.id}

UpdateApplicationTemplate


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application-templates/{existing_application_template.id}

Request

Path Parameters

namespace.idstring

existing_application_template.idstring

ID of the ApplicationTemplate

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

existing_application_templateobject

existing_application_template refers to the application template being updated.

idstring

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

update_maskstring

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFWorkspaceInfo2

/waypoint/namespace/{namespace.id}/application/by-name/{application.name}/workspace

GetTFWorkspaceInfo2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application/by-name/{application.name}/workspace

Request

Path Parameters

namespace.idstring

application.namestring

Query Parameters

application.idstring

add_on.idstring

add_on.namestring

Response

200 - OK

workspace_infoobject

upgrade_availableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFWorkspaceInfo

/waypoint/namespace/{namespace.id}/application/{application.id}/workspace

GetTFWorkspaceInfo


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/application/{application.id}/workspace

Request

Path Parameters

namespace.idstring

application.idstring

Query Parameters

application.namestring

add_on.idstring

add_on.namestring

Response

200 - OK

workspace_infoobject

upgrade_availableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListApplications

/waypoint/namespace/{namespace.id}/applications

ListApplications


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications

Request

Path Parameters

namespace.idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

with_total_countboolean

Response

200 - OK

applicationsobject[]

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

total_countstring

Will return -1 if request has a with_total_count = false or is with_total_count parameter is omitted.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetApplication2

/waypoint/namespace/{namespace.id}/applications/by-name/{application.name}

GetApplication2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/by-name/{application.name}

Request

Path Parameters

namespace.idstring

application.namestring

Query Parameters

application.idstring

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DestroyApplication2

/waypoint/namespace/{namespace.id}/applications/by-name/{application.name}

DestroyApplication2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/by-name/{application.name}

Request

Path Parameters

namespace.idstring

application.namestring

Query Parameters

application.idstring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplication2

/waypoint/namespace/{namespace.id}/applications/by-name/{application.name}

UpdateApplication2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/by-name/{application.name}

Request

Path Parameters

namespace.idstring

application.namestring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

applicationobject

Reference to an existing Application

idstring

namestring

readme_markdownstring

readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.

readmestring

readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.

action_cfg_refsobject[]

idstring
namestring

update_maskstring

Field mask to update only specific fields. I.e. if you want a field updated, you must include it in the field mask. For now, we only use this for clearing out action assignments.

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateApplicationFromTemplate

/waypoint/namespace/{namespace.id}/applications/from-template

CreateApplicationFromTemplate


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/from-template

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

namestring

application_templateobject

idstring
namestring

action_cfg_refsobject[]

idstring
namestring

variablesobject[]

InputVariable is a variable whose value has been set.

namestring
name is the name of the Terraform variable.
valuestring
value is the value set for the Terraform variable.
variable_typestring
variable_type is the type of Terraform variable.

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetApplication

/waypoint/namespace/{namespace.id}/applications/{application.id}

GetApplication


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/{application.id}

Request

Path Parameters

namespace.idstring

application.idstring

Query Parameters

application.namestring

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DestroyApplication

/waypoint/namespace/{namespace.id}/applications/{application.id}

DestroyApplication


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/{application.id}

Request

Path Parameters

namespace.idstring

application.idstring

Query Parameters

application.namestring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplication

/waypoint/namespace/{namespace.id}/applications/{application.id}

UpdateApplication


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/{application.id}

Request

Path Parameters

namespace.idstring

application.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

applicationobject

Reference to an existing Application

idstring

namestring

readme_markdownstring

readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.

readmestring

action_cfg_refsobject[]

idstring
namestring

update_maskstring

Field mask to update only specific fields. I.e. if you want a field updated, you must include it in the field mask. For now, we only use this for clearing out action assignments.

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpgradeApplicationTFWorkspace

/waypoint/namespace/{namespace.id}/applications/{application.name}/upgrade-tf-workspace

UpgradeApplicationTFWorkspace


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/applications/{application.name}/upgrade-tf-workspace

Request

Path Parameters

namespace.idstring

application.namestring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

applicationobject

Application is the application whose workspace will be upgraded.

idstring

variablesobject[]

InputVariable is a variable whose value has been set.

namestring
name is the name of the Terraform variable.
valuestring
value is the value set for the Terraform variable.
variable_typestring
variable_type is the type of Terraform variable.

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListApplicationTemplates2

/waypoint/namespace/{namespace.id}/templates

ListApplicationTemplates2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates

Request

Path Parameters

namespace.idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

with_total_countboolean

If set to false or not provided, response will not include a total_count value

Response

200 - OK

application_templatesobject[]

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

total_countstring

Will return -1 if request has a with_total_count = false or is with_total_count parameter is omitted.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateApplicationTemplate2

/waypoint/namespace/{namespace.id}/templates

CreateApplicationTemplate2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetApplicationTemplate4

/waypoint/namespace/{namespace.id}/templates/by-name/{application_template.name}

GetApplicationTemplate4


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/by-name/{application_template.name}

Request

Path Parameters

namespace.idstring

application_template.namestring

Name of the ApplicationTemplate

Query Parameters

application_template.idstring

ID of the ApplicationTemplate

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteApplicationTemplate4

/waypoint/namespace/{namespace.id}/templates/by-name/{application_template.name}

DeleteApplicationTemplate4


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/by-name/{application_template.name}

Request

Path Parameters

namespace.idstring

application_template.namestring

Name of the ApplicationTemplate

Query Parameters

application_template.idstring

ID of the ApplicationTemplate

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplicationTemplate4

/waypoint/namespace/{namespace.id}/templates/by-name/{existing_application_template.name}

UpdateApplicationTemplate4


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/by-name/{existing_application_template.name}

Request

Path Parameters

namespace.idstring

existing_application_template.namestring

Name of the ApplicationTemplate

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

existing_application_templateobject

existing_application_template refers to the application template being updated.

idstring

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

update_maskstring

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplicationTemplate6

/waypoint/namespace/{namespace.id}/templates/by-name/{existing_application_template.name}

UpdateApplicationTemplate6


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/by-name/{existing_application_template.name}

Request

Path Parameters

namespace.idstring

existing_application_template.namestring

Name of the ApplicationTemplate

Query Parameters

existing_application_template.idstring

ID of the ApplicationTemplate

Body Parameters

idstring

namestring

summarystring

descriptionstring

A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.

readme_markdown_templatestring

readme_templatestring

A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.

terraform_nocode_moduleobject

sourcestring
versionstring
The version of the Terraform no-code module.
module_idstring

labelsstring[]

terraform_cloud_workspace_detailsobject

namestring
The project name for the Terraform Cloud project.
project_idstring
The id of the Terraform Cloud project.

tagsobject[]

keystring
the key identifier for this tag.
valuestring

action_cfg_refsobject[]

idstring
namestring

variable_optionsobject[]

TFModuleVariable represents a Terraform module variable.

namestring
name is the name of the variable.
variable_typestring
optionsstring[]
user_editableboolean
indicates if the variable may be set by the app developer.
descriptionstring
description is the description of the variable.

module_sourcestring

module_source is where to find the source code for the desired child module.

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetApplicationTemplate3

/waypoint/namespace/{namespace.id}/templates/{application_template.id}

GetApplicationTemplate3


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/{application_template.id}

Request

Path Parameters

namespace.idstring

application_template.idstring

ID of the ApplicationTemplate

Query Parameters

application_template.namestring

Name of the ApplicationTemplate

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteApplicationTemplate3

/waypoint/namespace/{namespace.id}/templates/{application_template.id}

DeleteApplicationTemplate3


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/{application_template.id}

Request

Path Parameters

namespace.idstring

application_template.idstring

ID of the ApplicationTemplate

Query Parameters

application_template.namestring

Name of the ApplicationTemplate

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplicationTemplate3

/waypoint/namespace/{namespace.id}/templates/{existing_application_template.id}

UpdateApplicationTemplate3


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/{existing_application_template.id}

Request

Path Parameters

namespace.idstring

existing_application_template.idstring

ID of the ApplicationTemplate

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

existing_application_templateobject

existing_application_template refers to the application template being updated.

idstring

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

update_maskstring

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateApplicationTemplate5

/waypoint/namespace/{namespace.id}/templates/{existing_application_template.id}

UpdateApplicationTemplate5


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/templates/{existing_application_template.id}

Request

Path Parameters

namespace.idstring

existing_application_template.idstring

ID of the ApplicationTemplate

Query Parameters

existing_application_template.namestring

Name of the ApplicationTemplate

Body Parameters

idstring

namestring

summarystring

descriptionstring

A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.

readme_markdown_templatestring

readme_templatestring

terraform_nocode_moduleobject

sourcestring
versionstring
The version of the Terraform no-code module.
module_idstring

labelsstring[]

terraform_cloud_workspace_detailsobject

namestring
The project name for the Terraform Cloud project.
project_idstring
The id of the Terraform Cloud project.

tagsobject[]

keystring
the key identifier for this tag.
valuestring

action_cfg_refsobject[]

idstring
namestring

variable_optionsobject[]

TFModuleVariable represents a Terraform module variable.

namestring
name is the name of the variable.
variable_typestring
optionsstring[]
user_editableboolean
indicates if the variable may be set by the app developer.
descriptionstring
description is the description of the variable.

module_sourcestring

module_source is where to find the source code for the desired child module.

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFModuleDetails2

/waypoint/namespace/{namespace.id}/tf-module-details/{tfc_namespace}/{name}/{provider}

GetTFModuleDetails2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tf-module-details/{tfc_namespace}/{name}/{provider}

Request

Path Parameters

namespace.idstring

tfc_namespacestring

tfc_namespace is the Terraform user who owns the Terraform module.

namestring

name is the name of the Terraform module.

providerstring

provider is the name of the provider for the Terraform module.

Query Parameters

versionstring

version is the version of the Terraform module.

Response

200 - OK

module_detailsobject

readmestring
variablesobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFModuleDetails

/waypoint/namespace/{namespace.id}/tf-module-details/{tfc_namespace}/{name}/{provider}/{version}

GetTFModuleDetails


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tf-module-details/{tfc_namespace}/{name}/{provider}/{version}

Request

Path Parameters

namespace.idstring

tfc_namespacestring

tfc_namespace is the Terraform user who owns the Terraform module.

namestring

name is the name of the Terraform module.

providerstring

provider is the name of the provider for the Terraform module.

versionstring

version is the version of the Terraform module.

Response

200 - OK

module_detailsobject

readmestring
variablesobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFRunStatus

/waypoint/namespace/{namespace.id}/tf-run-status/{workspace_name}

GetTFRunStatus


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tf-run-status/{workspace_name}

Request

Path Parameters

namespace.idstring

workspace_namestring

Response

200 - OK

urlstring

statestring

input_variablesobject[]

InputVariable is a variable whose value has been set.

namestring
name is the name of the Terraform variable.
valuestring
value is the value set for the Terraform variable.
variable_typestring
variable_type is the type of Terraform variable.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListTFCOrganizations

/waypoint/namespace/{namespace.id}/tfc-organizations

ListTFCOrganizations


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfc-organizations

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

tokenstring

Token to use with the TFC API. If this is blank, the stored token will be used.

Response

200 - OK

tfc_organizationsobject[]

namestring
external_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListTFCProjects

/waypoint/namespace/{namespace.id}/tfc-projects

ListTFCProjects


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfc-projects

Request

Path Parameters

namespace.idstring

Response

200 - OK

tfc_projectsobject[]

namestring
The project name for the Terraform cloud project.
project_idstring
The id of the Terraform cloud project.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetTFCConfig

/waypoint/namespace/{namespace.id}/tfcconfig

GetTFCConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfcconfig

Request

Path Parameters

namespace.idstring

Response

200 - OK

tfc_configobject

organization_namestring
tokenstring
Terraform cloud token team or personal token. This is redacted when returned on API responses.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteTFCConfig

/waypoint/namespace/{namespace.id}/tfcconfig

DeleteTFCConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfcconfig

Request

Path Parameters

namespace.idstring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateTFCConfig

/waypoint/namespace/{namespace.id}/tfcconfig

CreateTFCConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfcconfig

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

tfc_configobject

organization_namestring
tokenstring
Terraform cloud token team or personal token. This is redacted when returned on API responses.

Response

200 - OK

tfc_configobject

organization_namestring
tokenstring
Terraform cloud token team or personal token. This is redacted when returned on API responses.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateTFCConfig

/waypoint/namespace/{namespace.id}/tfcconfig

UpdateTFCConfig


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfcconfig

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.

tfc_configobject

organization_namestring
tokenstring
Terraform cloud token team or personal token. This is redacted when returned on API responses.

Response

200 - OK

tfc_configobject

organization_namestring
tokenstring
Terraform cloud token team or personal token. This is redacted when returned on API responses.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CheckTFCOrganization

/waypoint/namespace/{namespace.id}/tfcconfig/check-organization

CheckTFCOrganization


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfcconfig/check-organization

Request

Path Parameters

namespace.idstring

Response

200 - OK

is_validboolean

is_valid is true if the organization is valid.

permissionsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListNoCodeModules

/waypoint/namespace/{namespace.id}/tfcmodules

ListNoCodeModules


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/tfcmodules

Request

Path Parameters

namespace.idstring

Response

200 - OK

no_code_modulesobject[]

versionsstring[]
namestring
providerstring
createdstring
last_updatedstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_GetActionConfigBundle2

/waypoint/namespace/{namespace.id}/ui/actionconfig/by-name/{action_name}

UI_GetActionConfigBundle2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/actionconfig/by-name/{action_name}

Request

Path Parameters

namespace.idstring

action_namestring

The name of the action being requested (will only be used if id not provided)

Query Parameters

action_idstring

The id of the action config being requested

Response

200 - OK

action_config_bundleobject

action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
latest_runobject
- namespaceobject
  Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
  idstring
- sequencestring
- action_configobject
  idstring
  action_urlstring
  URL to trigger an action on. Only used in Custom mode.
  namestring
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  descriptionstring
  created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
- created_atstring
- completed_atstring
- run_bystring
  NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
- response_statusstring
  This is the status of the request that the action ran.
  
  NONE: default/zero value; we have no status yet
  
  UNKNOWN: a status we didn't understand
  
  SUCCESS: action submitted successfully
  
  ERROR: it did not work
- status_logobject[]
  emitted_atstring
  logstring
  metadataobject
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- scopeobject
  globalobject
  applicationobject
  idstring
  namestring
- background_jobobject
  This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
  statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
  
  detailsstring
- idstring
- action_config_refobject
  idstring
  namestring
- variablesobject[]
  NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
  namestring
  valuestring
  sensitiveboolean
total_runsobject
- runsstring
- last_daystring
- last_monthstring
assigned_applicationsobject[]
- applicationobject
  idstring
  namestring
- latest_runobject
  namespaceobject
  Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
  idstring
  sequencestring
  action_configobject
  idstring
  action_urlstring
  URL to trigger an action on. Only used in Custom mode.
  namestring
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  descriptionstring
  created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
  created_atstring
  completed_atstring
  run_bystring
  NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
  response_statusstring
  This is the status of the request that the action ran.
  
  NONE: default/zero value; we have no status yet
  
  UNKNOWN: a status we didn't understand
  
  SUCCESS: action submitted successfully
  
  ERROR: it did not work
  
  status_logobject[]
  emitted_atstring
  logstring
  metadataobject
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  scopeobject
  globalobject
  applicationobject
  idstring
  namestring
  background_jobobject
  This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
  statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
  
  detailsstring
  idstring
  action_config_refobject
  idstring
  namestring
  variablesobject[]
  NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
  namestring
  valuestring
  sensitiveboolean
- total_runs_last_daystring
assigned_application_templatesobject[]
- application_templateobject
  idstring
  namestring
variables_usedobject[]
- keystring
- valuestring
- sensitiveboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_GetActionConfigBundle

/waypoint/namespace/{namespace.id}/ui/actionconfig/{action_id}

UI_GetActionConfigBundle


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/actionconfig/{action_id}

Request

Path Parameters

namespace.idstring

action_idstring

The id of the action config being requested

Query Parameters

action_namestring

The name of the action being requested (will only be used if id not provided)

Response

200 - OK

action_config_bundleobject

action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
latest_runobject
- namespaceobject
  Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
  idstring
- sequencestring
- action_configobject
  idstring
  action_urlstring
  URL to trigger an action on. Only used in Custom mode.
  namestring
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  descriptionstring
  created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
- created_atstring
- completed_atstring
- run_bystring
  NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
- response_statusstring
  This is the status of the request that the action ran.
  
  NONE: default/zero value; we have no status yet
  
  UNKNOWN: a status we didn't understand
  
  SUCCESS: action submitted successfully
  
  ERROR: it did not work
- status_logobject[]
  emitted_atstring
  logstring
  metadataobject
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- scopeobject
  globalobject
  applicationobject
  idstring
  namestring
- background_jobobject
  This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
  statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
  
  detailsstring
- idstring
- action_config_refobject
  idstring
  namestring
- variablesobject[]
  NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
  namestring
  valuestring
  sensitiveboolean
total_runsobject
- runsstring
- last_daystring
- last_monthstring
assigned_applicationsobject[]
- applicationobject
  idstring
  namestring
- latest_runobject
  namespaceobject
  Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
  idstring
  sequencestring
  action_configobject
  idstring
  action_urlstring
  URL to trigger an action on. Only used in Custom mode.
  namestring
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  descriptionstring
  created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
  created_atstring
  completed_atstring
  run_bystring
  NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
  response_statusstring
  This is the status of the request that the action ran.
  
  NONE: default/zero value; we have no status yet
  
  UNKNOWN: a status we didn't understand
  
  SUCCESS: action submitted successfully
  
  ERROR: it did not work
  
  status_logobject[]
  emitted_atstring
  logstring
  metadataobject
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  scopeobject
  globalobject
  applicationobject
  idstring
  namestring
  background_jobobject
  This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
  statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
  
  detailsstring
  idstring
  action_config_refobject
  idstring
  namestring
  variablesobject[]
  NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
  namestring
  valuestring
  sensitiveboolean
- total_runs_last_daystring
assigned_application_templatesobject[]
- application_templateobject
  idstring
  namestring
variables_usedobject[]
- keystring
- valuestring
- sensitiveboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UIListActionConfigBundles

/waypoint/namespace/{namespace.id}/ui/actionconfigs

UIListActionConfigBundles


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/actionconfigs

Request

Path Parameters

namespace.idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

action_config_bundlesobject[]

action_configobject
- idstring
- action_urlstring
  URL to trigger an action on. Only used in Custom mode.
- namestring
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- descriptionstring
- created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
latest_runobject
- namespaceobject
  Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
  idstring
- sequencestring
- action_configobject
  idstring
  action_urlstring
  URL to trigger an action on. Only used in Custom mode.
  namestring
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  descriptionstring
  created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
- created_atstring
- completed_atstring
- run_bystring
  NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
- response_statusstring
  This is the status of the request that the action ran.
  
  NONE: default/zero value; we have no status yet
  
  UNKNOWN: a status we didn't understand
  
  SUCCESS: action submitted successfully
  
  ERROR: it did not work
- status_logobject[]
  emitted_atstring
  logstring
  metadataobject
- requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
- scopeobject
  globalobject
  applicationobject
  idstring
  namestring
- background_jobobject
  This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
  statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
  
  detailsstring
- idstring
- action_config_refobject
  idstring
  namestring
- variablesobject[]
  NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
  namestring
  valuestring
  sensitiveboolean
total_runsobject
- runsstring
- last_daystring
- last_monthstring
assigned_applicationsobject[]
- applicationobject
  idstring
  namestring
- latest_runobject
  namespaceobject
  Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
  idstring
  sequencestring
  action_configobject
  idstring
  action_urlstring
  URL to trigger an action on. Only used in Custom mode.
  namestring
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  descriptionstring
  created_atstring
  The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.
  created_atstring
  completed_atstring
  run_bystring
  NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message
  response_statusstring
  This is the status of the request that the action ran.
  
  NONE: default/zero value; we have no status yet
  
  UNKNOWN: a status we didn't understand
  
  SUCCESS: action submitted successfully
  
  ERROR: it did not work
  
  status_logobject[]
  emitted_atstring
  logstring
  metadataobject
  requestobject
  customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
  githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
  agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
  scopeobject
  globalobject
  applicationobject
  idstring
  namestring
  background_jobobject
  This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.
  statusstring
  The various status we allow a job to be in. NOTE(briancain): I hate that buf linter requires the Enum name to be in front of each field, but I guess that's what we do to make the tests pass lol. It also requres the Zero value always be UNSPECIFIED.
  
  STATUS_UNSPECIFIED: default/zero value; we have no job status
  
  STATUS_UNKNOWN: we don't know the status of the job!
  
  STATUS_RUNNING: the job was marked as running
  
  STATUS_HALTED: the job was halted/failed to be launched
  
  STATUS_SUCCESS: the job was successful
  
  STATUS_ERRORED: the job ran, but errored out
  
  detailsstring
  idstring
  action_config_refobject
  idstring
  namestring
  variablesobject[]
  NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.
  namestring
  valuestring
  sensitiveboolean
- total_runs_last_daystring
assigned_application_templatesobject[]
- application_templateobject
  idstring
  namestring
variables_usedobject[]
- keystring
- valuestring
- sensitiveboolean

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_CreateActionConfigWithVars

/waypoint/namespace/{namespace.id}/ui/actionconfigwithvars

UI_CreateActionConfigWithVars


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/actionconfigwithvars

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

action_configobject

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

variablesobject[]

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

Response

200 - OK

action_configobject

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

variablesobject[]

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_ListAddOnDefinitions

/waypoint/namespace/{namespace.id}/ui/add-on-definitions

UI_ListAddOnDefinitions


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/add-on-definitions

Request

Path Parameters

namespace.idstring

Query Parameters

application.idstring

application.namestring

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

add_on_definition_bundlesobject[]

add_on_definitionobject
- idstring
- namestring
- terraform_nocode_moduleobject
  sourcestring
  versionstring
  The version of the Terraform no-code module.
  module_idstring
- summarystring
- descriptionstring
- readme_markdown_templatestring
- readme_templatestring
  readme_template is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown_template and support for both is transitional.
- labelsstring[]
- variable_optionsobject[]
  TFModuleVariable represents a Terraform module variable.
  namestring
  name is the name of the variable.
  variable_typestring
  optionsstring[]
  user_editableboolean
  indicates if the variable may be set by the app developer.
  descriptionstring
  description is the description of the variable.
- tagsobject[]
  keystring
  the key identifier for this tag.
  valuestring
- terraform_cloud_workspace_detailsobject
  namestring
  The project name for the Terraform Cloud project.
  project_idstring
  The id of the Terraform Cloud project.
- variable_options_out_of_syncboolean
  variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
- module_sourcestring
  module_source is where to find the source code for the desired child module.
install_countstring

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_GetApplicationTemplateBundle2

/waypoint/namespace/{namespace.id}/ui/application-templates/by-name/{application_template.name}

UI_GetApplicationTemplateBundle2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/application-templates/by-name/{application_template.name}

Request

Path Parameters

namespace.idstring

application_template.namestring

Name of the ApplicationTemplate

Query Parameters

application_template.idstring

ID of the ApplicationTemplate

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

action_configsobject[]

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_GetApplicationTemplateBundle

/waypoint/namespace/{namespace.id}/ui/application-templates/{application_template.id}

UI_GetApplicationTemplateBundle


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/application-templates/{application_template.id}

Request

Path Parameters

namespace.idstring

application_template.idstring

ID of the ApplicationTemplate

Query Parameters

application_template.namestring

Name of the ApplicationTemplate

Response

200 - OK

application_templateobject

idstring
namestring
summarystring
descriptionstring
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
readme_markdown_templatestring
readme_templatestring
A markdown text template which is rendered when an Application is created from a ApplicationTemplate to be shown to application developers. Accepted tokens: "{{ .ApplicationName }}", representing the application developer chosen application name "{{ .TfcOrgName }}", representing the Terraform Cloud organization name in which the no-code module was reified. This field is favored over readme_markdown_template and support for both is transitional.
terraform_nocode_moduleobject
- sourcestring
- versionstring
  The version of the Terraform no-code module.
- module_idstring
labelsstring[]
terraform_cloud_workspace_detailsobject
- namestring
  The project name for the Terraform Cloud project.
- project_idstring
  The id of the Terraform Cloud project.
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
variable_optionsobject[]
TFModuleVariable represents a Terraform module variable.
- namestring
  name is the name of the variable.
- variable_typestring
- optionsstring[]
- user_editableboolean
  indicates if the variable may be set by the app developer.
- descriptionstring
  description is the description of the variable.
variable_options_out_of_syncboolean
variable_options_out_of_sync is a boolean value that indicates whether the variable_options are out of sync with the Terraform no-code module, published in Terraform Cloud. This is used to determine whether the variable_options should be updated. API client should not set this value.
module_sourcestring
module_source is where to find the source code for the desired child module.

action_configsobject[]

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_BulkUpdateActionAssignForApp

/waypoint/namespace/{namespace.id}/ui/applications/action-assignments

UI_BulkUpdateActionAssignForApp


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/applications/action-assignments

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

applicationsobject[]

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Response

200 - OK

applicationsobject[]

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_GetApplicationBundle2

/waypoint/namespace/{namespace.id}/ui/applications/by-name/{application.name}

UI_GetApplicationBundle2


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/applications/by-name/{application.name}

Request

Path Parameters

namespace.idstring

application.namestring

Query Parameters

application.idstring

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

action_configsobject[]

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

input_variablesobject[]

InputVariable is a variable whose value has been set.

namestring
name is the name of the Terraform variable.
valuestring
value is the value set for the Terraform variable.
variable_typestring
variable_type is the type of Terraform variable.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_GetApplicationBundle

/waypoint/namespace/{namespace.id}/ui/applications/{application.id}

UI_GetApplicationBundle


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/applications/{application.id}

Request

Path Parameters

namespace.idstring

application.idstring

Query Parameters

application.namestring

Response

200 - OK

applicationobject

idstring
namestring
readme_markdownstring
readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
readmestring
readme is markdown formatted instructions on how to operate the application. This may be populated from a application template. This field is favored over readme_markdown and support for both is transitional.
template_namestring
application_templateobject
- idstring
- namestring
tagsobject[]
- keystring
  the key identifier for this tag.
- valuestring
action_cfg_refsobject[]
- idstring
- namestring
output_valuesobject[]
- namestring
- valuestring
- typestring
- sensitiveboolean
tfc_workspace_idstring

action_configsobject[]

idstring
action_urlstring
URL to trigger an action on. Only used in Custom mode.
namestring
requestobject
- customobject
  Custom mode allows users to define the HTTP method, the request body, etc.
  methodstring
  headersobject[]
  keystring
  valuestring
  urlstring
  bodystring
  A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.
- githubobject
  GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
  methodstring
  auth_tokenstring
  TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.
  usernamestring
  repostring
  refstring
  The git reference for the workflow. Can be a branch or tag name.
  inputsobject
  Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.
  workflow_idstring
  run_idstring
  enable_debug_logboolean
- agentobject
  opobject
  idstring
  bodystring
  action_run_idstring
  groupstring
descriptionstring
created_atstring
The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

input_variablesobject[]

InputVariable is a variable whose value has been set.

namestring
name is the name of the Terraform variable.
valuestring
value is the value set for the Terraform variable.
variable_typestring
variable_type is the type of Terraform variable.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UI_LoadProductBanner

/waypoint/namespace/{namespace.id}/ui/product-banner

UI_LoadProductBanner


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/ui/product-banner

Request

Path Parameters

namespace.idstring

Response

200 - OK

token_expiredboolean

product_validboolean

tfc_org_permissionsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetVariable

/waypoint/namespace/{namespace.id}/variable

GetVariable


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/variable

Request

Path Parameters

namespace.idstring

Query Parameters

variable.idstring

variable.keystring

variable.action.idstring

variable.action.namestring

Response

200 - OK

variableobject

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteVariable

/waypoint/namespace/{namespace.id}/variable

DeleteVariable


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/variable

Request

Path Parameters

namespace.idstring

Query Parameters

variable.idstring

variable.keystring

variable.action.idstring

variable.action.namestring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateVariable

/waypoint/namespace/{namespace.id}/variable

CreateVariable


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/variable

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

variableobject

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

Response

200 - OK

variableobject

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

UpdateVariable

/waypoint/namespace/{namespace.id}/variable

UpdateVariable


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/variable

Request

Path Parameters

namespace.idstring

Body Parameters

namespaceobject

refobject

idstring
keystring
globalobject
actionobject
- idstring
- namestring

variableobject

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

update_maskstring

Optional, will be used for PATCH requests. This includes what fields to update in the request.

Response

200 - OK

variableobject

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

ListVariables

/waypoint/namespace/{namespace.id}/variables

ListVariables


https://api.cloud.hashicorp.com/waypoint/2023-08-18/namespace/{namespace.id}/variables

Request

Path Parameters

namespace.idstring

Query Parameters

scope.application_template.idstring

ID of the ApplicationTemplate

scope.application_template.namestring

Name of the ApplicationTemplate

scope.application.idstring

scope.application.namestring

scope.action.idstring

scope.action.namestring

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

variablesobject[]

idstring
keystring
valuestring
default_valuestring
sensitiveboolean
Whether the variable is sensitive. Cannot be updated once created.
descriptionstring
typestring
scopeobject
- globalobject
- application_templateobject
  idstring
  namestring
- applicationobject
  idstring
  namestring
- actionobject
  idstring
  namestring
overridableboolean

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_tokenstring
This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.
previous_page_tokenstring
This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

GetNamespace

/namespaces

GetNamespace


https://api.cloud.hashicorp.com/waypoint/2023-08-18/organizations/{location.organization_id}/projects/{location.project_id}/namespaces

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

Query Parameters

location.region.providerstring

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.regionstring

region is the cloud region ("us-west1", "us-east1")

Response

200 - OK

namespaceobject

idstring
locationobject
Location represents a target for an operation in HCP.
- organization_idstring
  organization_id is the id of the organization.
- project_idstring
  project_id is the projects id.
- regionobject
  Region identifies a Cloud data-plane region.
  providerstring
  regionstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

CreateNamespace

/namespaces

CreateNamespace


https://api.cloud.hashicorp.com/waypoint/2023-08-18/organizations/{location.organization_id}/projects/{location.project_id}/namespaces

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

Body Parameters

locationobject

Location represents a target for an operation in HCP.

regionobject
Region identifies a Cloud data-plane region.
- providerstring
- regionstring

Response

200 - OK

namespaceobject

idstring
locationobject
Location represents a target for an operation in HCP.
- organization_idstring
  organization_id is the id of the organization.
- project_idstring
  project_id is the projects id.
- regionobject
  Region identifies a Cloud data-plane region.
  providerstring
  regionstring

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

DeleteNamespace

/namespaces/{namespace.id}

DeleteNamespace


https://api.cloud.hashicorp.com/waypoint/2023-08-18/organizations/{location.organization_id}/projects/{location.project_id}/namespaces/{namespace.id}

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namespace.idstring

Query Parameters

location.region.providerstring

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.regionstring

region is the cloud region ("us-west1", "us-east1")

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

​​/​​waypoint​​/​​namespace​

​​/​​namespaces

​​/​​namespaces​​/​​{namespace.id}

Resources

Resources

​​/​​waypoint​​/​​namespace​

​​/​​namespaces

​​/​​namespaces​​/​​{namespace.id}

Resources

Operations

​Get​Action​Run

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Run​Action

Request

Path Parameters

Body Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​List​Action​Runs​By​Namespace

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​List​Action​Runs2

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Send​Status​Log

Request

Path Parameters

Body Parameters

Response

Default Error ResponseDefault Error Response

​List​Action​Runs

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Get​Action​Config

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Delete​Action​Config

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Create​Action​Config

Request

Path Parameters

Body Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Update​Action​Config

Request

Path Parameters

Body Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​List​Action​Configs

/waypoint/namespace

/namespaces

/namespaces/{namespace.id}

/waypoint/namespace

/namespaces

/namespaces/{namespace.id}

GetActionRun

200 - OK

Default Error Response

RunAction

200 - OK

Default Error Response

ListActionRunsByNamespace

200 - OK

Default Error Response

ListActionRuns2

200 - OK

Default Error Response

SendStatusLog

Default Error Response

ListActionRuns

200 - OK

Default Error Response

GetActionConfig

200 - OK

Default Error Response

DeleteActionConfig

200 - OK

Default Error Response

CreateActionConfig

200 - OK

Default Error Response

UpdateActionConfig

200 - OK

Default Error Response

ListActionConfigs

200 - OK

Default Error Response

CreateAddOn

200 - OK

Default Error Response

CreateAddOnDefinition

200 - OK

Default Error Response

GetAddOnDefinition2

200 - OK

Default Error Response

DeleteAddOnDefinition2

Default Error Response

UpdateAddOnDefinition2

200 - OK

Default Error Response

GetAddOnDefinition

200 - OK

Default Error Response

DeleteAddOnDefinition

Default Error Response

UpdateAddOnDefinition

200 - OK

Default Error Response

ListAddOnDefinitions

200 - OK

Default Error Response

GetAddOn2