Skip to main content
POST
Test connectivity to Núclea for a participant

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

participantIspb
string
obrigatório

Participant ISPB (8 characters, digits or uppercase letters). A non-conforming value is rejected with 400.

Exemplo:

"12345678"

Resposta

OK

cdConnection
object
obrigatório

Managed file-transfer channel status (NOT_CONFIGURED).

nucleaApi
object
obrigatório

Núclea REST-channel connectivity probe outcome: status is OK when the probe echo round-trips and DEGRADED otherwise. The probe sent is selected by the participant role: AGEN001 for the DOMICILE_IF (IF Domicílio) role, AGEN999 for other roles.

participantId
string
obrigatório

Participant id (8-character ISPB).

Exemplo:

"12345678"

rsfnConnection
object
obrigatório

Message-broker channel status (NOT_CONFIGURED).

certificateExpiresAt
string

Signing-certificate expiry (RFC3339 UTC); never populated.

Exemplo:

"2027-06-15T00:00:00Z"

certificateValid
boolean

Whether the signing certificate is valid (never populated).

Exemplo:

true