Data Sources

Manage data sources.

List data sources

get

Lists all data sources.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

limitinteger · min: 1 · max: 500Optional

This is the maximum number of results that may be returned. Fewer may be returned than the value of limit.

Do not depend on the number of results being fewer than the limit value to indicate that your query reached the end of the list of data, use the absence of after (see Cursors) instead. For example, if you set limit to 10 and 9 results are returned, there may be more data available.

If not set, the default limit (limit = 25) will be used. The maximum value for this parameter is 500.

Default: 25

afterstring · nullableOptional

This is the cursor that points to the end of the page of data that has been returned.

Responses

200

The list of data sources.

application/json

A page of data sources.

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

An unexpected error has occurred.

application/json

get/dataSources

HTTPcURLJavaScriptPython

GET /rest/protect/v1/dataSources HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "cursors": {
    "after": null
  },
  "results": []
}

Add a new data source

post

Adds a new data source.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

application/json

namestringRequired

The name of the data source.

Example: Google BigQuery

dataSourceNamestringRequired

The value of the "Data Source Type" attribute on the Database asset. It is also used in group mapping as the "provider" name

Example: GoogleBigQuery

dataSourceAliasesstring[]Optional

A list of aliases for the data source name used in the "Data Source Type" attribute on the Database asset.

Example: BigQuery

Responses

201

The data source has been added.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

post/dataSources

HTTPcURLJavaScriptPython

POST /rest/protect/v1/dataSources HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "Google BigQuery",
  "dataSourceName": "GoogleBigQuery",
  "dataSourceAliases": [
    "BigQuery"
  ]
}

{
  "name": "Google BigQuery",
  "dataSourceName": "GoogleBigQuery",
  "dataSourceAliases": [
    "BigQuery"
  ],
  "id": "fc422bf7-b873-49fc-a00e-ec550a3e9aa5",
  "isBuiltIn": true,
  "createdBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "createdOn": 1688024863616,
  "lastModifiedBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "lastModifiedOn": 1688024863616
}

Retrieve a data source

get

Returns information about the data source with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the data source.

Responses

200

The data source with the specified ID.

application/json

namestringRequired

The name of the data source.

Example: Google BigQuery

dataSourceNamestringRequired

The value of the "Data Source Type" attribute on the Database asset. It is also used in group mapping as the "provider" name

Example: GoogleBigQuery

dataSourceAliasesstring[]Optional

A list of aliases for the data source name used in the "Data Source Type" attribute on the Database asset.

Example: BigQuery

idstring · uuidRequired

The ID of the data source.

Example: fc422bf7-b873-49fc-a00e-ec550a3e9aa5

isBuiltInbooleanOptional

Indicates whether the data source is protect built-in or not.

Default: falseExample: true

createdBystring · uuidRequired

ID of the Collibra user who created this data source.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

createdOninteger · int64Required

The timestamp of when this data source was created

Example: 1688024863616

lastModifiedBystring · uuidRequired

ID of the Collibra user who last updated this data source.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

lastModifiedOninteger · int64Required

The timestamp of when this data source was last updated.

Example: 1688024863616

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

get/dataSources/{id}

HTTPcURLJavaScriptPython

GET /rest/protect/v1/dataSources/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "name": "Google BigQuery",
  "dataSourceName": "GoogleBigQuery",
  "dataSourceAliases": [
    "BigQuery"
  ],
  "id": "fc422bf7-b873-49fc-a00e-ec550a3e9aa5",
  "isBuiltIn": true,
  "createdBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "createdOn": 1688024863616,
  "lastModifiedBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "lastModifiedOn": 1688024863616
}

Delete a data source

delete

Deletes the data source with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the data source.

Responses

204

The data source has been deleted.

No content

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

delete/dataSources/{id}

HTTPcURLJavaScriptPython

DELETE /rest/protect/v1/dataSources/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Update a data source

patch

Updates the data source with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the data source.

Body

application/json

namestringOptional

The name of the data source.

Example: Google BigQuery

dataSourceNamestringOptional

The value of the "Data Source Type" attribute on the Database asset. It is also used in group mapping as the "provider" name

Example: GoogleBigQuery

dataSourceAliasesstring[]Optional

A list of aliases for the data source name used in the "Data Source Type" attribute on the Database asset.

Example: BigQuery

Responses

200

The data source has been updated.

application/json

namestringRequired

The name of the data source.

Example: Google BigQuery

dataSourceNamestringRequired

The value of the "Data Source Type" attribute on the Database asset. It is also used in group mapping as the "provider" name

Example: GoogleBigQuery

dataSourceAliasesstring[]Optional

A list of aliases for the data source name used in the "Data Source Type" attribute on the Database asset.

Example: BigQuery

idstring · uuidRequired

The ID of the data source.

Example: fc422bf7-b873-49fc-a00e-ec550a3e9aa5

isBuiltInbooleanOptional

Indicates whether the data source is protect built-in or not.

Default: falseExample: true

createdBystring · uuidRequired

ID of the Collibra user who created this data source.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

createdOninteger · int64Required

The timestamp of when this data source was created

Example: 1688024863616

lastModifiedBystring · uuidRequired

ID of the Collibra user who last updated this data source.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

lastModifiedOninteger · int64Required

The timestamp of when this data source was last updated.

Example: 1688024863616

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

patch/dataSources/{id}

HTTPcURLJavaScriptPython

PATCH /rest/protect/v1/dataSources/{id} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "Google BigQuery",
  "dataSourceName": "GoogleBigQuery",
  "dataSourceAliases": [
    "BigQuery"
  ]
}

{
  "name": "Google BigQuery",
  "dataSourceName": "GoogleBigQuery",
  "dataSourceAliases": [
    "BigQuery"
  ],
  "id": "fc422bf7-b873-49fc-a00e-ec550a3e9aa5",
  "isBuiltIn": true,
  "createdBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "createdOn": 1688024863616,
  "lastModifiedBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "lastModifiedOn": 1688024863616
}