Static IP

SIPs

GET /{applianceId}/sips

List the static IPs

Path parameters

applianceId string Required: The id of the cluster node the request is for.

curl

curl -X GET "https://appliance.example.com/api/v1/{applianceId}/sips" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/sips';
$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/{applianceId}/sips", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/sips', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Static IPs",
  "data": [
    {
      "id": "189-1e2-8b1-85e",
      "groupId": "189-1e2-8b1-85e",
      "ip": "10.10.11.101"
    }
  ]
}

POST /{applianceId}/sips

Add a static IP

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

Path parameters

applianceId string Required: .Body parameters

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

curl

curl -X POST "https://appliance.example.com/api/v1/{applianceId}/sips" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "groupId": "<groupId>",
  "ip": "<ip>",
  "externalPingCheck": "true"
}'

PHP

<?php

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

$payload = [
    'groupId' => '<groupId>',
    'ip' => '<ip>',
    'externalPingCheck' => 'true',
];

$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>",
    "externalPingCheck": "true"
}

response = requests.post("https://appliance.example.com/api/v1/{applianceId}/sips", headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/sips', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "groupId": "<groupId>",
  "ip": "<ip>",
  "externalPingCheck": "true"
}),
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Static IP address added successfully",
  "data": {
    "id": "600-6f1-1a8-548"
  }
}

SIPs by ID

GET /{applianceId}/sips/{id}

Add a floating ip to a group

Path parameters

applianceId string Required: The id of the cluster node the request is for.
id string Required: The id of the sip.

curl

curl -X GET "https://appliance.example.com/api/v1/{applianceId}/sips/{id}" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/sips/{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/{applianceId}/sips/{id}", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/sips/{id}', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Static IP",
  "data": {
    "id": "189-1e2-8b1-85e",
    "groupId": "189-1e2-8b1-85e",
    "ip": "10.10.11.101"
  }
}

PUT /{applianceId}/sips/{id}

Edit ip to specified node and interface

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

Path parameters

applianceId string Required
id string Required: .Body parameters

groupId string Required
ip string Required: staticIP.
externalPingCheck boolean default: "true"

curl

curl -X PUT "https://appliance.example.com/api/v1/{applianceId}/sips/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "groupId": "<groupId>",
  "ip": "<ip>",
  "externalPingCheck": "true"
}'

PHP

<?php

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

$payload = [
    'groupId' => '<groupId>',
    'ip' => '<ip>',
    'externalPingCheck' => 'true',
];

$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>",
    "externalPingCheck": "true"
}

response = requests.put("https://appliance.example.com/api/v1/{applianceId}/sips/{id}", headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/sips/{id}', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "groupId": "<groupId>",
  "ip": "<ip>",
  "externalPingCheck": "true"
}),
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Static IP address edited successfully"
}

DELETE /{applianceId}/sips/{id}

Remove a Static IP

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

Path parameters

applianceId string Required
id string Required: The id of the sip.

Query parameters

ip string Required: id of ip to delete.

curl

curl -X DELETE "https://appliance.example.com/api/v1/{applianceId}/sips/{id}" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/sips/{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/{applianceId}/sips/{id}", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/sips/{id}', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Static IP address deleted successfully"
}