Skip to main content

Servers API

Content​

Servers collection:

Single Server:

Servers collection

Get list of servers​

GET /api/v0/servers

This method needs permission access on servers.

Method for listing all Server.

Request​

GET /api/v0/servers HTTP/1.1
Content-Type: application/json

Responses​

200 OK​

GET /api/v0/servers HTTP/1.1
Content-Type: application/json
Status-Code: 200

{
    "items": [
        {
            "id": 1,
            "name": "aaa.simplo.cz",
            "hetzner_server_id": 26776140,
            "ipv4": "11.22.333.44",
            "ipv6": "aaaa:bbb:cccc:dddd::/64",
            "private_net_ip": "11.2.3.4",
            "is_gateway": true,
            "created_at": "2023-10-09T10:30:05+0200",
            "updated_at": "2023-10-09T10:30:05+0200",
            "_links": [
                {
                    "href": "/api/v0/servers/1",
                    "rel": "self",
                    "type": "GET"
                }
            ]
        },
        {
            "id": 2,
            "name": "bbb.simplo.cz",
            "hetzner_server_id": 26776141,
            "ipv4": "11.22.333.444",
            "ipv6": "aaaa:bbb:cccc:dddd::/64",
            "private_net_ip": "11.2.3.1",
            "is_gateway": false,
            "created_at": "2023-10-09T10:30:05+0200",
            "updated_at": "2023-10-09T10:30:05+0200",
            "_links": [
                {
                    "href": "/api/v0/servers/2",
                    "rel": "self",
                    "type": "GET"
                }
            ]
        },
    ]
}

Single Server

Show Single Server​

GET /api/v0/servers/{ServerId}

This method needs permission read on servers.

Request​

GET /api/v0/servers/1 HTTP/1.1
Content-Type: application/json

Responses​

200 OK​

{
    "id": 1,
    "name": "gateway01.simplo.cz",
    "hetzner_server_id": "123",
    "ipv4": "1.1.1.1",
    "ipv6": "0::f",
    "private_net_ip": "1.1.1.1",
    "is_gateway": true,
    "type": "cpx11",
    "location": "fsn1",
    "imported_at": "2024-03-06T13:40:52+0100",
    "created_at": "2024-02-27T09:13:05+0100",
    "updated_at": "2024-03-06T13:40:55+0100",
    "_links": [
        {
            "href": "/api/v0/servers/1",
            "rel": "self",
            "type": "GET"
        }
    ]
}