Revogar um agente local

POST

/connect/agents/{agentId}/revoke

curl --request POST \
  --url https://api-connect.zoppy.com.br/connect/agents/example/revoke \
  --header 'Authorization: Bearer <token>'

• Produção
• Staging

Corta o túnel do agente na hora e recusa toda conexão dele depois. Não tem volta: para usar a máquina de novo, gere um código e pareie outro agente.

Authorizations

• bearer

Parameters

Path Parameters

agentId

required

string

Id do agente local

Responses

200

O agente, revogado

Media typeapplication/json

object

id

required

Id do agente local

string format: uuid

name

required

O nome dado na tela ou, sem ele, o nome da máquina

string

status

required

Active: pode abrir o túnel; revoked: cortado de vez

string

Allowed values: active revoked

connected

required

Se o túnel dele com o gateway está aberto agora

boolean

agentVersion

required

Versão do zoppy-agent instalada

string

contractVersion

required

A versão do contrato do túnel que ele fala

integer

platform

required

Instalação escolhida no pareamento (windows, linux ou docker); null para agentes pareados antes disso

string

nullable

Allowed values: windows linux docker

os

required

Windows, linux…

string

arch

required

Arquitetura da máquina (amd64, arm64…)

string

hostname

required

A máquina onde ele roda

string

reach

required

O que a lista local dele alcança, como o agente informa: quem decide é a lista da loja naquela máquina

Array<object>

object

kind

required

Http: uma API dentro da rede; sql: um banco de dados

string

Allowed values: http sql

host

required

Como está escrito na máquina do agente: um nome, um IP, *.sufixo ou um CIDR

string

port

Porta

integer

engine

Para sql: sqlserver, oracle, firebird, mysql ou postgres

string

database

Para sql: o banco como o servidor o conhece

string

lastSeenAt

required

Último sinal de vida do agente

string format: date-time

nullable

connectedAt

required

Quando o túnel abriu pela última vez

string format: date-time

nullable

disconnectedAt

required

Quando o túnel caiu pela última vez

string format: date-time

nullable

offlineSince

required

Preenchido enquanto os administradores têm um aviso aberto de agente fora do ar

string format: date-time

nullable

keyRotationDueAt

required

Quando o agente troca a chave dele (a cada 90 dias)

string format: date-time

pairedAt

required

Quando foi pareado

string format: date-time

revokedAt

required

Quando foi revogado; null enquanto ativo

string format: date-time

nullable

connectors

required

Os conectores cujo manifesto manda chamadas por este agente

Array<object>

object

id

required

Id do conector

string format: uuid

name

required

Nome do conector

string

status

required

Estado do conector: draft, enabled ou paused

string

Example

{
  "status": "active",
  "platform": "windows",
  "reach": [
    {
      "kind": "http"
    }
  ]
}

403

Token ausente ou papel sem acesso: só MASTER e ADMIN (connect.unauthorized, connect.forbidden_role)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

404

Nenhum agente local com esse id na loja (connect.agent_not_found)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}