Hetzner Robot Webservice

https://robot.hetzner.com/doc/webservice/
Admin
Hetzner Robot Webservice is an HTTP-based API for managing servers, IP addresses, storage boxes,...
Tokens:118,570
Snippets:582
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### POST /boot/{server-number}/vnc

Source: https://robot.hetzner.com/doc/webservice/en.html

Activate VNC installation for a specified server. This endpoint allows you to start a VNC installation by providing the distribution, architecture, and language.

```APIDOC
## POST /boot/{server-number}/vnc

### Description
Activate VNC installation

### Method
POST

### Endpoint
/boot/{server-number}/vnc

### Parameters
#### Path Parameters
- **server-number** (Integer) - Required - Server ID

#### Request Body
- **dist** (String) - Required - Distribution
- **@deprecated arch** (Integer) - Optional - Architecture (default: 64)
- **lang** (String) - Required - Language

### Request Example
```
curl -u "user:password" https://robot-ws.your-server.de/boot/321/vnc -d 'dist=centOS-5.0&lang=en_US'
```

### Response
#### Success Response (200)
- **vnc** (Object) - VNC boot configuration
  - **server_ip** (String) - Server main IP address
  - **server_ipv6_net** (String) - Server main IPv6 net address
  - **server_number** (Integer) - Server ID
  - **dist** (String) - Distribution
  - **@deprecated arch** (Integer) - Architecture
  - **lang** (String) - Language
  - **active** (Boolean) - true
  - **password** (String) - VNC installation password

#### Response Example
```
{
  "vnc":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":"centOS-5.0",
    "@deprecated arch":32,
    "lang":"en_US",
    "active":true,
    "password":"jEt0dtUvomlyOwRr"
  }
}
```

### Errors
| Status | Code | Description |
|--------|------|-------------|
| 400 | INVALID_INPUT | Invalid input parameters |
| 404 | SERVER_NOT_FOUND | Server with id {server-number} not found |
| 404 | BOOT_NOT_AVAILABLE | No boot configuration available for this server |
| 500 | BOOT_ACTIVATION_FAILED | Activation of the VNC installation failed due to an internal error |

### Deprecations
- @deprecated POST /boot/{server-ip}/vnc - The main IPv4 address may be used alternatively to specify the server.
```

--------------------------------

### Query Windows boot options with GET /boot/{server-number}/windows

Source: https://robot.hetzner.com/doc/webservice/en.html

Queries boot options for the Windows installation. The response includes available operating systems, languages, and the current installation status. Requires authentication and is subject to a request limit of 500 requests per hour.

```bash
curl -u "user:password" https://robot-ws.your-server.de/boot/321/windows

```

```json
{
  "windows":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":[
      "standard"
    ],
    "os":[
      "Windows Server 2022 Standard Edition",
      "Windows Server 2019 Standard Edition",
      "Windows Server 2016 Standard Edition"
    ],
    "lang":[
      "en",
      "de"
    ],
    "active":false,
    "password":null
  }
}

```

--------------------------------

### POST /boot/{server-number}/windows

Source: https://robot.hetzner.com/doc/webservice/en.html

Activates Windows installation on a server. Requires the Windows addon to be ordered via the Robot webpanel. After a reboot, the installation starts and all data on the server is deleted.

```APIDOC
## POST /boot/{server-number}/windows

### Description
Activate Windows installation. You need to order the Windows addon for the server via the Robot webpanel first. After a reboot, the installation will start, and all data on the server will be deleted.

### Method
POST

### Endpoint
/boot/{server-number}/windows

### Parameters
#### Path Parameters
- **server-number** (Integer) - Required - Server ID

#### Request Body
- **lang** (String) - Required - Language
- **os** (String) - Required - Operating system

### Request Example
```
curl -u "user:password" https://robot-ws.your-server.de/boot/321/windows -d 'lang=en' -d 'os=Windows Server 2019 Standard Edition'
```

### Response
#### Success Response (200)
- **windows** (Object) - Contains the following fields:
  - **server_ip** (String) - Server main IP address
  - **server_ipv6_net** (String) - Server main IPv6 net address
  - **server_number** (Integer) - Server ID
  - **dist** (String) - Distribution (deprecated)
  - **arch** (Integer) - Architecture (deprecated)
  - **os** (String) - Operating system
  - **lang** (String) - Language
  - **active** (Boolean) - true
  - **password** (String) - Windows installation password

#### Response Example
```
{
  "windows":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":"standard",
    "os":"Windows Server 2019 Standard Edition",
    "lang":"en",
    "active":true,
    "password":"jEt0dtUvomlyOwRr"
  }
}
```

### Errors
| Status | Code | Description |
|--------|------|-------------|
| 400 | INVALID_INPUT | Invalid input parameters |
| 404 | SERVER_NOT_FOUND | Server with id {server-number} not found |
| 404 | BOOT_NOT_AVAILABLE | No boot configuration available for this server |
| 404 | WINDOWS_MISSING_ADDON | No windows addon found |
| 404 | WINDOWS_OUTDATED_VERSION | The windows version is not supported anymore |
| 500 | BOOT_ACTIVATION_FAILED | Activation of the windows installation failed due to an internal error |

### Request Limit
500 requests per 1 hour

### Deprecations
- **POST /boot/{server-ip}/windows** - The main IPv4 address may be used alternatively to specify the server.
```

--------------------------------

### GET /boot/{server-number}/linux - Query Linux boot options

Source: https://robot.hetzner.com/doc/webservice/en.html

Query boot options for the Linux installation of a server. The request requires basic authentication with a user and password. The response includes server IP addresses, available distributions, architectures, languages, and installation status. The request limit is 500 requests per hour.

```bash
curl -u "user:password" https://robot-ws.your-server.de/boot/321/linux

```

```json
{
  "linux":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":[
      "CentOS 5.5 minimal",
      "Debian 7.8 minimal"
    ],
    "@deprecated arch":[
      64,
      32
    ],
    "lang":[
      "en"
    ],
    "active":false,
    "password":null,
    "authorized_key":[

    ],
    "host_key":[

    ]
  }
}

```

--------------------------------

### POST /boot/{server-number}/windows - Activate Windows installation

Source: https://robot.hetzner.com/doc/webservice/en.html

Activates Windows installation on a server. Requires the Windows addon to be ordered via the Robot webpanel first. After a reboot, the installation starts and all data on the server is deleted. The response includes the server details and the Windows installation password.

```bash
curl -u "user:password" https://robot-ws.your-server.de/boot/321/windows -d 'lang=en' -d 'os=Windows Server 2019 Standard Edition'
```

```json
{
  "windows":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":"standard",
    "os":"Windows Server 2019 Standard Edition",
    "lang":"en",
    "active":true,
    "password":"jEt0dtUvomlyOwRr"
  }
}
```

--------------------------------

### GET /boot/{server-number}/windows

Source: https://robot.hetzner.com/doc/webservice/en.html

Retrieves the boot options for the Windows installation of a specified server. This endpoint provides details about available distributions, operating systems, languages, and the current installation status.

```APIDOC
## GET /boot/{server-number}/windows

### Description
Query boot options for the windows installation

### Method
GET

### Endpoint
/boot/{server-number}/windows

### Parameters
#### Path Parameters
- **server-number** (Integer) - Required - Server ID

### Request Example
```
curl -u "user:password" https://robot-ws.your-server.de/boot/321/windows
```

### Response
#### Success Response (200)
- **windows** (Object) - Windows installation details
  - **server_ip** (String) - Server main IP address
  - **server_ipv6_net** (String) - Server main IPv6 net address
  - **server_number** (Integer) - Server ID
  - **@deprecated dist** (Array|String) - Array of available distributions or the active distribution
  - **@deprecated arch** (Array|Integer) - Array of available architectures or the active architecture
  - **os** (Array|String) - Array of available operating systems or the active operating system
  - **lang** (Array|String) - Array of available languages or the active language
  - **active** (Boolean) - Current Windows installation status
  - **password** (String) - Current Windows installation password or null

#### Response Example
```
{
  "windows":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":[
      "standard"
    ],
    "os":[
      "Windows Server 2022 Standard Edition",
      "Windows Server 2019 Standard Edition",
      "Windows Server 2016 Standard Edition"
    ],
    "lang":[
      "en",
      "de"
    ],
    "active":false,
    "password":null
  }
}
```

### Errors
| Status | Code | Description |
|--------|------|-------------|
| 404 | SERVER_NOT_FOUND | Server with id {server-number} not found |
| 404 | BOOT_NOT_AVAILABLE | No boot configuration available for this server |
| 404 | WINDOWS_OUTDATED_VERSION | The windows version is not supported anymore |

### Deprecations
- @deprecated GET /boot/{server-ip}/windows - The main IPv4 address may be used alternatively to specify the server.
```

--------------------------------

### GET /boot/{server-number}/linux

Source: https://robot.hetzner.com/doc/webservice/en.html

Query boot options for the Linux installation of a server.

```APIDOC
## GET /boot/{server-number}/linux

### Description
Query boot options for the Linux installation

### Method
GET

### Endpoint
/boot/{server-number}/linux

### Parameters
#### Path Parameters
- **server-number** (Integer) - Required - Server ID

### Request Example
```
curl -u "user:password" https://robot-ws.your-server.de/boot/321/linux
```

### Response
#### Success Response (200)
- **linux** (Object) - Linux boot configuration
- **server_ip** (String) - Server main IP address
- **server_ipv6_net** (String) - Server main IPv6 net address
- **server_number** (Integer) - Server ID
- **dist** (Array|String) - Array of available distributions or the active distribution
- **@deprecated arch** (Array|Integer) - Array of available architectures or the active architecture
- **lang** (Array|String) - Array of available languages or the active language
- **active** (Boolean) - Current Linux installation status
- **password** (String) - Current Linux installation password or null
- **authorized_key** (Array) - Authorized public SSH keys
- **host_key** (Array) - Host keys

#### Response Example
```
{
  "linux": {
    "server_ip": "123.123.123.123",
    "server_ipv6_net": "2a01:4f8:111:4221::",
    "server_number": 321,
    "dist": [
      "CentOS 5.5 minimal",
      "Debian 7.8 minimal"
    ],
    "@deprecated arch": [
      64,
      32
    ],
    "lang": [
      "en"
    ],
    "active": false,
    "password": null,
    "authorized_key": [],
    "host_key": []
  }
}
```

### Errors
| Status | Code | Description |
|--------|------|-------------|
| 404 | SERVER_NOT_FOUND | Server with id {server-number} not found |
| 404 | BOOT_NOT_AVAILABLE | No boot configuration available for this server |

### Deprecations
- @deprecated GET /boot/{server-ip}/linux - The main IPv4 address may be used alternatively to specify the server.
```

--------------------------------

### POST /boot/{server-number}/vnc - Activate VNC installation

Source: https://robot.hetzner.com/doc/webservice/en.html

Activate VNC installation by sending a POST request with distribution and language parameters. The response includes the active VNC password and status. The request limit is 500 requests per hour.

```bash
 curl -u "user:password" https://robot-ws.your-server.de/boot/321/vnc -d 'dist=centOS-5.0&lang=en_US'

```

```json
{
  "vnc":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":"centOS-5.0",
    "@deprecated arch":32,
    "lang":"en_US",
    "active":true,
    "password":"jEt0dtUvomlyOwRr"
  }
}

```

--------------------------------

### GET /order/server_addon/{server-number}/product - List available server addons

Source: https://robot.hetzner.com/doc/webservice/en.html

Retrieve the list of available server addons for a specific server using the Robot webservice. The request requires basic authentication with a username and password. The response is a JSON array of product objects, each containing an id, name, type, and pricing details including monthly and hourly rates as well as setup fees. The request limit is 500 requests per hour.

```bash
curl -u "user:password" https://robot-ws.your-server.de/order/server_addon/123/product

```

```json
[
  {
    "product":{
      "id":"additional_ipv4",
      "name":"Additional IP address",
      "type":"ip_ipv4",
      "price":{
        "location":"NBG1",
        "price":{
          "net":"0.8403",
          "gross":"0.8403",
          "hourly_net":"0.0014",
          "hourly_gross":"0.0014"
        },
        "price_setup":{
          "net":"19.0000",
          "gross":"19.0000"
        }
      }
    }
  },
  {
    "product":{
      "id":"subnet_ipv4_29",
      "name":"Additional subnet \/29 (monthly charge)",
      "type":"subnet_ipv4",
      "price":{
        "location":"NBG1",
        "price":{
          "net":"6.7227",
          "gross":"6.7227",
          "hourly_net":"0.0108",
          "hourly_gross":"0.0108"
        },
        "price_setup":{
          "net":"152.0000",
          "gross":"152.0000"
        }
      }
    }
  }
]

```

--------------------------------

### GET /boot/{server-number}/linux/last - Show last Linux installation

Source: https://robot.hetzner.com/doc/webservice/en.html

Shows the data of the last Linux installation for a server. The response includes the distribution, architecture, language, active status, and password. Requires server number 321 and authentication credentials.

```bash
curl -u "user:password" https://robot-ws.your-server.de/boot/321/linux/last

```

```json
{
  "linux":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":"CentOS 5.5 minimal",
    "@deprecated arch":32,
    "lang":"en",
    "active":true,
    "password":"jEt0dtUvomlyOwRr",
    "authorized_key":[

    ],
    "host_key":[

    ]
  }
}

```

--------------------------------

### GET /boot/{server-number}/vnc

Source: https://robot.hetzner.com/doc/webservice/en.html

Query boot options for the VNC installation. This endpoint retrieves the current VNC boot configuration for a specified server, including available distributions, architectures, languages, and the current activation status.

```APIDOC
## GET /boot/{server-number}/vnc

### Description
Query boot options for the VNC installation

### Method
GET

### Endpoint
/boot/{server-number}/vnc

### Parameters
#### Path Parameters
- **server-number** (Integer) - Required - Server ID

### Request Example
```
curl -u "user:password" https://robot-ws.your-server.de/boot/321/vnc
```

### Response
#### Success Response (200)
- **vnc** (Object) - VNC boot configuration
  - **server_ip** (String) - Server main IP address
  - **server_ipv6_net** (String) - Server main IPv6 net address
  - **server_number** (Integer) - Server ID
  - **dist** (Array|String) - Array of available distributions or the active distribution
  - **@deprecated arch** (Array|Integer) - Array of available architectures or the active architecture
  - **lang** (Array|String) - Array of available languages or the active language
  - **active** (Boolean) - Current VNC installation status
  - **password** (String) - Current VNC installation password or null

#### Response Example
```
{
  "vnc":{
    "server_ip":"123.123.123.123",
    "server_ipv6_net":"2a01:4f8:111:4221::",
    "server_number":321,
    "dist":[
      "centOS-5.0",
      "Fedora-6",
      "openSUSE-10.2"
    ],
    "@deprecated arch":[
      64,
      32
    ],
    "lang":[
      "de_DE",
      "en_US"
    ],
    "active":false,
    "password":null
  }
}
```

### Errors
| Status | Code | Description |
|--------|------|-------------|
| 404 | SERVER_NOT_FOUND | Server with id {server-number} not found |
| 404 | BOOT_NOT_AVAILABLE | No boot configuration available for this server |

### Deprecations
- @deprecated GET /boot/{server-ip}/vnc - The main IPv4 address may be used alternatively to specify the server.
```

--------------------------------

### PHP client example for failover IP operations

Source: https://robot.hetzner.com/doc/webservice/en.html

Example usage of the PHP client library for the Robot webservice. Requires PHP with libcurl support and the client library from https://robot.hetzner.com/downloads/robot-client.zip. Demonstrates retrieving all failover IPs, retrieving a specific failover IP, and switching routing with error handling.

```php
<?php
require 'RobotRestClient.class.php';
require 'RobotClientException.class.php';
require 'RobotClient.class.php';

$robot = new RobotClient('https://robot-ws.your-server.de', 'login', 'password');

// retrieve all failover ips
$results = $robot->failoverGet();

foreach ($results as $result)
{
  echo $result->failover->ip . "\n";
  echo $result->failover->server_ip . "\n";
  echo $result->failover->active_server_ip . "\n";
}

// retrieve a specific failover ip
$result = $robot->failoverGet('123.123.123.123');

echo $result->failover->ip . "\n";
echo $result->failover->server_ip . "\n";
echo $result->failover->active_server_ip . "\n";

// switch routing
try
{
  $robot->failoverRoute('123.123.123.123', '213.133.104.190');
}
catch (RobotClientException $e)
{
  echo $e->getMessage() . "\n";
}

```

--------------------------------

### GET /boot/{server-number} - Query boot configuration

Source: https://robot.hetzner.com/doc/webservice/en.html

Query the current boot configuration status for a server using the GET /boot/{server-number} endpoint. The response shows the available configurations for rescue, linux, vnc, and windows, each with their active status and available options. Only one configuration can be active at a time.

```bash
curl -u "user:password" https://robot-ws.your-server.de/boot/321

```

```json
{
  "boot":{
    "rescue":{
      "server_ip":"123.123.123.123",
      "server_ipv6_net":"2a01:4f8:111:4221::",
      "server_number":321,
      "os":[
        "linux",
        "vkvm"
      ],
      "@deprecated arch":[
        64,
        32
      ],
      "active":false,
      "password":null,
      "authorized_key":[

      ],
      "host_key":[

      ]
    },
    "linux":{
      "server_ip":"123.123.123.123",
      "server_ipv6_net":"2a01:4f8:111:4221::",
      "server_number":321,
      "dist":[
        "CentOS 5.5 minimal",
        "Debian 7.8 minimal"
      ],
      "@deprecated arch":[
        64,
        32
      ],
      "lang":[
        "en"
      ],
      "active":false,
      "password":null,
      "authorized_key":[

      ],
      "host_key":[

      ]
    },
    "vnc":{
      "server_ip":"123.123.123.123",
      "server_ipv6_net":"2a01:4f8:111:4221::",
      "server_number":321,
      "dist":[
        "centOS-5.0",
        "Fedora-6",
        "openSUSE-10.2"
      ],
      "@deprecated arch":[
        64,
        32
      ],
      "lang":[
        "de_DE",
        "en_US"
      ],
      "active":false,
      "password":null
    },
    "windows":{
      "server_ip":"123.123.123.123",
      "server_ipv6_net":"2a01:4f8:111:4221::",
      "server_number":321,
      "os":[
        "Windows Server 2022 Standard Edition",
        "Windows Server 2019 Standard Edition",
        "Windows Server 2016 Standard Edition"
      ],
      "dist":null,
      "lang":null,
      "active":false,
      "password":null
    }
  }
}

```

--------------------------------

### Example JSON response for GET /ip

Source: https://robot.hetzner.com/doc/webservice/en.html

Shows the JSON array returned by the GET /ip endpoint, containing two IP objects with their properties.

```json
[
  {
    "ip":{
      "ip":"123.123.123.123",
      "server_ip":"123.123.123.123",
      "server_number":321,
      "locked":false,
      "separate_mac":null,
      "traffic_warnings":false,
      "traffic_hourly":50,
      "traffic_daily":50,
      "traffic_monthly":8
    }
  },
  {
    "ip":{
      "ip":"124.124.124.124",
      "server_ip":"123.123.123.123",
      "server_number":321,
      "locked":false,
      "separate_mac":null,
      "traffic_warnings":false,
      "traffic_hourly":200,
      "traffic_daily":2000,
      "traffic_monthly":20
    }
  }
]
```

--------------------------------

### GET /order/server/product - List available server products

Source: https://robot.hetzner.com/doc/webservice/en.html

Retrieve the product overview of currently offered standard server products. The request requires basic authentication with a username and password. The response is a JSON array containing product details such as ID, name, description, traffic, distributions, locations, prices, and orderable addons. The request limit is 500 requests per hour.

```bash
curl -u "user:password" https://robot-ws.your-server.de/order/server/product

```

```json
[
  {
    "product":{
      "id":"EX60",
      "name":"Dedicated Server EX60",
      "description":[
        "Intel\u00ae Core\u2122 i7-920 Quad-Core",
        "48 GB DDR3 RAM",
        "2 x 2 TB SATA 3 Gb\/s Enterprise HDD; 7200 rpm(Software-RAID 1)",
        "1 Gbit\/s bandwidth"
      ],
      "traffic":"30 TB",
      "dist":[
        "Rescue system",
        "CentOS 6.6 minimal",
        "CentOS 7.0 minimal",
        "Debian 7.7 LAMP",
        "Debian 7.7 minimal",
        "openSUSE 13.2 minimal",
        "Ubuntu 14.04.1 LTS minimal",
        "Ubuntu 14.10 minimal"
      ],
      "@deprecated arch":[
        64,
        32
      ],
      "lang":[
        "en"
      ],
      "location":[
        "FSN1",
        "NBG1"
      ],
      "prices":[
        {
          "location":"FSN1",
          "price":{
            "net":"49.5800",
            "gross":"49.5800",
            "hourly_net":"0.0795",
            "hourly_gross":"0.0795"
          },
          "price_setup":{
            "net":"0.0000",
            "gross":"0.0000"
          }
        },
        {
          "location":"NBG1",
          "price":{
            "net":"49.5800",
            "gross":"49.5800",
            "hourly_net":"0.0795",
            "hourly_gross":"0.0795"
          },
          "price_setup":{
            "net":"0.0000",
            "gross":"0.0000"
          }
        }
      ],
      "orderable_addons":[
        {
          "id":"primary_ipv4",
          "name":"Primary IPv4",
          "min":0,
          "max":1,
          "prices":[
            {
              "location":"FSN1",
              "price":{
                "net":"1.7000",
                "gross":"1.7000",
                "hourly_net":"0.0027",
                "hourly_gross":"0.0027"
              },
              "price_setup":{
                "net":"0.0000",
                "gross":"0.0000"
              }
            },
            {
              "location":"NBG1",
              "price":{
                "net":"1.7000",
                "gross":"1.7000",
                "hourly_net":"0.0027",
                "hourly_gross":"0.0027"
              },
              "price_setup":{
                "net":"0.0000",
                "gross":"0.0000"
              }
            }
          ]
        }
      ]
    }
  },
  {
    "product":{
      "id":"EX40",
      "name":"Dedicated Server EX40",
      "description":[
        "Intel\u00ae Core\u2122 i7-4770 Quad-Core Haswell",
        "32 GB DDR3 RAM",
        "2 x 2 TB SATA 6 Gb\/s Enterprise HDD; 7200 rpm(Software-RAID 1)",
        "1 Gbit\/s bandwidth"
      ],
      "traffic":"30 TB",
      "dist":[
        "Rescue system",
        "CentOS 6.6 minimal",
        "CentOS 7.0 minimal",
        "Debian 7.7 LAMP",
        "Debian 7.7 minimal",
        "openSUSE 13.2 minimal",
        "Ubuntu 14.04.1 LTS minimal",
        "Ubuntu 14.10 minimal"
      ],
      "@deprecated arch":[
        64,
        32
      ],
      "lang":[
        "en"
      ],
      "location":[
        "FSN1",
        "NBG1"
      ],
      "prices":[
        {
          "location":"FSN1",
          "price":{
            "net":"84.0300",
            "gross":"84.0300",
            "hourly_net":"0.1347",
            "hourly_gross":"0.1347"
          },
          "price_setup":{
            "net":"41.1800",
            "gross":"41.1800"
          }
        },
        {
          "location":"NBG1",
          "price":{
            "net":"84.0300",
            "gross":"84.0300",
            "hourly_net":"0.1347",
            "hourly_gross":"0.1347"
          },
          "price_setup":{
            "net":"41.1800",
            "gross":"41.1800"
          }
        }
      ],
      "orderable_addons":[
        {
          "id":"primary_ipv4",
          "name":"Primary IPv4",
          "min":0,
          "max":1,
          "prices":[
            {
              "location":"FSN1",
              "price":{
                "net":"1.7000",
                "gross":"1.7000",
                "hourly_net":"0.0027",
                "hourly_gross":"0.0027"
              },
              "price_setup":{
                "net":"0.0000",
                "gross":"0.0000"
              }
            },
            {
              "location":"NBG1",
              "price":{
                "net":"1.7000",
                "gross":"1.7000",
                "hourly_net":"0.0027",
                "hourly_gross":"0.0027"
              },
              "price_setup":{
                "net":"0.0000",
                "gross":"0.0000"
              }
            }
          ]
        }
      ]
    }
  }
]

```

--------------------------------

### GET /subnet/{net-ip}/mac - JSON response

Source: https://robot.hetzner.com/doc/webservice/en.html

Example response for the GET request. Contains the IP, mask, current MAC address, and possible MAC addresses.

```json
{
  "mac":{
    "ip":"2a01:4f8:111:4221::",
    "mask":"64",
    "mac":"00:21:85:62:3e:9c",
    "possible_mac":{
      "123.123.123.123":"00:21:85:62:3e:9c",
      "123.123.123.124":"00:21:85:62:3e:9d"
    }
  }
}
```

--------------------------------

### GET /order/server/product

Source: https://robot.hetzner.com/doc/webservice/en.html

Retrieves the list of currently offered standard server products with their specifications, pricing, and available add-ons.

```APIDOC
## GET /order/server/product

### Description
Product overview of currently offered standard server products

### Method
GET

### Endpoint
/order/server/product

### Request Example
```
curl -u "user:password" https://robot-ws.your-server.de/order/server/product
```

### Response
#### Success Response (200)
- **product** (array) - List of available server products.
  - **id** (string) - Product identifier, e.g., "EX60".
  - **name** (string) - Product name.
  - **description** (array of strings) - Hardware description.
  - **traffic** (string) - Included traffic volume.
  - **dist** (array of strings) - Available distributions.
  - **@deprecated arch** (array of integers) - Deprecated architecture values.
  - **lang** (array of strings) - Supported languages.
  - **location** (array of strings) - Available locations.
  - **prices** (array) - Price information per location.
    - **location** (string) - Location code.
    - **price** (object) - Monthly price details (net, gross, hourly_net, hourly_gross).
    - **price_setup** (object) - Setup fee details (net, gross).
  - **orderable_addons** (array) - Available add-ons.
    - **id** (string) - Add-on identifier.
    - **name** (string) - Add-on name.
    - **min** (integer) - Minimum quantity.
    - **max** (integer) - Maximum quantity.
    - **prices** (array) - Price information per location.

#### Response Example
```json
[
  {
    "product": {
      "id": "EX60",
      "name": "Dedicated Server EX60",
      "description": [
        "Intel\u00ae Core\u2122 i7-920 Quad-Core",
        "48 GB DDR3 RAM",
        "2 x 2 TB SATA 3 Gb\/s Enterprise HDD; 7200 rpm(Software-RAID 1)",
        "1 Gbit\/s bandwidth"
      ],
      "traffic": "30 TB",
      "dist": [
        "Rescue system",
        "CentOS 6.6 minimal",
        "CentOS 7.0 minimal",
        "Debian 7.7 LAMP",
        "Debian 7.7 minimal",
        "openSUSE 13.2 minimal",
        "Ubuntu 14.04.1 LTS minimal",
        "Ubuntu 14.10 minimal"
      ],
      "@deprecated arch": [
        64,
        32
      ],
      "lang": [
        "en"
      ],
      "location": [
        "FSN1",
        "NBG1"
      ],
      "prices": [
        {
          "location": "FSN1",
          "price": {
            "net": "49.5800",
            "gross": "49.5800",
            "hourly_net": "0.0795",
            "hourly_gross": "0.0795"
          },
          "price_setup": {
            "net": "0.0000",
            "gross": "0.0000"
          }
        },
        {
          "location": "NBG1",
          "price": {
            "net": "49.5800",
            "gross": "49.5800",
            "hourly_net": "0.0795",
            "hourly_gross": "0.0795"
          },
          "price_setup": {
            "net": "0.0000",
            "gross": "0.0000"
          }
        }
      ],
      "orderable_addons": [
        {
          "id": "primary_ipv4",
          "name": "Primary IPv4",
          "min": 0,
          "max": 1,
          "prices": [
            {
              "location": "FSN1",
              "price": {
                "net": "1.7000",
                "gross": "1.7000",
                "hourly_net": "0.0027",
                "hourly_gross": "0.0027"
              },
              "price_setup": {
                "net": "0.0000",
                "gross": "0.0000"
              }
            },
            {
              "location": "NBG1",
              "price": {
                "net": "1.7000",
                "gross": "1.7000",
                "hourly_net": "0.0027",
                "hourly_gross": "0.0027"
              },
              "price_setup": {
                "net": "0.0000",
                "gross": "0.0000"
              }
            }
          ]
        }
      ]
    }
  },
  {
    "product": {
      "id": "EX40",
      "name": "Dedicated Server EX40",
      "description": [
        "Intel\u00ae Core\u2122 i7-4770 Quad-Core Haswell",
        "32 GB DDR3 RAM",
        "2 x 2 TB SATA 6 Gb\/s Enterprise HDD; 7200 rpm(Software-RAID 1)",
        "1 Gbit\/s bandwidth"
      ],
      "traffic": "30 TB",
      "dist": [
        "Rescue system",
        "CentOS 6.6 minimal",
        "CentOS 7.0 minimal",
        "Debian 7.7 LAMP",
        "Debian 7.7 minimal",
        "openSUSE 13.2 minimal",
        "Ubuntu 14.04.1 LTS minimal",
        "Ubuntu 14.10 minimal"
      ],
      "@deprecated arch": [
        64,
        32
      ],
      "lang": [
        "en"
      ],
      "location": [
        "FSN1",
        "NBG1"
      ],
      "prices": [
        {
          "location": "FSN1",
          "price": {
            "net": "84.0300",
            "gross": "84.0300",
            "hourly_net": "0.1347",
            "hourly_gross": "0.1347"
          },
          "price_setup": {
            "net": "41.1800",
            "gross": "41.1800"
          }
        },
        {
          "location": "NBG1",
          "price": {
            "net": "84.0300",
            "gross": "84.0300",
            "hourly_net": "0.1347",
            "hourly_gross": "0.1347"
          },
          "price_setup": {
            "net": "41.1800",
            "gross": "41.1800"
          }
        }
      ],
      "orderable_addons": [
        {
          "id": "primary_ipv4",
          "name": "Primary IPv4",
          "min": 0,
          "max": 1,
          "prices": [
            {
              "location": "FSN1",
              "price": {
                "net": "1.7000",
                "gross": "1.7000",
                "hourly_net": "0.0027",
                "hourly_gross": "0.0027"
              },
              "price_setup": {
                "net": "0.0000",
                "gross": "0.0000"
              }
            },
            {
              "location": "NBG1",
              "price": {
                "net": "1.7000",
                "gross": "1.7000",
                "hourly_net": "0.0027",
                "hourly_gross": "0.0027"
              },
              "price_setup": {
                "net": "0.0000",
                "gross": "0.0000"
              }
            }
          ]
        }
      ]
    }
  }
]
```

### Request limit
500 requests per 1 hour
```

--------------------------------

### Response for GET IP cancellation

Source: https://robot.hetzner.com/doc/webservice/en.html

Example JSON response from the GET /ip/{ip}/cancellation endpoint. Shows the cancellation object with fields: ip, server_number, earliest_cancellation_date, cancelled, and cancellation_date.

```json
{
  "cancellation":{
    "ip":"123.123.123.123",
    "server_number":321,
    "earliest_cancellation_date":"2022-02-11",
    "cancelled":false,
    "cancellation-date":null
  }
}

```

--------------------------------

### GET /order/server/product/{product-id} - Query server product details

Source: https://robot.hetzner.com/doc/webservice/en.html

Query a specific server product by its product ID. The request requires basic authentication with a user and password. The response includes product details such as name, description, traffic, available distributions, locations, prices, and orderable addons. The request limit is 500 requests per hour.

```bash
curl -u "user:password" https://robot-ws.your-server.de/order/server/product/EX40

```

```json
{
  "product":{
    "id":"EX40",
    "name":"Dedicated Server EX40",
    "description":[
      "Intel\u00ae Core\u2122 i7-4770 Quad-Core Haswell",
      "32 GB DDR3 RAM",
      "2 x 2 TB SATA 6 Gb\/s Enterprise HDD; 7200 rpm(Software-RAID 1)",
      "1 Gbit\/s bandwidth"
    ],
    "traffic":"30 TB",
    "dist":[
      "Rescue system",
      "CentOS 6.6 minimal",
      "CentOS 7.0 minimal",
      "Debian 7.7 LAMP",
      "Debian 7.7 minimal",
      "openSUSE 13.2 minimal",
      "Ubuntu 14.04.1 LTS minimal",
      "Ubuntu 14.10 minimal"
    ],
    "@deprecated arch":[
      64,
      32
    ],
    "lang":[
      "en"
    ],
    "location":[
      "FSN1",
      "NBG1"
    ],
    "prices":[
      {
        "location":"FSN1",
        "price":{
          "net":"84.0300",
          "gross":"84.0300",
          "hourly_net":"0.1347",
          "hourly_gross":"0.1347"
        },
        "price_setup":{
          "net":"41.1800",
          "gross":"41.1800"
        }
      },
      {
        "location":"NBG1",
        "price":{
          "net":"84.0300",
          "gross":"84.0300",
          "hourly_net":"0.1347",
          "hourly_gross":"0.1347"
        },
        "price_setup":{
          "net":"41.1800",
          "gross":"41.1800"
        }
      }
    ],
    "orderable_addons":[
      {
        "id":"primary_ipv4",
        "name":"Primary IPv4",
        "min":0,
        "max":1,
        "prices":[
          {
            "location":"FSN1",
            "price":{
              "net":"1.7000",
              "gross":"1.7000",
              "hourly_net":"0.0027",
              "hourly_gross":"0.0027"
            },
            "price_setup":{
              "net":"0.0000",
              "gross":"0.0000"
            }
          },
          {
            "location":"NBG1",
            "price":{
              "net":"1.7000",
              "gross":"1.7000",
              "hourly_net":"0.0027",
              "hourly_gross":"0.0027"
            },
            "price_setup":{
              "net":"0.0000",
              "gross":"0.0000"
            }
          }
        ]
      }
    ]
  }
}

```

--------------------------------

### Order server with Primary IPv4 addon

Source: https://robot.hetzner.com/doc/webservice/en.html

Orders a server with the Primary IPv4 addon by passing addon[]=primary_ipv4. The response shows the addon included in the transaction.

```bash
curl -u "user:password" https://robot-ws.your-server.de/order/server_market/transaction \
--data-urlencode 'product_id=283693' \
--data-urlencode 'authorized_key[]=15:28:b0:03:95:f0:77:b3:10:56:15:6b:77:22:a5:bb' \
--data-urlencode 'addon[]=primary_ipv4'

```

```json
{
  "transaction":{
    "id":"B20150121-344958-251479",
    "date":"2015-01-21T12:54:01+01:00",
    "status":"in process",
    "server_number":null,
    "server_ip":null,
    "authorized_key":[
      {
        "key":{
          "name":"key1",
          "fingerprint":"15:28:b0:03:95:f0:77:b3:10:56:15:6b:77:22:a5:bb",
          "type":"ED25519",
          "size":256
        }
      }
    ],
    "host_key":[

    ],
    "comment":null,
    "product":{
      "id":283693,
      "name":"SB110",
      "description":[
        "Intel Core i7 980x",
        "6x RAM 4096 MB DDR3",
        "2x HDD 1,5 TB SATA",
        "2x SSD 120 GB SATA"
      ],
      "traffic":"20 TB",
      "dist":"Rescue system",
      "@deprecated arch":"64",
      "lang":"en",
      "cpu":"Intel Core i7 980x",
      "cpu_benchmark":8944,
      "memory_size":24,
      "hdd_size":1536,
      "hdd_text":"ENT.HDD ECC INIC",
      "hdd_count":2,
      "datacenter":"FSN1-DC5",
      "network_speed":"100 Mbit\/s"
    },
    "addons":[
      "primary_ipv4"
    ]
  }
}

```
Tokens:
Raw