HCP Vault Secrets Centralized secrets lifecycle management for developers. Learn More
HashiCorp Cloud Platform

HCP Vault Secrets Service

Loading…
Status
(opens in new tab)
preview

API for managing Secrets on Cloud Services.

Operations

​List​Apps

get

​/​apps

​List​Apps


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps

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
appsobject[]
  • 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
  • namestring
  • descriptionstring
  • created_atstring
  • updated_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • updated_byobject
    • namestring
    • typestring
    • emailstring
  • sync_integrationsstring[]
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​App

post

​/​apps

​Create​App


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps

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
namestring
descriptionstring
sync_integrationsstring[]

Response

200 - OK
appobject
  • 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
  • namestring
  • descriptionstring
  • created_atstring
  • updated_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • updated_byobject
    • namestring
    • typestring
    • emailstring
  • sync_integrationsstring[]
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​App​K​V​Secret

post

​/​apps​/​{app_name}​/​kv

​Create​App​K​V​Secret


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/kv

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
namestring
valuestring

Response

200 - OK
secretobject
  • namestring
  • versionobject
    • versionstring
    • typestring
    • created_atstring
    • created_byobject
      • namestring
      • typestring
      • emailstring
  • created_atstring
  • latest_versionstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • sync_statusobject
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Open​App​Secrets

get

​/​apps​/​{app_name}​/​open

​Open​App​Secrets


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/open

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
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
secretsobject[]
  • namestring
  • versionobject
    • versionstring
    • typestring
    • created_atstring
    • valuestring
    • created_byobject
      • namestring
      • typestring
      • emailstring
  • created_atstring
  • latest_versionstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • sync_statusobject
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Open​App​Secret

get

​/​apps​/​{app_name}​/​open​/​{secret_name}

​Open​App​Secret


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/open/{secret_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
secret_namestringRequired
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
secretobject
  • namestring
  • versionobject
    • versionstring
    • typestring
    • created_atstring
    • valuestring
    • created_byobject
      • namestring
      • typestring
      • emailstring
  • created_atstring
  • latest_versionstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • sync_statusobject
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Open​App​Secret​Versions

get

​/​apps​/​{app_name}​/​open​/​{secret_name}​/​versions

​List​Open​App​Secret​Versions


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/open/{secret_name}/versions

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
secret_namestringRequired
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
versionsobject[]
  • versionstring
  • typestring
  • created_atstring
  • valuestring
  • created_byobject
    • namestring
    • typestring
    • emailstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Open​App​Secret​Version

get

​/​apps​/​{app_name}​/​open​/​{secret_name}​/​versions​/​{version}

​Open​App​Secret​Version


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/open/{secret_name}/versions/{version}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
secret_namestringRequired
versionstringRequired
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
versionobject
  • versionstring
  • typestring
  • created_atstring
  • valuestring
  • created_byobject
    • namestring
    • typestring
    • emailstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​App​Secrets

get

​/​apps​/​{app_name}​/​secrets

​List​App​Secrets


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/secrets

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
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
secretsobject[]
  • namestring
  • versionobject
    • versionstring
    • typestring
    • created_atstring
    • created_byobject
      • namestring
      • typestring
      • emailstring
  • created_atstring
  • latest_versionstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • sync_statusobject
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​App​Secret

get

​/​apps​/​{app_name}​/​secrets​/​{secret_name}

​Get​App​Secret


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/secrets/{secret_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
secret_namestringRequired
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
secretobject
  • namestring
  • versionobject
    • versionstring
    • typestring
    • created_atstring
    • created_byobject
      • namestring
      • typestring
      • emailstring
  • created_atstring
  • latest_versionstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • sync_statusobject
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​App​Secret

delete

​/​apps​/​{app_name}​/​secrets​/​{secret_name}

​Delete​App​Secret


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/secrets/{secret_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
secret_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​App​Secret​Versions

get

​/​apps​/​{app_name}​/​secrets​/​{secret_name}​/​versions

​List​App​Secret​Versions


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/secrets/{secret_name}/versions

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
secret_namestringRequired
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
versionsobject[]
  • versionstring
  • typestring
  • created_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​App​Secret​Version

get

​/​apps​/​{app_name}​/​secrets​/​{secret_name}​/​versions​/​{version}

​Get​App​Secret​Version


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

app_namestringRequired
secret_namestringRequired
versionstringRequired
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
versionobject
  • versionstring
  • typestring
  • created_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​App

get

​/​apps​/​{name}

​Get​App


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

namestringRequired
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
appobject
  • 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
  • namestring
  • descriptionstring
  • created_atstring
  • updated_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • updated_byobject
    • namestring
    • typestring
    • emailstring
  • sync_integrationsstring[]
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​App

delete

​/​apps​/​{name}

​Delete​App


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​App

patch

​/​apps​/​{name}

​Update​App


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/apps/{name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

namestringRequired
Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
descriptionstring
sync_integrationsstring[]

Response

200 - OK
appobject
  • 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
  • namestring
  • descriptionstring
  • created_atstring
  • updated_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • updated_byobject
    • namestring
    • typestring
    • emailstring
  • sync_integrationsstring[]
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​Aws​Sm​Sync​Integration

post

​/​sync​/​aws-sm

​Create​Aws​Sm​Sync​Integration


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/sync/aws-sm

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
namestring
aws_sm_connection_detailsobject
  • access_key_idstring
  • secret_access_keystring
  • regionstring
  • role_arnstring
  • external_idstring

Response

200 - OK
sync_integrationobject
  • 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
  • namestring
  • typestring
  • created_atstring
  • updated_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • updated_byobject
    • namestring
    • typestring
    • emailstring
  • aws_sm_connection_detailsobject
    • regionstring
    • role_arnstring
    • external_idstring
  • gh_repo_connection_detailsobject
    • ownerstring
    • repositorystring
    • installation_idstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Upsert​Aws​Sm​Sync​Integration

put

​/​sync​/​aws-sm

​Upsert​Aws​Sm​Sync​Integration


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/sync/aws-sm

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
namestring
aws_sm_connection_detailsobject
  • access_key_idstring
  • secret_access_keystring
  • regionstring
  • role_arnstring
  • external_idstring

Response

200 - OK
sync_integrationobject
  • 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
  • namestring
  • typestring
  • created_atstring
  • updated_atstring
  • created_byobject
    • namestring
    • typestring
    • emailstring
  • updated_byobject
    • namestring
    • typestring
    • emailstring
  • aws_sm_connection_detailsobject
    • regionstring
    • role_arnstring
    • external_idstring
  • gh_repo_connection_detailsobject
    • ownerstring
    • repositorystring
    • installation_idstring
Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Aws​Sm​Sync​Integration

patch

​/​sync​/​aws-sm​/​{name}

​Update​Aws​Sm​Sync​Integration


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/projects/{location.project_id}/sync/aws-sm/{name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

namestringRequired
Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
aws_sm_connection_detailsobject
  • access_key_idstring
  • secret_access_keystring