Skip to main content
POST
Enable a Provider Configuration

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Unique identifier of the provider configuration.

Response

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

config
object
required

Provider-specific configuration.

Example:
createdAt
string<date-time>
required

Timestamp when the configuration was created.

Example:

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

id
string<uuid>
required

Unique identifier of the configuration.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

kind
enum<string>
required

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

Available options:
catalog,
external_openapi
Example:

"catalog"

name
string
required

Name of the configuration.

Example:

"ClearSale Production"

providerId
string
required

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

Example:

"clearsale"

schemaBindings
object[]
required

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>
required

Current status: active or disabled.

Available options:
active,
disabled
Example:

"active"

updatedAt
string<date-time>
required

Timestamp of the last update.

Example:

"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
Example:
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
Example:
description
string

Human-readable description.

Example:

"ClearSale anti-fraud for Pix transactions"

metadata
object

Custom metadata.

Example: