Fetches connection details for a Cloudflare Tunnel.
/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/connections
get
Cloudflare Tunnel
cloudflare-tunnel-list-cloudflare-tunnel-connections
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Cloudflare account ID",
"example": "699d98642c564d2e855e9661899b7252",
"maxLength": 32,
"type": "string"
}
},
{
"in": "path",
"name": "tunnel_id",
"required": true,
"schema": {
"description": "UUID of the tunnel.",
"example": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"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": {
"description": "A client (typically cloudflared) that maintains connections to a Cloudflare data center.",
"properties": {
"arch": {
"description": "The cloudflared OS architecture used to establish this connection.",
"example": "linux_amd64",
"type": "string"
},
"config_version": {
"description": "The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.",
"type": "integer"
},
"conns": {
"description": "The Cloudflare Tunnel connections between your origin and Cloudflare's edge.",
"items": {
"properties": {
"client_id": {
"description": "UUID of the cloudflared instance."
},
"client_version": {
"description": "The cloudflared version used to establish this connection.",
"example": "2022.7.1",
"type": "string"
},
"colo_name": {
"description": "The Cloudflare data center used for this connection.",
"example": "DFW",
"type": "string"
},
"id": {
"description": "UUID of the Cloudflare Tunnel connection.",
"example": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"is_pending_reconnect": {
"description": "Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic.",
"example": false,
"type": "boolean"
},
"opened_at": {
"description": "Timestamp of when the connection was established.",
"example": "2021-01-25T18:22:34.317854Z",
"format": "date-time",
"type": "string"
},
"origin_ip": {
"description": "The public IP address of the host running cloudflared.",
"example": "85.12.78.6",
"type": "string"
},
"uuid": {
"description": "UUID of the Cloudflare Tunnel connection.",
"example": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
}
},
"type": "array"
},
"features": {
"description": "Features enabled for the Cloudflare Tunnel.",
"items": {
"example": "ha-origin",
"type": "string"
},
"type": "array"
},
"id": {
"description": "UUID of the Cloudflare Tunnel connection.",
"example": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"run_at": {
"description": "Timestamp of when the tunnel connection was started.",
"example": "2009-11-10T23:00:00Z",
"format": "date-time",
"type": "string"
},
"version": {
"description": "The cloudflared version used to establish this connection.",
"example": "2022.7.1",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "List Cloudflare Tunnel connections 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": {
"description": "A client (typically cloudflared) that maintains connections to a Cloudflare data center.",
"properties": {
"arch": {
"description": "The cloudflared OS architecture used to establish this connection.",
"example": "linux_amd64",
"type": "string"
},
"config_version": {
"description": "The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.",
"type": "integer"
},
"conns": {
"description": "The Cloudflare Tunnel connections between your origin and Cloudflare's edge.",
"items": {
"properties": {
"client_id": {
"description": "UUID of the cloudflared instance."
},
"client_version": {
"description": "The cloudflared version used to establish this connection.",
"example": "2022.7.1",
"type": "string"
},
"colo_name": {
"description": "The Cloudflare data center used for this connection.",
"example": "DFW",
"type": "string"
},
"id": {
"description": "UUID of the Cloudflare Tunnel connection.",
"example": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"is_pending_reconnect": {
"description": "Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic.",
"example": false,
"type": "boolean"
},
"opened_at": {
"description": "Timestamp of when the connection was established.",
"example": "2021-01-25T18:22:34.317854Z",
"format": "date-time",
"type": "string"
},
"origin_ip": {
"description": "The public IP address of the host running cloudflared.",
"example": "85.12.78.6",
"type": "string"
},
"uuid": {
"description": "UUID of the Cloudflare Tunnel connection.",
"example": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
}
},
"type": "array"
},
"features": {
"description": "Features enabled for the Cloudflare Tunnel.",
"items": {
"example": "ha-origin",
"type": "string"
},
"type": "array"
},
"id": {
"description": "UUID of the Cloudflare Tunnel connection.",
"example": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"run_at": {
"description": "Timestamp of when the tunnel connection was started.",
"example": "2009-11-10T23:00:00Z",
"format": "date-time",
"type": "string"
},
"version": {
"description": "The cloudflared version used to establish this connection.",
"example": "2022.7.1",
"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 Cloudflare Tunnel connections response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]