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

HCP Vault Secrets Service

API for managing Secrets on Cloud Services.

Operations

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

@typestring

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

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

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

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

@typestring

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

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

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

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

aws_external_idstring

gh_installation_idstring

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

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

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

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

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

@typestring

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

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

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

Default Error Response

codeinteger

messagestring

detailsobject[]

@typestring

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

@typestring

​/​apps

​/​apps​/​{app_name}

​/​apps​/​{name}

​/​sync​/​aws-sm

​/​sync​/​force

​/​sync​/​gh-repo

​/​sync​/​installations

​/​sync​/​integrations

Resources

Resources

​/​apps

​/​apps​/​{app_name}

​/​apps​/​{name}

​/​sync​/​aws-sm

​/​sync​/​force

​/​sync​/​gh-repo

​/​sync​/​installations

​/​sync​/​integrations

Resources

Operations

​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

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Open​App​Secret

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​List​Open​App​Secret​Versions

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Open​App​Secret​Version

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​List​App​Secrets

Request

Path Parameters

Query Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​Get​App​Secret

Request

Path Parameters

Query Parameters

/apps

/apps/{app_name}

/apps/{name}

/sync/aws-sm

/sync/force

/sync/gh-repo

/sync/installations

/sync/integrations

/apps

/apps/{app_name}

/apps/{name}

/sync/aws-sm

/sync/force

/sync/gh-repo

/sync/installations

/sync/integrations

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

GetApp

200 - OK

Default Error Response

DeleteApp

Default Error Response

UpdateApp

200 - OK

Default Error Response

CreateAwsSmSyncIntegration

200 - OK

Default Error Response

UpsertAwsSmSyncIntegration

200 - OK

Default Error Response

UpdateAwsSmSyncIntegration

200 - OK

Default Error Response

ForceSync