Endurance
Get started

Floating IP

FIPs

Get all Floating IPs

GET /fips

curl
curl -X GET "https://appliance.example.com/api/v1/fips" \
  -H "Authorization: Bearer $TOKEN"
PHP
<?php

$url = 'https://appliance.example.com/api/v1/fips';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);
Python
import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.get("https://appliance.example.com/api/v1/fips", headers=headers)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/fips', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();
Bruno
meta {
  name: List the floating IPs
  type: http
  seq: 1
}

get {
  url: https://{{node-0}}:{{port}}/api/v1/fips
  body: none
  auth: bearer
}

auth:bearer {
  token: {{token}}
}
Response
{
  "status": "success",
  "message": "Floating IPs",
  "data": [
    {
      "id": "189-1e2-8b1-85e",
      "groupId": "189-1e2-8b1-85e",
      "ip": "10.10.11.101",
      "enabled": true,
      "role": "service",
      "snatPortRange": null
    }
  ]
}

Add a floating IP

POST /fips

This change is staged. Send PUT /services/apply to apply it.

Body parameters
groupId string Required
ip string Required
enabled boolean default: "true"

Boolean to make the IP enabled

role default: "service" service | snat

What the FIP is for. A service FIP is what a Frontend binds to. A snat FIP is a SNAT IP: the source address a Layer 4 Source NAT Backend’s traffic leaves from. It never accepts a client connection, and cannot be a Frontend’s FIP. Kept when omitted; it cannot change while the FIP is in use.

snatPortRange object

The source ports a SNAT IP may use, for every Backend that uses it. Only for a snat FIP; null leaves the choice to the appliance. Kept when omitted.

Fields
low integer
high integer
curl
curl -X POST "https://appliance.example.com/api/v1/fips" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "groupId": "<groupId>",
  "ip": "<ip>",
  "enabled": "true",
  "role": "service",
  "snatPortRange": {
    "low": 0,
    "high": 0
  }
}'
PHP
<?php

$url = 'https://appliance.example.com/api/v1/fips';
$headers = [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
];

$payload = [
    'groupId' => '<groupId>',
    'ip' => '<ip>',
    'enabled' => 'true',
    'role' => 'service',
    'snatPortRange' => [
        'low' => 0,
        'high' => 0,
    ],
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);
Python
import requests

headers = {"Authorization": f"Bearer {token}"}
payload = {
    "groupId": "<groupId>",
    "ip": "<ip>",
    "enabled": "true",
    "role": "service",
    "snatPortRange": {
        "low": 0,
        "high": 0
    }
}

response = requests.post("https://appliance.example.com/api/v1/fips", headers=headers, json=payload)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/fips', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "groupId": "<groupId>",
  "ip": "<ip>",
  "enabled": "true",
  "role": "service",
  "snatPortRange": {
    "low": 0,
    "high": 0
  }
}),
});

const data = await response.json();
Bruno
meta {
  name: Create a floating IP
  type: http
  seq: 1
}

post {
  url: https://{{node-0}}:{{port}}/api/v1/fips
  body: json
  auth: bearer
}

headers {
  Content-Type: application/json
}

auth:bearer {
  token: {{token}}
}

body:json {
  {
    "groupId": "<groupId>",
    "ip": "<ip>",
    "enabled": "true",
    "role": "service",
    "snatPortRange": {
      "low": 0,
      "high": 0
    }
  }
}
Response
{
  "status": "success",
  "message": "Floating IP: {ip} added to group successfully",
  "data": {
    "id": "189-1e2-8b1-85e"
  }
}

Disable the floating IPs

Set All Floating IPs Down

PUT /fips/disable

This change is staged. Send PUT /services/apply to apply it.

Body parameters
ids string Required

Supply an array of ids to disable if empty all will be disabled

curl
curl -X PUT "https://appliance.example.com/api/v1/fips/disable" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": "<ids>"
}'
PHP
<?php

$url = 'https://appliance.example.com/api/v1/fips/disable';
$headers = [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
];

$payload = [
    'ids' => '<ids>',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);
Python
import requests

headers = {"Authorization": f"Bearer {token}"}
payload = {
    "ids": "<ids>"
}

response = requests.put("https://appliance.example.com/api/v1/fips/disable", headers=headers, json=payload)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/fips/disable', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "ids": "<ids>"
}),
});

const data = await response.json();
Bruno
meta {
  name: Disable the floating IPs
  type: http
  seq: 1
}

put {
  url: https://{{node-0}}:{{port}}/api/v1/fips/disable
  body: json
  auth: bearer
}

headers {
  Content-Type: application/json
}

auth:bearer {
  token: {{token}}
}

body:json {
  {
    "ids": "<ids>"
  }
}
Response
{
  "status": "success",
  "message": "Floating IPs now disabled"
}

Enable the floating IPs

Set All Floating IPs Up

PUT /fips/enable

This change is staged. Send PUT /services/apply to apply it.

Body parameters
ids string Required

Supply an array of ids to enable if empty all will be enabled

curl
curl -X PUT "https://appliance.example.com/api/v1/fips/enable" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": "<ids>"
}'
PHP
<?php

$url = 'https://appliance.example.com/api/v1/fips/enable';
$headers = [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
];

$payload = [
    'ids' => '<ids>',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);
Python
import requests

headers = {"Authorization": f"Bearer {token}"}
payload = {
    "ids": "<ids>"
}

response = requests.put("https://appliance.example.com/api/v1/fips/enable", headers=headers, json=payload)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/fips/enable', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "ids": "<ids>"
}),
});

const data = await response.json();
Bruno
meta {
  name: Enable the floating IPs
  type: http
  seq: 1
}

put {
  url: https://{{node-0}}:{{port}}/api/v1/fips/enable
  body: json
  auth: bearer
}

headers {
  Content-Type: application/json
}

auth:bearer {
  token: {{token}}
}

body:json {
  {
    "ids": "<ids>"
  }
}
Response
{
  "status": "success",
  "message": "Floating IPs now enabled"
}

FIPs by ID

Add a floating ip to a group

GET /fips/{id}

Path parameters
id string Required

The id of the fip.

curl
curl -X GET "https://appliance.example.com/api/v1/fips/{id}" \
  -H "Authorization: Bearer $TOKEN"
PHP
<?php

$url = 'https://appliance.example.com/api/v1/fips/{id}';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);
Python
import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.get("https://appliance.example.com/api/v1/fips/{id}", headers=headers)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/fips/{id}', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();
Bruno
meta {
  name: Get a floating IP
  type: http
  seq: 1
}

get {
  url: https://{{node-0}}:{{port}}/api/v1/fips/{id}
  body: none
  auth: bearer
}

auth:bearer {
  token: {{token}}
}
Response
{
  "status": "success",
  "message": "Floating IP",
  "data": {
    "id": "189-1e2-8b1-85e",
    "groupId": "189-1e2-8b1-85e",
    "ip": "10.10.11.101",
    "enabled": true,
    "role": "service",
    "snatPortRange": null
  }
}

Edit a floating IP

PUT /fips/{id}

This change is staged. Send PUT /services/apply to apply it.

Path parameters
id string Required

.Body parameters

groupId string Required
ip string Required
enabled boolean default: "true"

Boolean to make the IP enabled

role default: "service" service | snat

What the FIP is for. A service FIP is what a Frontend binds to. A snat FIP is a SNAT IP: the source address a Layer 4 Source NAT Backend’s traffic leaves from. It never accepts a client connection, and cannot be a Frontend’s FIP. Kept when omitted; it cannot change while the FIP is in use.

snatPortRange object

The source ports a SNAT IP may use, for every Backend that uses it. Only for a snat FIP; null leaves the choice to the appliance. Kept when omitted.

Fields
low integer
high integer
curl
curl -X PUT "https://appliance.example.com/api/v1/fips/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "groupId": "<groupId>",
  "ip": "<ip>",
  "enabled": "true",
  "role": "service",
  "snatPortRange": {
    "low": 0,
    "high": 0
  }
}'
PHP
<?php

$url = 'https://appliance.example.com/api/v1/fips/{id}';
$headers = [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
];

$payload = [
    'groupId' => '<groupId>',
    'ip' => '<ip>',
    'enabled' => 'true',
    'role' => 'service',
    'snatPortRange' => [
        'low' => 0,
        'high' => 0,
    ],
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);
Python
import requests

headers = {"Authorization": f"Bearer {token}"}
payload = {
    "groupId": "<groupId>",
    "ip": "<ip>",
    "enabled": "true",
    "role": "service",
    "snatPortRange": {
        "low": 0,
        "high": 0
    }
}

response = requests.put("https://appliance.example.com/api/v1/fips/{id}", headers=headers, json=payload)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/fips/{id}', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "groupId": "<groupId>",
  "ip": "<ip>",
  "enabled": "true",
  "role": "service",
  "snatPortRange": {
    "low": 0,
    "high": 0
  }
}),
});

const data = await response.json();
Bruno
meta {
  name: Update a floating IP
  type: http
  seq: 1
}

put {
  url: https://{{node-0}}:{{port}}/api/v1/fips/{id}
  body: json
  auth: bearer
}

headers {
  Content-Type: application/json
}

auth:bearer {
  token: {{token}}
}

body:json {
  {
    "groupId": "<groupId>",
    "ip": "<ip>",
    "enabled": "true",
    "role": "service",
    "snatPortRange": {
      "low": 0,
      "high": 0
    }
  }
}
Response
{
  "status": "success",
  "message": "Floating IP: {ip} edited in group successfully"
}

Delete a floating IP

DELETE /fips/{id}

This change is staged. Send PUT /services/apply to apply it.

Path parameters
id string Required
curl
curl -X DELETE "https://appliance.example.com/api/v1/fips/{id}" \
  -H "Authorization: Bearer $TOKEN"
PHP
<?php

$url = 'https://appliance.example.com/api/v1/fips/{id}';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);
Python
import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.delete("https://appliance.example.com/api/v1/fips/{id}", headers=headers)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/fips/{id}', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();
Bruno
meta {
  name: Delete a floating IP
  type: http
  seq: 1
}

delete {
  url: https://{{node-0}}:{{port}}/api/v1/fips/{id}
  body: none
  auth: bearer
}

auth:bearer {
  token: {{token}}
}
Response
{
  "status": "success",
  "message": "Floating IP: {ip} deleted successfully"
}