Lists and filters private network routes in an account.
/accounts/{account_identifier}/teamnet/routes
get
Tunnel route
tunnel-route-list-tunnel-routes
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Cloudflare account ID",
"example": "699d98642c564d2e855e9661899b7252",
"maxLength": 32,
"type": "string"
}
},
{
"in": "query",
"name": "comment",
"schema": {
"description": "Optional remark describing the route.",
"example": "Example comment for this route.",
"type": "string"
}
},
{
"in": "query",
"name": "is_deleted",
"schema": {
"description": "If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included."
}
},
{
"in": "query",
"name": "network_subset",
"schema": {
"description": "If set, only list routes that are contained within this IP range."
}
},
{
"in": "query",
"name": "network_superset",
"schema": {
"description": "If set, only list routes that contain this IP range."
}
},
{
"in": "query",
"name": "existed_at",
"schema": {
"description": "If provided, include only routes that were created (and not deleted) before this time."
}
},
{
"in": "query",
"name": "tunnel_id",
"schema": {
"description": "UUID of the Cloudflare Tunnel serving the route."
}
},
{
"in": "query",
"name": "route_id",
"schema": {
"description": "UUID of the route.",
"example": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "tun_types",
"schema": {
"description": "The types of tunnels to filter separated by a comma.",
"example": "cfd_tunnel,warp_connector",
"type": "string"
}
},
{
"in": "query",
"name": "virtual_network_id",
"schema": {
"description": "UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account."
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"description": "Number of results to display.",
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "page",
"schema": {
"default": 1,
"description": "Page number of paginated results.",
"minimum": 1,
"type": "number"
}
}
]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": {
"comment": {
"description": "Optional remark describing the route.",
"example": "Example comment for this route.",
"type": "string"
},
"created_at": {
"description": "Timestamp of when the route was created."
},
"deleted_at": {
"description": "Timestamp of when the route was deleted. If `null`, the route has not been deleted.",
"example": "2021-01-25T18:22:34.317854Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"description": "UUID of the route.",
"example": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"network": {
"description": "The private IPv4 or IPv6 range connected by the route, in CIDR notation.",
"example": "172.16.0.0/16",
"type": "string"
},
"tun_type": {
"description": "The type of tunnel.",
"enum": [
"cfd_tunnel",
"warp_connector",
"ip_sec",
"gre",
"cni"
],
"example": "cfd_tunnel",
"type": "string"
},
"tunnel_id": {
"description": "UUID of the Cloudflare Tunnel serving the route."
},
"tunnel_name": {
"description": "The user-friendly name of the Cloudflare Tunnel serving the route."
},
"virtual_network_id": {
"description": "UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account."
},
"virtual_network_name": {
"description": "A user-friendly name for the virtual network.",
"example": "us-east-1-vpc",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "List tunnel routes 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": {
"comment": {
"description": "Optional remark describing the route.",
"example": "Example comment for this route.",
"type": "string"
},
"created_at": {
"description": "Timestamp of when the route was created."
},
"deleted_at": {
"description": "Timestamp of when the route was deleted. If `null`, the route has not been deleted.",
"example": "2021-01-25T18:22:34.317854Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"description": "UUID of the route.",
"example": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"network": {
"description": "The private IPv4 or IPv6 range connected by the route, in CIDR notation.",
"example": "172.16.0.0/16",
"type": "string"
},
"tun_type": {
"description": "The type of tunnel.",
"enum": [
"cfd_tunnel",
"warp_connector",
"ip_sec",
"gre",
"cni"
],
"example": "cfd_tunnel",
"type": "string"
},
"tunnel_id": {
"description": "UUID of the Cloudflare Tunnel serving the route."
},
"tunnel_name": {
"description": "The user-friendly name of the Cloudflare Tunnel serving the route."
},
"virtual_network_id": {
"description": "UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account."
},
"virtual_network_name": {
"description": "A user-friendly name for the virtual network.",
"example": "us-east-1-vpc",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"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 tunnel routes response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]