HashiTalks 2025 Learn about unique use cases, homelab setups, and best practices at scale at our 24-hour virtual knowledge sharing event. Register
HashiCorp Cloud Platform

HCP Waypoint

Loading…
Status
(opens in new tab)
preview

:warning: Version 2023-08-18 of the Waypoint service will be retired Febuary 2025. Service for managing applications.

Download Spec

Operations

​Get​Namespace

get

​/​namespaces

​Get​Namespace

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{location.organization_id}/projects/{location.project_id}/namespaces

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

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
  • activeboolean
  • has_activatedboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​Namespace

post

​/​namespaces

​Create​Namespace

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{location.organization_id}/projects/{location.project_id}/namespaces

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

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
  • activeboolean
  • has_activatedboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Namespace

delete

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

​Delete​Namespace

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{location.organization_id}/projects/{location.project_id}/namespaces/{namespace.id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

namespace.idstringRequired
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")

namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Action​Run

get

​/​action

​Get​Action​Run

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/action

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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
    • 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
  • 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.

      • 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
      • STATUS_QUEUED: the job is queued to run, used by agents
    • 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

​Run​Action

put

​/​action

​Run​Action

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/action

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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
  • 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
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
    • 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
  • 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.

      • 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
      • STATUS_QUEUED: the job is queued to run, used by agents
    • 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

​List​Action​Runs​By​Namespace

get

​/​action-runs

​List​Action​Runs​By​Namespace

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/action-runs

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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
    • 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
  • 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.

      • 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
      • STATUS_QUEUED: the job is queued to run, used by agents
    • 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

​List​Action​Runs2

get

​/​action​/​by-name​/​{action_name}​/​runs

​List​Action​Runs2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/action/by-name/{action_name}/runs

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

action_namestringRequired

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

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

action_idstring

The id of the action config being listed

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
    • 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
  • 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.

      • 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
      • STATUS_QUEUED: the job is queued to run, used by agents
    • 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

​Send​Status​Log

post

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

​Send​Status​Log

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/action/{action_config.id}/action-runs/{action_run_seq}/status-log

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

action_config.idstringRequired

ULID of the action config id

action_run_seqstringRequired

The run sequence to attach this run to

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​List​Action​Runs

get

​/​action​/​{action_id}​/​runs

​List​Action​Runs

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/action/{action_id}/runs

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

action_idstringRequired

The id of the action config being listed

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

action_namestring

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

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
    • 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
  • 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.

      • 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
      • STATUS_QUEUED: the job is queued to run, used by agents
    • 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

​Get​Action​Config

get

​/​actionconfig

​Get​Action​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/actionconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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
    • 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
  • 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.

      • 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
      • STATUS_QUEUED: the job is queued to run, used by agents
    • 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

​Delete​Action​Config

delete

​/​actionconfig

​Delete​Action​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/actionconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​Create​Action​Config

post

​/​actionconfig

​Create​Action​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/actionconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Update​Action​Config

patch

​/​actionconfig

​Update​Action​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/actionconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​List​Action​Configs

get

​/​actionconfigs

​List​Action​Configs

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/actionconfigs

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

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

​Create​Add​On

post

​/​add-on

​Create​Add​On

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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[]
  • summarystring
  • descriptionstring
  • 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
  • module_idstring

    module_id is the ID of the Terraform no-code module configured for the add-on definition used to create this add-on.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​Add​On​Definition

post

​/​add-on-definition

​Create​Add​On​Definition

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definition

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
namestring

DEPRECATED: Use add_on_definition instead.

summarystring

DEPRECATED: Use add_on_definition instead.

descriptionstring

DEPRECATED: Use add_on_definition instead.

readme_markdown_templatestring

DEPRECATED: Use add_on_definition instead.

readme_templatestring

DEPRECATED: Use add_on_definition instead.

labelsstring[]
variable_optionsobject[]

TFModuleVariable represents a Terraform module variable.

  • namestring

    name is the name of the variable.

  • variable_typestring

    variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

  • 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

DEPRECATED: Use add_on_definition instead.

tf_execution_modestring

DEPRECATED: Use add_on_definition instead.

tf_agent_pool_idstring

DEPRECATED: Use add_on_definition instead.

add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Response

200 - OK
add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Add​On​Definition2

get

​/​add-on-definition​/​by-name​/​{add_on_definition.name}

​Get​Add​On​Definition2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definition/by-name/{add_on_definition.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on_definition.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

add_on_definition.idstring

Response

200 - OK
add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Add​On​Definition2

delete

​/​add-on-definition​/​by-name​/​{add_on_definition.name}

​Delete​Add​On​Definition2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definition/by-name/{add_on_definition.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on_definition.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

add_on_definition.idstring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Add​On​Definition2

put

​/​add-on-definition​/​by-name​/​{existing_add_on_definition.name}

​Update​Add​On​Definition2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definition/by-name/{existing_add_on_definition.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_add_on_definition.namestringRequired
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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
existing_add_on_definitionobject

Reference to an existing Add-on

  • idstring
namestring

DEPRECATED: Use add_on_definition instead.

summarystring

DEPRECATED: Use add_on_definition instead.

descriptionstring

DEPRECATED: Use add_on_definition instead.

readme_markdown_templatestring

DEPRECATED: Use add_on_definition instead.

readme_templatestring

DEPRECATED: Use add_on_definition instead.

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

    variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

  • optionsstring[]
  • user_editableboolean

    indicates if the variable may be set by the app developer.

  • descriptionstring

    description is the description of the variable.

module_sourcestring

DEPRECATED: Use add_on_definition instead.

tf_execution_modestring

DEPRECATED: Use add_on_definition instead.

tf_agent_pool_idstring

DEPRECATED: Use add_on_definition instead.

add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Response

200 - OK
add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Add​On​Definition

get

​/​add-on-definition​/​{add_on_definition.id}

​Get​Add​On​Definition

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definition/{add_on_definition.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on_definition.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

add_on_definition.namestring

Response

200 - OK
add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Add​On​Definition

delete

​/​add-on-definition​/​{add_on_definition.id}

​Delete​Add​On​Definition

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definition/{add_on_definition.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on_definition.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

add_on_definition.namestring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Add​On​Definition

put

​/​add-on-definition​/​{existing_add_on_definition.id}

​Update​Add​On​Definition

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definition/{existing_add_on_definition.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_add_on_definition.idstringRequired
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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
existing_add_on_definitionobject

Reference to an existing Add-on

  • idstring
namestring

DEPRECATED: Use add_on_definition instead.

summarystring

DEPRECATED: Use add_on_definition instead.

descriptionstring

DEPRECATED: Use add_on_definition instead.

readme_markdown_templatestring

DEPRECATED: Use add_on_definition instead.

readme_templatestring

DEPRECATED: Use add_on_definition instead.

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

    variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

  • optionsstring[]
  • user_editableboolean

    indicates if the variable may be set by the app developer.

  • descriptionstring

    description is the description of the variable.

module_sourcestring

DEPRECATED: Use add_on_definition instead.

tf_execution_modestring

DEPRECATED: Use add_on_definition instead.

tf_agent_pool_idstring

DEPRECATED: Use add_on_definition instead.

add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Response

200 - OK
add_on_definitionobject
  • idstring
  • namestring
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Add​On​Definitions

get

​/​add-on-definitions

​List​Add​On​Definitions

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on-definitions

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

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
  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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

​Get​Add​On2

get

​/​add-on​/​by-name​/​{add_on.name}

​Get​Add​On2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on/by-name/{add_on.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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[]
  • summarystring
  • descriptionstring
  • 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
  • module_idstring

    module_id is the ID of the Terraform no-code module configured for the add-on definition used to create this add-on.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Destroy​Add​On2

delete

​/​add-on​/​by-name​/​{add_on.name}

​Destroy​Add​On2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on/by-name/{add_on.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

add_on.idstring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​T​F​Workspace​Info3

get

​/​add-on​/​by-name​/​{add_on.name}​/​workspace

​Get​T​F​Workspace​Info3

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on/by-name/{add_on.name}/workspace

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.idstring
application.namestring
add_on.idstring

Response

200 - OK
workspace_infoobject
  • upgrade_availableboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Add​On

get

​/​add-on​/​{add_on.id}

​Get​Add​On

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on/{add_on.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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[]
  • summarystring
  • descriptionstring
  • 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
  • module_idstring

    module_id is the ID of the Terraform no-code module configured for the add-on definition used to create this add-on.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Destroy​Add​On

delete

​/​add-on​/​{add_on.id}

​Destroy​Add​On

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on/{add_on.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

add_on.namestring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​T​F​Workspace​Info4

get

​/​add-on​/​{add_on.id}​/​workspace

​Get​T​F​Workspace​Info4

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on/{add_on.id}/workspace

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

add_on.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.idstring
application.namestring
add_on.namestring

Response

200 - OK
workspace_infoobject
  • upgrade_availableboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Add​On

put

​/​add-on​/​{existing_add_on.id}

​Update​Add​On

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-on/{existing_add_on.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_add_on.idstringRequired
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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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[]
  • summarystring
  • descriptionstring
  • 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
  • module_idstring

    module_id is the ID of the Terraform no-code module configured for the add-on definition used to create this add-on.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Add​Ons

get

​/​add-ons

​List​Add​Ons

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/add-ons

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.idstring
application.namestring
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.

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[]
  • summarystring
  • descriptionstring
  • 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
  • module_idstring

    module_id is the ID of the Terraform no-code module configured for the add-on definition used to create this add-on.

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

​List​Agent​Groups

get

​/​agent​/​group

​List​Agent​Groups

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/group

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

200 - OK
groupsobject[]
  • namestring
  • descriptionstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​Agent​Group

post

​/​agent​/​group

​Create​Agent​Group

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/group

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
groupobject
  • namestring
  • descriptionstring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Agent​Group

get

​/​agent​/​group​/​{name}

​Get​Agent​Group

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/group/{name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

namestringRequired

The name of the group to retrieve the information about

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

200 - OK
groupobject
  • namestring
  • descriptionstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Agent​Group

delete

​/​agent​/​group​/​{name}

​Delete​Agent​Group

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/group/{name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

namestringRequired

The name of the group to delete

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Agent​Group

patch

​/​agent​/​group​/​{name}

​Update​Agent​Group

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/group/{name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

namestringRequired

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
descriptionstring

Response

200 - OK
groupobject
  • namestring
  • descriptionstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Validate​Agent​Groups

post

​/​agent​/​group:validate

​Validate​Agent​Groups

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/group:validate

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
groupsstring[]

Response

200 - OK
known_groupsstring[]
unknown_groupsstring[]
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Ending​Action

post

​/​agent​/​operation:endAction

​Ending​Action

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/operation:endAction

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Queue​Agent​Operation

post

​/​agent​/​operation:queue

​Queue​Agent​Operation

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/operation:queue

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
operationobject
  • idstring
  • bodystring
  • action_run_idstring
  • groupstring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Retrieve​Agent​Operation

post

​/​agent​/​operation:retrieve

​Retrieve​Agent​Operation

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/operation:retrieve

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
groupsstring[]

Response

200 - OK
operationobject
  • idstring
  • bodystring
  • action_run_idstring
  • groupstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Starting​Action

post

​/​agent​/​operation:startAction

​Starting​Action

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/agent/operation:startAction

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
action_run_idstring
group_namestring

Response

200 - OK
action_run_idstring
sequencestring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Application​Templates

get

​/​application-templates

​List​Application​Templates

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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

​Create​Application​Template

post

​/​application-templates

​Create​Application​Template

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Application​Template2

get

​/​application-templates​/​by-name​/​{application_template.name}

​Get​Application​Template2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates/by-name/{application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.namestringRequired

Name of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Application​Template2

delete

​/​application-templates​/​by-name​/​{application_template.name}

​Delete​Application​Template2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates/by-name/{application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.namestringRequired

Name of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application_template.idstring

ID of the ApplicationTemplate

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application​Template2

put

​/​application-templates​/​by-name​/​{existing_application_template.name}

​Update​Application​Template2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates/by-name/{existing_application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_application_template.namestringRequired

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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.

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Application​Template

get

​/​application-templates​/​{application_template.id}

​Get​Application​Template

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates/{application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.idstringRequired

ID of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Application​Template

delete

​/​application-templates​/​{application_template.id}

​Delete​Application​Template

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates/{application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.idstringRequired

ID of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application_template.namestring

Name of the ApplicationTemplate

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application​Template

put

​/​application-templates​/​{existing_application_template.id}

​Update​Application​Template

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application-templates/{existing_application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_application_template.idstringRequired

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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.

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​T​F​Workspace​Info2

get

​/​application​/​by-name​/​{application.name}​/​workspace

​Get​T​F​Workspace​Info2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application/by-name/{application.name}/workspace

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.idstring
add_on.idstring
add_on.namestring

Response

200 - OK
workspace_infoobject
  • upgrade_availableboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​T​F​Workspace​Info

get

​/​application​/​{application.id}​/​workspace

​Get​T​F​Workspace​Info

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/application/{application.id}/workspace

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.namestring
add_on.idstring
add_on.namestring

Response

200 - OK
workspace_infoobject
  • upgrade_availableboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Applications

get

​/​applications

​List​Applications

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

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

​Get​Application2

get

​/​applications​/​by-name​/​{application.name}

​Get​Application2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/by-name/{application.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​Destroy​Application2

delete

​/​applications​/​by-name​/​{application.name}

​Destroy​Application2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/by-name/{application.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.idstring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application2

put

​/​applications​/​by-name​/​{application.name}

​Update​Application2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/by-name/{application.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.namestringRequired
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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Create​Application​From​Template

post

​/​applications​/​from-template

​Create​Application​From​Template

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/from-template

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Get​Application

get

​/​applications​/​{application.id}

​Get​Application

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/{application.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​Destroy​Application

delete

​/​applications​/​{application.id}

​Destroy​Application

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/{application.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.namestring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application

patch

​/​applications​/​{application.id}

​Update​Application

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/{application.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.idstringRequired
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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Upgrade​Application​T​F​Workspace

post

​/​applications​/​{application.name}​/​upgrade-tf-workspace

​Upgrade​Application​T​F​Workspace

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/applications/{application.name}/upgrade-tf-workspace

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.namestringRequired
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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Check​Namespace​Activation

get

​/​check-activation

​Check​Namespace​Activation

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/check-activation

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

forceboolean

If true, will force a recheck of the namespace even if it was recently checked.

Response

200 - OK
activeboolean
has_activatedboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Application​Templates2

get

​/​templates

​List​Application​Templates2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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

​Create​Application​Template2

post

​/​templates

​Create​Application​Template2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Application​Template4

get

​/​templates​/​by-name​/​{application_template.name}

​Get​Application​Template4

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/by-name/{application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.namestringRequired

Name of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Application​Template4

delete

​/​templates​/​by-name​/​{application_template.name}

​Delete​Application​Template4

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/by-name/{application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.namestringRequired

Name of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application_template.idstring

ID of the ApplicationTemplate

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application​Template4

put

​/​templates​/​by-name​/​{existing_application_template.name}

​Update​Application​Template4

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/by-name/{existing_application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_application_template.namestringRequired

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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.

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application​Template6

patch

​/​templates​/​by-name​/​{existing_application_template.name}

​Update​Application​Template6

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/by-name/{existing_application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_application_template.namestringRequired

Name of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

existing_application_template.idstring

ID of the ApplicationTemplate

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

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

    variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

  • 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.

tf_execution_modestring

tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

tf_agent_pool_idstring

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'.

module_idstring

module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Application​Template3

get

​/​templates​/​{application_template.id}

​Get​Application​Template3

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/{application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.idstringRequired

ID of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Application​Template3

delete

​/​templates​/​{application_template.id}

​Delete​Application​Template3

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/{application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.idstringRequired

ID of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application_template.namestring

Name of the ApplicationTemplate

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application​Template3

put

​/​templates​/​{existing_application_template.id}

​Update​Application​Template3

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/{existing_application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_application_template.idstringRequired

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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.

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Application​Template5

patch

​/​templates​/​{existing_application_template.id}

​Update​Application​Template5

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/templates/{existing_application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

existing_application_template.idstringRequired

ID of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

existing_application_template.namestring

Name of the ApplicationTemplate

use_module_readmeboolean

If true, will auto-import the readme from the Terraform module used rather than the one specified in application_template.

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.

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

    variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

  • 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.

tf_execution_modestring

tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

tf_agent_pool_idstring

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'.

module_idstring

module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​T​F​Agent​Pools

get

​/​tf-agent-pools

​List​T​F​Agent​Pools

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tf-agent-pools

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

200 - OK
agent_poolsobject[]
  • idstring
  • namestring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​T​F​Module​Details2

get

​/​tf-module-details​/​{tfc_namespace}​/​{name}​/​{provider}

​Get​T​F​Module​Details2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tf-module-details/{tfc_namespace}/{name}/{provider}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

tfc_namespacestringRequired

tfc_namespace is the Terraform user who owns the Terraform module.

namestringRequired

name is the name of the Terraform module.

providerstringRequired

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

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

versionstring

DEPRECATED: Do not use.

module_idstringRequired

module_id is the ID of the Terraform no-code module. The expected format is "nocode-". This parameter is used for the API call to Atlas.

Response

200 - OK
module_detailsobject
  • readmestring
  • variablesobject[]

    TFModuleVariable represents a Terraform module variable.

    • namestring

      name is the name of the variable.

    • variable_typestring

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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

​Get​T​F​Module​Details3

get

​/​tf-module-details​/​{tfc_namespace}​/​{name}​/​{provider}​/​{module_id}

​Get​T​F​Module​Details3

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tf-module-details/{tfc_namespace}/{name}/{provider}/{module_id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

tfc_namespacestringRequired

tfc_namespace is the Terraform user who owns the Terraform module.

namestringRequired

name is the name of the Terraform module.

providerstringRequired

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

module_idstringRequired

module_id is the ID of the Terraform no-code module. The expected format is "nocode-". This parameter is used for the API call to Atlas.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

versionstring

DEPRECATED: Do not use.

Response

200 - OK
module_detailsobject
  • readmestring
  • variablesobject[]

    TFModuleVariable represents a Terraform module variable.

    • namestring

      name is the name of the variable.

    • variable_typestring

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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

​Get​T​F​Module​Details

get

​/​tf-module-details​/​{tfc_namespace}​/​{name}​/​{provider}​/​{version}

​Get​T​F​Module​Details

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tf-module-details/{tfc_namespace}/{name}/{provider}/{version}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

tfc_namespacestringRequired

tfc_namespace is the Terraform user who owns the Terraform module.

namestringRequired

name is the name of the Terraform module.

providerstringRequired

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

versionstringRequired

DEPRECATED: Do not use.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

module_idstringRequired

module_id is the ID of the Terraform no-code module. The expected format is "nocode-". This parameter is used for the API call to Atlas.

Response

200 - OK
module_detailsobject
  • readmestring
  • variablesobject[]

    TFModuleVariable represents a Terraform module variable.

    • namestring

      name is the name of the variable.

    • variable_typestring

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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

​Get​T​F​Run​Status

get

​/​tf-run-status​/​{workspace_name}

​Get​T​F​Run​Status

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tf-run-status/{workspace_name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

workspace_namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​List​T​F​C​Organizations

post

​/​tfc-organizations

​List​T​F​C​Organizations

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfc-organizations

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​List​T​F​C​Projects

get

​/​tfc-projects

​List​T​F​C​Projects

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfc-projects

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​Get​T​F​C​Config

get

​/​tfcconfig

​Get​T​F​C​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfcconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​Delete​T​F​C​Config

delete

​/​tfcconfig

​Delete​T​F​C​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfcconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​T​F​C​Config

post

​/​tfcconfig

​Create​T​F​C​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfcconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Update​T​F​C​Config

patch

​/​tfcconfig

​Update​T​F​C​Config

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfcconfig

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

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.

  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Check​T​F​C​Organization

get

​/​tfcconfig​/​check-organization

​Check​T​F​C​Organization

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfcconfig/check-organization

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

200 - OK
is_validboolean

is_valid is true if the organization is valid.

permissionsstring[]
has_templates_and_addonsboolean
has_actionsboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​No​Code​Modules

get

​/​tfcmodules

​List​No​Code​Modules

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfcmodules

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

200 - OK
no_code_modulesobject[]
  • versionsstring[]
  • namestring

    name is the name of the no-code module.

  • providerstring

    provider is the Terraform provider for the no-code module.

    ex: AWS

  • createdstring

    date created

  • last_updatedstring
  • tf_namespacestring
  • registry_namestring

    registry_name is the name of the Terraform registry where the module is hosted. This is one of "public" or "private".

  • module_idstring

    module_id is the ID of the no-code module.

  • pinned_versionstring

    pinned_version is the version of the module that is pinned for use in no-code.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​No​Code​Modules2

get

​/​tfmodules

​List​No​Code​Modules2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/tfmodules

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

200 - OK
no_code_modulesobject[]
  • versionsstring[]
  • namestring

    name is the name of the no-code module.

  • providerstring

    provider is the Terraform provider for the no-code module.

    ex: AWS

  • createdstring

    date created

  • last_updatedstring
  • tf_namespacestring
  • registry_namestring

    registry_name is the name of the Terraform registry where the module is hosted. This is one of "public" or "private".

  • module_idstring

    module_id is the ID of the no-code module.

  • pinned_versionstring

    pinned_version is the version of the module that is pinned for use in no-code.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​U​I_​Get​Action​Config​Bundle2

get

​/​ui​/​actionconfig​/​by-name​/​{action_name}

​U​I_​Get​Action​Config​Bundle2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/actionconfig/by-name/{action_name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

action_namestringRequired

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

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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
      • 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
    • 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.

        • 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
        • STATUS_QUEUED: the job is queued to run, used by agents
      • 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
        • 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
      • 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.

          • 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
          • STATUS_QUEUED: the job is queued to run, used by agents
        • 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

​U​I_​Get​Action​Config​Bundle

get

​/​ui​/​actionconfig​/​{action_id}

​U​I_​Get​Action​Config​Bundle

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/actionconfig/{action_id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

action_idstringRequired

The id of the action config being requested

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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
      • 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
    • 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.

        • 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
        • STATUS_QUEUED: the job is queued to run, used by agents
      • 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
        • 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
      • 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.

          • 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
          • STATUS_QUEUED: the job is queued to run, used by agents
        • 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

​U​I​List​Action​Config​Bundles

get

​/​ui​/​actionconfigs

​U​I​List​Action​Config​Bundles

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/actionconfigs

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

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
      • 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
    • 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.

        • 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
        • STATUS_QUEUED: the job is queued to run, used by agents
      • 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
        • 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
      • 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.

          • 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
          • STATUS_QUEUED: the job is queued to run, used by agents
        • 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

​U​I_​Create​Action​Config​With​Vars

post

​/​ui​/​actionconfigwithvars

​U​I_​Create​Action​Config​With​Vars

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/actionconfigwithvars

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​U​I_​List​Add​On​Definitions

get

​/​ui​/​add-on-definitions

​U​I_​List​Add​On​Definitions

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/add-on-definitions

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

application.idstring
application.namestring
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.

Response

200 - OK
add_on_definition_bundlesobject[]
  • add_on_definitionobject
    • idstring
    • namestring
    • 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

        variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

      • 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.

    • tf_execution_modestring

      tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

    • tf_agent_pool_idstring

      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'.

    • module_idstring

      module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

  • 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

​U​I_​Get​Application​Template​Bundle2

get

​/​ui​/​application-templates​/​by-name​/​{application_template.name}

​U​I_​Get​Application​Template​Bundle2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/application-templates/by-name/{application_template.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.namestringRequired

Name of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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

​U​I_​Get​Application​Template​Bundle

get

​/​ui​/​application-templates​/​{application_template.id}

​U​I_​Get​Application​Template​Bundle

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/application-templates/{application_template.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application_template.idstringRequired

ID of the ApplicationTemplate

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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.

  • 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

      variable_type is the type of Terraform variable. See the documentation for more info: https://developer.hashicorp.com/terraform/language/expressions/types The API client should not set this field.

    • 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.

  • tf_execution_modestring

    tf_execution_mode is the mode in which the Terraform backed workspace should operate in. Defaults to 'remote'.

  • tf_agent_pool_idstring

    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'.

  • module_idstring

    module_id is the ID of the template's Terraform module. Clients are expected to set this field when creating a new application template.

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

​U​I_​Bulk​Update​Action​Assign​For​App

patch

​/​ui​/​applications​/​action-assignments

​U​I_​Bulk​Update​Action​Assign​For​App

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/applications/action-assignments

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​U​I_​Get​Application​Bundle2

get

​/​ui​/​applications​/​by-name​/​{application.name}

​U​I_​Get​Application​Bundle2

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/applications/by-name/{application.name}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.namestringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​U​I_​Get​Application​Bundle

get

​/​ui​/​applications​/​{application.id}

​U​I_​Get​Application​Bundle

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/applications/{application.id}

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

application.idstringRequired
Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​U​I_​Load​Product​Banner

get

​/​ui​/​product-banner

​U​I_​Load​Product​Banner

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/ui/product-banner

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

Response

200 - OK
token_expiredboolean
product_validboolean
tfc_org_permissionsstring[]
product_has_activatedboolean
has_actionsboolean
has_templates_and_addonsboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Variable

get

​/​variable

​Get​Variable

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/variable

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

​Delete​Variable

delete

​/​variable

​Delete​Variable

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/variable

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

variable.idstring
variable.keystring
variable.action.idstring
variable.action.namestring

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​Variable

post

​/​variable

​Create​Variable

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/variable

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​Update​Variable

patch

​/​variable

​Update​Variable

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/variable

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Body Parameters
namespaceobject
  • idstring
  • locationobject

    When used via an API request, this is populated and used to populate id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
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

​List​Variables

get

​/​variables

​List​Variables

https://api.cloud.hashicorp.com/waypoint/2024-11-22/organizations/{namespace.location.organization_id}/projects/{namespace.location.project_id}/variables

Request

Path Parameters
namespace.location.organization_idstringRequired

organization_id is the id of the organization.

namespace.location.project_idstringRequired

project_id is the projects id.

Query Parameters
namespace.idstring
namespace.location.region.providerstring

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

namespace.location.region.regionstring

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

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

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.

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