API Reference

Zero Trust

Devices

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Registrations

List registrations

zero_trust.devices.registrations.list(RegistrationListParams**kwargs) -> SyncCursorPagination[RegistrationListResponse]

GET/accounts/{account_id}/devices/registrations

Get registration

zero_trust.devices.registrations.get(strregistration_id, RegistrationGetParams**kwargs) -> RegistrationGetResponse

GET/accounts/{account_id}/devices/registrations/{registration_id}

Delete registration

zero_trust.devices.registrations.delete(strregistration_id, RegistrationDeleteParams**kwargs) -> object

DELETE/accounts/{account_id}/devices/registrations/{registration_id}

Delete registrations

zero_trust.devices.registrations.bulk_delete(RegistrationBulkDeleteParams**kwargs) -> object

DELETE/accounts/{account_id}/devices/registrations

Revoke registrations

zero_trust.devices.registrations.revoke(RegistrationRevokeParams**kwargs) -> object

POST/accounts/{account_id}/devices/registrations/revoke

Unrevoke registrations

zero_trust.devices.registrations.unrevoke(RegistrationUnrevokeParams**kwargs) -> object

POST/accounts/{account_id}/devices/registrations/unrevoke

ModelsExpand Collapse

class RegistrationListResponse: …

A WARP configuration tied to a single user. Multiple registrations can be created from a single WARP device.

id: str

The ID of the registration.

created_at: str

The RFC3339 timestamp when the registration was created.

device: Device

Device details embedded inside of a registration.

id: str

The ID of the device.

name: str

The name of the device.

client_version: Optional[str]

Version of the WARP client.

key: str

The public key used to connect to the Cloudflare network.

last_seen_at: str

The RFC3339 timestamp when the registration was last seen.

updated_at: str

The RFC3339 timestamp when the registration was last updated.

deleted_at: Optional[str]

The RFC3339 timestamp when the registration was deleted.

key_type: Optional[str]

The type of encryption key used by the WARP client for the active key. Currently ‘curve25519’ for WireGuard and ‘secp256r1’ for MASQUE.

policy: Optional[Policy]

The device settings profile assigned to this registration.

id: str

The ID of the device settings profile.

default: bool

Whether the device settings profile is the default profile for the account.

deleted: bool

Whether the device settings profile was deleted.

name: str

The name of the device settings profile.

updated_at: str

The RFC3339 timestamp of when the device settings profile last changed for the registration.

revoked_at: Optional[str]

The RFC3339 timestamp when the registration was revoked.

tunnel_type: Optional[str]

Type of the tunnel - wireguard or masque.

user: Optional[User]

id: Optional[str]

UUID.

maxLength36

email: Optional[str]

The contact email address of the user.

maxLength90

name: Optional[str]

The enrolled device user’s name.

class RegistrationGetResponse: …

A WARP configuration tied to a single user. Multiple registrations can be created from a single WARP device.

id: str

The ID of the registration.

created_at: str

The RFC3339 timestamp when the registration was created.

device: Device

Device details embedded inside of a registration.

id: str

The ID of the device.

name: str

The name of the device.

client_version: Optional[str]

Version of the WARP client.

key: str

The public key used to connect to the Cloudflare network.

last_seen_at: str

The RFC3339 timestamp when the registration was last seen.

updated_at: str

The RFC3339 timestamp when the registration was last updated.

deleted_at: Optional[str]

The RFC3339 timestamp when the registration was deleted.

key_type: Optional[str]

The type of encryption key used by the WARP client for the active key. Currently ‘curve25519’ for WireGuard and ‘secp256r1’ for MASQUE.

policy: Optional[Policy]

The device settings profile assigned to this registration.

id: str

The ID of the device settings profile.

default: bool

Whether the device settings profile is the default profile for the account.

deleted: bool

Whether the device settings profile was deleted.

name: str

The name of the device settings profile.

updated_at: str

The RFC3339 timestamp of when the device settings profile last changed for the registration.

revoked_at: Optional[str]

The RFC3339 timestamp when the registration was revoked.

tunnel_type: Optional[str]

Type of the tunnel - wireguard or masque.

user: Optional[User]

id: Optional[str]

UUID.

maxLength36

email: Optional[str]

The contact email address of the user.

maxLength90

name: Optional[str]

The enrolled device user’s name.