Service IPs

GET /service-ips

Get all Service IPs

curl

curl -X GET "https://appliance.example.com/api/v1/service-ips" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "Service IPs",
  "data": [
    {
      "id": "189-1e2-8b1-85e",
      "label": "Web Service"
    }
  ]
}

POST /service-ips

Add a service IP

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

Body parameters

name string Required

curl

curl -X POST "https://appliance.example.com/api/v1/service-ips" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "<name>"
}'

PHP

<?php

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

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

$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 = {
    "name": "<name>"
}

response = requests.post("https://appliance.example.com/api/v1/service-ips", headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "Service IP added successfully",
  "data": {
    "id": "189-1e2-8b1-85e"
  }
}

Count the service IPs with no static IP on a node

GET /service-ips/unassigned

Count of Service IPs with unassigned Static IP on a node

curl

curl -X GET "https://appliance.example.com/api/v1/service-ips/unassigned" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "Unassigned service IPs",
  "data": {
    "count": 1
  }
}

By ID

GET /service-ips/{id}

Add a service ip to a group

Path parameters

id string Required: The id of the service-ip.

curl

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

PHP

<?php

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "Service IP",
  "data": {
    "id": "189-1e2-8b1-85e",
    "label": "Web Service",
    "usage": [
      {
        "service": "haproxy",
        "serviceFullName": "HAProxy",
        "serviceId": null,
        "serviceName": "HAProxy Persistence Replication",
        "serviceNodeId": null,
        "section": "",
        "sectionFullName": ""
      }
    ],
    "sips": [
      {
        "nodeId": "edd-1d5-72f-3c0",
        "sipId": "67c-006-613-d3b"
      },
      {
        "nodeId": "ad3-a85-94d-14a",
        "sipId": null
      }
    ]
  }
}

PUT /service-ips/{id}

Edit a service IP

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

Path parameters

id string Required: .Body parameters

name string Required

curl

curl -X PUT "https://appliance.example.com/api/v1/service-ips/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "<name>"
}'

PHP

<?php

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

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

$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 = {
    "name": "<name>"
}

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "Service IP edited successfully"
}

DELETE /service-ips/{id}

Delete a service IP

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/service-ips/{id}" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "Service IP deleted successfully"
}

Assign a static IP to a service IP

POST /{applianceId}/service-ips/{id}/assign

Assign a SIP to a Service IP

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

Path parameters

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

sipId string Required: Static IP ID

curl

curl -X POST "https://appliance.example.com/api/v1/{applianceId}/service-ips/{id}/assign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "sipId": "<sipId>"
}'

PHP

<?php

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

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

$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 = {
    "sipId": "<sipId>"
}

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "SIP assign to a Service IP successfully"
}

Unassign a static IP from a service IP

DELETE /{applianceId}/service-ips/{id}/unassign

Unassign a SIP to a service IP

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

Path parameters

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

curl

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

PHP

<?php

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "SIP unassign from a Service IP successfully"
}