API Reference

Zero Trust

Devices

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Registrations

List registrations

client.zeroTrust.devices.registrations.list(RegistrationListParams { account_id, id, cursor, 10 more } params, RequestOptionsoptions?): CursorPagination<RegistrationListResponse { id, created_at, device, 9 more } >

GET/accounts/{account_id}/devices/registrations

Get registration

client.zeroTrust.devices.registrations.get(stringregistrationId, RegistrationGetParams { account_id, include } params, RequestOptionsoptions?): RegistrationGetResponse { id, created_at, device, 9 more }

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

Delete registration

client.zeroTrust.devices.registrations.delete(stringregistrationId, RegistrationDeleteParams { account_id } params, RequestOptionsoptions?): RegistrationDeleteResponse | null

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

Delete registrations

client.zeroTrust.devices.registrations.bulkDelete(RegistrationBulkDeleteParams { account_id, id } params, RequestOptionsoptions?): RegistrationBulkDeleteResponse | null

DELETE/accounts/{account_id}/devices/registrations

Revoke registrations

client.zeroTrust.devices.registrations.revoke(RegistrationRevokeParams { account_id, id } params, RequestOptionsoptions?): RegistrationRevokeResponse | null

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

Unrevoke registrations

client.zeroTrust.devices.registrations.unrevoke(RegistrationUnrevokeParams { account_id, id } params, RequestOptionsoptions?): RegistrationUnrevokeResponse | null

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

ModelsExpand Collapse

RegistrationListResponse { id, created_at, device, 9 more }

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

id: string

The ID of the registration.

created_at: string

The RFC3339 timestamp when the registration was created.

device: Device { id, name, client_version }

Device details embedded inside of a registration.

id: string

The ID of the device.

name: string

The name of the device.

client_version?: string

Version of the WARP client.

key: string

The public key used to connect to the Cloudflare network.

last_seen_at: string

The RFC3339 timestamp when the registration was last seen.

updated_at: string

The RFC3339 timestamp when the registration was last updated.

deleted_at?: string | null

The RFC3339 timestamp when the registration was deleted.

key_type?: string | null

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

policy?: Policy { id, default, deleted, 2 more }

The device settings profile assigned to this registration.

id: string

The ID of the device settings profile.

default: boolean

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

deleted: boolean

Whether the device settings profile was deleted.

name: string

The name of the device settings profile.

updated_at: string

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

revoked_at?: string | null

The RFC3339 timestamp when the registration was revoked.

tunnel_type?: string | null

Type of the tunnel - wireguard or masque.

user?: User { id, email, name }

id?: string

UUID.

maxLength36

email?: string

The contact email address of the user.

maxLength90

name?: string

The enrolled device user’s name.

RegistrationGetResponse { id, created_at, device, 9 more }

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

id: string

The ID of the registration.

created_at: string

The RFC3339 timestamp when the registration was created.

device: Device { id, name, client_version }

Device details embedded inside of a registration.

id: string

The ID of the device.

name: string

The name of the device.

client_version?: string

Version of the WARP client.

key: string

The public key used to connect to the Cloudflare network.

last_seen_at: string

The RFC3339 timestamp when the registration was last seen.

updated_at: string

The RFC3339 timestamp when the registration was last updated.

deleted_at?: string | null

The RFC3339 timestamp when the registration was deleted.

key_type?: string | null

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

policy?: Policy { id, default, deleted, 2 more }

The device settings profile assigned to this registration.

id: string

The ID of the device settings profile.

default: boolean

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

deleted: boolean

Whether the device settings profile was deleted.

name: string

The name of the device settings profile.

updated_at: string

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

revoked_at?: string | null

The RFC3339 timestamp when the registration was revoked.

tunnel_type?: string | null

Type of the tunnel - wireguard or masque.

user?: User { id, email, name }

id?: string

UUID.

maxLength36

email?: string

The contact email address of the user.

maxLength90

name?: string

The enrolled device user’s name.

RegistrationDeleteResponse = unknown

RegistrationBulkDeleteResponse = unknown

RegistrationRevokeResponse = unknown

RegistrationUnrevokeResponse = unknown