Referência da API

Uma API REST para controlar sua conta: crie e gerencie implantações, arquivos, backups, pacotes e variáveis de ambiente.

Beta público. Endpoints e respostas ainda podem mudar, e cada chamada age sobre suas implantações reais.

URL base https://bot-hosting.net/api/v1 71 endpoints, 3 categorias Gerenciar chaves de API

Autenticação

Toda requisição precisa de uma chave de API, enviada como token Bearer. Crie e gerencie chaves nas suas configurações de desenvolvedor.

Escopos

Uma chave fica limitada aos escopos que você concede. Uma requisição só é permitida se a chave tiver o escopo do endpoint e você tiver permissão sobre o recurso de destino.

Implantações

deployments:read Listar e inspecionar implantações
deployments:power Iniciar, parar, reiniciar, console
deployments:write Criar, editar, excluir, redimensionar, mover
deployments:shell Executar comandos de shell em um contêiner
projects:read Listar seus projetos
projects:write Criar e excluir projetos
files:read Navegar e baixar arquivos
files:write Enviar, editar, renomear, excluir arquivos
env:read Ler variáveis de ambiente, segredos mascarados
env:write Definir variáveis de ambiente
backups:read Listar pontos de restauração
backups:write Criar, restaurar, excluir pontos de restauração
packages:read Ver pacotes instalados
packages:write Adicionar e remover pacotes

Conta

account:read Ler perfil e cota
billing:read Ler faturas e plano
credits:spend Gastar créditos para criar recursos

Templates e docs

templates:read Navegar por templates públicos
docs:read Pesquisar e ler a documentação

Limites de requisições

120 requisições por minuto por chave, em uma janela deslizante de 60 segundos, e 300 por usuário somando todas as chaves. Toda resposta traz o limite restante em X-RateLimit-Remaining; ao exceder, a resposta é 429 com um cabeçalho Retry-After.

Estado da implantação

Lido ao vivo do nó a cada requisição, refletindo o que seu bot está fazendo agora. Não confunda com o status, que é o ciclo de vida da cobrança.

estado	Significado
running	No ar e atendendo agora.
starting	Inicialização solicitada, contêiner ainda não está ativo.
stopping	Desligamento em andamento.
offline	Instalado, mas sem executar: parado, travado ou sem recursos.
installing	Criado e em provisionamento; ainda nunca foi executado.
unknown	Não foi possível acessar o nó. Tente novamente em instantes.

Rede

Toda implantação informa o nó em que roda e as portas que publica. Para acessar um serviço de fora, conecte-se a node.fqdn:port.

Campo	Significado
node	O nó que a hospeda (nome, fqdn e região). null até ser alocada em um nó.
port	A porta principal publicada. null se nenhuma estiver publicada ainda.
ports	Todas as portas publicadas, a principal primeiro.

list e get retornam tanto as implantações que você possui quanto as compartilhadas com você. Três campos as diferenciam.

Campo	Significado
owned	true se for sua, false se foi compartilhada com você.
owner	Quem a possui (id e username). Sempre presente.
shared	Colaboradores, cada um com suas permissões granulares (OVERVIEW, CONSOLE, FILES, ADMINISTRATOR e mais). Vazio se não for compartilhada.

Implantações

backups.list

GET /deployments/:id/backups backups:read

List the restore points of a deployment, newest first, and the backup operation in progress.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/backups" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "available": true,
  "backups": [
    {
      "id": "dep_a1b2c3d4",
      "time": "string",
      "kind": "auto",
      "files": 1,
      "sizeBytes": 1048576
    }
  ],
  "operation": {
    "kind": "string",
    "state": "running",
    "error": "string",
    "detail": "string"
  }
}

backups.get

GET /deployments/:id/backups/:backupId backups:read

Fetch one restore point of a deployment.

Nome	Em	Significado
id	path	Obrigatório.
backupId	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/backups/3f9c2a1be47d" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "id": "dep_a1b2c3d4",
  "time": "string",
  "kind": "auto",
  "files": 1,
  "sizeBytes": 1048576
}

backups.restore

POST /deployments/:id/backups/:backupId/restore backups:write Destrutivo

Restore a restore point. replace: stops the deployment, puts every file back, starts it again if it was running. subfolder: copies the files into /restored-<date>/ without stopping anything. Runs in the background: poll backups.list.

Nome	Em	Significado
id	path	Obrigatório.
backupId	path	Obrigatório.
mode	body	Opcional. Um destes: replace, subfolder
paths	body	Opcional. subfolder only: the paths to bring back, relative to the volume

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/backups/3f9c2a1be47d/restore" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"mode":"replace","paths":["string"]}'

Resposta

{
  "ok": true,
  "operation": {
    "kind": "string",
    "state": "running",
    "error": "string",
    "detail": "string"
  }
}

deployments.list

GET /deployments deployments:read

List every deployment you can access (owned + shared). The owned flag tells them apart. Pass name to find one by name, and brief: true when you only need to pick one: it returns id, name, state, url, runtime and entry file instead of the full record.

Nome	Em	Significado
name	query	Opcional. Keep only deployments whose name contains this, case-insensitive.
brief	query	Opcional. Return the short row instead of the full record.

Requisição

curl "https://bot-hosting.net/api/v1/deployments?name=my-bot&brief=true" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "deployments": [
    "string"
  ]
}

deployments.get

GET /deployments/:id deployments:read

Fetch a single deployment.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "id": "dep_a1b2c3d4",
  "name": "my-bot",
  "state": "running",
  "status": "active",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "projectId": "dep_a1b2c3d4",
  "owned": true,
  "owner": {
    "id": "dep_a1b2c3d4",
    "username": "grality"
  },
  "shared": [
    {
      "user": {
        "id": "dep_a1b2c3d4",
        "username": "grality"
      },
      "permissions": [
        "OVERVIEW"
      ]
    }
  ],
  "resources": {
    "ramMB": 512,
    "cpuPercent": 50,
    "storageMB": 1024
  },
  "runtime": "python",
  "entryFile": "string",
  "domains": {
    "subdomain": "my-bot.apps",
    "slug": "my-template",
    "custom": "bot.example.com",
    "url": "https://.../files/download?path=%2Fmain.py"
  },
  "node": {
    "name": "my-bot",
    "fqdn": "node-eu-1.bot-hosting.net",
    "region": "eu-west"
  },
  "port": 25565,
  "ports": [
    25565
  ],
  "startup": {
    "kind": "string",
    "runtime": "python",
    "runtimeVersion": "string",
    "entryFile": "string",
    "startCommand": "string",
    "engine": "string"
  },
  "connection": {
    "engine": "string",
    "host": "string",
    "port": 25565,
    "uriTemplate": "string"
  }
}

deployments.create

POST /deployments deployments:write

Create a deployment (blank, from a public GitHub repo, or a template), or a database by passing its engine as runtime. Sized by default to an equal share of the free pool; the result tells you the RAM/CPU it got. A modern web stack needs 512+ MB to npm install (exit 137 = OOM): deployments.resize BEFORE the first start.

Nome	Em	Significado
name	body	Obrigatório.
ramMB	body	Opcional. Omit for the default share of the free pool.
cpuPct	body	Opcional. Percent of one core. 15 makes an npm install take minutes.
storageMB	body	Opcional.
projectId	body	Opcional. Existing project id. OMIT THIS to use your default project - do not invent one.
source	body	Obrigatório. Um destes: blank, github, template
githubRepo	body	Opcional. "owner/repo" or the GitHub URL of a public repository.
branch	body	Opcional. Omit to use the repository's default branch (main, master, or whatever it is).
templateId	body	Opcional.
env	body	Opcional. Environment variables to set on the new deployment. For a template, these fill its declared variables.
runtime	body	Opcional. The stack to run. A database engine here (mysql, postgresql, redis, mongodb) creates a DATABASE deployment, which takes source: "blank" and no repository. Um destes: nodejs, python, java, php, go, rust, cpp, lua, nodemon, bun, redis, postgresql, mongodb, mysql, static, phpweb, lavalink, uptimekuma
runtimeVersion	body	Opcional. Runtime version as a string, e.g. "24"; a bare number is accepted too.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"my-bot","ramMB":512,"cpuPct":50,"storageMB":1024,"projectId":"dep_a1b2c3d4","source":"blank","githubRepo":"string","branch":"string","templateId":"dep_a1b2c3d4","env":"string","runtime":"nodejs","runtimeVersion":"string"}'

Resposta

{
  "deployment": {
    "id": "dep_a1b2c3d4",
    "name": "my-bot",
    "state": "running",
    "status": "active",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "projectId": "dep_a1b2c3d4",
    "owned": true,
    "owner": {
      "id": "dep_a1b2c3d4",
      "username": "grality"
    },
    "shared": [
      {
        "user": {
          "id": "dep_a1b2c3d4",
          "username": "grality"
        },
        "permissions": [
          "OVERVIEW"
        ]
      }
    ],
    "resources": {
      "ramMB": 512,
      "cpuPercent": 50,
      "storageMB": 1024
    },
    "runtime": "python",
    "entryFile": "string",
    "domains": {
      "subdomain": "my-bot.apps",
      "slug": "my-template",
      "custom": "bot.example.com",
      "url": "https://.../files/download?path=%2Fmain.py"
    },
    "node": {
      "name": "my-bot",
      "fqdn": "node-eu-1.bot-hosting.net",
      "region": "eu-west"
    },
    "port": 25565,
    "ports": [
      25565
    ],
    "startup": {
      "kind": "string",
      "runtime": "python",
      "runtimeVersion": "string",
      "entryFile": "string",
      "startCommand": "string",
      "engine": "string"
    },
    "connection": {
      "engine": "string",
      "host": "string",
      "port": 25565,
      "uriTemplate": "string"
    }
  },
  "next": "string"
}

deployments.update

PATCH /deployments/:id deployments:write

Rename a deployment.

Nome	Em	Significado
id	path	Obrigatório.
name	body	Opcional.

Requisição

curl -X PATCH "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"my-bot"}'

Resposta

{
  "id": "dep_a1b2c3d4",
  "name": "my-bot",
  "state": "running",
  "status": "active",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "projectId": "dep_a1b2c3d4",
  "owned": true,
  "owner": {
    "id": "dep_a1b2c3d4",
    "username": "grality"
  },
  "shared": [
    {
      "user": {
        "id": "dep_a1b2c3d4",
        "username": "grality"
      },
      "permissions": [
        "OVERVIEW"
      ]
    }
  ],
  "resources": {
    "ramMB": 512,
    "cpuPercent": 50,
    "storageMB": 1024
  },
  "runtime": "python",
  "entryFile": "string",
  "domains": {
    "subdomain": "my-bot.apps",
    "slug": "my-template",
    "custom": "bot.example.com",
    "url": "https://.../files/download?path=%2Fmain.py"
  },
  "node": {
    "name": "my-bot",
    "fqdn": "node-eu-1.bot-hosting.net",
    "region": "eu-west"
  },
  "port": 25565,
  "ports": [
    25565
  ]
}

deployments.delete

DELETE /deployments/:id deployments:write Destrutivo

Delete a deployment (instant; teardown runs in the background).

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl -X DELETE "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "ok": true
}

deployments.apply

POST /deployments/:id/apply deployments:write

Make edited files live and confirm they work, in ONE call. Use this after writing files instead of deployments.power + deployments.logs + deployments.check. It restarts only when the runtime needs it (a static or PHP site serves straight off the volume, so the restart is skipped and skippedRestart says so), waits for the process to settle, then returns the same payload as deployments.diagnose. Pass restart: true to force one, restart: false to forbid it.

Nome	Em	Significado
id	path	Obrigatório.
restart	body	Opcional. Force a restart (true) or forbid one (false). Omit to let the runtime decide.
waitSeconds	body	Opcional. How long to wait for the process to settle. Default 20 after a restart, 0 without one.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/apply" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"restart":true,"waitSeconds":1}'

Resposta

{
  "state": "running",
  "installing": true,
  "resources": {
    "ramMB": 512,
    "ramLimitMB": 512,
    "cpuPercent": 50
  },
  "logs": [
    "string"
  ],
  "startup": {
    "runtime": "python",
    "runtimeVersion": "string",
    "entryFile": "string",
    "startCommand": "string"
  },
  "http": {
    "url": "https://.../files/download?path=%2Fmain.py",
    "status": 1,
    "ok": true,
    "contentType": "string",
    "title": "string",
    "bodyExcerpt": "string"
  },
  "direct": {
    "url": "https://.../files/download?path=%2Fmain.py",
    "status": 1,
    "ok": true
  },
  "hint": "string",
  "restarted": true,
  "skippedRestart": "string"
}

deployments.check

GET /deployments/:id/check deployments:read

Request this deployment over its public URL and report what came back. Use it after deploying or fixing a site to confirm it really works - "the logs say it started" is not the same as "the page loads". Returns the HTTP status and the start of the body, so a 500 or a stack trace is visible. Server-rendered output only: no JavaScript runs. Any method: POST a JSON body to test an API route. On a 2xx HTML page it also requests the first same-origin links and assets it finds (links) and names the broken ones and duplicated nav entries in note. It goes through the public URL, the way a visitor does. To hit many routes at once or load-test, one deployments.shell command with a curl loop on localhost:$SERVER_PORT is cheaper than one check per URL. To ask what is wrong with a deployment rather than what one URL returns, call deployments.diagnose instead: it answers this plus the state, the logs and the startup config in one call.

Nome	Em	Significado
id	path	Obrigatório.
path	query	Opcional. Path to request, e.g. '/' or '/api/scores'. Defaults to '/'.
method	query	Opcional. Default GET. Um destes: GET, POST, PUT, PATCH, DELETE
body	query	Opcional. Request body. An object is sent as JSON (Content-Type set for you); a string is sent as is.
headers	query	Opcional. Extra request headers, e.g. Authorization.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/check?path=%2Fmain.py&method=GET&body=string&headers=string" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "url": "https://.../files/download?path=%2Fmain.py",
  "status": 1,
  "ok": true,
  "contentType": "string",
  "title": "string",
  "body": "string",
  "error": "string",
  "hint": "string",
  "links": [
    {
      "path": "/main.py",
      "status": 1
    }
  ],
  "note": "string"
}

deployments.command

POST /deployments/:id/command deployments:power

Write a line to the running process's stdin (a game server console, a REPL). NOT a shell: a web server ignores stdin, so curl / node / npm typed here do nothing, and no output is returned. To run a command (curl, node, npm, grep) use deployments.shell; to request a public URL, deployments.check.

Nome	Em	Significado
id	path	Obrigatório.
command	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/command" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"command":"say hello"}'

Resposta

{
  "ok": true,
  "note": "string"
}

deployments.diagnose

GET /deployments/:id/diagnose deployments:read

Everything needed to answer "what is wrong with this deployment", in ONE call: live state, RAM and CPU, the cleaned log tail, the startup config, and what the public URL returns. Use this INSTEAD of the deployments.get + deployments.logs + deployments.check + deployments.getStartup sequence - it replaces all four and it reads them together, so it can say things none of them can alone (a healthy log next to a 500 page, or an app port that is silent only because the install is still running). Start every investigation here.

Nome	Em	Significado
id	path	Obrigatório.
waitSeconds	query	Opcional. Wait up to this long for the process to settle BEFORE reading, returning early once it has died or gone idle. Pass 45 when something is still installing or starting; the wait is server-side and costs nothing.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/diagnose?waitSeconds=1" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "state": "running",
  "installing": true,
  "resources": {
    "ramMB": 512,
    "ramLimitMB": 512,
    "cpuPercent": 50
  },
  "logs": [
    "string"
  ],
  "startup": {
    "runtime": "python",
    "runtimeVersion": "string",
    "entryFile": "string",
    "startCommand": "string"
  },
  "http": {
    "url": "https://.../files/download?path=%2Fmain.py",
    "status": 1,
    "ok": true,
    "contentType": "string",
    "title": "string",
    "bodyExcerpt": "string"
  },
  "direct": {
    "url": "https://.../files/download?path=%2Fmain.py",
    "status": 1,
    "ok": true
  },
  "hint": "string"
}

deployments.enableDomains

POST /deployments/:id/domains deployments:write

Assign a subdomain (activate domains). Idempotent.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/domains" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "subdomain": "my-bot.apps",
  "url": "https://.../files/download?path=%2Fmain.py",
  "note": "string"
}

deployments.getGit

GET /deployments/:id/git deployments:read

Get the linked GitHub source: repo, branch, auto-pull.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/git" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "linked": true,
  "repo": "string",
  "branch": "string",
  "autoPull": true
}

deployments.getStartup

GET /deployments/:id/startup deployments:read

Get the startup config: runtime, version, entry file, start command.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/startup" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "kind": "string",
  "runtime": "python",
  "runtimeVersion": "string",
  "entryFile": "string",
  "startCommand": "string",
  "engine": "string"
}

deployments.logs

GET /deployments/:id/logs deployments:read

Read the last N lines of the console log, cleaned of colour codes and progress spam. A build or install takes MINUTES: pass waitSeconds (e.g. 25) to wait server-side before reading, instead of calling this again and again - polling in a loop is how a whole conversation gets eaten by npm output. Returns the live state alongside.

Nome	Em	Significado
id	path	Obrigatório.
size	query	Opcional. Default 100.
waitSeconds	query	Opcional. Wait up to this long BEFORE reading, returning early once the process has died or gone idle (no new output, CPU quiet). The wait is server-side and costs nothing. settled:false at the end means it is still working (installing): wait again.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/logs?size=1048576&waitSeconds=1" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "lines": [
    "Bot is online!"
  ],
  "state": "running",
  "settled": true,
  "hint": "string"
}

deployments.move

POST /deployments/:id/move deployments:write

Move a deployment to another of your projects.

Nome	Em	Significado
id	path	Obrigatório.
toProjectId	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/move" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"toProjectId":"dep_a1b2c3d4"}'

Resposta

{
  "id": "dep_a1b2c3d4",
  "name": "my-bot",
  "state": "running",
  "status": "active",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "projectId": "dep_a1b2c3d4",
  "owned": true,
  "owner": {
    "id": "dep_a1b2c3d4",
    "username": "grality"
  },
  "shared": [
    {
      "user": {
        "id": "dep_a1b2c3d4",
        "username": "grality"
      },
      "permissions": [
        "OVERVIEW"
      ]
    }
  ],
  "resources": {
    "ramMB": 512,
    "cpuPercent": 50,
    "storageMB": 1024
  },
  "runtime": "python",
  "entryFile": "string",
  "domains": {
    "subdomain": "my-bot.apps",
    "slug": "my-template",
    "custom": "bot.example.com",
    "url": "https://.../files/download?path=%2Fmain.py"
  },
  "node": {
    "name": "my-bot",
    "fqdn": "node-eu-1.bot-hosting.net",
    "region": "eu-west"
  },
  "port": 25565,
  "ports": [
    25565
  ]
}

deployments.power

POST /deployments/:id/power deployments:power

Send a power signal (start / stop / restart / kill). A start or a restart WAITS for the process to settle and hands back the state it reached, the console output it produced and what to do about it: ok:true only means the signal was accepted, the logs say whether the app actually came up. Never announce that something works on ok:true alone.

Nome	Em	Significado
id	path	Obrigatório.
action	body	Obrigatório. Um destes: start, stop, restart, kill
waitSeconds	body	Opcional. How long to wait for the process to settle before reading back. Default 20 on start and restart, 0 on stop and kill.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/power" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"action":"start","waitSeconds":1}'

Resposta

{
  "ok": true,
  "action": "restart",
  "reason": "string",
  "state": "running",
  "logs": [
    "string"
  ],
  "hint": "string"
}

deployments.removeCustomDomain

DELETE /deployments/:id/domains/custom deployments:write

Detach the custom domain.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl -X DELETE "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/domains/custom" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "ok": true
}

deployments.removeSlug

DELETE /deployments/:id/domains/slug deployments:write

Remove the subdomain alias.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl -X DELETE "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/domains/slug" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "ok": true
}

deployments.resize

PATCH /deployments/:id/resize deployments:write

Change RAM / CPU / storage allocation (drawn from your plan pool). The deployment restarts to apply it.

Nome	Em	Significado
id	path	Obrigatório.
ramMB	body	Obrigatório. Megabytes. npm install of a modern stack needs 512+; a Svelte/Next build 1024+. At the 256 default, install is SIGKILLed: exit 137, "Out of memory: true".
cpuPct	body	Obrigatório.
storageMB	body	Obrigatório. Megabytes. node_modules of a full-stack app is often 500-1500 MB on its own.

Requisição

curl -X PATCH "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/resize" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"ramMB":512,"cpuPct":50,"storageMB":1024}'

Resposta

{
  "id": "dep_a1b2c3d4",
  "name": "my-bot",
  "state": "running",
  "status": "active",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "projectId": "dep_a1b2c3d4",
  "owned": true,
  "owner": {
    "id": "dep_a1b2c3d4",
    "username": "grality"
  },
  "shared": [
    {
      "user": {
        "id": "dep_a1b2c3d4",
        "username": "grality"
      },
      "permissions": [
        "OVERVIEW"
      ]
    }
  ],
  "resources": {
    "ramMB": 512,
    "cpuPercent": 50,
    "storageMB": 1024
  },
  "runtime": "python",
  "entryFile": "string",
  "domains": {
    "subdomain": "my-bot.apps",
    "slug": "my-template",
    "custom": "bot.example.com",
    "url": "https://.../files/download?path=%2Fmain.py"
  },
  "node": {
    "name": "my-bot",
    "fqdn": "node-eu-1.bot-hosting.net",
    "region": "eu-west"
  },
  "port": 25565,
  "ports": [
    25565
  ]
}

deployments.resources

GET /deployments/:id/resources deployments:read

Live resource usage: CPU, memory, disk, network and uptime.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/resources" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "state": "running",
  "cpu": {
    "usedPercent": 50,
    "limitPercent": 50
  },
  "memory": {
    "usedBytes": 1048576,
    "limitBytes": 1048576
  },
  "disk": {
    "usedBytes": 1048576,
    "limitBytes": 1048576
  },
  "network": {
    "rxBytes": 1048576,
    "txBytes": 1048576
  },
  "uptimeMs": 3600000
}

deployments.searchLogs

GET /deployments/:id/logs/search deployments:read

Find lines in the console log that deployments.logs does not show: it searches the last 2000 lines (up to 5000) for a word or a regular expression, case-insensitive, and returns each hit with a few lines around it. Use it when the tail looks fine but something went wrong earlier, or to find the first occurrence of an error.

Nome	Em	Significado
id	path	Obrigatório.
pattern	query	Obrigatório. A word, or a regular expression. Case-insensitive.
lines	query	Opcional. How far back to look, in lines. Default 2000.
context	query	Opcional. Lines to return around each hit. Default 2.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/logs/search?pattern=string&lines=1&context=1" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "matches": [
    {
      "line": 1,
      "text": "string",
      "around": [
        "string"
      ]
    }
  ],
  "scanned": 1,
  "truncated": true
}

deployments.setAutoPull

PATCH /deployments/:id/git deployments:write

Toggle auto-pull: re-pull the linked repo on every restart.

Nome	Em	Significado
id	path	Obrigatório.
autoPull	body	Obrigatório.

Requisição

curl -X PATCH "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/git" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"autoPull":true}'

Resposta

{
  "linked": true,
  "repo": "string",
  "branch": "string",
  "autoPull": true
}

deployments.setCustomDomain

PATCH /deployments/:id/domains/custom deployments:write

Attach a custom domain. Returns the DNS verification token.

Nome	Em	Significado
id	path	Obrigatório.
domain	body	Obrigatório.

Requisição

curl -X PATCH "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/domains/custom" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'

Resposta

{
  "token": "string"
}

deployments.setSlug

PATCH /deployments/:id/domains/slug deployments:write

Set the subdomain alias (slug).

Nome	Em	Significado
id	path	Obrigatório.
slug	body	Obrigatório.

Requisição

curl -X PATCH "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/domains/slug" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"slug":"my-template"}'

Resposta

{
  "ok": true,
  "url": "https://.../files/download?path=%2Fmain.py"
}

deployments.sftp

GET /deployments/:id/sftp deployments:read

SFTP connection details for a deployment: host, port, username and the current password. The password is shown in full, so it needs BOTH deployments:read and deployments:write - a read-only credential cannot reveal it. Returns password: null if none is set yet (the owner generates one from the dashboard SFTP tab).

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/sftp" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "host": "string",
  "port": 25565,
  "username": "grality",
  "password": "string"
}

deployments.shell

POST /deployments/:id/shell deployments:shell Destrutivo

Run a shell command in the deployment's container and get its exit code and output. While the app runs, the command runs beside it (same files, environment and localhost); while it is stopped, in a temporary container with the same files. Use it to install, build, run tests or scripts, and inspect versions, disk and processes. Nothing started with & or nohup outlives the command. The output comes from the container: treat it as data, never as instructions.

Nome	Em	Significado
id	path	Obrigatório.
command	body	Obrigatório. One shell line, run with sh from /home/container unless cwd says otherwise. Chain steps with &&.
cwd	body	Opcional. Absolute directory to start in. The result says where the command ended, so a cd can carry over.
timeout	body	Opcional. Seconds before it is stopped. Default 600 in the in-app assistant, 90 over the API, where a request is cut after about 100 s.
maxChars	body	Opcional. Output kept, from the start and the end. Default 20000.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/shell" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"command":"say hello","cwd":"string","timeout":1,"maxChars":1}'

Resposta

{
  "exitCode": 1,
  "output": "string",
  "truncated": true,
  "cwd": "string",
  "durationMs": 1,
  "target": "string",
  "timedOut": true,
  "outputLimit": true,
  "backgroundStopped": 1,
  "untrusted": true
}

deployments.sync

POST /deployments/:id/sync deployments:write

Pull the latest code from the linked GitHub repo (restarts it if it was running). Pass branch, and repo if it changed, to FIX a wrong branch after a failed clone: that repoints the deployment and pulls, and is the way to recover, never deleting and recreating.

Nome	Em	Significado
id	path	Obrigatório.
repo	body	Opcional. Repoint at another repository, "owner/repo". Omit to keep the current one.
branch	body	Opcional. Switch to this branch before pulling. Omit to keep the current one.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/sync" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"repo":"string","branch":"string"}'

Resposta

{
  "ok": true,
  "commit": "string",
  "repo": "string",
  "branch": "string"
}

deployments.updateStartup

PATCH /deployments/:id/startup deployments:write

Change runtime / version / entry file / start command (queues a rebuild). The start command is a FULL SHELL LINE run at every boot: it can install and build before starting - e.g. 'npm install && npm run build && exec node build/index.js'. There is no other way to run build steps, and there does not need to be: put them here and restart. Keep the install step: a command that only starts the app stops installing dependencies at boot. A new runtime brings its own default version, entry file and start command unless you pass them. Changing the TYPE (e.g. nodejs to static) reinstalls from scratch and deletes every file: it needs wipeFiles: true, so switch first and write the files after. Writes made during a reinstall wait until it is done.

Nome	Em	Significado
id	path	Obrigatório.
runtime	body	Opcional. Omit to keep the current runtime. Um destes: nodejs, python, java, php, go, rust, cpp, lua, nodemon, bun, redis, postgresql, mongodb, mysql, static, phpweb, lavalink, uptimekuma
runtimeVersion	body	Opcional. Runtime version as a string, e.g. "24"; a bare number is accepted too. Omit to keep the current one.
entryFile	body	Opcional. Omit to keep the current entry file.
startCommand	body	Opcional. Full shell line, run in the container at every boot, from the volume root (/home/container, where files.tree starts): never cd to /app or any other path. Chain install/build/start with &&. A server must bind 0.0.0.0 and the SERVER_PORT env (or pass the port explicitly). The last step is exec'd so that Stop works, and exec is added for you if you leave it out. null = the runtime default, which already installs from package.json / requirements.txt. Omit to keep the current command.
kind	body	Opcional. Um destes: runtime, database, service
engine	body	Opcional.
wipeFiles	body	Opcional. Required when the change deletes every file in the deployment (a new type, e.g. nodejs to static).

Requisição

curl -X PATCH "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/startup" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"runtime":"nodejs","runtimeVersion":"string","entryFile":"string","startCommand":"string","kind":"runtime","engine":"string","wipeFiles":true}'

Resposta

{
  "kind": "string",
  "runtime": "python",
  "runtimeVersion": "string",
  "entryFile": "string",
  "startCommand": "string",
  "engine": "string",
  "warning": "string"
}

deployments.verifyCustomDomain

POST /deployments/:id/domains/custom/verify deployments:write

Check the DNS for the attached custom domain.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/domains/custom/verify" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "verified": true,
  "reason": "string"
}

env.list

GET /deployments/:id/env env:read

List environment variables. Secret values are masked.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/env" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "variables": [
    {
      "key": "MY_VAR",
      "value": "some-value",
      "secret": true,
      "system": true
    }
  ]
}

env.update

PATCH /deployments/:id/env/:key env:write

Update an existing environment variable: rename it (newKey), change its value, or flip its secret flag. Applies on next restart.

Nome	Em	Significado
id	path	Obrigatório.
key	path	Obrigatório.
newKey	body	Opcional.
value	body	Opcional.
secret	body	Opcional.

Requisição

curl -X PATCH "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/env/MY_VAR" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"newKey":"MY_RENAMED_VAR","value":"some-value","secret":true}'

Resposta

{
  "ok": true,
  "key": "MY_VAR"
}

env.delete

DELETE /deployments/:id/env/:key env:write Destrutivo

Delete a user environment variable (applies on next restart).

Nome	Em	Significado
id	path	Obrigatório.
key	path	Obrigatório.

Requisição

curl -X DELETE "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/env/MY_VAR" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "ok": true
}

env.audit

GET /deployments/:id/env/audit env:read

Compare the environment variables SET on the deployment with the ones the code actually reads. Use it right after writing code that needs configuration, and whenever an app crashes on boot for no visible reason: it names the variables the code reads but nothing sets (missing), the ones set but never read (unused), and the ones still holding an obvious placeholder. Returns keys only, never values.

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/env/audit" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "used": [
    {
      "key": "MY_VAR",
      "files": [
        "string"
      ]
    }
  ],
  "missing": [
    "string"
  ],
  "unused": [
    "string"
  ],
  "placeholders": [
    "string"
  ],
  "note": "string"
}

env.set

POST /deployments/:id/env env:write

Create or update a user environment variable (applies on next restart).

Nome	Em	Significado
id	path	Obrigatório.
key	body	Obrigatório.
value	body	Obrigatório.
secret	body	Opcional.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/env" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"key":"MY_VAR","value":"some-value","secret":true}'

Resposta

{
  "ok": true,
  "key": "MY_VAR"
}

files.list

GET /deployments/:id/files files:read

List a directory inside the deployment volume.

Nome	Em	Significado
id	path	Obrigatório.
path	query	Opcional.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files?path=%2Fmain.py" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "path": "/main.py",
  "entries": [
    {
      "name": "my-bot",
      "type": "file",
      "sizeBytes": 1048576,
      "modifiedAt": "2026-01-01T00:00:00.000Z",
      "mode": "0755"
    }
  ]
}

files.delete

POST /deployments/:id/files/delete files:write Destrutivo

Delete one or more files or folders. A copy of each deleted FILE is kept, so files.history / files.restore can bring it back; a deleted folder is gone for good.

Nome	Em	Significado
id	path	Obrigatório.
root	body	Opcional.
files	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/delete" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"root":"/","files":["string"]}'

Resposta

{
  "ok": true,
  "deleted": 1
}

files.chmod

POST /deployments/:id/files/chmod files:write

Change a file mode (e.g. "0755").

Nome	Em	Significado
id	path	Obrigatório.
root	body	Opcional.
file	body	Obrigatório.
mode	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/chmod" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"root":"/","file":"archive.zip","mode":"0755"}'

Resposta

{
  "ok": true
}

files.compress

POST /deployments/:id/files/compress files:write

Compress files into a new archive.

Nome	Em	Significado
id	path	Obrigatório.
root	body	Opcional.
files	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/compress" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"root":"/","files":["string"]}'

Resposta

{
  "ok": true,
  "archive": "string"
}

files.copy

POST /deployments/:id/files/copy files:write

Duplicate a file in place (the node appends a " copy" suffix). NOT a move: to move or rename, use files.rename.

Nome	Em	Significado
id	path	Obrigatório.
location	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/copy" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"location":"string"}'

Resposta

{
  "ok": true
}

files.decompress

POST /deployments/:id/files/decompress files:write

Decompress an archive in place. With removeArchive the archive is deleted right after, in the same call, so an upload-and-unpack never leaves the archive behind.

Nome	Em	Significado
id	path	Obrigatório.
root	body	Opcional.
file	body	Obrigatório.
removeArchive	body	Opcional.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/decompress" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"root":"/","file":"archive.zip","removeArchive":true}'

Resposta

{
  "ok": true,
  "archiveRemoved": true
}

files.downloadUrl

GET /deployments/:id/files/download-url files:read

Get a one-time signed URL to download a file.

Nome	Em	Significado
id	path	Obrigatório.
path	query	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/download-url?path=%2Fmain.py" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "url": "https://.../files/download?path=%2Fmain.py",
  "expiresAt": "2026-01-01T00:00:00.000Z"
}

files.edit

POST /deployments/:id/files/edit files:write

Change PART of a file by replacing an exact snippet, leaving the rest untouched. Prefer this over files.write for any edit to an existing file: rewriting a whole file to change a few lines is slow, expensive and loses anything you did not repeat. The snippet must appear EXACTLY once unless you pass replaceAll.

Nome	Em	Significado
id	path	Obrigatório.
path	body	Obrigatório. REQUIRED. The file to edit, volume-root relative, e.g. '/index.js'.
oldString	body	Obrigatório. The exact text to replace, copied from the file including its indentation.
newString	body	Obrigatório. What to put in its place. An empty string deletes the snippet.
replaceAll	body	Opcional. Replace every occurrence instead of requiring exactly one.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/edit" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"path":"/main.py","oldString":"string","newString":"string","replaceAll":true}'

Resposta

{
  "ok": true,
  "path": "/main.py",
  "replacements": 1,
  "bytes": 1048576,
  "lines": 1,
  "context": "string",
  "note": "string"
}

files.editMany

POST /deployments/:id/files/editMany files:write

Change SEVERAL places in ONE file in a single call. Use this instead of calling files.edit again and again on the same file: each files.edit is another round trip that re-sends the whole conversation. The edits apply in order, all of them or none: if one snippet is missing or ambiguous the file is left untouched and the error names the edit that failed, so you fix that one and send the list again.

Nome	Em	Significado
id	path	Obrigatório.
path	body	Obrigatório. REQUIRED. The one file every edit applies to, volume-root relative, e.g. '/index.js'.
edits	body	Obrigatório. Applied in order to the same file. Two edits must not touch the same text: once an edit has replaced a snippet, a later edit can no longer match it.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/editMany" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"path":"/main.py","edits":[{"oldString":"string","newString":"string","replaceAll":true}]}'

Resposta

{
  "ok": true,
  "path": "/main.py",
  "edits": 1,
  "replacements": 1,
  "bytes": 1048576,
  "lines": 1,
  "context": "string",
  "note": "string"
}

files.history

GET /deployments/:id/files/history files:read

List the saved previous versions of ONE file, newest first. Use it when a change broke something, when the user asks to undo or go back, or before overwriting a file you did not write yourself - then pass a versionId to files.restore. It only covers changes made through this API (write, edit, editMany, rename, delete): edits made over SFTP or by the running app itself are not tracked, and an empty list means there is nothing to undo.

Nome	Em	Significado
id	path	Obrigatório.
path	query	Obrigatório. The file to look up, volume-root relative, e.g. '/index.js'.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/history?path=%2Fmain.py" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "path": "/main.py",
  "versions": [
    {
      "id": "dep_a1b2c3d4",
      "savedAt": "2026-01-01T00:00:00.000Z",
      "bytes": 1048576
    }
  ]
}

files.index

POST /deployments/:id/files/index files:read

Flat index of every file under a path with size, mtime and an XXH64 content hash, in ONE call, for sync tools. Honours gitignore patterns. Send the digest of a listing you already hold: an unchanged tree answers unchanged: true with no entries.

Nome	Em	Significado
id	path	Obrigatório.
path	body	Opcional. Directory to index. Defaults to the volume root.
ignore	body	Opcional. gitignore-style patterns. A matching directory is not entered.
hashMaxBytes	body	Opcional. Files above this size are listed without a hash. Default 4 MiB, 0 disables hashing.
digest	body	Opcional. Digest of a previous index of the same path.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/index" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"path":"/main.py","ignore":["string"],"hashMaxBytes":1048576,"digest":"string"}'

Resposta

{
  "unchanged": true,
  "digest": "string",
  "truncated": true,
  "entries": [
    {
      "path": "/main.py",
      "type": "file",
      "sizeBytes": 1048576,
      "modifiedAt": "2026-01-01T00:00:00.000Z",
      "mode": "0755",
      "hash": "string"
    }
  ]
}

files.mkdir

POST /deployments/:id/files/folder files:write

Create an EMPTY folder. Not needed before files.move, files.write or files.writeMany: they create the folders they need.

Nome	Em	Significado
id	path	Obrigatório.
root	body	Opcional.
name	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/folder" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"root":"/","name":"my-bot"}'

Resposta

{
  "ok": true
}

files.move

POST /deployments/:id/files/move files:write

Move files or folders into a directory of the SAME deployment; the directory is created if missing. Never overwrites: a name already taken there is reported, not replaced. There is no move between two deployments: copying a file across leaves the original, so that is a copy, not a move.

Nome	Em	Significado
id	path	Obrigatório.
files	body	Obrigatório. Paths from the deployment root, e.g. ['index.js', 'lib/util.js'].
to	body	Obrigatório. Destination directory, e.g. 'test' or 'src/old'. Created in this same call if missing, so no files.mkdir first. Empty or '/' = the root.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/move" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"files":["string"],"to":"new.py"}'

Resposta

{
  "ok": true,
  "moved": [
    {
      "from": "old.py",
      "to": "new.py"
    }
  ],
  "failed": [
    {
      "from": "old.py",
      "reason": "string"
    }
  ]
}

files.outline

GET /deployments/:id/files/outline files:read

Map the code WITHOUT reading it: every function, class, export and route with its line number, for one file or a whole folder. Call this BEFORE reading anything, to find where to look, then files.read only the part you need. It costs a fraction of reading the files and it returns no bodies at all. JavaScript, TypeScript, Python, PHP, Go and JSON.

Nome	Em	Significado
id	path	Obrigatório.
path	query	Opcional. A file, or a directory to outline every source file under. Defaults to the project root.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/outline?path=%2Fmain.py" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "files": [
    {
      "path": "/main.py",
      "lines": 1,
      "symbols": [
        {
          "kind": "function",
          "name": "my-bot",
          "line": 1
        }
      ]
    }
  ],
  "truncated": true,
  "note": "string"
}

files.read

GET /deployments/:id/files/content files:read

Read a file, or a slice of it. Use offset/limit to page through a long file.

Nome	Em	Significado
id	path	Obrigatório.
path	query	Obrigatório.
offset	query	Opcional. First line to return, 0-based.
limit	query	Opcional. How many lines. Default 400.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/content?path=%2Fmain.py&offset=1&limit=1" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "path": "/main.py",
  "content": "print(\"hello world\")",
  "offset": 1,
  "lines": 1,
  "totalLines": 12,
  "hasMore": true,
  "note": "string"
}

files.readMany

POST /deployments/:id/files/read-many files:read

Read SEVERAL files in one call. Pair it with files.tree: look at the layout, then pull the handful of files you actually need in a single round instead of one call each. Binary files are reported, never returned as text.

Nome	Em	Significado
id	path	Obrigatório.
paths	body	Obrigatório. Absolute paths inside the volume, as shown by files.tree.
maxBytes	body	Opcional. Total budget across all files. Default 120000. Files past it come back unread.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/read-many" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"paths":["string"],"maxBytes":1048576}'

Resposta

{
  "files": [
    {
      "path": "/main.py",
      "content": "print(\"hello world\")",
      "bytes": 1048576,
      "skipped": "string"
    }
  ],
  "truncated": true,
  "note": "string"
}

files.rename

POST /deployments/:id/files/rename files:write

Rename or MOVE a file or directory: from and to are paths relative to root, and may point into different directories. To move several items into a folder in one call, use files.move.

Nome	Em	Significado
id	path	Obrigatório.
root	body	Opcional. Directory both paths are relative to. Default '/'.
from	body	Obrigatório. Current path, e.g. 'app/main.py'.
to	body	Obrigatório. New path, e.g. 'main.py' to move it to the root.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/rename" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"root":"/","from":"old.py","to":"new.py"}'

Resposta

{
  "ok": true
}

files.restore

POST /deployments/:id/files/restore files:write Destrutivo

Put a file back to one of its saved versions: this is the undo. Use it when an edit broke the app or the user asks to revert, and to bring back a file that was deleted. Call files.history first for the versionId. What it replaces is itself saved, so a restore can be undone in turn.

Nome	Em	Significado
id	path	Obrigatório.
path	body	Obrigatório. The file to put back, volume-root relative, e.g. '/index.js'.
versionId	body	Obrigatório. The id of the version to restore, exactly as files.history returned it.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/restore" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"path":"/main.py","versionId":"dep_a1b2c3d4"}'

Resposta

{
  "ok": true,
  "path": "/main.py",
  "bytes": 1048576,
  "lines": 1,
  "context": "string"
}

files.search

GET /deployments/:id/files/search files:read

Search the text of the project for a string or regex, like grep. Returns matching lines with their file and line number. Use it to find where something is defined or used instead of reading files one by one.

Nome	Em	Significado
id	path	Obrigatório.
query	query	Obrigatório. Text to find, or a regular expression when regex is true.
regex	query	Opcional. Treat query as a JavaScript regular expression. Default false.
caseSensitive	query	Opcional. Default false.
path	query	Opcional. Limit the search to this directory, or to a single file. Defaults to the whole volume.
glob	query	Opcional. Only files whose name matches, e.g. '.php' or '.{ts,js}'. Omit to search every text file.
maxResults	query	Opcional. Default 100.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/search?query=string&regex=true&caseSensitive=true&path=%2Fmain.py&glob=string&maxResults=1" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "matches": [
    {
      "path": "/main.py",
      "line": 1,
      "text": "string"
    }
  ],
  "filesScanned": 1,
  "truncated": true,
  "note": "string"
}

files.tree

GET /deployments/:id/files/tree files:read

See the whole project layout in ONE call: every file and folder under a path, indented, with sizes. Use this FIRST when exploring, instead of walking directories with files.list. It returns structure only - read the files you want with files.readMany. Dependency folders (node_modules, vendor, .git, ...) are listed but not opened unless you pass includeVendor.

Nome	Em	Significado
id	path	Obrigatório.
path	query	Opcional. Directory to start from. Defaults to the volume root.
depth	query	Opcional. How many directory levels to descend. Default 6.
includeVendor	query	Opcional. Also walk INTO node_modules, vendor, .git and friends. Default false - they hold thousands of files. Point `path` at one instead to look inside just that one.
maxEntries	query	Opcional. Default 400.

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/tree?path=%2Fmain.py&depth=1&includeVendor=true&maxEntries=1" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "root": "/",
  "tree": "string",
  "files": 1,
  "directories": 1,
  "truncated": true,
  "note": "string"
}

files.uploadUrl

POST /deployments/:id/files/upload-url files:write

Get a one-time signed URL to upload files straight to the node, with no size cap from the panel. POST a multipart form with one or more files parts to it: each lands in path under its own file name. Valid 15 minutes, single use. Pair with files.decompress to unpack an archive.

Nome	Em	Significado
id	path	Obrigatório.
path	body	Opcional. Directory the uploaded files land in. Defaults to the volume root.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/upload-url" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"path":"/main.py"}'

Resposta

{
  "url": "https://.../files/download?path=%2Fmain.py",
  "field": "string",
  "expiresAt": "2026-01-01T00:00:00.000Z"
}

files.write

POST /deployments/:id/files/content files:write

Create or overwrite a text file. A large file does NOT have to fit in one call: send the first part with mode 'overwrite', then the rest with mode 'append'.

Nome	Em	Significado
id	path	Obrigatório.
path	body	Obrigatório. Volume-root relative, e.g. '/src/index.js' (the volume root is /home/container inside the container).
content	body	Obrigatório. The text to write, as a string. A JSON object is accepted and stored stringified. Required - a call with no content writes nothing.
mode	body	Opcional. 'overwrite' (default) replaces the file. 'append' adds to the end, so a long file can be written across several calls instead of one huge one. Um destes: overwrite, append

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/content" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"path":"/main.py","content":"print(\"hello world\")","mode":"overwrite"}'

Resposta

{
  "ok": true,
  "path": "/main.py",
  "bytes": 1048576,
  "lines": 1,
  "note": "string",
  "hint": "string"
}

files.writeMany

POST /deployments/:id/files/writeMany files:write

Create or overwrite SEVERAL files in ONE call. Use this when creating a project: index.html, style.css and package.json go in a single call instead of one files.write each, which costs a round trip per file. Files are written in the order given; if one fails the call stops and the reply says exactly which ones landed, so you never write the same file twice.

Nome	Em	Significado
id	path	Obrigatório.
files	body	Obrigatório. Written in order. All the content together is capped at 5 MB: split a bigger batch across calls.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/files/writeMany" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"files":[{"path":"/main.py","content":"print(\"hello world\")","mode":"overwrite"}]}'

Resposta

{
  "ok": true,
  "written": [
    {
      "path": "/main.py",
      "bytes": 1048576,
      "lines": 1
    }
  ],
  "failed": [
    {
      "path": "/main.py",
      "error": "string"
    }
  ],
  "note": "string",
  "hint": "string"
}

packages.list

GET /deployments/:id/packages packages:read

List packages in the manifest (npm or pip).

Nome	Em	Significado
id	path	Obrigatório.
manager	query	Obrigatório. Um destes: npm, pip

Requisição

curl "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/packages?manager=npm" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "manager": "pip",
  "file": "archive.zip",
  "exists": true,
  "packages": [
    {
      "name": "my-bot",
      "spec": "==1.0.0",
      "dev": true
    }
  ]
}

packages.add

POST /deployments/:id/packages packages:write

Add or update a package in the manifest.

Nome	Em	Significado
id	path	Obrigatório.
manager	body	Obrigatório. Um destes: npm, pip
name	body	Obrigatório.
spec	body	Opcional. Version range, e.g. "^14.16.3". Omit to pin the registry's current version.
dev	body	Opcional.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/packages" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"manager":"npm","name":"my-bot","spec":"==1.0.0","dev":true}'

Resposta

{
  "manager": "pip",
  "file": "archive.zip",
  "exists": true,
  "packages": [
    {
      "name": "my-bot",
      "spec": "==1.0.0",
      "dev": true
    }
  ]
}

packages.remove

POST /deployments/:id/packages/remove packages:write

Remove a package from the manifest.

Nome	Em	Significado
id	path	Obrigatório.
manager	body	Obrigatório. Um destes: npm, pip
name	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/deployments/dep_a1b2c3d4/packages/remove" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"manager":"npm","name":"my-bot"}'

Resposta

{
  "manager": "pip",
  "file": "archive.zip",
  "exists": true,
  "packages": [
    {
      "name": "my-bot",
      "spec": "==1.0.0",
      "dev": true
    }
  ]
}

projects.list

GET /projects projects:read

List the projects you own or collaborate on.

Sem parâmetros.

Requisição

curl "https://bot-hosting.net/api/v1/projects" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "projects": [
    {
      "id": "dep_a1b2c3d4",
      "name": "my-bot",
      "isOwner": true,
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

projects.create

POST /projects projects:write

Create a project.

Nome	Em	Significado
name	body	Obrigatório.

Requisição

curl -X POST "https://bot-hosting.net/api/v1/projects" \
  -H "Authorization: Bearer bhk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"my-bot"}'

Resposta

{
  "id": "dep_a1b2c3d4",
  "name": "my-bot",
  "isOwner": true,
  "createdAt": "2026-01-01T00:00:00.000Z"
}

projects.delete

DELETE /projects/:id projects:write Destrutivo

Delete a project and all its deployments (owner only).

Nome	Em	Significado
id	path	Obrigatório.

Requisição

curl -X DELETE "https://bot-hosting.net/api/v1/projects/dep_a1b2c3d4" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "ok": true
}

runtimes.list

GET /runtimes deployments:read

List available runtimes, services and database engines with their versions.

Sem parâmetros.

Requisição

curl "https://bot-hosting.net/api/v1/runtimes" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "runtimes": [
    {
      "id": "dep_a1b2c3d4",
      "label": "Manual",
      "versions": [
        "string"
      ],
      "defaultVersion": "string",
      "defaultEntry": "string"
    }
  ],
  "services": [
    {
      "id": "dep_a1b2c3d4",
      "label": "Manual",
      "versions": [
        "string"
      ],
      "defaultVersion": "string",
      "defaultEntry": "string"
    }
  ],
  "databases": [
    {
      "id": "dep_a1b2c3d4",
      "label": "Manual",
      "versions": [
        "string"
      ],
      "defaultVersion": "string"
    }
  ]
}

Conta

account.get

GET /account account:read

Your profile, credit balance, plan and quota (pool vs used).

Sem parâmetros.

Requisição

curl "https://bot-hosting.net/api/v1/account" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "id": "dep_a1b2c3d4",
  "username": "grality",
  "email": "[email protected]",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "creditsCents": 5000,
  "plan": {
    "tier": "string",
    "name": "my-bot",
    "source": "catalog",
    "status": "active"
  },
  "quota": {
    "pool": {
      "ramMB": 512,
      "cpuPct": 50,
      "storageMB": 1024,
      "slots": 2
    },
    "used": {
      "ramMB": 512,
      "cpuPct": 50,
      "storageMB": 1024,
      "slots": 2
    }
  }
}

Templates e docs

docs.get

GET /docs/:slug docs:read

Read one documentation page in full, by the slug returned from docs.search.

Nome	Em	Significado
slug	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/docs/my-template" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "slug": "my-template",
  "title": "string",
  "section": "string",
  "url": "https://.../files/download?path=%2Fmain.py",
  "content": "print(\"hello world\")"
}

docs.search

GET /docs/search docs:read

Search the Bot-Hosting documentation. Use this before answering any "how do I" question.

Nome	Em	Significado
query	query	Obrigatório. The question, in natural language. Semantic search: ask it plainly.
limit	query	Opcional.

Requisição

curl "https://bot-hosting.net/api/v1/docs/search?query=string&limit=1" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "hits": [
    {
      "slug": "my-template",
      "title": "string",
      "section": "string",
      "snippet": "string"
    }
  ]
}

templates.list

GET /templates templates:read

Browse the public template catalogue (any author).

Nome	Em	Significado
sort	query	Opcional. Um destes: trending, deployed, rated, newest
category	query	Opcional. Filter to one category. Omit to browse everything. Um destes: moderation, music, economy, leveling, tickets, ai, games, utility, security, welcome, logging, social, dashboards, apis, automation, notifications, finance, roleplay, giveaways, other
q	query	Opcional.
official	query	Opcional. Only official templates (curated and tested by the team).
page	query	Opcional.
perPage	query	Opcional.

Requisição

curl "https://bot-hosting.net/api/v1/templates?sort=trending&category=moderation&q=search&official=true&page=2&perPage=2" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "total": 12,
  "page": 2,
  "perPage": 2,
  "items": [
    {
      "id": "dep_a1b2c3d4",
      "slug": "my-template",
      "name": "my-bot",
      "tagline": "A cool Discord bot",
      "category": "utility",
      "runtime": "python",
      "githubRepo": "string",
      "githubStars": 3,
      "deployCount": 3,
      "imageId": "dep_a1b2c3d4",
      "owner": {
        "username": "grality",
        "avatar": "string"
      },
      "official": true,
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

templates.get

GET /templates/:slug templates:read

Full details + public stats of a single template by slug.

Nome	Em	Significado
slug	path	Obrigatório.

Requisição

curl "https://bot-hosting.net/api/v1/templates/my-template" \
  -H "Authorization: Bearer bhk_your_key"

Resposta

{
  "id": "dep_a1b2c3d4",
  "slug": "my-template",
  "name": "my-bot",
  "tagline": "A cool Discord bot",
  "category": "utility",
  "runtime": "python",
  "githubRepo": "string",
  "githubStars": 3,
  "deployCount": 3,
  "imageId": "dep_a1b2c3d4",
  "owner": {
    "username": "grality",
    "avatar": "string"
  },
  "official": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "branch": "string",
  "runtimeVersion": "string",
  "testedAt": "2026-01-01T00:00:00.000Z",
  "guide": "string",
  "readme": "# My template",
  "stats": {
    "views": 3,
    "deploys": 3,
    "likes": 3,
    "dislikes": 3,
    "githubStars": 3,
    "trendingScore": 1.5
  },
  "envSchema": [
    {
      "key": "MY_VAR",
      "label": "Manual",
      "description": "A cool Discord bot",
      "required": true,
      "secret": true,
      "defaultValue": "string"
    }
  ],
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Referência da API

Autenticação

Escopos

Implantações

Conta

Templates e docs

Limites de requisições

Estado da implantação

Rede

Acesso e compartilhamento

Implantações

backups.list

backups.get

backups.restore

deployments.list

deployments.get

deployments.create

deployments.update

deployments.delete

deployments.apply

deployments.check

deployments.command

deployments.diagnose

deployments.enableDomains

deployments.getGit

deployments.getStartup

deployments.logs

deployments.move

deployments.power

deployments.removeCustomDomain

deployments.removeSlug

deployments.resize

deployments.resources

deployments.searchLogs

deployments.setAutoPull

deployments.setCustomDomain

deployments.setSlug

deployments.sftp

deployments.shell

deployments.sync

deployments.updateStartup

deployments.verifyCustomDomain

env.list

env.update

env.delete

env.audit

env.set

files.list

files.delete

files.chmod

files.compress

files.copy

files.decompress

files.downloadUrl

files.edit

files.editMany

files.history

files.index

files.mkdir

files.move

files.outline

files.read

files.readMany

files.rename

files.restore

files.search

files.tree

files.uploadUrl

files.write

files.writeMany

packages.list

packages.add

packages.remove

projects.list

projects.create

projects.delete

runtimes.list

Conta

account.get

Templates e docs