ByteHosting's API Documentation

API Keys and Authorization can be found at the Control Panel.

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

GET https://backend.panel.bytehosting.cloud/v1/service/list

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

GET https://backend.panel.bytehosting.cloud/v1/service/{serviceid}

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

GET https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/status

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

GET https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/os

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

GET https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/ip

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/ip/{ip}/rdns

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773
ip*	String	1.1.1.1

Request Body

Name	Type	Description
rdns*	String

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/stop

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/start

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/shutdown

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/reinstall

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

Request Body

Name	Type	Description
os	String

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

GET https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

GET https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

Request Body

Name	Type	Description
name*	String
action*	String
expression*	String

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron/{cronid}

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773
cronid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

Request Body

Name	Type	Description
name*	String
action*	String
expression*	String

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

DELETE https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/cron/{cronid}/delete

Path Parameters

Name	Type	Description
serviceid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773
cronid*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup/delete

Path Parameters

Name	Type	Description
backup*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/backup/restore

Path Parameters

Name	Type	Description
backup*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}

POST https://backend.panel.bytehosting.cloud/v1/service/{serviceid}/hide

Path Parameters

Name	Type	Description
service*	String	e53490af-aa1a-4c01-8617-b5f77e7fd773

200: OK

401: Unauthorized

{
  "error": "string"
}

403: Forbidden

{
  "error": "string"
}

404: Not Found

{
  "error": "string"
}

429: Too Many Requests

{
  "error": "string"
}