Service for managing applications.
GitHubCallbackSession
https:/GetNamespace
https:/CreateNamespace
https:/DeleteNamespace
https:/provider is the named cloud provider ("aws", "gcp", "azure")
GetActionRun
https:/provider is the named cloud provider ("aws", "gcp", "azure")
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
RunAction
https:/Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
ListActionRunsByNamespace
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
ListActionRuns2
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
SendStatusLog
https:/organization_id is the id of the organization.
The action config ID to send this to
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
ListActionRuns
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
GetActionConfig
https:/provider is the named cloud provider ("aws", "gcp", "azure")
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
DeleteActionConfig
https:/provider is the named cloud provider ("aws", "gcp", "azure")
CreateActionConfig
https:/GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
UpdateActionConfig
https:/GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
ListActionConfigs
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
CreateAddOn
https:/CreateAddOnDefinition
https:/TFModuleVariable represents a Terraform module variable.
TFModuleVariable represents a Terraform module variable.
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.
TFModuleVariable represents a Terraform module variable.
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.
GetAddOnDefinition2
https:/TFModuleVariable represents a Terraform module variable.
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.
DeleteAddOnDefinition2
https:/UpdateAddOnDefinition2
https:/TFModuleVariable represents a Terraform module variable.
TFModuleVariable represents a Terraform module variable.
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.
TFModuleVariable represents a Terraform module variable.
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.
UpdateAddOnDefinition4
https:/TFModuleVariable represents a Terraform module variable.
TFModuleVariable represents a Terraform module variable.
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.
TFModuleVariable represents a Terraform module variable.
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.
GetAddOnDefinition
https:/TFModuleVariable represents a Terraform module variable.
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.
DeleteAddOnDefinition
https:/UpdateAddOnDefinition
https:/TFModuleVariable represents a Terraform module variable.
TFModuleVariable represents a Terraform module variable.
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.
TFModuleVariable represents a Terraform module variable.
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.
UpdateAddOnDefinition3
https:/TFModuleVariable represents a Terraform module variable.
TFModuleVariable represents a Terraform module variable.
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.
TFModuleVariable represents a Terraform module variable.
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.
ListAddOnDefinitions
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
GetAddOn2
https:/DestroyAddOn2
https:/GetTFWorkspaceInfo3
https:/GetAddOn
https:/DestroyAddOn
https:/GetTFWorkspaceInfo4
https:/UpdateAddOn
https:/ListAddOns
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
ListAgentGroups
https:/CreateAgentGroup
https:/GetAgentGroup
https:/DeleteAgentGroup
https:/UpdateAgentGroup
https:/organization_id is the id of the organization.
ValidateAgentGroups
https:/EndingAction
https:/The status code for the operation. Follows general unix and http status code semantics.
QueueAgentOperation
https:/RetrieveAgentOperation
https:/StartingAction
https:/ListApplicationTemplates
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
CreateApplicationTemplate
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
GetApplicationTemplate2
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
DeleteApplicationTemplate2
https:/UpdateApplicationTemplate2
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
GetApplicationTemplate
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
DeleteApplicationTemplate
https:/UpdateApplicationTemplate
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
GetTFWorkspaceInfo2
https:/GetTFWorkspaceInfo
https:/ListApplications
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
GetApplication2
https:/DestroyApplication2
https:/UpdateApplication2
https:/readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
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.
CreateApplicationFromTemplate
https:/GetApplication
https:/DestroyApplication
https:/UpdateApplication
https:/readme_markdown is markdown formatted instructions on how to operate the application. This may be populated from a application template.
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.
UpgradeApplicationTFWorkspace
https:/CheckNamespaceActivation
https:/GetGitHubInstallations
https:/GetGitHubRepos
https:/CreateGitHubSession
https:/install_url is the URL of the GitHub install-only flow page for the app. Use this to allow the user to install the app in additional locations.
auth_url is the URL of the GitHub install & auth flow for the app. Use this for the regular “Authenticate with GitHub” flows from the Waypoint UIs. It will automatically skip the relevant steps if the app is already installed and authorized respective to the current user.
GetGitHubWorkflows
https:/ListIntegrations
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
CreateIntegration
https:/Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GetIntegration2
https:/Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
DeleteIntegration2
https:/GetIntegration
https:/Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
DeleteIntegration
https:/ListApplicationTemplates2
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
CreateApplicationTemplate2
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
GetApplicationTemplate4
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
DeleteApplicationTemplate4
https:/UpdateApplicationTemplate4
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
UpdateApplicationTemplate6
https:/provider is the named cloud provider ("aws", "gcp", "azure")
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
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.
TFModuleVariable represents a Terraform module variable.
tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.
tf_agent_pool_id is the ID of the agent pool to use for the Terraform workspace if 'agent' is used for 'tf_execution_mode'.
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.
TFModuleVariable represents a Terraform module variable.
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.
GetApplicationTemplate3
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
DeleteApplicationTemplate3
https:/UpdateApplicationTemplate3
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
UpdateApplicationTemplate5
https:/provider is the named cloud provider ("aws", "gcp", "azure")
A long-form description of what the ApplicationTemplate is to be used for. This description is shared between platform engineers and application developers.
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.
TFModuleVariable represents a Terraform module variable.
tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.
tf_agent_pool_id is the ID of the agent pool to use for the Terraform workspace if 'agent' is used for 'tf_execution_mode'.
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.
TFModuleVariable represents a Terraform module variable.
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.
ListTFAgentPools
https:/GetTFModuleDetails2
https:/organization_id is the id of the organization.
tfc_namespace is the Terraform user who owns the Terraform module.
provider is the named cloud provider ("aws", "gcp", "azure")
TFModuleVariable represents a Terraform module variable.
GetTFModuleDetails3
https:/organization_id is the id of the organization.
tfc_namespace is the Terraform user who owns the Terraform module.
TFModuleVariable represents a Terraform module variable.
GetTFModuleDetails
https:/organization_id is the id of the organization.
tfc_namespace is the Terraform user who owns the Terraform module.
provider is the named cloud provider ("aws", "gcp", "azure")
TFModuleVariable represents a Terraform module variable.
GetTFRunStatus
https:/ListTFCOrganizations
https:/ListTFCProjects
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
GetTFCConfig
https:/DeleteTFCConfig
https:/CreateTFCConfig
https:/UpdateTFCConfig
https:/CheckTFCOrganization
https:/ListNoCodeModules
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
ListNoCodeModules2
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
UI_GetActionConfigBundle2
https:/GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
UI_GetActionConfigBundle
https:/provider is the named cloud provider ("aws", "gcp", "azure")
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
UIListActionConfigBundles
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
Global references the entire server. This is used in some APIs as a way to read/write values that are server-global.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
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.
The various status we allow a job to be in.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
UI_CreateActionConfigWithVars
https:/GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
UI_ListAddOnDefinitions
https:/provider is the named cloud provider ("aws", "gcp", "azure")
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.
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.
TFModuleVariable represents a Terraform module variable.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.
UI_GetApplicationTemplateBundle2
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
UI_GetApplicationTemplateBundle
https:/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.
TFModuleVariable represents a Terraform module variable.
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.
GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
UI_BulkUpdateActionAssignForApp
https:/UI_GetApplicationBundle2
https:/GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
UI_GetApplicationBundle
https:/GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.
UI_LoadProductBanner
https:/provider is the named cloud provider ("aws", "gcp", "azure")
GetVariable
https:/DeleteVariable
https:/CreateVariable
https:/UpdateVariable
https:/ListVariables
https:/provider is the named cloud provider ("aws", "gcp", "azure")
ExternalID returns the ID of the action config reference in response messages and is an output only field.
ActionName returns the name of the action config reference in response messages and is an output only field.
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.
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.
PaginationResponse is the response holding the page tokens for a paginated list response.
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.