Skip to content

Get a datasource

GET
/api/v1/datasources/{id}

Returns redacted profile metadata and capability flags after VIEW permission. Stored security values are never rehydrated in the response.

id
required
string format: uuid

Datasource identifier.

Datasource returned

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

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

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

The requested resource does not exist or is not visible.

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