Skip to main content
POST
Disable a Provider Configuration

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Parâmetros de caminho

id
string<uuid>
obrigatório

Unique identifier of the provider configuration.

Resposta

Indicates that the request was successful and the response contains the requested data.

config
object
obrigatório

Provider-specific configuration.

Exemplo:
createdAt
string<date-time>
obrigatório

Timestamp when the configuration was created.

Exemplo:

"2026-03-17T14:00:00Z"

id
string<uuid>
obrigatório

Unique identifier of the configuration.

Exemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

kind
enum<string>
obrigatório

Connection kind of this configuration: catalog targets a provider published in the catalog, and external_openapi targets an OpenAPI document registered for your tenant.

Opções disponíveis:
catalog,
external_openapi
Exemplo:

"catalog"

name
string
obrigatório

Name of the configuration.

Exemplo:

"ClearSale Production"

providerId
string
obrigatório

ID of the catalog provider this configuration targets. A configuration of kind external_openapi created without one carries the reserved id external.openapi instead.

Exemplo:

"clearsale"

schemaBindings
object[]
obrigatório

Stored schemas this configuration binds to. The field is always present, and it is an empty list when the configuration binds no schema.

status
enum<string>
obrigatório

Current status: active or disabled.

Opções disponíveis:
active,
disabled
Exemplo:

"active"

updatedAt
string<date-time>
obrigatório

Timestamp of the last update.

Exemplo:

"2026-03-17T14:00:00Z"

allowedHosts
string[]

Outbound allow-list of destination hostnames. The field is absent when the configuration declares no allow-list.

Maximum array length: 100
Maximum string length: 253
Exemplo:
allowedPrivateHosts
string[]

Named private hosts this configuration may reach, managed by your operations team. The field is absent when the set is empty.

Maximum array length: 100
Maximum string length: 253
Exemplo:
description
string

Human-readable description.

Exemplo:

"ClearSale anti-fraud for Pix transactions"

metadata
object

Custom metadata.

Exemplo: