Type Alias CreateConnectionReq

type CreateConnectionReq = {
    authUrlOnly?: boolean;
    connectionName: string;
    connectionProperties: unknown;
    dataSourceId: string;
    spaceId?: string;
    tags?: string[];
}
Index

Properties

authUrlOnly? connectionName connectionProperties dataSourceId spaceId? tags?

Properties

authUrlOnly?: boolean

When set to true, only authentication URL will be returned if datasource supports OAuth (other properties set in the request will ignored). This property will be ignored if the request is not OAuth or datasource doesn't support OAuth

connectionName: string

Connection name

connectionProperties: unknown

List of connection properties required to create dataconnection for a given datasource, which is defined by the response of 'GET /v1/data-datasources/:{datasourceId}/api-specs'

dataSourceId: string

Datasource ID

spaceId?: string

Target connection space ID

tags?: string[]

string tags (32 or less) persisted with the connection object

Settings

Member Visibility

On This Page

Properties