Remover instância

Amb. de Desenv.

http://localhost:3000

DELETE

/instances/{instanceId}

Realiza remoção da instância informada.

Regras:

quando a instância estiver conectada, a API realiza a desconexão antes de remover

após a remoção, a instância deixa de ser acessível nas rotas da API

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Caminho

Parâmetros Header

🟢200OK

application/json

The request has succeeded.

Body

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'http://localhost:3000/instances/' \
--header 'x-api-key: <api-key>'

Response Example

200 - Instância removida

{
    "status": "deleted"
}

Modificado em 2026-04-17 20:31:44