Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Gerar código de pareamento

POST
/connect/agents/pairing-codes
curl --request POST \
  --url https://api-connect.zoppy.com.br/connect/agents/pairing-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "SRV-MATRIZ", "platform": "windows" }'

Código de uso único, válido por 30 minutos, que a instalação do agente pede. Só aparece esta vez: guardamos apenas o hash.

Authorizations

Seção intitulada “Authorizations”

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
name

O nome que o agente recebe (SRV-MATRIZ); sem ele, o nome da máquina

string
>= 1 characters <= 80 characters
platform

Onde o agente vai ser instalado: windows, linux ou docker

string
Allowed values: windows linux docker

Example 

{
  "name": "SRV-MATRIZ",
  "platform": "windows"
}

Responses

Seção intitulada “Responses”

201

Seção intitulada “201”

O código e quando vence

Media typeapplication/json
object
code
required

XXXX-XXXX: digitado na instalação do agente (zoppy-agent pair ), uma vez, em até 30 minutos

string
expiresAt
required

Até quando o código vale

string format: date-time
name
required

O nome pedido para o agente; null quando não foi dado

string
nullable
platform
required

Onde o agente vai ser instalado, como foi pedido; null quando não foi dito

string
nullable
Allowed values: windows linux docker
pairUrl
required

Onde o agente pareia: o host de agentes do gateway

string format: uri

Example 

{
  "platform": "windows"
}

403

Seção intitulada “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"
  }
}