Skip to content
API Reference
API Reference
Zones
Secrets

List

zones.secrets.list(strzone_id, SecretListParams**kwargs) -> SecretListResponse
GET/zones/{zone_id}/secrets
ParametersExpand Collapse
zone_id: str

A globally unique opaque identifier

minLength1
entity_id: Optional[str]

The entity to list all secrets for

type: Optional[Literal["token", "password"]]

The type of secrets to list

Accepts one of the following:
"token"
"password"
x_client_request_id: Optional[str]
formatuuid
ReturnsExpand Collapse
List[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.

List

from keycardai_api import KeycardAPI

client = KeycardAPI()
secrets = client.zones.secrets.list(
    zone_id="x",
)
print(secrets)
[
  {
    "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": {}
  }
]