API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Secrets Store

Secrets StoreStores

List account stores

secrets_store.stores.list(StoreListParams**kwargs) -> SyncV4PagePaginationArray[StoreListResponse]

GET/accounts/{account_id}/secrets_store/stores

Create a store

secrets_store.stores.create(StoreCreateParams**kwargs) -> SyncSinglePage[StoreCreateResponse]

POST/accounts/{account_id}/secrets_store/stores

Delete a store

secrets_store.stores.delete(strstore_id, StoreDeleteParams**kwargs) -> StoreDeleteResponse

DELETE/accounts/{account_id}/secrets_store/stores/{store_id}

ModelsExpand Collapse

class StoreListResponse: …

id: str

Store Identifier

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the store

class StoreCreateResponse: …

id: str

Store Identifier

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the store

class StoreDeleteResponse: …

id: str

Store Identifier

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the store

Secrets StoreStoresSecrets

List store secrets

secrets_store.stores.secrets.list(strstore_id, SecretListParams**kwargs) -> SyncV4PagePaginationArray[SecretListResponse]

GET/accounts/{account_id}/secrets_store/stores/{store_id}/secrets

Get a secret by ID

secrets_store.stores.secrets.get(strsecret_id, SecretGetParams**kwargs) -> SecretGetResponse

GET/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}

Create a secret

secrets_store.stores.secrets.create(strstore_id, SecretCreateParams**kwargs) -> SyncSinglePage[SecretCreateResponse]

POST/accounts/{account_id}/secrets_store/stores/{store_id}/secrets

Patch a secret

secrets_store.stores.secrets.edit(strsecret_id, SecretEditParams**kwargs) -> SecretEditResponse

PATCH/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}

Delete a secret

secrets_store.stores.secrets.delete(strsecret_id, SecretDeleteParams**kwargs) -> SecretDeleteResponse

DELETE/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}

Delete secrets

secrets_store.stores.secrets.bulk_delete(strstore_id, SecretBulkDeleteParams**kwargs) -> SyncSinglePage[SecretBulkDeleteResponse]

DELETE/accounts/{account_id}/secrets_store/stores/{store_id}/secrets

Duplicate Secret

secrets_store.stores.secrets.duplicate(strsecret_id, SecretDuplicateParams**kwargs) -> SecretDuplicateResponse

POST/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}/duplicate

ModelsExpand Collapse

class SecretListResponse: …

id: str

Secret identifier tag.

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the secret

status: Literal["pending", "active", "deleted"]

One of the following:

"pending"

"active"

"deleted"

store_id: str

Store Identifier

maxLength32

comment: Optional[str]

Freeform text describing the secret

class SecretGetResponse: …

id: str

Secret identifier tag.

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the secret

status: Literal["pending", "active", "deleted"]

One of the following:

"pending"

"active"

"deleted"

store_id: str

Store Identifier

maxLength32

comment: Optional[str]

Freeform text describing the secret

class SecretCreateResponse: …

id: str

Secret identifier tag.

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the secret

status: Literal["pending", "active", "deleted"]

One of the following:

"pending"

"active"

"deleted"

store_id: str

Store Identifier

maxLength32

comment: Optional[str]

Freeform text describing the secret

class SecretEditResponse: …

id: str

Secret identifier tag.

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the secret

status: Literal["pending", "active", "deleted"]

One of the following:

"pending"

"active"

"deleted"

store_id: str

Store Identifier

maxLength32

comment: Optional[str]

Freeform text describing the secret

class SecretDeleteResponse: …

id: str

Secret identifier tag.

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the secret

status: Literal["pending", "active", "deleted"]

One of the following:

"pending"

"active"

"deleted"

store_id: str

Store Identifier

maxLength32

comment: Optional[str]

Freeform text describing the secret

class SecretBulkDeleteResponse: …

id: str

Secret identifier tag.

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the secret

status: Literal["pending", "active", "deleted"]

One of the following:

"pending"

"active"

"deleted"

store_id: str

Store Identifier

maxLength32

comment: Optional[str]

Freeform text describing the secret

class SecretDuplicateResponse: …

id: str

Secret identifier tag.

maxLength32

created: datetime

Whenthe secret was created.

formatdate-time

modified: datetime

When the secret was modified.

formatdate-time

name: str

The name of the secret

status: Literal["pending", "active", "deleted"]

One of the following:

"pending"

"active"

"deleted"

store_id: str

Store Identifier

maxLength32

comment: Optional[str]

Freeform text describing the secret

Secrets StoreQuota

View secret usage

secrets_store.quota.get(QuotaGetParams**kwargs) -> QuotaGetResponse

GET/accounts/{account_id}/secrets_store/quota

ModelsExpand Collapse

class QuotaGetResponse: …

secrets: Secrets

quota: float

The number of secrets the account is entitlted to use

usage: float

The number of secrets the account is currently using