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

HCP Vault Secrets

API for managing Secrets on Cloud Services.

Operations

OpenAppSecretByResourceName

/{resource_name}:open

OpenAppSecretByResourceName


https://api.cloud.hashicorp.com/2023-11-28/{resource_name}:open

Request

Path Parameters

resource_namestring

Response

200 - OK

secretobject

namestring
typestring
providerstring
latest_versioninteger
created_atstring
created_by_idstring
sync_statusobject
static_versionobject
- versioninteger
- valuestring
- created_atstring
- created_by_idstring
rotating_versionobject
- versioninteger
- valuesobject
- created_by_idstring
- created_atstring
- expires_atstring
- revoked_atstring
- keysstring[]
dynamic_instanceobject
- valuesobject
- created_atstring
- expires_atstring
- ttlstring

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.

SetTier

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

SetTier


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/billing/tier

Request

Path Parameters

organization_idstring

Body Parameters

project_idstring

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/{organization_id}/usage

GetUsage2


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/usage

Request

Path Parameters

organization_idstring

Query Parameters

project_idstring

Response

200 - OK

billing_tierstring

appsobject

activeinteger
limitinteger
remaininginteger

integrationsobject

activeinteger
limitinteger
remaininginteger

access_api_countsobject

activeinteger
limitinteger
remaininginteger

static_secretsobject

activeinteger
limitinteger
remaininginteger

rotating_secretsobject

activeinteger
limitinteger
remaininginteger

dynamic_secretsobject

activeinteger
limitinteger
remaininginteger

gateway_poolsobject

activeinteger
limitinteger
remaininginteger

connected_syncsobject

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-11-28/organizations/{organization_id}/projects/{project_id}/apps

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

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

pagination.next_page_tokenstring

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

pagination.previous_page_tokenstring

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

namestring

Response

200 - OK

appsobject[]

organization_idstring
project_idstring
namestring
descriptionstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
secret_countinteger
resource_namestring
resource_idstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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-11-28/organizations/{organization_id}/projects/{project_id}/apps

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

descriptionstring

Response

200 - OK

appobject

organization_idstring
project_idstring
namestring
descriptionstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
secret_countinteger
resource_namestring
resource_idstring

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.

ListAwsDynamicSecrets

/apps/{app_name}/dynamic/aws/secret

ListAwsDynamicSecrets


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

secretsobject[]

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
assume_roleobject
- role_arnstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateAwsDynamicSecret

/apps/{app_name}/dynamic/aws/secret

CreateAwsDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

namestring

integration_namestring

default_ttlstring

assume_roleobject

role_arnstring

Response

200 - OK

secretobject

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
assume_roleobject
- role_arnstring

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.

GetAwsDynamicSecret

/apps/{app_name}/dynamic/aws/secret/{name}

GetAwsDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

secretobject

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
assume_roleobject
- role_arnstring

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.

DeleteAwsDynamicSecret

/apps/{app_name}/dynamic/aws/secret/{name}

DeleteAwsDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

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.

UpdateAwsDynamicSecret

/apps/{app_name}/dynamic/aws/secret/{name}

UpdateAwsDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

default_ttlstring

assume_roleobject

role_arnstring

Response

200 - OK

secretobject

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
assume_roleobject
- role_arnstring

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.

ListGcpDynamicSecrets

/apps/{app_name}/dynamic/gcp/secret

ListGcpDynamicSecrets


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

secretsobject[]

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
service_account_impersonationobject
- service_account_emailstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateGcpDynamicSecret

/apps/{app_name}/dynamic/gcp/secret

CreateGcpDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

namestring

integration_namestring

default_ttlstring

service_account_impersonationobject

service_account_emailstring

Response

200 - OK

secretobject

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
service_account_impersonationobject
- service_account_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.

GetGcpDynamicSecret

/apps/{app_name}/dynamic/gcp/secret/{name}

GetGcpDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

secretobject

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
service_account_impersonationobject
- service_account_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.

DeleteGcpDynamicSecret

/apps/{app_name}/dynamic/gcp/secret/{name}

DeleteGcpDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

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.

UpdateGcpDynamicSecret

/apps/{app_name}/dynamic/gcp/secret/{name}

UpdateGcpDynamicSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

default_ttlstring

service_account_impersonationobject

service_account_emailstring

Response

200 - OK

secretobject

namestring
integration_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
default_ttlstring
service_account_impersonationobject
- service_account_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.

CreateAwsIAMUserAccessKeyRotatingSecret

/apps/{app_name}/rotating/aws/secret

CreateAwsIAMUserAccessKeyRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

namestring

integration_namestring

rotation_policy_namestring

aws_iam_user_access_key_paramsobject

usernamestring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
aws_iam_user_access_key_paramsobject
- usernamestring

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.

GetAwsIAMUserAccessKeyRotatingSecretConfig

/apps/{app_name}/rotating/aws/secret/{name}

GetAwsIAMUserAccessKeyRotatingSecretConfig


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
aws_iam_user_access_key_paramsobject
- usernamestring

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.

UpdateAwsIAMUserAccessKeyRotatingSecret

/apps/{app_name}/rotating/aws/secret/{name}

UpdateAwsIAMUserAccessKeyRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

rotation_policy_namestring

rotate_on_updateboolean

aws_iam_user_access_key_paramsobject

usernamestring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
aws_iam_user_access_key_paramsobject
- usernamestring

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.

CreateConfluentCloudApiKeyRotatingSecret

/apps/{app_name}/rotating/confluent/secret

CreateConfluentCloudApiKeyRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

namestring

integration_namestring

rotation_policy_namestring

confluent_cloud_api_key_paramsobject

service_account_idstring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
confluent_cloud_api_key_paramsobject
- service_account_idstring

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.

GetConfluentCloudApiKeyRotatingSecretConfig

/apps/{app_name}/rotating/confluent/secret/{name}

GetConfluentCloudApiKeyRotatingSecretConfig


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
confluent_cloud_api_key_paramsobject
- service_account_idstring

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.

UpdateConfluentCloudApiKeyRotatingSecret

/apps/{app_name}/rotating/confluent/secret/{name}

UpdateConfluentCloudApiKeyRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

rotation_policy_namestring

rotate_on_updateboolean

confluent_cloud_api_key_paramsobject

service_account_idstring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
confluent_cloud_api_key_paramsobject
- service_account_idstring

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.

CreateGcpServiceAccountKeyRotatingSecret

/apps/{app_name}/rotating/gcp/secret

CreateGcpServiceAccountKeyRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

namestring

integration_namestring

rotation_policy_namestring

gcp_service_account_key_paramsobject

service_account_emailstring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
gcp_service_account_key_paramsobject
- service_account_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.

GetGcpServiceAccountKeyRotatingSecretConfig

/apps/{app_name}/rotating/gcp/secret/{name}

GetGcpServiceAccountKeyRotatingSecretConfig


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
gcp_service_account_key_paramsobject
- service_account_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.

UpdateGcpServiceAccountKeyRotatingSecret

/apps/{app_name}/rotating/gcp/secret/{name}

UpdateGcpServiceAccountKeyRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

rotation_policy_namestring

rotate_on_updateboolean

gcp_service_account_key_paramsobject

service_account_emailstring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
gcp_service_account_key_paramsobject
- service_account_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.

CreateMongoDBAtlasRotatingSecret

/apps/{app_name}/rotating/mongodb-atlas/secret

CreateMongoDBAtlasRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

secret_namestring

integration_namestring

rotation_policy_namestring

secret_detailsobject

mongodb_group_idstring
mongodb_rolesobject[]
- role_namestring
- database_namestring
- collection_namestring
mongodb_scopesobject[]
- namestring
- typestring

namestring

Response

200 - OK

configobject

app_namestring
secret_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
namestring

secret_detailsobject

mongodb_group_idstring
mongodb_rolesobject[]
- role_namestring
- database_namestring
- collection_namestring
mongodb_scopesobject[]
- namestring
- typestring

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.

GetMongoDBAtlasRotatingSecretConfig

/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

GetMongoDBAtlasRotatingSecretConfig


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

configobject

app_namestring
secret_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
namestring

mongodb_group_idstring

mongodb_rolesobject[]

role_namestring
database_namestring
collection_namestring

mongodb_scopesobject[]

namestring
typestring

secret_detailsobject

mongodb_group_idstring
mongodb_rolesobject[]
- role_namestring
- database_namestring
- collection_namestring
mongodb_scopesobject[]
- namestring
- typestring

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.

UpdateMongoDBAtlasRotatingSecret

/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

UpdateMongoDBAtlasRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

rotation_policy_namestring

secret_detailsobject

mongodb_group_idstring
mongodb_rolesobject[]
- role_namestring
- database_namestring
- collection_namestring
mongodb_scopesobject[]
- namestring
- typestring

rotate_on_updateboolean

Response

200 - OK

configobject

app_namestring
secret_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
namestring

secret_detailsobject

mongodb_group_idstring
mongodb_rolesobject[]
- role_namestring
- database_namestring
- collection_namestring
mongodb_scopesobject[]
- namestring
- typestring

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.

CreatePostgresRotatingSecret

/apps/{app_name}/rotating/postgres/secret

CreatePostgresRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

namestring

integration_namestring

rotation_policy_namestring

postgres_paramsobject

usernamesstring[]

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
postgres_paramsobject
- usernamesstring[]

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.

GetPostgresRotatingSecretConfig

/apps/{app_name}/rotating/postgres/secret/{name}

GetPostgresRotatingSecretConfig


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
postgres_paramsobject
- usernamesstring[]

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.

UpdatePostgresRotatingSecret

/apps/{app_name}/rotating/postgres/secret/{name}

UpdatePostgresRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

rotation_policy_namestring

postgres_paramsobject

usernamesstring[]

rotate_on_updateboolean

Response

200 - OK

configobject

namestring
app_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
postgres_paramsobject
- usernamesstring[]

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.

CreateTwilioRotatingSecret

/apps/{app_name}/rotating/twilio/secret

CreateTwilioRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

secret_namestring

integration_namestring

rotation_policy_namestring

namestring

Response

200 - OK

configobject

app_namestring
secret_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
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.

GetTwilioRotatingSecretConfig

/apps/{app_name}/rotating/twilio/secret/{name}

GetTwilioRotatingSecretConfig


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

configobject

app_namestring
secret_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
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.

UpdateTwilioRotatingSecret

/apps/{app_name}/rotating/twilio/secret/{name}

UpdateTwilioRotatingSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret/{name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

rotation_policy_namestring

rotate_on_updateboolean

Response

200 - OK

configobject

app_namestring
secret_namestring
integration_namestring
rotation_policy_namestring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
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.

CreateAppKVSecret

/apps/{app_name}/secret/kv

CreateAppKVSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secret/kv

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Body Parameters

namestring

valuestring

Response

200 - OK

secretobject

namestring
typestring
providerstring
latest_versioninteger
created_atstring
created_byobject
- namestring
- typestring
- emailstring
sync_statusobject
static_versionobject
- versioninteger
- created_atstring
- created_byobject
  namestring
  typestring
  emailstring
rotating_versionobject
- versioninteger
- keysstring[]
- created_byobject
  namestring
  typestring
  emailstring
- created_atstring
- expires_atstring
- revoked_atstring
dynamic_configobject
- ttlstring
version_countstring

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

namestring

typestring

Response

200 - OK

secretsobject[]

namestring
typestring
providerstring
latest_versioninteger
created_atstring
created_byobject
- namestring
- typestring
- emailstring
sync_statusobject
static_versionobject
- versioninteger
- created_atstring
- created_byobject
  namestring
  typestring
  emailstring
rotating_versionobject
- versioninteger
- keysstring[]
- created_byobject
  namestring
  typestring
  emailstring
- created_atstring
- expires_atstring
- revoked_atstring
dynamic_configobject
- ttlstring
version_countstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

GetRotatingSecretState

/apps/{app_name}/secrets/{name}/rotation-state

GetRotatingSecretState


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{name}/rotation-state

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Response

200 - OK

stateobject

statusstring
status_previousstring
latest_versioninteger
rotation_time_previousstring
rotation_time_nextstring
error_messagestring

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.

RotateSecret

/apps/{app_name}/secrets/{name}:rotate

RotateSecret


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{name}:rotate

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

namestring

Body Parameters

application/jsonobject

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.

GetAppSecret

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

GetAppSecret


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

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

Response

200 - OK

secretobject

namestring
typestring
providerstring
latest_versioninteger
created_atstring
created_byobject
- namestring
- typestring
- emailstring
sync_statusobject
static_versionobject
- versioninteger
- created_atstring
- created_byobject
  namestring
  typestring
  emailstring
rotating_versionobject
- versioninteger
- keysstring[]
- created_byobject
  namestring
  typestring
  emailstring
- created_atstring
- expires_atstring
- revoked_atstring
dynamic_configobject
- ttlstring
version_countstring

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

typestring

static_versionsobject

versionsobject[]
- versioninteger
- created_atstring
- created_byobject
  namestring
  typestring
  emailstring

rotating_versionsobject

versionsobject[]
- versioninteger
- keysstring[]
- created_byobject
  namestring
  typestring
  emailstring
- created_atstring
- expires_atstring
- revoked_atstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

versioninteger

Response

200 - OK

typestring

static_versionobject

versioninteger
created_atstring
created_byobject
- namestring
- typestring
- emailstring

rotating_versionobject

versioninteger
keysstring[]
created_byobject
- namestring
- typestring
- emailstring
created_atstring
expires_atstring
revoked_atstring

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

versioninteger

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.

OpenAppSecretVersion

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

OpenAppSecretVersion


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

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

versioninteger

Response

200 - OK

typestring

static_versionobject

versioninteger
valuestring
created_atstring
created_by_idstring

rotating_versionobject

versioninteger
valuesobject
created_by_idstring
created_atstring
expires_atstring
revoked_atstring
keysstring[]

dynamic_instanceobject

valuesobject
created_atstring
expires_atstring
ttlstring

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}/secrets/{secret_name}/versions:open

ListOpenAppSecretVersions


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

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

typestring

static_versionsobject

versionsobject[]
- versioninteger
- valuestring
- created_atstring
- created_by_idstring

rotating_versionsobject

versionsobject[]
- versioninteger
- valuesobject
- created_by_idstring
- created_atstring
- expires_atstring
- revoked_atstring
- keysstring[]

dynamic_instanceobject

valuesobject
created_atstring
expires_atstring
ttlstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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}/secrets/{secret_name}:open

OpenAppSecret


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

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

secret_namestring

Response

200 - OK

secretobject

namestring
typestring
providerstring
latest_versioninteger
created_atstring
created_by_idstring
sync_statusobject
static_versionobject
- versioninteger
- valuestring
- created_atstring
- created_by_idstring
rotating_versionobject
- versioninteger
- valuesobject
- created_by_idstring
- created_atstring
- expires_atstring
- revoked_atstring
- keysstring[]
dynamic_instanceobject
- valuesobject
- created_atstring
- expires_atstring
- ttlstring

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}/secrets:open

OpenAppSecrets


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

Request

Path Parameters

organization_idstring

project_idstring

app_namestring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

typesstring[]

Response

200 - OK

secretsobject[]

namestring
typestring
providerstring
latest_versioninteger
created_atstring
created_by_idstring
sync_statusobject
static_versionobject
- versioninteger
- valuestring
- created_atstring
- created_by_idstring
rotating_versionobject
- versioninteger
- valuesobject
- created_by_idstring
- created_atstring
- expires_atstring
- revoked_atstring
- keysstring[]
dynamic_instanceobject
- valuesobject
- created_atstring
- expires_atstring
- ttlstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

appobject

organization_idstring
project_idstring
namestring
descriptionstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
secret_countinteger
resource_namestring
resource_idstring

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

descriptionstring

Response

200 - OK

appobject

organization_idstring
project_idstring
namestring
descriptionstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
secret_countinteger
resource_namestring
resource_idstring

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.

GetAppSyncs

/apps/{name}/syncs

GetAppSyncs


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}/syncs

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

syncsobject[]

sync_namestring
aggregated_statusstring
aggregated_error_codestring
last_synced_atstring
num_secretsstring

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.

ListGatewayPools

/gateway-pools

ListGatewayPools


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools

Request

Path Parameters

organization_idstring

project_idstring

Response

200 - OK

gateway_poolsobject[]

organization_idstring
project_idstring
namestring
descriptionstring
resource_namestring
resource_idstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
service_principal_idstring

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.

CreateGatewayPool

/gateway-pools

CreateGatewayPool


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

descriptionstring

Response

200 - OK

gateway_poolobject

organization_idstring
project_idstring
namestring
descriptionstring
resource_namestring
resource_idstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
service_principal_idstring

client_idstring

client_secretstring

cert_pemstring

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.

GetGatewayPool

/gateway-pools/{gateway_pool_name}

GetGatewayPool


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Request

Path Parameters

organization_idstring

project_idstring

gateway_pool_namestring

Response

200 - OK

gateway_poolobject

organization_idstring
project_idstring
namestring
descriptionstring
resource_namestring
resource_idstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
service_principal_idstring

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.

DeleteGatewayPool

/gateway-pools/{gateway_pool_name}

DeleteGatewayPool


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Request

Path Parameters

organization_idstring

project_idstring

gateway_pool_namestring

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.

UpdateGatewayPool

/gateway-pools/{gateway_pool_name}

UpdateGatewayPool


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Request

Path Parameters

organization_idstring

project_idstring

gateway_pool_namestring

Body Parameters

descriptionstring

Response

200 - OK

gateway_poolobject

organization_idstring
project_idstring
namestring
descriptionstring
resource_namestring
resource_idstring
created_atstring
updated_atstring
created_byobject
- namestring
- typestring
- emailstring
updated_byobject
- namestring
- typestring
- emailstring
service_principal_idstring

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.

GetGatewayPoolCertificate

/gateway-pools/{gateway_pool_name}/certificate

GetGatewayPoolCertificate


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/certificate

Request

Path Parameters

organization_idstring

project_idstring

gateway_pool_namestring

Query Parameters

csr_pemstring

Response

200 - OK

certificate_pemstring

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.

ListGatewayPoolGateways

/gateway-pools/{gateway_pool_name}/gateways

ListGatewayPoolGateways


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/gateways

Request

Path Parameters

organization_idstring

project_idstring

gateway_pool_namestring

Response

200 - OK

gatewaysobject[]

idstring
osstring
versionstring
metadataobject
statusstring
status_messagestring
hostnamestring

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.

ListGatewayPoolIntegrations

/gateway-pools/{gateway_pool_name}/integrations

ListGatewayPoolIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/integrations

Request

Path Parameters

organization_idstring

project_idstring

gateway_pool_namestring

Response

200 - OK

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.

ListIntegrations

/integrations

ListIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

capabilitiesstring[]

providersstring[]

Response

200 - OK

integrationsobject[]

namestring
providerstring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
used_byobject
aws_federated_workload_identityobject
- role_arnstring
- audiencestring
gcp_federated_workload_identityobject
- service_account_emailstring
- audiencestring
twilio_static_credentialsobject
- account_sidstring
- api_key_sidstring
mongo_db_atlas_static_credentialsobject
- api_public_keystring
aws_access_keysobject
- access_key_idstring
gcp_service_account_keyobject
- project_idstring
- client_emailstring
gitlab_access_tokenobject
confluent_static_credentialsobject
- cloud_api_key_idstring
postgres_static_credentialsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateIntegration

/integrations

CreateIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

providerstring

capabilitiesstring[]

aws_federated_workload_identityobject

role_arnstring
audiencestring

gcp_federated_workload_identityobject

service_account_emailstring
audiencestring

twilio_static_credentialsobject

account_sidstring
api_key_sidstring
api_key_secretstring

mongo_db_atlas_static_credentialsobject

api_public_keystring
api_private_keystring

aws_access_keysobject

access_key_idstring
secret_access_keystring

gcp_service_account_keyobject

credentialsstring

gitlab_access_tokenobject

tokenstring

confluent_static_credentialsobject

cloud_api_key_idstring
cloud_api_secretstring

Response

200 - OK

integrationobject

namestring
providerstring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
used_byobject
aws_federated_workload_identityobject
- role_arnstring
- audiencestring
gcp_federated_workload_identityobject
- service_account_emailstring
- audiencestring
twilio_static_credentialsobject
- account_sidstring
- api_key_sidstring
mongo_db_atlas_static_credentialsobject
- api_public_keystring
aws_access_keysobject
- access_key_idstring
gcp_service_account_keyobject
- project_idstring
- client_emailstring
gitlab_access_tokenobject
confluent_static_credentialsobject
- cloud_api_key_idstring
postgres_static_credentialsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring

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.

ListAwsIntegrations

/integrations/aws/config

ListAwsIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

integrationsobject[]

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- role_arnstring
- audiencestring
access_keysobject
- access_key_idstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateAwsIntegration

/integrations/aws/config

CreateAwsIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

federated_workload_identityobject

role_arnstring
audiencestring

access_keysobject

access_key_idstring
secret_access_keystring

capabilitiesstring[]

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- role_arnstring
- audiencestring
access_keysobject
- access_key_idstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

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.

GetAwsIntegration

/integrations/aws/config/{name}

GetAwsIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- role_arnstring
- audiencestring
access_keysobject
- access_key_idstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

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.

DeleteAwsIntegration

/integrations/aws/config/{name}

DeleteAwsIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

UpdateAwsIntegration

/integrations/aws/config/{name}

UpdateAwsIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

federated_workload_identityobject

role_arnstring
audiencestring

access_keysobject

access_key_idstring
secret_access_keystring

capabilitiesstring[]

rotate_on_updateboolean

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- role_arnstring
- audiencestring
access_keysobject
- access_key_idstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

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.

ListConfluentIntegrations

/integrations/confluent/config

ListConfluentIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

integrationsobject[]

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject
static_credential_detailsobject
- cloud_api_key_idstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateConfluentIntegration

/integrations/confluent/config

CreateConfluentIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

capabilitiesstring[]

static_credential_detailsobject

cloud_api_key_idstring
cloud_api_secretstring

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject
static_credential_detailsobject
- cloud_api_key_idstring

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.

GetConfluentIntegration

/integrations/confluent/config/{name}

GetConfluentIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject
static_credential_detailsobject
- cloud_api_key_idstring

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.

DeleteConfluentIntegration

/integrations/confluent/config/{name}

DeleteConfluentIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

UpdateConfluentIntegration

/integrations/confluent/config/{name}

UpdateConfluentIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

capabilitiesstring[]

rotate_on_updateboolean

static_credential_detailsobject

cloud_api_key_idstring
cloud_api_secretstring

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject
static_credential_detailsobject
- cloud_api_key_idstring

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.

ListGcpIntegrations

/integrations/gcp/config

ListGcpIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

integrationsobject[]

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- service_account_emailstring
- audiencestring
service_account_keyobject
- project_idstring
- client_emailstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateGcpIntegration

/integrations/gcp/config

CreateGcpIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

federated_workload_identityobject

service_account_emailstring
audiencestring

service_account_keyobject

credentialsstring

capabilitiesstring[]

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- service_account_emailstring
- audiencestring
service_account_keyobject
- project_idstring
- client_emailstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

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.

GetGcpIntegration

/integrations/gcp/config/{name}

GetGcpIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- service_account_emailstring
- audiencestring
service_account_keyobject
- project_idstring
- client_emailstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

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.

DeleteGcpIntegration

/integrations/gcp/config/{name}

DeleteGcpIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

UpdateGcpIntegration

/integrations/gcp/config/{name}

UpdateGcpIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

federated_workload_identityobject

service_account_emailstring
audiencestring

service_account_keyobject

credentialsstring

capabilitiesstring[]

rotate_on_updateboolean

Response

200 - OK

integrationobject

namestring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
federated_workload_identityobject
- service_account_emailstring
- audiencestring
service_account_keyobject
- project_idstring
- client_emailstring
used_byobject
capabilitiesstring[]
resource_namestring
resource_idstring

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.

ListMongoDBAtlasIntegrations

/integrations/mongodb-atlas/config

ListMongoDBAtlasIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

integrationsobject[]

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- api_public_keystring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateMongoDBAtlasIntegration

/integrations/mongodb-atlas/config

CreateMongoDBAtlasIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

static_credential_detailsobject

api_public_keystring
api_private_keystring

capabilitiesstring[]

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- api_public_keystring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

GetMongoDBAtlasIntegration

/integrations/mongodb-atlas/config/{name}

GetMongoDBAtlasIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- api_public_keystring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

DeleteMongoDBAtlasIntegration

/integrations/mongodb-atlas/config/{name}

DeleteMongoDBAtlasIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

UpdateMongoDBAtlasIntegration

/integrations/mongodb-atlas/config/{name}

UpdateMongoDBAtlasIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

capabilitiesstring[]

gateway_pool_idstring

rotate_on_updateboolean

static_credential_detailsobject

api_public_keystring
api_private_keystring

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- api_public_keystring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

ListPostgresIntegrations

/integrations/postgres/config

ListPostgresIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

integrationsobject[]

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreatePostgresIntegration

/integrations/postgres/config

CreatePostgresIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

static_credential_detailsobject

connection_stringstring

gateway_pool_idstring

capabilitiesstring[]

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

GetPostgresIntegration

/integrations/postgres/config/{name}

GetPostgresIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

DeletePostgresIntegration

/integrations/postgres/config/{name}

DeletePostgresIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

UpdatePostgresIntegration

/integrations/postgres/config/{name}

UpdatePostgresIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

capabilitiesstring[]

rotate_on_updateboolean

static_credential_detailsobject

connection_stringstring

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

ListTwilioIntegrations

/integrations/twilio/config

ListTwilioIntegrations


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

integrationsobject[]

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- account_sidstring
- api_key_sidstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateTwilioIntegration

/integrations/twilio/config

CreateTwilioIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

static_credential_detailsobject

account_sidstring
api_key_sidstring
api_key_secretstring

capabilitiesstring[]

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- account_sidstring
- api_key_sidstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

GetTwilioIntegration

/integrations/twilio/config/{name}

GetTwilioIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- account_sidstring
- api_key_sidstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

DeleteTwilioIntegration

/integrations/twilio/config/{name}

DeleteTwilioIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

UpdateTwilioIntegration

/integrations/twilio/config/{name}

UpdateTwilioIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

capabilitiesstring[]

gateway_pool_idstring

rotate_on_updateboolean

static_credential_detailsobject

account_sidstring
api_key_sidstring
api_key_secretstring

Response

200 - OK

integrationobject

created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
namestring
static_credential_detailsobject
- account_sidstring
- api_key_sidstring
capabilitiesstring[]
resource_namestring
resource_idstring
used_byobject

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.

GetIntegration

/integrations/{name}

GetIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

integrationobject

namestring
providerstring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
used_byobject
aws_federated_workload_identityobject
- role_arnstring
- audiencestring
gcp_federated_workload_identityobject
- service_account_emailstring
- audiencestring
twilio_static_credentialsobject
- account_sidstring
- api_key_sidstring
mongo_db_atlas_static_credentialsobject
- api_public_keystring
aws_access_keysobject
- access_key_idstring
gcp_service_account_keyobject
- project_idstring
- client_emailstring
gitlab_access_tokenobject
confluent_static_credentialsobject
- cloud_api_key_idstring
postgres_static_credentialsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring

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.

DeleteIntegration

/integrations/{name}

DeleteIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

UpdateIntegration

/integrations/{name}

UpdateIntegration


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Body Parameters

providerstring

capabilitiesstring[]

aws_federated_workload_identityobject

role_arnstring
audiencestring

gcp_federated_workload_identityobject

service_account_emailstring
audiencestring

twilio_static_credentialsobject

account_sidstring
api_key_sidstring
api_key_secretstring

mongo_db_atlas_static_credentialsobject

api_public_keystring
api_private_keystring

aws_access_keysobject

access_key_idstring
secret_access_keystring

gcp_service_account_keyobject

credentialsstring

gitlab_access_tokenobject

tokenstring

confluent_static_credentialsobject

cloud_api_key_idstring
cloud_api_secretstring

postgres_static_credentialsobject

connection_stringstring

Response

200 - OK

integrationobject

namestring
providerstring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
used_byobject
aws_federated_workload_identityobject
- role_arnstring
- audiencestring
gcp_federated_workload_identityobject
- service_account_emailstring
- audiencestring
twilio_static_credentialsobject
- account_sidstring
- api_key_sidstring
mongo_db_atlas_static_credentialsobject
- api_public_keystring
aws_access_keysobject
- access_key_idstring
gcp_service_account_keyobject
- project_idstring
- client_emailstring
gitlab_access_tokenobject
confluent_static_credentialsobject
- cloud_api_key_idstring
postgres_static_credentialsobject
- connection_stringstring
capabilitiesstring[]
resource_namestring
resource_idstring

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.

ListSyncs

/syncs

ListSyncs


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs

Request

Path Parameters

organization_idstring

project_idstring

Query Parameters

pagination.page_sizeinteger

pagination.next_page_tokenstring

pagination.previous_page_tokenstring

Response

200 - OK

syncsobject[]

namestring
resource_namestring
resource_idstring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
typestring
integration_namestring
sync_config_gitlabobject
- scopestring
- group_idstring
- project_idstring
- environment_scopestring
- protectedboolean
- rawboolean

paginationobject

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

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

Default Error Response

codeinteger

messagestring

detailsobject[]

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

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

CreateSync

/syncs

CreateSync


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs

Request

Path Parameters

organization_idstring

project_idstring

Body Parameters

namestring

typestring

integration_namestring

sync_config_gitlabobject

scopestring
group_idstring
project_idstring
environment_scopestring
protectedboolean
rawboolean

Response

200 - OK

syncobject

namestring
resource_namestring
resource_idstring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
typestring
integration_namestring
sync_config_gitlabobject
- scopestring
- group_idstring
- project_idstring
- environment_scopestring
- protectedboolean
- rawboolean

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.

GetSync

/syncs/{name}

GetSync


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

Response

200 - OK

syncobject

namestring
resource_namestring
resource_idstring
created_atstring
updated_atstring
created_by_idstring
updated_by_idstring
typestring
integration_namestring
sync_config_gitlabobject
- scopestring
- group_idstring
- project_idstring
- environment_scopestring
- protectedboolean
- rawboolean

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.

DeleteSync

/syncs/{name}

DeleteSync


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs/{name}

Request

Path Parameters

organization_idstring

project_idstring

namestring

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.

GetUsage

/usage

GetUsage


https://api.cloud.hashicorp.com/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/usage

Request

Path Parameters

organization_idstring

project_idstring

Response

200 - OK

billing_tierstring

appsobject

activeinteger
limitinteger
remaininginteger

integrationsobject

activeinteger
limitinteger
remaininginteger

access_api_countsobject

activeinteger
limitinteger
remaininginteger

static_secretsobject

activeinteger
limitinteger
remaininginteger

rotating_secretsobject

activeinteger
limitinteger
remaininginteger

dynamic_secretsobject

activeinteger
limitinteger
remaininginteger

gateway_poolsobject

activeinteger
limitinteger
remaininginteger

connected_syncsobject

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.

​​/​​{resource_name}:open

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

​​/​​apps

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

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

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

​​/​​gateway-pools

​​/​​gateway-pools​​/​​{gateway_pool_name}

​​/​​gateway-pools​​/​​{gateway_pool_name}​

​​/​​integrations

​​/​​integrations​​/​​aws​

​​/​​integrations​​/​​confluent​

​​/​​integrations​​/​​gcp​

​​/​​integrations​​/​​mongodb-atlas​

​​/​​integrations​​/​​postgres​

​​/​​integrations​​/​​twilio​

​​/​​integrations​​/​​{name}

​​/​​syncs

​​/​​syncs​​/​​{name}

​​/​​usage

Resources

Resources

​​/​​{resource_name}:open

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

​​/​​apps

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

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

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

​​/​​gateway-pools

​​/​​gateway-pools​​/​​{gateway_pool_name}

​​/​​gateway-pools​​/​​{gateway_pool_name}​

​​/​​integrations

​​/​​integrations​​/​​aws​

​​/​​integrations​​/​​confluent​

​​/​​integrations​​/​​gcp​

​​/​​integrations​​/​​mongodb-atlas​

​​/​​integrations​​/​​postgres​

​​/​​integrations​​/​​twilio​

​​/​​integrations​​/​​{name}

​​/​​syncs

​​/​​syncs​​/​​{name}

​​/​​usage

Resources

Operations

​Open​App​Secret​By​Resource​Name

Request

Path Parameters

Response

200 - OK200 - OK

Default Error ResponseDefault Error Response

​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

​List​Aws​Dynamic​Secrets

Request

/{resource_name}:open

/secrets/organizations

/apps

/apps/{app_name}

/apps/{name}

/apps/{name}

/gateway-pools

/gateway-pools/{gateway_pool_name}

/gateway-pools/{gateway_pool_name}

/integrations

/integrations/aws

/integrations/confluent

/integrations/gcp

/integrations/mongodb-atlas

/integrations/postgres

/integrations/twilio

/integrations/{name}

/syncs

/syncs/{name}

/usage

/{resource_name}:open

/secrets/organizations

/apps

/apps/{app_name}

/apps/{name}

/apps/{name}

/gateway-pools

/gateway-pools/{gateway_pool_name}

/gateway-pools/{gateway_pool_name}

/integrations

/integrations/aws

/integrations/confluent

/integrations/gcp

/integrations/mongodb-atlas

/integrations/postgres

/integrations/twilio

/integrations/{name}

/syncs

/syncs/{name}

/usage

OpenAppSecretByResourceName

200 - OK

Default Error Response

SetTier

200 - OK

Default Error Response

GetUsage2

200 - OK

Default Error Response

ListApps

200 - OK

Default Error Response

CreateApp

200 - OK

Default Error Response

ListAwsDynamicSecrets

200 - OK

Default Error Response

CreateAwsDynamicSecret

200 - OK

Default Error Response

GetAwsDynamicSecret

200 - OK

Default Error Response

DeleteAwsDynamicSecret

Default Error Response

UpdateAwsDynamicSecret

200 - OK

Default Error Response

ListGcpDynamicSecrets

200 - OK

Default Error Response

CreateGcpDynamicSecret

200 - OK

Default Error Response

GetGcpDynamicSecret

200 - OK

Default Error Response

DeleteGcpDynamicSecret

Default Error Response