Skip to main content
PATCH
Key type: requires a private key. A public key returns 403 here, because it may only upload — see key types and scope. Call this from your server, never from browser code.

Overview

Partially updates the source identified by sourceId. Both fields are optional — send only what changes. When configuration is provided, its fields are merged into the existing configuration rather than replacing it, and previously-masked secret fields you send back unchanged (e.g. "****") are left untouched.

Path parameters

Request body

Response

The updated source, wrapped as { "success": true, "data": { ... } }.

Next steps

Source details

Fetch the current state of a source.

Delete source

Permanently remove a source from your workspace.

Authorizations

x-api-key
string
header
required

API key for public endpoints. Can also be provided via Authorization: Bearer

Path Parameters

sourceId
string<uuid>
required

Source ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
name
string
Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9_-]+$
configuration
object

Fields to merge into the existing configuration

Response

Updated source

Updated source

success
enum<boolean>
required
Available options:
true
data
object
required