HashiCorp Cloud Platform Vault SecretsStable

Open App Secret By Resource NameGET/2023-11-28/{resource_name}:open

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/2023-11-28/{resource_name}:open

Path Parameters

resource_name string

Successful Response

secret object

name string

type string

provider string

latest_version integer

created_at string

created_by_id string

sync_status object

static_version object

version integer

value string

created_at string

created_by_id string

rotating_version object

version integer

values object

created_by_id string

created_at string

expires_at string

revoked_at string

keys string[]

dynamic_instance object

values object

created_at string

expires_at string

ttl string

Set TierPUT/secrets/2023-11-28/organizations/{organization_id}/billing/tier

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/billing/tier

Path Parameters

organization_id string

Body Parameters

project_id string

tier string

List AppsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

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

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

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.

name_contains string

Successful Response

apps object[]

organization_id string

project_id string

name string

description string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

sync_names string[]

secret_count integer

resource_name string

resource_id string

pagination object

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

next_page_token string

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

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.

Create AppPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps

Path Parameters

organization_id string

project_id string

Body Parameters

name string

description string

sync_names string[]

Successful Response

app object

organization_id string

project_id string

name string

description string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

sync_names string[]

secret_count integer

resource_name string

resource_id string

List Aws Dynamic SecretsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret

Path Parameters

organization_id string

project_id string

app_name string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

secrets object[]

AWS

name string

integration_name string

created_at string

updated_at string

created_by_id string

updated_by_id string

default_ttl string

assume_role object

role_arn string

pagination object

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

next_page_token string

previous_page_token string

Create Aws Dynamic SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

default_ttl string

assume_role object

role_arn string

Get Aws Dynamic SecretGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Aws Dynamic SecretPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

default_ttl string

assume_role object

role_arn string

Delete Aws Dynamic SecretDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/aws/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

List Gcp Dynamic SecretsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret

Path Parameters

organization_id string

project_id string

app_name string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

secrets object[]

GCP

name string

integration_name string

created_at string

updated_at string

created_by_id string

updated_by_id string

default_ttl string

service_account_impersonation object

service_account_email string

pagination object

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

next_page_token string

previous_page_token string

Create Gcp Dynamic SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

default_ttl string

service_account_impersonation object

service_account_email string

Get Gcp Dynamic SecretGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Gcp Dynamic SecretPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

default_ttl string

service_account_impersonation object

service_account_email string

Delete Gcp Dynamic SecretDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/dynamic/gcp/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Create Aws Iam User Access Key Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

aws_iam_user_access_key_params object

username string

Get Aws Iam User Access Key Rotating Secret ConfigGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Aws Iam User Access Key Rotating SecretPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/aws/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

rotate_on_update boolean

aws_iam_user_access_key_params object

username string

Create Azure Application Password Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/azure/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/azure/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

azure_application_password_params object

app_object_id string

app_client_id string

Get Azure Application Password Rotating Secret ConfigGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/azure/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/azure/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Azure Application Password Rotating SecretPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/azure/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/azure/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

rotate_on_update boolean

azure_application_password_params object

app_object_id string

app_client_id string

Create Confluent Cloud Api Key Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

confluent_cloud_api_key_params object

service_account_id string

Get Confluent Cloud Api Key Rotating Secret ConfigGET

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Confluent Cloud Api Key Rotating SecretPUT

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/confluent/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

rotate_on_update boolean

confluent_cloud_api_key_params object

service_account_id string

Create Gcp Service Account Key Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

gcp_service_account_key_params object

service_account_email string

Get Gcp Service Account Key Rotating Secret ConfigGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Gcp Service Account Key Rotating SecretPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/gcp/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

rotate_on_update boolean

gcp_service_account_key_params object

service_account_email string

Create Mongo Db Atlas Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

secret_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

Successful Response

config object

app_name string

name string

integration_name string

rotation_policy_name string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

secret_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

Get Mongo Db Atlas Rotating Secret ConfigGET

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Successful Response

config object

app_name string

name string

integration_name string

rotation_policy_name string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

secret_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

Update Mongo Db Atlas Rotating SecretPUT

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/mongodb-atlas/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

secret_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

rotate_on_update boolean

Successful Response

config object

app_name string

name string

integration_name string

rotation_policy_name string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

secret_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

Create Postgres Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

postgres_params object

usernames string[]

Get Postgres Rotating Secret ConfigGET

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Postgres Rotating SecretPUT

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/postgres/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

postgres_params object

usernames string[]

rotate_on_update boolean

Create Random Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/random/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/random/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

params object

username_template string

Get Random Rotating Secret ConfigGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/random/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/random/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Random Rotating SecretPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/random/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/random/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

rotate_on_update boolean

params object

username_template string

Create Twilio Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

Get Twilio Rotating Secret ConfigGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Update Twilio Rotating SecretPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/rotating/twilio/secret/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

rotation_policy_name string

rotate_on_update boolean

Create App Kv SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secret/kv

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secret/kv

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

value string

Successful Response

secret object

name string

type string

provider string

latest_version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

sync_status object

static_version object

version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

rotating_version object

version integer

keys string[]

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

created_at string

expires_at string

revoked_at string

dynamic_config object

ttl string

version_count string

List App SecretsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets

Path Parameters

organization_id string

project_id string

app_name string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

name_contains string

types string[]

Successful Response

secrets object[]

name string

type string

provider string

latest_version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

sync_status object

static_version object

version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

rotating_version object

version integer

keys string[]

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

created_at string

expires_at string

revoked_at string

dynamic_config object

ttl string

version_count string

pagination object

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

next_page_token string

previous_page_token string

Create App Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/rotating

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/rotating

Path Parameters

organization_id string

project_id string

app_name string

Body Parameters

name string

integration_name string

rotation_policy_name string

aws_access_key_details object

Field name format: {provider}_{credential_type}_details

username string

azure_application_password_details object

app_object_id string

app_client_id string

confluent_cloud_api_key_details object

service_account_id string

gcp_service_account_key_details object

service_account_email string

mongodb_atlas_user_password_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

postgres_user_password_details object

usernames string[]

random_user_password_details object

username_template string

twilio_api_key_details object

Successful Response

secret object

name string

provider string

integration_name string

rotation_policy_name string

created_at string

updated_at string

created_by_id string

updated_by_id string

aws_access_key_details object

username string

azure_application_password_details object

app_object_id string

app_client_id string

confluent_cloud_api_key_details object

service_account_id string

gcp_service_account_key_details object

service_account_email string

mongodb_atlas_user_password_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

postgres_user_password_details object

usernames string[]

random_user_password_details object

username_template string

twilio_api_key_details object

Get App Rotating SecretGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/rotating/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/rotating/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Successful Response

secret object

name string

provider string

integration_name string

rotation_policy_name string

created_at string

updated_at string

created_by_id string

updated_by_id string

aws_access_key_details object

username string

azure_application_password_details object

app_object_id string

app_client_id string

confluent_cloud_api_key_details object

service_account_id string

gcp_service_account_key_details object

service_account_email string

mongodb_atlas_user_password_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

postgres_user_password_details object

usernames string[]

random_user_password_details object

username_template string

twilio_api_key_details object

Update App Rotating SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/rotating/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/rotating/{name}

Path Parameters

organization_id string

project_id string

app_name string

name string

Body Parameters

integration_name string

rotation_policy_name string

rotate_on_update boolean

aws_access_key_details object

username string

azure_application_password_details object

app_object_id string

app_client_id string

confluent_cloud_api_key_details object

service_account_id string

gcp_service_account_key_details object

service_account_email string

mongodb_atlas_user_password_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

postgres_user_password_details object

usernames string[]

random_user_password_details object

username_template string

twilio_api_key_details object

Successful Response

secret object

name string

provider string

integration_name string

rotation_policy_name string

created_at string

updated_at string

created_by_id string

updated_by_id string

aws_access_key_details object

username string

azure_application_password_details object

app_object_id string

app_client_id string

confluent_cloud_api_key_details object

service_account_id string

gcp_service_account_key_details object

service_account_email string

mongodb_atlas_user_password_details object

mongodb_group_id string

mongodb_roles object[]

role_name string

database_name string

collection_name string

mongodb_scopes object[]

name string

type string

postgres_user_password_details object

usernames string[]

random_user_password_details object

username_template string

twilio_api_key_details object

Get Rotating Secret StateGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{name}/rotation-state

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{name}/rotation-state

Path Parameters

organization_id string

project_id string

app_name string

name string

Rotate SecretPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{name}:rotate

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{name}:rotate

Path Parameters

organization_id string

project_id string

app_name string

name string

Get App SecretGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

Successful Response

secret object

name string

type string

provider string

latest_version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

sync_status object

static_version object

version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

rotating_version object

version integer

keys string[]

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

created_at string

expires_at string

revoked_at string

dynamic_config object

ttl string

version_count string

Delete App SecretDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

List App Secret VersionsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

type string

static_versions object

versions object[]

version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

rotating_versions object

versions object[]

version integer

keys string[]

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

created_at string

expires_at string

revoked_at string

pagination object

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

next_page_token string

previous_page_token string

Get App Secret VersionGET

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

version integer

Successful Response

type string

static_version object

version integer

created_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

rotating_version object

version integer

keys string[]

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

created_at string

expires_at string

revoked_at string

Delete App Secret VersionDELETE

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

version integer

Open App Secret VersionGET

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}:open

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions/{version}:open

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

version integer

List Open App Secret VersionsGET

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions:open

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}/versions:open

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

type string

static_versions object

versions object[]

version integer

value string

created_at string

created_by_id string

rotating_versions object

versions object[]

version integer

values object

created_by_id string

created_at string

expires_at string

revoked_at string

keys string[]

dynamic_instance object

values object

created_at string

expires_at string

ttl string

pagination object

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

next_page_token string

previous_page_token string

Open App SecretGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}:open

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets/{secret_name}:open

Path Parameters

organization_id string

project_id string

app_name string

secret_name string

Successful Response

secret object

name string

type string

provider string

latest_version integer

created_at string

created_by_id string

sync_status object

static_version object

version integer

value string

created_at string

created_by_id string

rotating_version object

version integer

values object

created_by_id string

created_at string

expires_at string

revoked_at string

keys string[]

dynamic_instance object

values object

created_at string

expires_at string

ttl string

Open App SecretsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets:open

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{app_name}/secrets:open

Path Parameters

organization_id string

project_id string

app_name string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

types string[]

name_contains string

Successful Response

secrets object[]

name string

type string

provider string

latest_version integer

created_at string

created_by_id string

sync_status object

static_version object

version integer

value string

created_at string

created_by_id string

rotating_version object

version integer

values object

created_by_id string

created_at string

expires_at string

revoked_at string

keys string[]

dynamic_instance object

values object

created_at string

expires_at string

ttl string

pagination object

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

next_page_token string

previous_page_token string

Get AppGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Path Parameters

organization_id string

project_id string

name string

Successful Response

app object

organization_id string

project_id string

name string

description string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

sync_names string[]

secret_count integer

resource_name string

resource_id string

Delete AppDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Path Parameters

organization_id string

project_id string

name string

Update AppPATCH/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

description string

sync_names string[]

Successful Response

app object

organization_id string

project_id string

name string

description string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

sync_names string[]

secret_count integer

resource_name string

resource_id string

Get App SyncsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}/syncs

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/apps/{name}/syncs

PREVIEW / UNSTABLE

Path Parameters

organization_id string

project_id string

name string

List Gateway PoolsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools

Path Parameters

organization_id string

project_id string

Successful Response

gateway_pools object[]

organization_id string

project_id string

name string

description string

resource_name string

resource_id string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

service_principal_id string

Create Gateway PoolPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools

Path Parameters

organization_id string

project_id string

Body Parameters

name string

description string

Successful Response

gateway_pool object

organization_id string

project_id string

name string

description string

resource_name string

resource_id string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

service_principal_id string

client_id string

client_id is the oauth client_id for the gateway service principal

client_secret string

client_secret is the oauth client_secret for the gateway service principal

Get Gateway PoolGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Path Parameters

organization_id string

project_id string

gateway_pool_name string

Successful Response

gateway_pool object

organization_id string

project_id string

name string

description string

resource_name string

resource_id string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

service_principal_id string

Update Gateway PoolPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Path Parameters

organization_id string

project_id string

gateway_pool_name string

Body Parameters

description string

Successful Response

gateway_pool object

organization_id string

project_id string

name string

description string

resource_name string

resource_id string

created_at string

updated_at string

created_by object

Information about the principal who created or updated the resource

name string

type string

email string

updated_by object

Information about the principal who created or updated the resource

name string

type string

email string

service_principal_id string

Delete Gateway PoolDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}

Path Parameters

organization_id string

project_id string

gateway_pool_name string

Get Gateway Pool CertificateGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/certificate

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/certificate

Path Parameters

organization_id string

project_id string

gateway_pool_name string

Query Parameters

csr_pem string

List Gateway Pool GatewaysGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/gateways

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/gateways

Path Parameters

organization_id string

project_id string

gateway_pool_name string

List Gateway Pool IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/integrations

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/gateway-pools/{gateway_pool_name}/integrations

Path Parameters

organization_id string

project_id string

gateway_pool_name string

List IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

capabilities string[]

providers string[]

name_contains string

Successful Response

integrations object[]

name string

provider string

created_at string

updated_at string

created_by_id string

updated_by_id string

used_by object

aws_federated_workload_identity object

role_arn string

audience string

gcp_federated_workload_identity object

service_account_email string

audience string

twilio_static_credentials object

account_sid string

api_key_sid string

mongo_db_atlas_static_credentials object

api_public_key string

aws_access_keys object

access_key_id string

gcp_service_account_key object

project_id string

client_email string

gitlab_access_token object

confluent_static_credentials object

cloud_api_key_id string

postgres_static_credentials object

connection_string string

azure_client_secret object

tenant_id string

client_id string

azure_federated_workload_identity object

tenant_id string

client_id string

audience string

mysql_static_credentials object

connection_string string

capabilities string[]

resource_name string

resource_id string

pagination object

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

next_page_token string

previous_page_token string

Create IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations

Path Parameters

organization_id string

project_id string

Body Parameters

name string

provider string

capabilities string[]

aws_federated_workload_identity object

role_arn string

audience string

gcp_federated_workload_identity object

service_account_email string

audience string

twilio_static_credentials object

account_sid string

api_key_sid string

api_key_secret string

mongo_db_atlas_static_credentials object

api_public_key string

api_private_key string

aws_access_keys object

access_key_id string

secret_access_key string

gcp_service_account_key object

credentials string

gitlab_access_token object

--- Gitlab ---

token string

confluent_static_credentials object

cloud_api_key_id string

cloud_api_secret string

azure_client_secret object

tenant_id string

client_id string

client_secret string

azure_federated_workload_identity object

tenant_id string

client_id string

audience string

postgres_static_credentials object

connection_string string

mysql_static_credentials object

connection_string string

gateway_pool_id string

Successful Response

integration object

name string

provider string

created_at string

updated_at string

created_by_id string

updated_by_id string

used_by object

aws_federated_workload_identity object

role_arn string

audience string

gcp_federated_workload_identity object

service_account_email string

audience string

twilio_static_credentials object

account_sid string

api_key_sid string

mongo_db_atlas_static_credentials object

api_public_key string

aws_access_keys object

access_key_id string

gcp_service_account_key object

project_id string

client_email string

gitlab_access_token object

confluent_static_credentials object

cloud_api_key_id string

postgres_static_credentials object

connection_string string

azure_client_secret object

tenant_id string

client_id string

azure_federated_workload_identity object

tenant_id string

client_id string

audience string

mysql_static_credentials object

connection_string string

capabilities string[]

resource_name string

resource_id string

List Aws IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

name string

created_at string

updated_at string

created_by_id string

updated_by_id string

federated_workload_identity object

role_arn string

audience string

access_keys object

access_key_id string

used_by object

capabilities string[]

resource_name string

resource_id string

pagination object

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

next_page_token string

previous_page_token string

Create Aws IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

federated_workload_identity object

role_arn string

audience string

access_keys object

access_key_id string

secret_access_key string

capabilities string[]

Get Aws IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Aws IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

federated_workload_identity object

role_arn string

audience string

access_keys object

access_key_id string

secret_access_key string

capabilities string[]

rotate_on_update boolean

Delete Aws IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/aws/config/{name}

Path Parameters

organization_id string

project_id string

name string

List Azure IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

name string

created_at string

updated_at string

created_by_id string

updated_by_id string

federated_workload_identity object

tenant_id string

client_id string

audience string

client_secret object

tenant_id string

client_id string

used_by object

capabilities string[]

resource_name string

resource_id string

pagination object

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

next_page_token string

previous_page_token string

Create Azure IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

federated_workload_identity object

tenant_id string

client_id string

audience string

client_secret object

tenant_id string

client_id string

client_secret string

capabilities string[]

Get Azure IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Azure IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

federated_workload_identity object

tenant_id string

client_id string

audience string

client_secret object

tenant_id string

client_id string

client_secret string

capabilities string[]

rotate_on_update boolean

Delete Azure IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/azure/config/{name}

Path Parameters

organization_id string

project_id string

name string

List Confluent IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

name string

created_at string

updated_at string

created_by_id string

updated_by_id string

capabilities string[]

resource_name string

resource_id string

used_by object

static_credential_details object

cloud_api_key_id string

pagination object

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

next_page_token string

previous_page_token string

Create Confluent IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

capabilities string[]

static_credential_details object

cloud_api_key_id string

cloud_api_secret string

Get Confluent IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Confluent IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

capabilities string[]

rotate_on_update boolean

static_credential_details object

cloud_api_key_id string

cloud_api_secret string

Delete Confluent IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/confluent/config/{name}

Path Parameters

organization_id string

project_id string

name string

List Gcp IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

--- GCP ---

name string

created_at string

updated_at string

created_by_id string

updated_by_id string

federated_workload_identity object

service_account_email string

audience string

service_account_key object

project_id string

client_email string

used_by object

capabilities string[]

resource_name string

resource_id string

pagination object

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

next_page_token string

previous_page_token string

Create Gcp IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

federated_workload_identity object

service_account_email string

audience string

service_account_key object

credentials string

capabilities string[]

Get Gcp IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Gcp IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

federated_workload_identity object

service_account_email string

audience string

service_account_key object

credentials string

capabilities string[]

rotate_on_update boolean

Delete Gcp IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/gcp/config/{name}

Path Parameters

organization_id string

project_id string

name string

List Mongo Db Atlas IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

created_at string

updated_at string

created_by_id string

updated_by_id string

name string

static_credential_details object

api_public_key string

capabilities string[]

resource_name string

resource_id string

used_by object

pagination object

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

next_page_token string

previous_page_token string

Create Mongo Db Atlas IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

static_credential_details object

api_public_key string

api_private_key string

capabilities string[]

Get Mongo Db Atlas IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Mongo Db Atlas IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

capabilities string[]

gateway_pool_id string

rotate_on_update boolean

static_credential_details object

api_public_key string

api_private_key string

Delete Mongo Db Atlas IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/mongodb-atlas/config/{name}

Path Parameters

organization_id string

project_id string

name string

List Postgres IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

created_at string

updated_at string

created_by_id string

updated_by_id string

name string

static_credential_details object

connection_string string

capabilities string[]

resource_name string

resource_id string

used_by object

pagination object

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

next_page_token string

previous_page_token string

Create Postgres IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

static_credential_details object

connection_string string

gateway_pool_id string

capabilities string[]

Get Postgres IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Postgres IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

capabilities string[]

rotate_on_update boolean

static_credential_details object

connection_string string

Delete Postgres IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/postgres/config/{name}

Path Parameters

organization_id string

project_id string

name string

List Random IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

name string

capabilities string[]

created_at string

updated_at string

used_by object

created_by_id string

updated_by_id string

resource_name string

resource_id string

pagination object

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

next_page_token string

previous_page_token string

Create Random IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

capabilities string[]

Get Random IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Random IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

capabilities string[]

rotate_on_update boolean

Delete Random IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/random/config/{name}

Path Parameters

organization_id string

project_id string

name string

List Twilio IntegrationsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

integrations object[]

created_at string

updated_at string

created_by_id string

updated_by_id string

name string

static_credential_details object

account_sid string

api_key_sid string

capabilities string[]

resource_name string

resource_id string

used_by object

pagination object

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

next_page_token string

previous_page_token string

Create Twilio IntegrationPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config

Path Parameters

organization_id string

project_id string

Body Parameters

name string

static_credential_details object

account_sid string

api_key_sid string

api_key_secret string

capabilities string[]

Get Twilio IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Path Parameters

organization_id string

project_id string

name string

Update Twilio IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

capabilities string[]

gateway_pool_id string

rotate_on_update boolean

static_credential_details object

account_sid string

api_key_sid string

api_key_secret string

Delete Twilio IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/twilio/config/{name}

Path Parameters

organization_id string

project_id string

name string

Get IntegrationGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Path Parameters

organization_id string

project_id string

name string

Successful Response

integration object

name string

provider string

created_at string

updated_at string

created_by_id string

updated_by_id string

used_by object

aws_federated_workload_identity object

role_arn string

audience string

gcp_federated_workload_identity object

service_account_email string

audience string

twilio_static_credentials object

account_sid string

api_key_sid string

mongo_db_atlas_static_credentials object

api_public_key string

aws_access_keys object

access_key_id string

gcp_service_account_key object

project_id string

client_email string

gitlab_access_token object

confluent_static_credentials object

cloud_api_key_id string

postgres_static_credentials object

connection_string string

azure_client_secret object

tenant_id string

client_id string

azure_federated_workload_identity object

tenant_id string

client_id string

audience string

mysql_static_credentials object

connection_string string

capabilities string[]

resource_name string

resource_id string

Update IntegrationPUT/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Path Parameters

organization_id string

project_id string

name string

Body Parameters

provider string

capabilities string[]

aws_federated_workload_identity object

role_arn string

audience string

gcp_federated_workload_identity object

service_account_email string

audience string

twilio_static_credentials object

account_sid string

api_key_sid string

api_key_secret string

mongo_db_atlas_static_credentials object

api_public_key string

api_private_key string

aws_access_keys object

access_key_id string

secret_access_key string

gcp_service_account_key object

credentials string

gitlab_access_token object

--- Gitlab ---

token string

confluent_static_credentials object

cloud_api_key_id string

cloud_api_secret string

postgres_static_credentials object

connection_string string

azure_client_secret object

tenant_id string

client_id string

client_secret string

azure_federated_workload_identity object

tenant_id string

client_id string

audience string

mysql_static_credentials object

connection_string string

Successful Response

integration object

name string

provider string

created_at string

updated_at string

created_by_id string

updated_by_id string

used_by object

aws_federated_workload_identity object

role_arn string

audience string

gcp_federated_workload_identity object

service_account_email string

audience string

twilio_static_credentials object

account_sid string

api_key_sid string

mongo_db_atlas_static_credentials object

api_public_key string

aws_access_keys object

access_key_id string

gcp_service_account_key object

project_id string

client_email string

gitlab_access_token object

confluent_static_credentials object

cloud_api_key_id string

postgres_static_credentials object

connection_string string

azure_client_secret object

tenant_id string

client_id string

azure_federated_workload_identity object

tenant_id string

client_id string

audience string

mysql_static_credentials object

connection_string string

capabilities string[]

resource_name string

resource_id string

Delete IntegrationDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/integrations/{name}

Path Parameters

organization_id string

project_id string

name string

List ProvidersGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/providers

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/providers

Path Parameters

organization_id string

project_id string

Query Parameters

capabilities string[]

List SyncsGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs

Path Parameters

organization_id string

project_id string

Query Parameters

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

syncs object[]

Syncs

name string

resource_name string

resource_id string

created_at string

updated_at string

created_by_id string

updated_by_id string

type string

integration_name string

sync_config_gitlab object

scope string

group_id string

project_id string

environment_scope string

protected boolean

raw boolean

pagination object

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

next_page_token string

previous_page_token string

Create SyncPOST/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs

Path Parameters

organization_id string

project_id string

Body Parameters

name string

type string

integration_name string

sync_config_gitlab object

scope string

group_id string

project_id string

environment_scope string

protected boolean

raw boolean

Get SyncGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs/{name}

Path Parameters

organization_id string

project_id string

name string

Delete SyncDELETE/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs/{name}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/syncs/{name}

Path Parameters

organization_id string

project_id string

name string

Get UsageGET/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/usage

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/projects/{project_id}/usage

Path Parameters

organization_id string

project_id string

Successful Response

billing_tier string

apps object

active integer

limit integer

remaining integer

integrations object

active integer

limit integer

remaining integer

access_api_counts object

active integer

limit integer

remaining integer

static_secrets object

active integer

limit integer

remaining integer

rotating_secrets object

active integer

limit integer

remaining integer

dynamic_secrets object

active integer

limit integer

remaining integer

gateway_pools object

active integer

limit integer

remaining integer

connected_syncs object

active integer

limit integer

remaining integer

Get Usage2GET/secrets/2023-11-28/organizations/{organization_id}/usage

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/secrets/2023-11-28/organizations/{organization_id}/usage

Path Parameters

organization_id string

Query Parameters

project_id string

Successful Response

billing_tier string

apps object

active integer

limit integer

remaining integer

integrations object

active integer

limit integer

remaining integer

access_api_counts object

active integer

limit integer

remaining integer

static_secrets object

active integer

limit integer

remaining integer

rotating_secrets object

active integer

limit integer

remaining integer

dynamic_secrets object

active integer

limit integer

remaining integer

gateway_pools object

active integer

limit integer

remaining integer

connected_syncs object

active integer

limit integer

remaining integer

HashiCorp Cloud Platform Vault SecretsStableStable

HashiCorp Cloud Platform Vault SecretsStable