Create a datasource

POST

/api/v1/datasources

• Generated server url

Creates an encrypted datasource profile after validating its connector scheme. Responses expose only redacted connection metadata. ADMIN and CSRF are required.

Authorizations

• csrfHeader
• sessionCookie

Request Body^required

Request for a managed datasource profile. Unknown fields are rejected.

object

clearSecurityKeys

Security keys to remove explicitly during an update.

Array<string>

unique items

Example

[
  "password"
]

connectorType

required

Registered connector wire name.

string

Example

postgres

name

required

Unique display name.

string

Example

Warehouse source

security

Security values to encrypt. On update, omitted or blank entries preserve stored values.

object

key

additional properties

Security values to encrypt. On update, omitted or blank entries preserve stored values.

string

technicalParams

Non-secret connector settings. Omitted values default to an empty map.

object

key

additional properties

Non-secret connector settings. Omitted values default to an empty map.

string

Responses

201

Datasource created

Redacted managed datasource profile and permission-aware capabilities.

object

canEdit

Whether the current identity may edit this profile.

boolean

canUse

Whether the current identity may bind this profile to a job.

boolean

canView

Whether the current identity may view this profile.

boolean

capabilities

Role-specific connector capabilities used to validate job bindings.

object

singleJobOnly

Whether the connector requires jobs=1.

boolean

sinkCapable

Whether the connector can receive sink rows.

boolean

sinkModes

Array<string>

unique items

Allowed values: complete complete-atomic incremental

sourceCapable

Whether the connector can provide source rows.

boolean

sourceModes

Array<string>

unique items

Allowed values: complete complete-atomic incremental

sourceQuery

Whether source.query is supported.

boolean

connectorType

Registered connector wire name.

string

createdAt

Creation timestamp in UTC.

string format: date-time

id

Datasource identifier.

string format: uuid

name

Datasource display name.

string

safeConnectDisplay

Credential-redacted connection display suitable for the UI.

string

securityConfigured

Whether encrypted security material is configured, without exposing it.

boolean

technicalParams

Non-secret connector settings.

object

key

additional properties

Non-secret connector settings.

string

updatedAt

Last update timestamp in UTC.

string format: date-time

400

The request is malformed or fails validation.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference

401

Authentication is required or credentials are invalid.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference

403

The authenticated identity lacks the required permission.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference

409

The request conflicts with the current resource or run state.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference