Datasources

Soda Cloud API Datasource Endpoints

Onboard discovered datasets

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasources/{datasourceId}/onboardDatasets

This endpoint triggers the asynchronous onboarding of discovered datasets for a datasource.

Supply a list of discovered dataset IDs in the request body to onboard them as datasets.

The response includes an onboarding ID that you can use to poll the status of the onboarding process.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Authorization

Users must have global role permission CREATE_NEW_DATASOURCES_AND_DATASETS to execute this call.

Tags

Datasources

Rate limiting

10 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasourceIdstringRequired

Body

application/json

discoveredDatasetIdsstring[]Required

Responses

202

Accepted

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/datasources/{datasourceId}/onboardDatasets

HTTPcURLJavaScriptPython

POST /api/v1/datasources/{datasourceId}/onboardDatasets HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "discoveredDatasetIds": [
    "text"
  ]
}

No content

Get status for async dataset onboarding process

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasources/{datasourceId}/onboardDatasets/{operationId}

This endpoint allows you to check the status of an asynchronous dataset onboarding operation.

Use the operation ID returned by the onboard datasets endpoint to poll for its current state.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Authorization

Any Soda Cloud user in your organization may execute this query.

Tags

Datasources

Rate limiting

60 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasourceIdstringRequired

operationIdstringRequired

Responses

200

Successful response

application/json

endedstringOptional

idstringRequired

messagestringOptional

startedstringOptional

stateobject · enumRequiredPossible values:

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasources/{datasourceId}/onboardDatasets/{operationId}

HTTPcURLJavaScriptPython

GET /api/v1/datasources/{datasourceId}/onboardDatasets/{operationId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "ended": "text",
  "id": "text",
  "message": "text",
  "started": "text",
  "state": "queued"
}