HashiDays One conference. Three cities. Find a city near you
HashiCorp Cloud Platform

HCP Waypoint

Loading…
Status
(opens in new tab)
preview

Service for managing applications.

Operations

​Get​Action​Run

get

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

​Get​Action​Run


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

Request

Path Parameters
namespace.idstringRequired
Query Parameters
action_idstring

The id of the action config being requested

action_namestring

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

sequencestring

The sequence number of the action run (required)

Response

200 - OK
action_runobject
  • namespaceobject

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

    • idstring
  • sequencestring
  • action_configobject
    • idstring
    • action_urlstring

      URL to trigger an action on. Only used in Custom mode.

    • namestring
    • requestobject
      • customobject

        Custom mode allows users to define the HTTP method, the request body, etc.

        • methodstring
        • headersobject[]
          • keystring
          • valuestring
        • urlstring
        • bodystring

          A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

      • githubobject

        GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

        • methodstring
        • auth_tokenstring

          TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

        • usernamestring
        • repostring
        • refstring

          The git reference for the workflow. Can be a branch or tag name.

        • inputsobject

          Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

        • workflow_idstring
        • run_idstring
        • enable_debug_logboolean
      • agentobject
        • opobject
          • idstring
          • bodystring
          • action_run_idstring
          • groupstring
    • descriptionstring
    • created_atstring

      The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

  • created_atstring
  • completed_atstring
  • run_bystring

    NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message

  • response_statusstring

    This is the status of the request that the action ran.

    • NONE: default/zero value; we have no status yet
    • UNKNOWN: a status we didn't understand
    • SUCCESS: action submitted successfully
    • ERROR: it did not work
  • status_logobject[]
    • emitted_atstring
    • logstring
    • metadataobject
  • requestobject
    • customobject

      Custom mode allows users to define the HTTP method, the request body, etc.

      • methodstring
      • headersobject[]
        • keystring
        • valuestring
      • urlstring
      • bodystring

        A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

    • githubobject

      GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

      • methodstring
      • auth_tokenstring

        TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

      • usernamestring
      • repostring
      • refstring

        The git reference for the workflow. Can be a branch or tag name.

      • inputsobject

        Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

      • workflow_idstring
      • run_idstring
      • enable_debug_logboolean
    • agentobject
      • opobject
        • idstring
        • bodystring
        • action_run_idstring
        • groupstring
  • scopeobject
    • globalobject
    • applicationobject
      • idstring
      • namestring
  • background_jobobject

    This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.

    • statusstring

      The various status we allow a job to be in.

      • STATUS_UNSPECIFIED: default/zero value; we have no job status
      • STATUS_UNKNOWN: we don't know the status of the job!
      • STATUS_RUNNING: the job was marked as running
      • STATUS_HALTED: the job was halted/failed to be launched
      • STATUS_SUCCESS: the job was successful
      • STATUS_ERRORED: the job ran, but errored out
      • STATUS_QUEUED: the job is queued to run, used by agents
    • detailsstring
  • idstring
  • action_config_refobject
    • idstring
    • namestring
  • variablesobject[]

    NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.

    • namestring
    • valuestring
    • sensitiveboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Run​Action

put

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

​Run​Action


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

Request

Path Parameters
namespace.idstringRequired
Body Parameters
namespaceobject
action_refobject
  • idstring
  • namestring
scopeobject
  • globalobject
  • applicationobject
    • idstring
    • namestring
variable_overridesobject[]
  • keystring

    The ref key of the variable to override i.e. var.option or application.outputs.key This is a loose association to support local Waypoint vars and TF Outputs.

  • valuestring

    The value to use for the override. Cannot be blank.

  • sensitiveboolean
  • saveboolean

    Whether or not to save this variable's override value in the database for future invocations. Not all variable types are allowed to be saved like built-in Waypoint variables action.name or application.name.

Response

200 - OK
namespaceobject

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

  • idstring
action_runobject
  • namespaceobject

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

    • idstring
  • sequencestring
  • action_configobject
    • idstring
    • action_urlstring

      URL to trigger an action on. Only used in Custom mode.

    • namestring
    • requestobject
      • customobject

        Custom mode allows users to define the HTTP method, the request body, etc.

        • methodstring
        • headersobject[]
          • keystring
          • valuestring
        • urlstring
        • bodystring

          A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

      • githubobject

        GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

        • methodstring
        • auth_tokenstring

          TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

        • usernamestring
        • repostring
        • refstring

          The git reference for the workflow. Can be a branch or tag name.

        • inputsobject

          Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

        • workflow_idstring
        • run_idstring
        • enable_debug_logboolean
      • agentobject
        • opobject
          • idstring
          • bodystring
          • action_run_idstring
          • groupstring
    • descriptionstring
    • created_atstring

      The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

  • created_atstring
  • completed_atstring
  • run_bystring

    NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message

  • response_statusstring

    This is the status of the request that the action ran.

    • NONE: default/zero value; we have no status yet
    • UNKNOWN: a status we didn't understand
    • SUCCESS: action submitted successfully
    • ERROR: it did not work
  • status_logobject[]
    • emitted_atstring
    • logstring
    • metadataobject
  • requestobject
    • customobject

      Custom mode allows users to define the HTTP method, the request body, etc.

      • methodstring
      • headersobject[]
        • keystring
        • valuestring
      • urlstring
      • bodystring

        A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

    • githubobject

      GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

      • methodstring
      • auth_tokenstring

        TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

      • usernamestring
      • repostring
      • refstring

        The git reference for the workflow. Can be a branch or tag name.

      • inputsobject

        Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

      • workflow_idstring
      • run_idstring
      • enable_debug_logboolean
    • agentobject
      • opobject
        • idstring
        • bodystring
        • action_run_idstring
        • groupstring
  • scopeobject
    • globalobject
    • applicationobject
      • idstring
      • namestring
  • background_jobobject

    This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.

    • statusstring

      The various status we allow a job to be in.

      • STATUS_UNSPECIFIED: default/zero value; we have no job status
      • STATUS_UNKNOWN: we don't know the status of the job!
      • STATUS_RUNNING: the job was marked as running
      • STATUS_HALTED: the job was halted/failed to be launched
      • STATUS_SUCCESS: the job was successful
      • STATUS_ERRORED: the job ran, but errored out
      • STATUS_QUEUED: the job is queued to run, used by agents
    • detailsstring
  • idstring
  • action_config_refobject
    • idstring
    • namestring
  • variablesobject[]

    NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.

    • namestring
    • valuestring
    • sensitiveboolean
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Action​Runs​By​Namespace

get

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

​List​Action​Runs​By​Namespace


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

Request

Path Parameters
namespace.idstringRequired
Query Parameters
pagination.page_sizeinteger

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

pagination.next_page_tokenstring

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

pagination.previous_page_tokenstring

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

scope.application.idstring
scope.application.namestring

Response

200 - OK
action_runsobject[]
  • namespaceobject

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

    • idstring
  • sequencestring
  • action_configobject
    • idstring
    • action_urlstring

      URL to trigger an action on. Only used in Custom mode.

    • namestring
    • requestobject
      • customobject

        Custom mode allows users to define the HTTP method, the request body, etc.

        • methodstring
        • headersobject[]
          • keystring
          • valuestring
        • urlstring
        • bodystring

          A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

      • githubobject

        GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

        • methodstring
        • auth_tokenstring

          TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

        • usernamestring
        • repostring
        • refstring

          The git reference for the workflow. Can be a branch or tag name.

        • inputsobject

          Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

        • workflow_idstring
        • run_idstring
        • enable_debug_logboolean
      • agentobject
        • opobject
          • idstring
          • bodystring
          • action_run_idstring
          • groupstring
    • descriptionstring
    • created_atstring

      The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

  • created_atstring
  • completed_atstring
  • run_bystring

    NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message

  • response_statusstring

    This is the status of the request that the action ran.

    • NONE: default/zero value; we have no status yet
    • UNKNOWN: a status we didn't understand
    • SUCCESS: action submitted successfully
    • ERROR: it did not work
  • status_logobject[]
    • emitted_atstring
    • logstring
    • metadataobject
  • requestobject
    • customobject

      Custom mode allows users to define the HTTP method, the request body, etc.

      • methodstring
      • headersobject[]
        • keystring
        • valuestring
      • urlstring
      • bodystring

        A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

    • githubobject

      GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

      • methodstring
      • auth_tokenstring

        TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

      • usernamestring
      • repostring
      • refstring

        The git reference for the workflow. Can be a branch or tag name.

      • inputsobject

        Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

      • workflow_idstring
      • run_idstring
      • enable_debug_logboolean
    • agentobject
      • opobject
        • idstring
        • bodystring
        • action_run_idstring
        • groupstring
  • scopeobject
    • globalobject
    • applicationobject
      • idstring
      • namestring
  • background_jobobject

    This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.

    • statusstring

      The various status we allow a job to be in.

      • STATUS_UNSPECIFIED: default/zero value; we have no job status
      • STATUS_UNKNOWN: we don't know the status of the job!
      • STATUS_RUNNING: the job was marked as running
      • STATUS_HALTED: the job was halted/failed to be launched
      • STATUS_SUCCESS: the job was successful
      • STATUS_ERRORED: the job ran, but errored out
      • STATUS_QUEUED: the job is queued to run, used by agents
    • detailsstring
  • idstring
  • action_config_refobject
    • idstring
    • namestring
  • variablesobject[]

    NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.

    • namestring
    • valuestring
    • sensitiveboolean
paginationobject

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

  • next_page_tokenstring

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

  • previous_page_tokenstring

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

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Action​Runs2

get

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

​List​Action​Runs2


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

Request

Path Parameters
namespace.idstringRequired
action_namestringRequired

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

Query Parameters
action_idstring

The id of the action config being listed

pagination.page_sizeinteger

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

pagination.next_page_tokenstring

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

pagination.previous_page_tokenstring

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

scope.application.idstring
scope.application.namestring

Response

200 - OK
action_runsobject[]
  • namespaceobject

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

    • idstring
  • sequencestring
  • action_configobject
    • idstring
    • action_urlstring

      URL to trigger an action on. Only used in Custom mode.

    • namestring
    • requestobject
      • customobject

        Custom mode allows users to define the HTTP method, the request body, etc.

        • methodstring
        • headersobject[]
          • keystring
          • valuestring
        • urlstring
        • bodystring

          A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

      • githubobject

        GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

        • methodstring
        • auth_tokenstring

          TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

        • usernamestring
        • repostring
        • refstring

          The git reference for the workflow. Can be a branch or tag name.

        • inputsobject

          Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

        • workflow_idstring
        • run_idstring
        • enable_debug_logboolean
      • agentobject
        • opobject
          • idstring
          • bodystring
          • action_run_idstring
          • groupstring
    • descriptionstring
    • created_atstring

      The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

  • created_atstring
  • completed_atstring
  • run_bystring

    NOTE(briancain): Apparently GoWorker/Redis will have job information so maybe we can store that here directly on the run action message

  • response_statusstring

    This is the status of the request that the action ran.

    • NONE: default/zero value; we have no status yet
    • UNKNOWN: a status we didn't understand
    • SUCCESS: action submitted successfully
    • ERROR: it did not work
  • status_logobject[]
    • emitted_atstring
    • logstring
    • metadataobject
  • requestobject
    • customobject

      Custom mode allows users to define the HTTP method, the request body, etc.

      • methodstring
      • headersobject[]
        • keystring
        • valuestring
      • urlstring
      • bodystring

        A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

    • githubobject

      GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

      • methodstring
      • auth_tokenstring

        TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

      • usernamestring
      • repostring
      • refstring

        The git reference for the workflow. Can be a branch or tag name.

      • inputsobject

        Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

      • workflow_idstring
      • run_idstring
      • enable_debug_logboolean
    • agentobject
      • opobject
        • idstring
        • bodystring
        • action_run_idstring
        • groupstring
  • scopeobject
    • globalobject
    • applicationobject
      • idstring
      • namestring
  • background_jobobject

    This job message is purely for representing the status of running a background job through Goworker. Waypoint does not have a "jobs" database table. This message is mainly used for the API to represent the status of running an operation like RunAction as a background job for debugging. Currently it is mainly used to represent the status of running RunAction as a background job.

    • statusstring

      The various status we allow a job to be in.

      • STATUS_UNSPECIFIED: default/zero value; we have no job status
      • STATUS_UNKNOWN: we don't know the status of the job!
      • STATUS_RUNNING: the job was marked as running
      • STATUS_HALTED: the job was halted/failed to be launched
      • STATUS_SUCCESS: the job was successful
      • STATUS_ERRORED: the job ran, but errored out
      • STATUS_QUEUED: the job is queued to run, used by agents
    • detailsstring
  • idstring
  • action_config_refobject
    • idstring
    • namestring
  • variablesobject[]

    NOTE(briancain): In action vars phase 1, this might turn into its own proto message. For now, we'll define it inline here but will likely break our API to change ActionRuns to reference those instead.

    • namestring
    • valuestring
    • sensitiveboolean
paginationobject

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

  • next_page_tokenstring

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

  • previous_page_tokenstring

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

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Send​Status​Log

post

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

​Send​Status​Log


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

Request

Path Parameters
namespace.idstringRequired
action_config.idstringRequired

ULID of the action config id

action_run_seqstringRequired

The run sequence to attach this run to

Body Parameters
namespaceobject
status_logobject
  • emitted_atstring
  • logstring
  • metadataobject
action_configobject

The action config ID to send this to

  • action_urlstring

    URL to trigger an action on. Only used in Custom mode.

  • namestring
  • requestobject
    • customobject

      Custom mode allows users to define the HTTP method, the request body, etc.

      • methodstring
      • headersobject[]
        • keystring
        • valuestring
      • urlstring
      • bodystring

        A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

    • githubobject

      GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

      • methodstring
      • auth_tokenstring

        TODO(briancain): SECURITY. We'd be storing users GitHub auth tokens, but we need it to make the request for them.

      • usernamestring
      • repostring
      • refstring

        The git reference for the workflow. Can be a branch or tag name.

      • inputsobject

        Input keys and values configured in the workflow file. Expected to be turned into a string of json key/vals.

      • workflow_idstring
      • run_idstring
      • enable_debug_logboolean
    • agentobject
      • opobject
        • idstring
        • bodystring
        • action_run_idstring
        • groupstring
  • descriptionstring
  • created_atstring

    The time the action config was created in the database This is mainly a convenience field for the UI and might not always be set.

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Action​Runs

get

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

​List​Action​Runs


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

Request

Path Parameters
namespace.idstringRequired
action_idstringRequired

The id of the action config being listed

Query Parameters
action_namestring

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

pagination.page_sizeinteger

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

pagination.next_page_tokenstring

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

pagination.previous_page_tokenstring

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

scope.application.idstring
scope.application.namestring

Response

200 - OK
action_runsobject[]
  • namespaceobject

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

    • idstring
  • sequencestring
  • action_configobject
    • idstring
    • action_urlstring

      URL to trigger an action on. Only used in Custom mode.

    • namestring
    • requestobject
      • customobject

        Custom mode allows users to define the HTTP method, the request body, etc.

        • methodstring
        • headersobject[]
          • keystring
          • valuestring
        • urlstring
        • bodystring

          A body to be submitted with the request, if required. Will be converted to bytes and sent as the request body.

      • githubobject

        GitHub mode is configured to do various operations on a GitHub repositories defined Workflows.

        • methodstring