Update a Provider Configuration

curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowedHosts": [
    "api.acme.com",
    ".kyc-provider.io"
  ],
  "allowedPrivateHosts": [
    "nginx.pix-inline.internal"
  ],
  "config": {},
  "description": "ClearSale anti-fraud — updated with new API version",
  "metadata": {},
  "name": "ClearSale Production v2",
  "schemaBindings": [
    {
      "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
      "type": "openapi",
      "operations": [
        {
          "method": "POST",
          "path": "/payments"
        }
      ]
    }
  ]
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}"

	payload := strings.NewReader("{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowedHosts: ['api.acme.com', '.kyc-provider.io'],
    allowedPrivateHosts: ['nginx.pix-inline.internal'],
    config: {},
    description: 'ClearSale anti-fraud — updated with new API version',
    metadata: {},
    name: 'ClearSale Production v2',
    schemaBindings: [
      {
        schemaId: '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
        type: 'openapi',
        operations: [{method: 'POST', path: '/payments'}]
      }
    ]
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}"

payload = {
    "allowedHosts": ["api.acme.com", ".kyc-provider.io"],
    "allowedPrivateHosts": ["nginx.pix-inline.internal"],
    "config": {},
    "description": "ClearSale anti-fraud — updated with new API version",
    "metadata": {},
    "name": "ClearSale Production v2",
    "schemaBindings": [
        {
            "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
            "type": "openapi",
            "operations": [
                {
                    "method": "POST",
                    "path": "/payments"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

PATCH

provider-configurations

{id}

Update a Provider Configuration

curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowedHosts": [
    "api.acme.com",
    ".kyc-provider.io"
  ],
  "allowedPrivateHosts": [
    "nginx.pix-inline.internal"
  ],
  "config": {},
  "description": "ClearSale anti-fraud — updated with new API version",
  "metadata": {},
  "name": "ClearSale Production v2",
  "schemaBindings": [
    {
      "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
      "type": "openapi",
      "operations": [
        {
          "method": "POST",
          "path": "/payments"
        }
      ]
    }
  ]
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}"

	payload := strings.NewReader("{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowedHosts: ['api.acme.com', '.kyc-provider.io'],
    allowedPrivateHosts: ['nginx.pix-inline.internal'],
    config: {},
    description: 'ClearSale anti-fraud — updated with new API version',
    metadata: {},
    name: 'ClearSale Production v2',
    schemaBindings: [
      {
        schemaId: '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
        type: 'openapi',
        operations: [{method: 'POST', path: '/payments'}]
      }
    ]
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}"

payload = {
    "allowedHosts": ["api.acme.com", ".kyc-provider.io"],
    "allowedPrivateHosts": ["nginx.pix-inline.internal"],
    "config": {},
    "description": "ClearSale anti-fraud — updated with new API version",
    "metadata": {},
    "name": "ClearSale Production v2",
    "schemaBindings": [
        {
            "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
            "type": "openapi",
            "operations": [
                {
                    "method": "POST",
                    "path": "/payments"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

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

string<uuid>

obrigatório

Unique identifier of the provider configuration.

Corpo

application/json

Request body containing the updated provider configuration details.

allowedHosts

string[]

Replaces the outbound allow-list. Omit the field to leave the stored list unchanged. Send an empty list to clear it, and a non-empty list to replace it. The new list must satisfy the same rules as on create, including the base-URL coverage check and the generic HTTP provider rule.

Maximum array length: 100

Maximum string length: 253

Exemplo:

["api.acme.com", ".kyc-provider.io"]

allowedPrivateHosts

string[]

Replaces the named private-host allowance. Omit the field to leave the stored set unchanged. Send an empty list to clear it, and a non-empty list to replace it. Entries follow the same format as on create.

Maximum array length: 100

Maximum string length: 253

Exemplo:

["nginx.pix-inline.internal"]

config

object

Updated provider-specific configuration.

Show child attributes

description

string

Updated description.

Maximum string length: 500

Exemplo:

"ClearSale anti-fraud — updated with new API version"

metadata

object

Updated metadata.

Show child attributes

name

string

Updated name.

Required string length: 1 - 100

Exemplo:

"ClearSale Production v2"

schemaBindings

object[]

Replaces the schema bindings. Omit the field to leave the stored bindings unchanged. Send an empty list to remove them all, and a non-empty list to replace the set. Flowker checks every entry against the stored schemas before it saves anything.

Maximum array length: 100

Show child attributes

Resposta

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

config

object

obrigatório

Provider-specific configuration.

Show child attributes

Exemplo:

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

createdAt

string<date-time>

obrigatório

Timestamp when the configuration was created.

Exemplo:

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

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.

Show child attributes

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:

["api.clearsale.com.br"]

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:

["nginx.pix-inline.internal"]

description

string

Human-readable description.

Exemplo:

"ClearSale anti-fraud for Pix transactions"

metadata

object

Custom metadata.

Show child attributes

Exemplo:

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

Primeiros passos

API de Catálogo

API de Workflows

API de Agendamento

API de Execuções

API de Dashboards

API de Configurações de Executor

API de Configurações de Provider

API de Registro de Esquemas

API de Esquemas OpenAPI

API de Esquemas XSD

API de Webhooks

Tratamento de erros

Update a Provider Configuration

Autorizações

Parâmetros de caminho

Corpo

Resposta