Tests the Railgun connection to the zone.
/zones/{zone_identifier}/railguns/{identifier}/diagnose
get
Railgun Connections for a Zone
railgun-connections-for-a-zone-test-railgun-connection
{
"business": true,
"enterprise": true,
"free": false,
"pro": false
}{
"enum": [
"#zone_settings:read"
]
}[
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"description": "Railgun connection identifier tag.",
"example": "e928d310693a83094309acf9ead50448",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "zone_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": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"body_hash": {
"description": "Hash version of body.",
"example": "be27f2429421e12f200cab1da43ba301bdc70e1d",
"type": "string"
},
"body_size": {
"description": "Size of the body in bytes.",
"example": "63910 bytes",
"type": "string"
},
"cf-cache-status": {
"description": "Lists any `cf-cache-status` present.",
"type": "string"
},
"cf-ray": {
"description": "Lists any `cf-ray` present.",
"example": "1ddd7570575207d9-LAX",
"type": "string"
},
"cf-wan-error": {
"description": "Lists any `cf-wan-error` present.",
"type": "string"
},
"cloudflare": {
"description": "Whether Cloudflare is enabled on the host.",
"example": "on",
"type": "string"
},
"connection_close": {
"default": true,
"description": "Connection closed or open.",
"example": false,
"type": "boolean"
},
"elapsed_time": {
"description": "Amount of seconds that the test lasted.",
"example": "0.239013s",
"type": "string"
},
"host_name": {
"description": "The hostname queried.",
"example": "www.example.com",
"type": "string"
},
"http_status": {
"description": "The HTTP status response code.",
"example": 200,
"type": "number"
},
"method": {
"description": "HTTP Method used to test the connection.",
"enum": [
"GET",
"POST"
],
"example": "GET"
},
"missing_headers": {
"description": "What headers are missing.",
"example": "No Content-Length or Transfer-Encoding.",
"type": "string"
},
"protocol": {
"description": "Protocol used to test the connection.",
"example": "HTTP/1.1",
"type": "string"
},
"railgun": {
"description": "Indicates if Railgun is enabled on the queried hostname.",
"example": "on",
"type": "string"
},
"response_status": {
"description": "HTTP Status code.",
"example": "200 OK",
"type": "string"
},
"url": {
"description": "Url of the domain you can compare the connection to.",
"example": "https://www.cloudflare.com",
"type": "string"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Test Railgun connection 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"
},
{
"properties": {
"result": {
"properties": {
"body_hash": {
"description": "Hash version of body.",
"example": "be27f2429421e12f200cab1da43ba301bdc70e1d",
"type": "string"
},
"body_size": {
"description": "Size of the body in bytes.",
"example": "63910 bytes",
"type": "string"
},
"cf-cache-status": {
"description": "Lists any `cf-cache-status` present.",
"type": "string"
},
"cf-ray": {
"description": "Lists any `cf-ray` present.",
"example": "1ddd7570575207d9-LAX",
"type": "string"
},
"cf-wan-error": {
"description": "Lists any `cf-wan-error` present.",
"type": "string"
},
"cloudflare": {
"description": "Whether Cloudflare is enabled on the host.",
"example": "on",
"type": "string"
},
"connection_close": {
"default": true,
"description": "Connection closed or open.",
"example": false,
"type": "boolean"
},
"elapsed_time": {
"description": "Amount of seconds that the test lasted.",
"example": "0.239013s",
"type": "string"
},
"host_name": {
"description": "The hostname queried.",
"example": "www.example.com",
"type": "string"
},
"http_status": {
"description": "The HTTP status response code.",
"example": 200,
"type": "number"
},
"method": {
"description": "HTTP Method used to test the connection.",
"enum": [
"GET",
"POST"
],
"example": "GET"
},
"missing_headers": {
"description": "What headers are missing.",
"example": "No Content-Length or Transfer-Encoding.",
"type": "string"
},
"protocol": {
"description": "Protocol used to test the connection.",
"example": "HTTP/1.1",
"type": "string"
},
"railgun": {
"description": "Indicates if Railgun is enabled on the queried hostname.",
"example": "on",
"type": "string"
},
"response_status": {
"description": "HTTP Status code.",
"example": "200 OK",
"type": "string"
},
"url": {
"description": "Url of the domain you can compare the connection to.",
"example": "https://www.cloudflare.com",
"type": "string"
}
},
"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": "Test Railgun connection response failure"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_token": []
}
]