Create a DEX test.
/accounts/{identifier}/devices/dex_tests
post
Device DEX Tests
device-dex-test-create-device-dex-test
nullnull[
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"example": "699d98642c564d2e855e9661899b7252"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"description": "The configuration object which contains the details for the WARP client to conduct the test.",
"example": {
"host": "https://dash.cloudflare.com",
"kind": "http",
"method": "GET"
},
"properties": {
"host": {
"description": "The desired endpoint to test.",
"example": "https://dash.cloudflare.com",
"type": "string"
},
"kind": {
"description": "The type of test.",
"example": "http",
"type": "string"
},
"method": {
"description": "The HTTP request method type.",
"example": "GET",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Additional details about the test.",
"example": "Checks the dash endpoint every 30 minutes",
"type": "string"
},
"enabled": {
"description": "Determines whether or not the test is active.",
"example": true,
"type": "boolean"
},
"interval": {
"description": "How often the test will run.",
"example": "30m",
"type": "string"
},
"name": {
"description": "The name of the DEX test. Must be unique.",
"example": "HTTP dash health check",
"type": "string"
}
},
"required": [
"name",
"interval",
"enabled",
"data"
],
"type": "object"
}
}
},
"required": true
}{
"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": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true,
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"data": {
"description": "The configuration object which contains the details for the WARP client to conduct the test.",
"example": {
"host": "https://dash.cloudflare.com",
"kind": "http",
"method": "GET"
},
"properties": {
"host": {
"description": "The desired endpoint to test.",
"example": "https://dash.cloudflare.com",
"type": "string"
},
"kind": {
"description": "The type of test.",
"example": "http",
"type": "string"
},
"method": {
"description": "The HTTP request method type.",
"example": "GET",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Additional details about the test.",
"example": "Checks the dash endpoint every 30 minutes",
"type": "string"
},
"enabled": {
"description": "Determines whether or not the test is active.",
"example": true,
"type": "boolean"
},
"interval": {
"description": "How often the test will run.",
"example": "30m",
"type": "string"
},
"name": {
"description": "The name of the DEX test. Must be unique.",
"example": "HTTP dash health check",
"type": "string"
}
},
"required": [
"name",
"interval",
"enabled",
"data"
],
"type": "object"
}
}
}
]
}
}
},
"description": "Update Dex test 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": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true,
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"data": {
"description": "The configuration object which contains the details for the WARP client to conduct the test.",
"example": {
"host": "https://dash.cloudflare.com",
"kind": "http",
"method": "GET"
},
"properties": {
"host": {
"description": "The desired endpoint to test.",
"example": "https://dash.cloudflare.com",
"type": "string"
},
"kind": {
"description": "The type of test.",
"example": "http",
"type": "string"
},
"method": {
"description": "The HTTP request method type.",
"example": "GET",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Additional details about the test.",
"example": "Checks the dash endpoint every 30 minutes",
"type": "string"
},
"enabled": {
"description": "Determines whether or not the test is active.",
"example": true,
"type": "boolean"
},
"interval": {
"description": "How often the test will run.",
"example": "30m",
"type": "string"
},
"name": {
"description": "The name of the DEX test. Must be unique.",
"example": "HTTP dash health check",
"type": "string"
}
},
"required": [
"name",
"interval",
"enabled",
"data"
],
"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": "Update Dex test response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]