Azure

Get the Azure active-state probe

GET /azure/active-state

Active-State Probe — succeeds only on the PulseHA-active node

This endpoint does not require authentication.

curl
curl -X GET "https://appliance.example.com/api/v1/azure/active-state"
PHP
<?php

$url = 'https://appliance.example.com/api/v1/azure/active-state';
$headers = [
];

$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


response = requests.get("https://appliance.example.com/api/v1/azure/active-state")
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/azure/active-state', {
  method: 'GET',
});

const data = await response.json();
Response
{
  "status": "success",
  "message": "active",
  "data": []
}

List the Azure load balancer rules

GET /azure/load-balancer-rules

Get all Azure load balancer rules (VIP projection)

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

$url = 'https://appliance.example.com/api/v1/azure/load-balancer-rules';
$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/azure/load-balancer-rules", headers=headers)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/azure/load-balancer-rules', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();
Response
{
  "status": "success",
  "message": "Azure load balancer rules",
  "data": []
}

Get an Azure load balancer rule

GET /azure/load-balancer-rules/{id}

Get an Azure load balancer rule by ID

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

$url = 'https://appliance.example.com/api/v1/azure/load-balancer-rules/{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/azure/load-balancer-rules/{id}", headers=headers)
response.raise_for_status()
print(response.json())
JavaScript
const response = await fetch('https://appliance.example.com/api/v1/azure/load-balancer-rules/{id}', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();
Response
{
  "status": "success",
  "message": "Azure load balancer rule",
  "data": []
}