List connections associated with the Railgun.
/accounts/{account_identifier}/railguns/{railgun_identifier}/connections
get
Railgun Connections
railgun-connections-list-connections
{
"business": true,
"enterprise": true,
"free": false,
"pro": false
}{
"enum": [
"#organization:read"
]
}[
{
"in": "path",
"name": "railgun_identifier",
"required": true,
"schema": {
"description": "Railgun identifier tag.",
"example": "e928d310693a83094309acf9ead50448",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "enabled",
"schema": {
"default": false,
"description": "A value indicating whether the connection is enabled or not.",
"example": true,
"type": "boolean"
}
},
{
"in": "query",
"name": "page",
"schema": {
"description": "Requested page within paginated list of results.",
"example": 1,
"type": "number"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"description": "Maximum number of results requested.",
"example": 20,
"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": {
"created_on": {
"description": "When the connection was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"enabled": {
"default": false,
"description": "A value indicating whether the connection is enabled or not.",
"example": true,
"type": "boolean"
},
"id": {
"description": "Connection identifier tag.",
"example": "c4a7362d577a6c3019a474fd6f485821",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"description": "When the connection was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"zone": {
"properties": {
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The domain name",
"example": "example.com",
"maxLength": 253,
"pattern": "^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
"required": [
"id",
"zone",
"enabled"
],
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List 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": {
"properties": {
"created_on": {
"description": "When the connection was created.",
"example": "2017-06-14T00:00:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"enabled": {
"default": false,
"description": "A value indicating whether the connection is enabled or not.",
"example": true,
"type": "boolean"
},
"id": {
"description": "Connection identifier tag.",
"example": "c4a7362d577a6c3019a474fd6f485821",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"modified_on": {
"description": "When the connection was last modified.",
"example": "2017-06-14T05:20:00Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"zone": {
"properties": {
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The domain name",
"example": "example.com",
"maxLength": 253,
"pattern": "^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
"required": [
"id",
"zone",
"enabled"
],
"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 Connections response failure"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_token": []
}
]