> For the complete documentation index, see [llms.txt](https://bytehosting.gitbook.io/bytehostings-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bytehosting.gitbook.io/bytehostings-api-documentation/bytehostings-api-documentation.md).

# ByteHosting's API Documentation

#### API Keys and Authorization can be found at the [Control Panel.](https://panel.bytehosting.cloud/apikeys)

#### There is a global rate limit of 120 requests per minute per IP or Token. If an endpoint specifies an additional limit, it is noted in the documentation.

#### API URL: <https://backend.panel.bytehosting.cloud/v1>

<mark style="color:blue;">`GET`</mark> `https://backend.panel.bytehosting.cloud/v1/service/list`

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/status`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/os`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/ip`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/ip/{ip}/rdns`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |
| ip<mark style="color:red;">\*</mark>        | String | 1.1.1.1                              |

#### Request Body

| Name                                   | Type   | Description |
| -------------------------------------- | ------ | ----------- |
| rdns<mark style="color:red;">\*</mark> | String |             |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/stop`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/start`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/shutdown`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/reinstall`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

#### Request Body

| Name | Type   | Description |
| ---- | ------ | ----------- |
| os   | String |             |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

#### Request Body

| Name                                         | Type   | Description |
| -------------------------------------------- | ------ | ----------- |
| name<mark style="color:red;">\*</mark>       | String |             |
| action<mark style="color:red;">\*</mark>     | String |             |
| expression<mark style="color:red;">\*</mark> | String |             |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron/{cronid}`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |
| cronid<mark style="color:red;">\*</mark>    | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

#### Request Body

| Name                                         | Type   | Description |
| -------------------------------------------- | ------ | ----------- |
| name<mark style="color:red;">\*</mark>       | String |             |
| action<mark style="color:red;">\*</mark>     | String |             |
| expression<mark style="color:red;">\*</mark> | String |             |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:red;">`DELETE`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron/{cronid}/delete`

#### Path Parameters

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| serviceid<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |
| cronid<mark style="color:red;">\*</mark>    | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup/delete`

#### Path Parameters

| Name                                     | Type   | Description                          |
| ---------------------------------------- | ------ | ------------------------------------ |
| backup<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup/restore`

#### Path Parameters

| Name                                     | Type   | Description                          |
| ---------------------------------------- | ------ | ------------------------------------ |
| backup<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}

<mark style="color:green;">`POST`</mark> `https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/hide`

#### Path Parameters

| Name                                      | Type   | Description                          |
| ----------------------------------------- | ------ | ------------------------------------ |
| service<mark style="color:red;">\*</mark> | String | e53490af-aa1a-4c01-8617-b5f77e7fd773 |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="401: Unauthorized " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="403: Forbidden " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="404: Not Found " %}

```json
{
  "error": "string"
}
```

{% endtab %}

{% tab title="429: Too Many Requests " %}

```json
{
  "error": "string"
}
```

{% endtab %}
{% endtabs %}