Get a Provider Configuration

Use this endpoint to retrieve a specific provider configuration by its unique identifier. The response never returns the credential that the authentication type declares (its API key, bearer token, password, client secret, or signing secret). Flowker masks any other value, including a free-form authentication parameter, only when it recognizes the field name as sensitive. Store credential material only in the fields that the authentication type declares.

GET /v1/provider-configurations/{id}

Get a Provider Configuration

cURL

curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "description": "ClearSale anti-fraud for Pix transactions",
  "providerId": "clearsale",
  "kind": "catalog",
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "environment": "production"
  },
  "allowedHosts": [
    "api.clearsale.com.br"
  ],
  "schemaBindings": [],
  "status": "active",
  "metadata": {
    "team": "risk"
  },
  "createdAt": "2026-03-17T14:00:00Z",
  "updatedAt": "2026-03-17T14:00:00Z"
}

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de ruta

id · string<uuid> · requerido

Unique identifier of the provider configuration.

Respuesta

200

application/json

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

config · object · requerido

Provider-specific configuration.

Show child attributes

Ejemplo:

{
  "baseUrl": "https://api.clearsale.com.br",
  "environment": "production"
}

createdAt · string<date-time> · requerido

Timestamp when the configuration was created.

Ejemplo:

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

id · string<uuid> · requerido

Unique identifier of the configuration.

Ejemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

kind · enum<string> · requerido

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

Opciones disponibles: catalog, external_openapi

Ejemplo:

"catalog"

name · string · requerido

Name of the configuration.

Ejemplo:

"ClearSale Production"

providerId · string · requerido

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

Ejemplo:

"clearsale"

schemaBindings · object[] · requerido

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

Show child attributes

status · enum<string> · requerido

Current status: active or disabled.

Opciones disponibles: active, disabled

Ejemplo:

"active"

updatedAt · string<date-time> · requerido

Timestamp of the last update.

Ejemplo:

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

protected · boolean · requerido

Whether only a person may change this configuration.

Ejemplo:

false

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

Ejemplo:

["api.clearsale.com.br"]

allowedPrivateHosts · string[]

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

Maximum array length: 100

Maximum string length: 253

Ejemplo:

["nginx.pix-inline.internal"]

description · string

Human-readable description.

Ejemplo:

"ClearSale anti-fraud for Pix transactions"

metadata · object

Custom metadata.

Show child attributes

Ejemplo:

{
  "environment": "production",
  "team": "risk"
}