Skip to content
API Reference
API Reference
Zones
Secrets

Update

zones.secrets.update(strid, SecretUpdateParams**kwargs) -> Secret
PATCH/zones/{zone_id}/secrets/{id}
ParametersExpand Collapse
zone_id: str

A globally unique opaque identifier

minLength1
id: str
data: Optional[Data]
Accepts one of the following:
class SecretTokenFields: …
token: str
type: Literal["token"]
class SecretPasswordFields: …
password: str
type: Literal["password"]
username: str
description: Optional[str]

A description of the entity

maxLength128
metadata: Optional[object]

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

name: Optional[str]

A name for the entity to be displayed in UI

x_client_request_id: Optional[str]
formatuuid
ReturnsExpand 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.

Update

from keycardai_api import KeycardAPI

client = KeycardAPI()
secret = client.zones.secrets.update(
    id="id",
    zone_id="x",
)
print(secret.id)
{
  "id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "entity_id": "x",
  "name": "name",
  "type": "token",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "version": 1,
  "zone_id": "x",
  "description": "description",
  "metadata": {}
}
Returns Examples
{
  "id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "entity_id": "x",
  "name": "name",
  "type": "token",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "version": 1,
  "zone_id": "x",
  "description": "description",
  "metadata": {}
}