router-allocations¶

Summary¶

GET /v3/lightning/router-allocations

Description¶

Paginated list of router IP allocations the caller can see. Only allocations whose underlying lightning device the caller can update are returned.

Tags: lightning

Parameters¶

Header Parameters¶

Name	Type	Required	Example
`Authorization`	`string`	✓ Yes	`Bearer {AuthToken}`
`Content-Type`	`string`	✓ Yes	`application/json`
`Accept`	`string`	✓ Yes	`application/json`
`AppIdV3`	`string`	✓ Yes	`LCUID-LAP-******----**********`

Responses¶

Response: 200¶

Description: Sample Response

Content Type: `application/json`¶

Schema¶

Type: object

Properties:

success (boolean): true
lightning_router_ip_allocations (object) Type: object

Properties:

current_page (integer)
data (array)
- Array items: object Type: object
Properties:
- lcuid (string)
- site_id (string)
- wg_ip (string)
- lan_subnet (string)
- rut_lan_ip (string)
- device_ip (string)
- status (integer)
- reserved_until (string)
- released_at (string)
- release_reason (string)
- lightning_device_id (integer)
- allocated_to_router_id (string)
- requested_by (string)
- created_at (string)
- updated_at (string)
first_page_url (string)
from (integer)
last_page (integer)
last_page_url (string)
links (array)
- Array items: object Type: object
Properties:
- url (string)
- label (string)
- active (boolean)
next_page_url (string)
path (string)
per_page (integer)
prev_page_url (string)
to (integer)
total (integer)

Example Response¶

{
    "success": true,
    "lightning_router_ip_allocations": {
        "current_page": 1,
        "data": [
            {
                "lcuid": "LCUID-LDRA-42350eed-6abe-4b5b-bd32-f758e2e1504c",
                "site_id": null,
                "wg_ip": "10.70.1.2",
                "lan_subnet": "10.71.0.4/30",
                "rut_lan_ip": "10.71.0.5",
                "device_ip": "10.71.0.6",
                "status": 1,
                "reserved_until": "2026-10-09T21:36:30.000000Z",
                "released_at": null,
                "release_reason": null,
                "lightning_device_id": 20476,
                "allocated_to_router_id": null,
                "requested_by": "tester@example.com",
                "created_at": "2026-10-08T21:36:30.000000Z",
                "updated_at": "2026-10-08T21:36:30.000000Z"
            }
        ],
        "first_page_url": "http://localhost:8080/api/v3/lightning/router-allocations?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://localhost:8080/api/v3/lightning/router-allocations?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://localhost:8080/api/v3/lightning/router-allocations?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://localhost:8080/api/v3/lightning/router-allocations",
        "per_page": 50,
        "prev_page_url": null,
        "to": 1,
        "total": 8
    }
}

Example Implementations¶

Bash (cURL)¶

curl --request GET \
    --get "https://api.lucit.app/api/v3/lightning/router-allocations" \
    --header "Authorization: Bearer {AuthToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "AppIdV3: LCUID-LAP-********-****-****-****-************"

JavaScript (Fetch API)¶

const url = new URL(
    "https://api.lucit.app/api/v3/lightning/router-allocations"
);

const headers = {
    "Authorization": "Bearer {AuthToken}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "AppIdV3": "LCUID-LAP-********-****-****-****-************",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

PHP (Guzzle)¶

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.lucit.app/api/v3/lightning/router-allocations',
    [
        'headers' => [
            'Authorization' => 'Bearer {AuthToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Python (Requests)¶

import requests
import json

url = 'https://api.lucit.app/api/v3/lightning/router-allocations'
headers = {
  'Authorization': 'Bearer {AuthToken}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example Responses¶

200 Response¶

{
    "success": true,
    "lightning_router_ip_allocations": {
        "current_page": 1,
        "data": [
            {
                "lcuid": "LCUID-LDRA-42350eed-6abe-4b5b-bd32-f758e2e1504c",
                "site_id": null,
                "wg_ip": "10.70.1.2",
                "lan_subnet": "10.71.0.4/30",
                "rut_lan_ip": "10.71.0.5",
                "device_ip": "10.71.0.6",
                "status": 1,
                "reserved_until": "2026-10-09T21:36:30.000000Z",
                "released_at": null,
                "release_reason": null,
                "lightning_device_id": 20476,
                "allocated_to_router_id": null,
                "requested_by": "tester@example.com",
                "created_at": "2026-10-08T21:36:30.000000Z",
                "updated_at": "2026-10-08T21:36:30.000000Z"
            }
        ],
        "first_page_url": "http://localhost:8080/api/v3/lightning/router-allocations?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://localhost:8080/api/v3/lightning/router-allocations?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://localhost:8080/api/v3/lightning/router-allocations?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://localhost:8080/api/v3/lightning/router-allocations",
        "per_page": 50,
        "prev_page_url": null,
        "to": 1,
        "total": 8
    }
}

← Back to lightning index | Back to main index