Acquisition complete HashiCorp officially joins the IBM family. Learn more
HashiCorp Cloud Platform

HCP Waypoint

Loading…
Status
(opens in new tab)
preview

Service for managing applications.

Download Spec

Operations

​Git​Hub​Callback​Session

get

​/​waypoint​/​github​/​callback

​Git​Hub​Callback​Session

https://api.cloud.hashicorp.com/waypoint/2024-11-22/github/callback

Request

Query Parameters
codestring

code is the code from the callback

statestring

state is session id

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​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
  • has_actionsboolean
  • actions_grace_periodboolean
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
  • has_actionsboolean
  • actions_grace_periodboolean
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
    • outputsobject
      • external_idstring

        ExternalID returns the ID of the action config reference in response messages and is an output only field.

      • action_namestring

        ActionName returns the name of the action config reference in response messages and is an output only field.

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

      ExternalID returns the ID of the action config reference in response messages and is an output only field.

    • action_namestring

      ActionName returns the name of the action config reference in response messages and is an output only field.

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

        ExternalID returns the ID of the action config reference in response messages and is an output only field.

      • action_namestring

        ActionName returns the name of the action config reference in response messages and is an output only field.

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

        ExternalID returns the ID of the action config reference in response messages and is an output only field.

      • action_namestring

        ActionName returns the name of the action config reference in response messages and is an output only field.

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

        ExternalID returns the ID of the action config reference in response messages and is an output only field.

      • action_namestring

        ActionName returns the name of the action config reference in response messages and is an output only field.

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

        ExternalID returns the ID of the action config reference in response messages and is an output only field.

      • action_namestring

        ActionName returns the name of the action config reference in response messages and is an output only field.

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

        ExternalID returns the ID of the action config reference in response messages and is an output only field.

      • action_namestring

        ActionName returns the name of the action config reference in response messages and is an output only field.

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

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.

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

​Update​Add​On​Definition4

patch

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

​Update​Add​On​Definition4

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.

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.

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.

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.

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

​Update​Add​On​Definition3

patch

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

​Update​Add​On​Definition3

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.

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.

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