List Devices

List Enrolled Devices.

application/json

Body

result

required

Any of

allOf {2}

array[object (devices) {19}]

allOf {2}

One of

array[object (devices) {19}]

object

created

string <date-time>

devices_components-schemas-created

optional

When the device was created.

Example:

2017-06-14T00:00:00Z

deleted

boolean

schemas-deleted

optional

True if the device was deleted.

Example:

true

device_type

enum<string>

platform

optional

Allowed values:

windowsmaclinuxandroidios

Example:

windows

string

devices_components-schemas-uuid

optional

Device ID.

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

string

devices_components-schemas-ip

optional

IPv4 or IPv6 address.

Example:

1.1.1.1

key

string

schemas-key

optional

The device's public key.

Example:

yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=

last_seen

string <date-time>

last_seen

optional

When the device last connected to Cloudflare services.

Example:

2017-06-14T00:00:00Z

mac_address

string

mac_address

optional

The device mac address.

Example:

00-00-5E-00-53-00

manufacturer

string

manufacturer

optional

The device manufacturer name.

Example:

My phone corp

model

string

model

optional

The device model name.

Example:

MyPhone(pro-X)

name

string

devices_components-schemas-name

optional

The device name.

Example:

My mobile device

os_distro_name

string

os_distro_name

optional

The Linux distro name.

Example:

ubuntu

os_distro_revision

string

os_distro_revision

optional

The Linux distro revision.

Example:

1.0.0

os_version

string

os_version

optional

The operating system version.

Example:

10.0.0

revoked_at

string <date-time>

revoked_at

optional

When the device was revoked.

Example:

2017-06-14T00:00:00Z

serial_number

string

components-schemas-serial_number

optional

The device serial number.

Example:

EXAMPLEHMD6R

updated

string <date-time>

updated

optional

When the device was updated.

Example:

2017-06-14T00:00:00Z

user

object

user

optional

version

string

devices_components-schemas-version

optional

The WARP client version.

Example:

1.0.0

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "created": "2017-06-14T00:00:00Z",
            "deleted": true,
            "device_type": "windows",
            "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
            "ip": "1.1.1.1",
            "key": "yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=",
            "last_seen": "2017-06-14T00:00:00Z",
            "mac_address": "00-00-5E-00-53-00",
            "manufacturer": "My phone corp",
            "model": "MyPhone(pro-X)",
            "name": "My mobile device",
            "os_distro_name": "ubuntu",
            "os_distro_revision": "1.0.0",
            "os_version": "10.0.0",
            "revoked_at": "2017-06-14T00:00:00Z",
            "serial_number": "EXAMPLEHMD6R",
            "updated": "2017-06-14T00:00:00Z",
            "user": {
                "email": "user@example.com",
                "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                "name": "John Appleseed"
            },
            "version": "1.0.0"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses