Fetches a list of enrolled devices.
/accounts/{identifier}/devices
get
Devices
devices-list-devices
nullnull[
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"example": "699d98642c564d2e855e9661899b7252"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful.",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"created": {
"description": "When the device was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"deleted": {
"description": "True if the device was deleted.",
"example": true,
"type": "boolean"
},
"device_type": {
"enum": [
"windows",
"mac",
"linux",
"android",
"ios"
],
"example": "windows",
"type": "string"
},
"id": {
"description": "Device ID.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
},
"ip": {
"description": "IPv4 or IPv6 address.",
"example": "1.1.1.1",
"type": "string"
},
"key": {
"description": "The device's public key.",
"example": "yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=",
"type": "string"
},
"last_seen": {
"description": "When the device last connected to Cloudflare services.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"mac_address": {
"description": "The device mac address.",
"example": "00-00-5E-00-53-00",
"type": "string"
},
"manufacturer": {
"description": "The device manufacturer name.",
"example": "My phone corp",
"type": "string"
},
"model": {
"description": "The device model name.",
"example": "MyPhone(pro-X)",
"type": "string"
},
"name": {
"description": "The device name.",
"example": "My mobile device",
"type": "string"
},
"os_distro_name": {
"description": "The Linux distro name.",
"example": "ubuntu",
"type": "string"
},
"os_distro_revision": {
"description": "The Linux distro revision.",
"example": "1.0.0",
"type": "string"
},
"os_version": {
"description": "The operating system version.",
"example": "10.0.0",
"type": "string"
},
"os_version_extra": {
"description": "The operating system version extra parameter.",
"example": "(a)",
"type": "string"
},
"revoked_at": {
"description": "When the device was revoked.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"serial_number": {
"description": "The device serial number.",
"example": "EXAMPLEHMD6R",
"type": "string"
},
"updated": {
"description": "When the device was updated.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"user": {
"properties": {
"email": {
"description": "The contact email address of the user.",
"example": "user@example.com",
"maxLength": 90,
"type": "string"
},
"id": {
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The enrolled device user's name.",
"example": "John Appleseed",
"type": "string"
}
},
"type": "object"
},
"version": {
"description": "The WARP client version.",
"example": "1.0.0",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List devices response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful.",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"created": {
"description": "When the device was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"deleted": {
"description": "True if the device was deleted.",
"example": true,
"type": "boolean"
},
"device_type": {
"enum": [
"windows",
"mac",
"linux",
"android",
"ios"
],
"example": "windows",
"type": "string"
},
"id": {
"description": "Device ID.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
},
"ip": {
"description": "IPv4 or IPv6 address.",
"example": "1.1.1.1",
"type": "string"
},
"key": {
"description": "The device's public key.",
"example": "yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=",
"type": "string"
},
"last_seen": {
"description": "When the device last connected to Cloudflare services.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"mac_address": {
"description": "The device mac address.",
"example": "00-00-5E-00-53-00",
"type": "string"
},
"manufacturer": {
"description": "The device manufacturer name.",
"example": "My phone corp",
"type": "string"
},
"model": {
"description": "The device model name.",
"example": "MyPhone(pro-X)",
"type": "string"
},
"name": {
"description": "The device name.",
"example": "My mobile device",
"type": "string"
},
"os_distro_name": {
"description": "The Linux distro name.",
"example": "ubuntu",
"type": "string"
},
"os_distro_revision": {
"description": "The Linux distro revision.",
"example": "1.0.0",
"type": "string"
},
"os_version": {
"description": "The operating system version.",
"example": "10.0.0",
"type": "string"
},
"os_version_extra": {
"description": "The operating system version extra parameter.",
"example": "(a)",
"type": "string"
},
"revoked_at": {
"description": "When the device was revoked.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"serial_number": {
"description": "The device serial number.",
"example": "EXAMPLEHMD6R",
"type": "string"
},
"updated": {
"description": "When the device was updated.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"type": "string"
},
"user": {
"properties": {
"email": {
"description": "The contact email address of the user.",
"example": "user@example.com",
"maxLength": 90,
"type": "string"
},
"id": {
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The enrolled device user's name.",
"example": "John Appleseed",
"type": "string"
}
},
"type": "object"
},
"version": {
"description": "The WARP client version.",
"example": "1.0.0",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List devices response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]