HashiDays One conference. Three cities. Find a city near you

HCP Vault Secrets

API for managing Secrets on Cloud Services.

Operations

SetTier

/secrets/organizations/{location.organization_id}/billing/tier

SetTier


https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{location.organization_id}/billing/tier

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

Body Parameters

locationobject

Location represents a target for an operation in HCP.

project_idstring
project_id is the projects id.
regionobject
Region identifies a Cloud data-plane region.
- providerstring
- regionstring

tierstring

Response

200 - OK

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetUsage2

/secrets/organizations/{location.organization_id}/usage

GetUsage2


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

Query Parameters

location.project_idstring

project_id is the projects id.

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

billing_tierstring

appsobject

activeinteger
limitinteger
remaininginteger

secretsobject

activeinteger
limitinteger
remaininginteger

integrationsobject

activeinteger
limitinteger
remaininginteger

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

ListApps

/apps

ListApps


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

CreateApp

/apps

CreateApp


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

CreateAppKVSecret

/apps/{app_name}/kv

CreateAppKVSecret


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

OpenAppSecrets

/apps/{app_name}/open

OpenAppSecrets


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

OpenAppSecret

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

OpenAppSecret


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

ListOpenAppSecretVersions

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

ListOpenAppSecretVersions


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

OpenAppSecretVersion

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

OpenAppSecretVersion


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

versionstring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

ListAppSecrets

/apps/{app_name}/secrets

ListAppSecrets


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetAppSecret

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

GetAppSecret


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

DeleteAppSecret

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

DeleteAppSecret


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

ListAppSecretVersions

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

ListAppSecretVersions


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetAppSecretVersion

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

GetAppSecretVersion


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

versionstring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

DeleteAppSecretVersion

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

DeleteAppSecretVersion


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

app_namestring

secret_namestring

versionstring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetApp

/apps/{name}

GetApp


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

DeleteApp

/apps/{name}

DeleteApp


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpdateApp

/apps/{name}

UpdateApp


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

CreateAwsSmSyncIntegration

/sync/aws-sm

CreateAwsSmSyncIntegration


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_idstring

organization_id is the id of the organization.

location.project_idstring

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

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpsertAwsSmSyncIntegration

/sync/aws-sm

UpsertAwsSmSyncIntegration


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_idstring

organization_id is the id of the organization.

location.project_idstring

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

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpdateAwsSmSyncIntegration

/sync/aws-sm/{name}

UpdateAwsSmSyncIntegration


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_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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
regionstring
role_arnstring

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

ForceSync

/sync/force

ForceSync


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

app_namestring

sync_integration_namestring

operationstring

Response

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

CreateGhRepoSyncIntegration

/sync/gh-repo

CreateGhRepoSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

gh_repo_connection_detailsobject

tokenstring
ownerstring
repositorystring

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpsertGhRepoSyncIntegration

/sync/gh-repo

UpsertGhRepoSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

gh_repo_connection_detailsobject

tokenstring
ownerstring
repositorystring

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpdateGhRepoSyncIntegration

/sync/gh-repo/{name}

UpdateGhRepoSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

Body Parameters

locationobject

Location represents a target for an operation in HCP.

regionobject
Region identifies a Cloud data-plane region.
- providerstring
- regionstring

gh_repo_connection_detailsobject

tokenstring
ownerstring
repositorystring

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetGitHubInstallLinks

/sync/github/links

GetGitHubInstallLinks


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

installation_urlstring

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpsertSyncInstallation

/sync/installations

UpsertSyncInstallation


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

Response

200 - OK

sync_installationobject

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
aws_assume_roleobject
- external_idstring
gh_appobject
- installation_idstring
- ownerstring
- repositoriesstring[]
vercel_oauthobject
- configuration_idstring
- user_or_team_idstring
- user_or_team_namestring
- is_teamboolean
- projectsobject[]
  idstring
  namestring
- user_or_team_display_namestring

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetSyncInstallation

/sync/installations/{name}

GetSyncInstallation


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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

sync_installationobject

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
aws_assume_roleobject
- external_idstring
gh_appobject
- installation_idstring
- ownerstring
- repositoriesstring[]
vercel_oauthobject
- configuration_idstring
- user_or_team_idstring
- user_or_team_namestring
- is_teamboolean
- projectsobject[]
  idstring
  namestring
- user_or_team_display_namestring

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

DeleteSyncInstallation

/sync/installations/{name}

DeleteSyncInstallation


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

ListSyncIntegrations

/sync/integrations

ListSyncIntegrations


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

sync_integrationsobject[]

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetSyncIntegration

/sync/integrations/{name}

GetSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

DeleteSyncIntegration

/sync/integrations/{name}

DeleteSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

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[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

CreateVercelProjectSyncIntegration

/sync/vercel-project

CreateVercelProjectSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

vercel_project_connection_detailsobject

access_tokenstring
project_idstring
project_namestring
team_idstring
deployment_environmentsstring[]
user_or_team_namestring

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpsertVercelProjectSyncIntegration

/sync/vercel-project

UpsertVercelProjectSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

vercel_project_connection_detailsobject

access_tokenstring
project_idstring
project_namestring
team_idstring
deployment_environmentsstring[]
user_or_team_namestring

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

UpdateVercelProjectSyncIntegration

/sync/vercel-project/{name}

UpdateVercelProjectSyncIntegration


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

namestring

Body Parameters

locationobject

Location represents a target for an operation in HCP.

regionobject
Region identifies a Cloud data-plane region.
- providerstring
- regionstring

vercel_project_connection_detailsobject

access_tokenstring
project_idstring
project_namestring
team_idstring
deployment_environmentsstring[]
user_or_team_namestring

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
vercel_project_connection_detailsobject
- configuration_idstring
- project_idstring
- project_namestring
- team_idstring
- deployment_environmentsstring[]

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetVercelInstallationLink

/sync/vercel/link

GetVercelInstallationLink


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

installation_urlstring

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

GetUsage

/usage

GetUsage


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

Request

Path Parameters

location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

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

billing_tierstring

appsobject

activeinteger
limitinteger
remaininginteger

secretsobject

activeinteger
limitinteger
remaininginteger

integrationsobject

activeinteger
limitinteger
remaininginteger

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

CompleteGitHubInstall

/secrets/sync/github/callback

CompleteGitHubInstall


https://api.cloud.hashicorp.com/secrets/2023-06-13/sync/github/callback

Request

Query Parameters

codestring

statestring

installation_idstring

setup_actionstring

Response

200 - OK

content_typestring

The HTTP Content-Type header value specifying the content type of the body.

datastring

The HTTP request/response body as raw binary.

extensionsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

CompleteVercelInstallation

/secrets/sync/vercel/callback

CompleteVercelInstallation


https://api.cloud.hashicorp.com/secrets/2023-06-13/sync/vercel/callback

Request

Query Parameters

codestring

statestring

configuration_idstring

team_idstring

Response

200 - OK

content_typestring

The HTTP Content-Type header value specifying the content type of the body.

datastring

The HTTP request/response body as raw binary.

extensionsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

Default Error Response

codeinteger

messagestring

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

@typestring
A URL that describes the type of the serialized message.

​​/​​secrets​​/​​organizations​

​​/​​apps

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

​​/​​apps​​/​​{name}

​​/​​sync​​/​​aws-sm

​​/​​sync​​/​​aws-sm​

​​/​​sync​​/​​force

​​/​​sync​​/​​gh-repo

​​/​​sync​​/​​gh-repo​

​​/​​sync​​/​​github​

​​/​​sync​​/​​installations

​​/​​sync​​/​​installations​

​​/​​sync​​/​​integrations

​​/​​sync​​/​​integrations​

​​/​​sync​​/​​vercel-project

​​/​​sync​​/​​vercel-project​

​​/​​sync​​/​​vercel​

​​/​​usage

​​/​​secrets​​/​​sync​

Resources

Resources

​​/​​secrets​​/​​organizations​

​​/​​apps

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

​​/​​apps​​/​​{name}

​​/​​sync​​/​​aws-sm

​​/​​sync​​/​​aws-sm​

​​/​​sync​​/​​force

​​/​​sync​​/​​gh-repo

​​/​​sync​​/​​gh-repo​

​​/​​sync​​/​​github​

​​/​​sync​​/​​installations

​​/​​sync​​/​​installations​

​​/​​sync​​/​​integrations

​​/​​sync​​/​​integrations​

​​/​​sync​​/​​vercel-project

​​/​​sync​​/​​vercel-project​

​​/​​sync​​/​​vercel​

​​/​​usage

​​/​​secrets​​/​​sync​

Resources

Operations

​Set​Tier

Request

Path Parameters

Body Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Get​Usage2

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​List​Apps

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Create​App

Request

Path Parameters

Body Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Create​App​K​V​Secret

Request

Path Parameters

Body Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Open​App​Secrets

Request

Path Parameters

/secrets/organizations

/apps

/apps/{app_name}

/apps/{name}

/sync/aws-sm

/sync/aws-sm

/sync/force

/sync/gh-repo

/sync/gh-repo

/sync/github

/sync/installations

/sync/installations

/sync/integrations

/sync/integrations

/sync/vercel-project

/sync/vercel-project

/sync/vercel

/usage

/secrets/sync

/secrets/organizations

/apps

/apps/{app_name}

/apps/{name}

/sync/aws-sm

/sync/aws-sm

/sync/force

/sync/gh-repo

/sync/gh-repo

/sync/github

/sync/installations

/sync/installations

/sync/integrations

/sync/integrations

/sync/vercel-project

/sync/vercel-project

/sync/vercel

/usage

/secrets/sync

SetTier

200 - OK

Default Error Response

GetUsage2

200 - OK

Default Error Response

ListApps

200 - OK

Default Error Response

CreateApp

200 - OK

Default Error Response

CreateAppKVSecret

200 - OK

Default Error Response

OpenAppSecrets

200 - OK

Default Error Response

OpenAppSecret

200 - OK

Default Error Response

ListOpenAppSecretVersions

200 - OK

Default Error Response

OpenAppSecretVersion

200 - OK

Default Error Response

ListAppSecrets

200 - OK

Default Error Response

GetAppSecret

200 - OK

Default Error Response

DeleteAppSecret

Default Error Response

ListAppSecretVersions

200 - OK

Default Error Response

GetAppSecretVersion

200 - OK

Default Error Response

DeleteAppSecretVersion