Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.
/accounts/{identifier}/devices/policy/{uuid}/include
put
Devices
devices-set-split-tunnel-include-list-for-a-device-settings-policy
nullnull[
{
"in": "path",
"name": "uuid",
"required": true,
"schema": {
"description": "Device ID.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"example": "699d98642c564d2e855e9661899b7252"
}
}
]{
"content": {
"application/json": {
"schema": {
"items": {
"properties": {
"address": {
"description": "The address in CIDR format to include in the tunnel. If address is present, host must not be present.",
"example": "192.0.2.0/24",
"type": "string"
},
"description": {
"description": "A description of the split tunnel item, displayed in the client UI.",
"example": "Include testing domains from the tunnel",
"maxLength": 100,
"type": "string"
},
"host": {
"description": "The domain name to include in the tunnel. If host is present, address must not be present.",
"example": "*.example.com",
"type": "string"
}
},
"required": [
"address",
"description"
],
"type": "object"
},
"type": "array"
}
}
},
"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": {
"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": {
"address": {
"description": "The address in CIDR format to include in the tunnel. If address is present, host must not be present.",
"example": "192.0.2.0/24",
"type": "string"
},
"description": {
"description": "A description of the split tunnel item, displayed in the client UI.",
"example": "Include testing domains from the tunnel",
"maxLength": 100,
"type": "string"
},
"host": {
"description": "The domain name to include in the tunnel. If host is present, address must not be present.",
"example": "*.example.com",
"type": "string"
}
},
"required": [
"address",
"description"
],
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "Set the Split Tunnel include list for a device settings profile 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": {
"address": {
"description": "The address in CIDR format to include in the tunnel. If address is present, host must not be present.",
"example": "192.0.2.0/24",
"type": "string"
},
"description": {
"description": "A description of the split tunnel item, displayed in the client UI.",
"example": "Include testing domains from the tunnel",
"maxLength": 100,
"type": "string"
},
"host": {
"description": "The domain name to include in the tunnel. If host is present, address must not be present.",
"example": "*.example.com",
"type": "string"
}
},
"required": [
"address",
"description"
],
"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": "Set the Split Tunnel include list for a device settings profile response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]