API Reference

Zones

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Secrets

Create

POST/zones/{zone_id}/secrets

List

GET/zones/{zone_id}/secrets

Delete

DELETE/zones/{zone_id}/secrets/{id}

Update

PATCH/zones/{zone_id}/secrets/{id}

Retrieve

GET/zones/{zone_id}/secrets/{id}

ModelsExpand Collapse

Secret = object { id, created_at, entity_id, 7 more }

id: string

A globally unique opaque identifier

minLength1

created_at: string

formatdate-time

entity_id: string

A globally unique opaque identifier

minLength1

name: string

A name for the entity to be displayed in UI

type: "token" or "password"

Accepts one of the following:

"token"

"password"

updated_at: string

formatdate-time

version: number

minimum1

zone_id: string

A globally unique opaque identifier

minLength1

description: optional string

A description of the entity

maxLength128

metadata: optional unknown

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

SecretPasswordFields = object { password, type, username }

password: string

type: "password"

username: string

SecretTokenFields = object { token, type }

token: string

type: "token"