Skip to main content
POST
/
api
/
datasource
/
v1
/
datasources
Create a Data Source
curl --request POST \
  --url https://api.example.com/api/datasource/v1/datasources \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "authType": "AzureBasic",
  "config": {},
  "credentials": {
    "secretCredentials": {},
    "visibleCredentials": {}
  },
  "dataSourceType": "ADLSConfig",
  "name": "data-source-name",
  "permissions": {
    "isEveryone": true,
    "userAndOrganizationIds": [
      "<string>"
    ]
  },
  "description": "My Data Source"
}
'
{
  "authType": "AzureBasic",
  "config": {},
  "dataSourceType": "ADLSConfig",
  "displayName": "Azure Data Lake Store",
  "id": "62604702b7e5d347dbe7a909",
  "lastUpdated": "2022-04-23T18:25:43.511Z",
  "name": "data-source-name",
  "ownerId": "62604702b7e5d347dbe7a909",
  "ownerUsername": "owner-username",
  "permissions": {
    "isEveryone": true,
    "userAndOrganizationIds": [
      "<string>"
    ]
  },
  "description": "My Data Source"
}

Authorizations

​
X-Domino-Api-Key
string
header
required

Body

application/json

Data Source to create

​
authType
string
required

The type of Data Source authentication

Example:

"AzureBasic"

​
config
object
required

A map of configuration name -> value

​
credentialType
enum<string>
required

Whether the credentials is individual to a user or shared

Available options:
Individual,
Shared
​
credentials
object
required
​
dataSourceType
string
required

The configuration type of the Data Source

Example:

"ADLSConfig"

​
name
string
required

User given name of the Data Source

Example:

"data-source-name"

​
permissions
object
required
​
description
string

Description of the Data Source

Example:

"My Data Source"

Response

Success

​
authType
string
required

The type of Data Source authentication

Example:

"AzureBasic"

​
config
object
required

A map of configuration name -> value

​
credentialType
enum<string>
required

Whether the credentials is individual to a user or shared

Available options:
Individual,
Shared
​
dataSourceType
string
required

The configuration type of the Data Source

Example:

"ADLSConfig"

​
displayName
string
required

Data Source display name

Example:

"Azure Data Lake Store"

​
id
string
required

ID of the Data Source

Example:

"62604702b7e5d347dbe7a909"

​
lastUpdated
string<date-time>
required

ISO 8601 formatted time of when the Data Source was last updated

Example:

"2022-04-23T18:25:43.511Z"

​
name
string
required

User given name of the Data Source

Example:

"data-source-name"

​
ownerId
string
required

ID of the Data Source owner

Example:

"62604702b7e5d347dbe7a909"

​
ownerUsername
string
required

Username of the owner of the Data Source

Example:

"owner-username"

​
permissions
object
required
​
description
string

Description of the Data Source

Example:

"My Data Source"