List details for devices using WARP
/accounts/{account_identifier}/dex/fleet-status/devices
get
DEX Synthetic Application Montitoring
dex-fleet-status-live-devices
null{
"enum": [
"#dex:read",
"#teams:report"
]
}[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"example": "01a7362d577a6c3019a474fd6f485823",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "time_end",
"required": true,
"schema": {
"description": "Timestamp in ISO format",
"example": "2023-10-11T00:00:00Z",
"type": "string"
}
},
{
"in": "query",
"name": "time_start",
"required": true,
"schema": {
"description": "Timestamp in ISO format",
"example": "2023-10-11T00:00:00Z",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"required": true,
"schema": {
"default": 1,
"description": "Page number of paginated results",
"example": 1,
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "per_page",
"required": true,
"schema": {
"description": "Number of items per page",
"example": 10,
"maximum": 50,
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "sort_by",
"schema": {
"default": "timestamp",
"description": "Dimension to sort results by",
"enum": [
"colo",
"device_id",
"mode",
"platform",
"status",
"timestamp",
"version"
],
"type": "string"
}
},
{
"in": "query",
"name": "colo",
"schema": {
"description": "Cloudflare colo",
"example": "SJC",
"type": "string"
}
},
{
"in": "query",
"name": "device_id",
"schema": {
"description": "Device-specific ID, given as UUID v4",
"example": "cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7",
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"schema": {
"description": "The mode under which the WARP client is run",
"example": "proxy",
"type": "string"
}
},
{
"in": "query",
"name": "status",
"schema": {
"description": "Network status",
"example": "connected",
"type": "string"
}
},
{
"in": "query",
"name": "platform",
"schema": {
"description": "Operating system",
"example": "windows",
"type": "string"
}
},
{
"in": "query",
"name": "version",
"schema": {
"description": "WARP client version",
"example": "1.0.0",
"type": "string"
}
}
]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": {
"colo": {
"description": "Cloudflare colo",
"example": "SJC",
"type": "string"
},
"deviceId": {
"description": "Device identifier (UUID v4)",
"type": "string"
},
"deviceName": {
"description": "Device identifier (human readable)",
"type": "string"
},
"personEmail": {
"description": "User contact email address",
"type": "string"
},
"platform": {
"description": "Operating system",
"example": "windows",
"type": "string"
},
"status": {
"description": "Network status",
"example": "connected",
"type": "string"
},
"version": {
"description": "WARP client version",
"example": "1.0.0",
"type": "string"
}
},
"required": [
"colo",
"deviceId",
"mode",
"platform",
"status",
"timestamp",
"version"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "List devices response"
},
"4xx": {
"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": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"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": []
},
{
"api_email": [],
"api_key": []
}
]