View a bridge

View device

For disk capacity in megabytes Permission - bridges

GET /api/v1/bridges/{bridge}

Parameters

int bridge, Unique device identifier

200 OK

Returns a device object

JSON

{
    "id": 1,
    "name": "name",
    "uuid": "uuid",
    "mac": "mac",
    "serial_number": "serial_number",
    "status": "activated",
    "is_online": true,
    "version": "1.1.1.1",
    "last_updated_at": "2020-01-01T00:00:00.000000Z",
    "created_at": "2023-02-03T10:51:53.000000Z",
    "updated_at": "2023-02-03T10:51:53.000000Z",
    "storages": [
        {
            "id": 2,
            "path": "/storage",
            "usage": 15.5,
            "capacity": 100000.5
        }
    ]
}

401 Unauthorized

Authorization token not sent or not valid

422 Unprocessable Entity

Returns a JSON object with an error.

JSON

{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The cause of the error will be described here"
        ]
    }
}

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/v1/bridges/{bridge}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "bridge": 0
}'

PHP

$data = array (
  'bridge' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/bridges/{bridge}', false, $context);