Lists IPsec tunnels associated with an account.
/accounts/{account_identifier}/magic/ipsec_tunnels
get
Magic IPsec tunnels
magic-ipsec-tunnels-list-ipsec-tunnels
{
"business": false,
"enterprise": true,
"free": false,
"pro": false
}null[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"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": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"ipsec_tunnels": {
"items": {
"properties": {
"allow_null_cipher": {
"description": "When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).",
"example": true,
"type": "boolean"
},
"cloudflare_endpoint": {
"description": "The IP address assigned to the Cloudflare side of the IPsec tunnel.",
"example": "203.0.113.1",
"type": "string"
},
"created_on": {
"description": "The date and time the tunnel was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"customer_endpoint": {
"description": "The IP address assigned to the customer side of the IPsec tunnel.",
"example": "203.0.113.1",
"type": "string"
},
"description": {
"description": "An optional description forthe IPsec tunnel.",
"example": "Tunnel for ISP X",
"type": "string"
},
"id": {
"description": "Tunnel identifier tag.",
"example": "c4a7362d577a6c3019a474fd6f485821",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"interface_address": {
"description": "A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.",
"example": "192.0.2.0/31",
"type": "string"
},
"modified_on": {
"description": "The date and time the tunnel was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the IPsec tunnel. The name cannot share a name with other tunnels.",
"example": "IPsec_1",
"type": "string"
},
"psk_metadata": {
"description": "The PSK metadata that includes when the PSK was generated.",
"properties": {
"last_generated_on": {
"description": "The date and time the tunnel was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"replay_protection": {
"default": false,
"description": "If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.",
"example": false,
"type": "boolean"
},
"tunnel_health_check": {
"properties": {
"enabled": {
"default": true,
"description": "Determines whether to run healthchecks for a tunnel.",
"example": true,
"type": "boolean"
},
"rate": {
"default": "mid",
"description": "How frequent the health check is run. The default value is `mid`.",
"enum": [
"low",
"mid",
"high"
],
"example": "low",
"type": "string"
},
"target": {
"description": "The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.",
"example": "203.0.113.1",
"type": "string"
},
"type": {
"default": "reply",
"description": "The type of healthcheck to run, reply or request. The default value is `reply`.",
"enum": [
"reply",
"request"
],
"example": "request",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"cloudflare_endpoint",
"interface_address"
],
"type": "object"
},
"type": "array"
}
}
}
}
}
]
}
}
},
"description": "List IPsec tunnels 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": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"ipsec_tunnels": {
"items": {
"properties": {
"allow_null_cipher": {
"description": "When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).",
"example": true,
"type": "boolean"
},
"cloudflare_endpoint": {
"description": "The IP address assigned to the Cloudflare side of the IPsec tunnel.",
"example": "203.0.113.1",
"type": "string"
},
"created_on": {
"description": "The date and time the tunnel was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"customer_endpoint": {
"description": "The IP address assigned to the customer side of the IPsec tunnel.",
"example": "203.0.113.1",
"type": "string"
},
"description": {
"description": "An optional description forthe IPsec tunnel.",
"example": "Tunnel for ISP X",
"type": "string"
},
"id": {
"description": "Tunnel identifier tag.",
"example": "c4a7362d577a6c3019a474fd6f485821",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"interface_address": {
"description": "A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.",
"example": "192.0.2.0/31",
"type": "string"
},
"modified_on": {
"description": "The date and time the tunnel was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the IPsec tunnel. The name cannot share a name with other tunnels.",
"example": "IPsec_1",
"type": "string"
},
"psk_metadata": {
"description": "The PSK metadata that includes when the PSK was generated.",
"properties": {
"last_generated_on": {
"description": "The date and time the tunnel was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"replay_protection": {
"default": false,
"description": "If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.",
"example": false,
"type": "boolean"
},
"tunnel_health_check": {
"properties": {
"enabled": {
"default": true,
"description": "Determines whether to run healthchecks for a tunnel.",
"example": true,
"type": "boolean"
},
"rate": {
"default": "mid",
"description": "How frequent the health check is run. The default value is `mid`.",
"enum": [
"low",
"mid",
"high"
],
"example": "low",
"type": "string"
},
"target": {
"description": "The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.",
"example": "203.0.113.1",
"type": "string"
},
"type": {
"default": "reply",
"description": "The type of healthcheck to run, reply or request. The default value is `reply`.",
"enum": [
"reply",
"request"
],
"example": "request",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"cloudflare_endpoint",
"interface_address"
],
"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": "List IPsec tunnels response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]