Skip to content
Docs

Secrets

API Reference
Zones

Secrets

Create
zones.secrets.create(strpath_zone_id, SecretCreateParams**kwargs) -> Secret
POST/zones/{zone_id}/secrets
List
zones.secrets.list(strzone_id, SecretListParams**kwargs) -> SecretListResponse
GET/zones/{zone_id}/secrets
Delete
zones.secrets.delete(strid, SecretDeleteParams**kwargs)
DELETE/zones/{zone_id}/secrets/{id}
Update
zones.secrets.update(strid, SecretUpdateParams**kwargs) -> Secret
PATCH/zones/{zone_id}/secrets/{id}
Retrieve
zones.secrets.retrieve(strid, SecretRetrieveParams**kwargs) -> SecretRetrieveResponse
GET/zones/{zone_id}/secrets/{id}
ModelsExpand Collapse
class Secret: …
id: str

A globally unique opaque identifier

minLength1
created_at: datetime
formatdate-time
entity_id: str

A globally unique opaque identifier

minLength1
name: str

A name for the entity to be displayed in UI

type: Literal["token", "password"]
Accepts one of the following:
"token"
"password"
updated_at: datetime
formatdate-time
version: int
minimum1
zone_id: str

A globally unique opaque identifier

minLength1
description: Optional[str]

A description of the entity

maxLength128
metadata: Optional[object]

A JSON object containing arbitrary metadata. Metadata will not be encrypted.

class SecretPasswordFields: …
password: str
type: Literal["password"]
username: str
class SecretTokenFields: …
token: str
type: Literal["token"]