Skip to main content
PUT
Activate a rail for the caller's tenant

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Idempotency key; a retry with the same key replays the first answer.

Parámetros de ruta

channelId
enum<string>
requerido

The rail. Closed vocabulary — a value outside it is a 404, never a new rail.

Opciones disponibles:
spb,
pix

Respuesta

OK

channelId
enum<string>
requerido
Opciones disponibles:
spb,
pix
registeredAt
string<date-time>
requerido
registeredBy
string
requerido

The operator who first activated the rail for the tenant.

Maximum string length: 128
state
enum<string>
requerido
Opciones disponibles:
REGISTERED,
ACTIVE,
SUSPENDED
tenantId
string
requerido

The caller's tenant, from the validated identity: the identifier an engine's credential path names.

Maximum string length: 255
activatedAt
string<date-time>

When the rail last began carrying traffic.

suspendReason
string
Maximum string length: 512
suspendedAt
string<date-time>