Ctrlk
Collibra sitesRequest a demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Connections

Resource management (CRUD) for Connections.

List site connections

get

Returns a paginated list of data source connections from the target Edge site.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
siteIdstring · uuidRequired

Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.

Example: {"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}
Query parameters
cursorstringOptional

An opaque, URL-safe Base64 encoded string used for pagination. To fetch the next page, provide the value returned in the nextCursor field of the previous response. Omit this parameter for the first page.

limitinteger · min: 1 · max: 500Optional

Number of items to return per page.

Default: 100
Responses
200

Success

application/json

This is the paginated response for data source connection management endpoints.

nextCursorstringOptional
get/sites/{siteId}/connections
GET /rest/edge/v1/sites/{siteId}/connections HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "nextCursor": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "edgeSiteId": "123e4567-e89b-12d3-a456-426614174000",
      "vaultId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2026-01-01T00:00:00.000Z",
      "lastModifiedOn": "2026-01-01T00:00:00.000Z",
      "testConnectionSupported": true,
      "properties": {
        "type": "text",
        "auth": {
          "type": "text"
        },
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": {
            "type": "text",
            "edgeArtifactId": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      }
    }
  ]
}

Create a connection

post

Creates a new data source connection from the target Edge site.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
siteIdstring · uuidRequired

Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.

Example: {"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}
Body

Request body for creating a data source connection.

namestring · max: 255RequiredPattern: ^[a-zA-Z0-9_.-]+$
descriptionstring · max: 4000Optional
vaultIdstring · uuidOptional

Associated vault id, if configured

propertiesone ofRequired
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
Responses
201

Created

application/json
post/sites/{siteId}/connections
POST /rest/edge/v1/sites/{siteId}/connections HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "name": "aws-s3",
  "properties": {
    "type": "ConnectionAws",
    "auth": {
      "type": "AuthAwsIam",
      "awsAccessKeyId": {
        "type": "ValueString",
        "value": "AKIAIOSFODNN7EXAMPLE"
      },
      "awsSecretKey": {
        "type": "ValueString",
        "value": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
      }
    }
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "edgeSiteId": "123e4567-e89b-12d3-a456-426614174000",
  "vaultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-01-01T00:00:00.000Z",
  "lastModifiedOn": "2026-01-01T00:00:00.000Z",
  "testConnectionSupported": true,
  "properties": {
    "type": "text",
    "auth": {
      "type": "text"
    },
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "text",
        "edgeArtifactId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
}

Get a connection

get

Returns the data source connection by using the target connection ID in {connectionId}.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
siteIdstring · uuidRequired

Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.

Example: {"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}
connectionIdstring · uuidRequired

Connection ID.

Example: {"summary":"Connection ID","value":"123e4567-e89b-12d3-a456-426614174001"}
Responses
200

Success

application/json

Response body for data source connection management endpoints.

idstring · uuidRequired
namestringRequired
descriptionstringOptional
edgeSiteIdstring · uuidRequired
vaultIdstring · uuidOptional

Associated vault id, if configured

createdOnstring · date-timeRequired
lastModifiedOnstring · date-timeRequired
testConnectionSupportedbooleanRead-onlyRequired

Indicates whether this connection type supports the test connection operation. Only connections with testConnectionSupported: true can be used with POST /sites/{siteId}/connections/{connectionId}/test.

propertiesone ofRequired
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
get/sites/{siteId}/connections/{connectionId}
GET /rest/edge/v1/sites/{siteId}/connections/{connectionId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "edgeSiteId": "123e4567-e89b-12d3-a456-426614174000",
  "vaultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-01-01T00:00:00.000Z",
  "lastModifiedOn": "2026-01-01T00:00:00.000Z",
  "testConnectionSupported": true,
  "properties": {
    "type": "text",
    "auth": {
      "type": "text"
    },
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "text",
        "edgeArtifactId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
}

Update a connection (full replace)

put

Replaces an existing data source connection. This operation performs a full replacement — every field must be provided on each call, or it resets to its default value. name is required, and changing it renames the connection. The edgeSiteId field is set at creation time and cannot be changed; it is ignored if included in the request body.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
siteIdstring · uuidRequired

Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.

Example: {"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}
connectionIdstring · uuidRequired

Connection ID.

Example: {"summary":"Connection ID","value":"123e4567-e89b-12d3-a456-426614174001"}
Body

Request body to fully replace a data source connection. This is a full replacement, not a partial update - every field must be supplied on each call or it will be reset to its default. name is required, and changing it renames the connection. edgeSiteId is set at creation and cannot be changed; it is ignored if included in the request body.

namestring · max: 255RequiredPattern: ^[a-zA-Z0-9_.-]+$
descriptionstring · max: 4000Optional
vaultIdstring · uuidOptional

Associated vault id, if configured

propertiesone ofRequired
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
Responses
200

Success

application/json
put/sites/{siteId}/connections/{connectionId}
PUT /rest/edge/v1/sites/{siteId}/connections/{connectionId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "name": "renamed-connection",
  "properties": {
    "type": "ConnectionAws",
    "auth": {
      "type": "AuthAwsIam",
      "awsAccessKeyId": {
        "type": "ValueString",
        "value": "AKIAIOSFODNN7EXAMPLE"
      },
      "awsSecretKey": {
        "type": "ValueString",
        "value": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
      }
    }
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "edgeSiteId": "123e4567-e89b-12d3-a456-426614174000",
  "vaultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-01-01T00:00:00.000Z",
  "lastModifiedOn": "2026-01-01T00:00:00.000Z",
  "testConnectionSupported": true,
  "properties": {
    "type": "text",
    "auth": {
      "type": "text"
    },
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "text",
        "edgeArtifactId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
}

Delete a connection

delete

Deletes the specified connection identified by the target connection ID in {connectionId}. To look up a connection ID, use GET /sites/{siteId}/connections, where siteId is your target Edge site.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
siteIdstring · uuidRequired

Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.

Example: {"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}
connectionIdstring · uuidRequired

Connection ID.

Example: {"summary":"Connection ID","value":"123e4567-e89b-12d3-a456-426614174001"}
Responses
204

Success

No content
delete/sites/{siteId}/connections/{connectionId}
DELETE /rest/edge/v1/sites/{siteId}/connections/{connectionId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Partially update a connection

patch

Partially updates an existing data source connection. Only the fields provided in the request body are changed; all omitted fields — including secrets — keep their current values.

Merge semantics are additive:

  • Scalar fields are replaced with the provided value.

  • parameters maps are merged by key — provided keys are added or updated, other keys are preserved.

  • Object fields (e.g. auth, driver) are merged recursively. The type discriminator must be provided on every object supplied in the request and must match the existing value. Switching the connection type, the authentication type, or the driver type requires a full replace (PUT).

  • List fields (e.g. additionalClasspathFiles) are appended to; duplicate values are ignored.

  • Nothing can be deleted with this operation. To remove a field, a map key, or a list element, use PUT.

To rotate a secret, provide a new value for it (e.g. send auth.password alone); omitted secrets are preserved. Switching a value between an inline value and a vault reference is not supported via PATCH — use PUT.

Supplying name renames the connection. The edgeSiteId field is set at creation time and cannot be changed; it is ignored if included in the request body.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
siteIdstring · uuidRequired

Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.

Example: {"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}
connectionIdstring · uuidRequired

Connection ID.

Example: {"summary":"Connection ID","value":"123e4567-e89b-12d3-a456-426614174001"}
Body

Request body for partially updating a data source connection. All fields are optional; omitted fields keep their current values. Merge semantics are additive: scalar values are replaced, parameters maps are merged by key, object fields are merged recursively, and list fields are appended to (duplicates are ignored). Nothing can be deleted with this operation — use the full-replace PUT instead. The type discriminator on the connection, on its authentication configuration, and on any other discriminated sub-object such as driver must match the existing value — switching types requires a full-replace PUT. Supplying name renames the connection. edgeSiteId is set at creation and cannot be changed; it is ignored if included in the request body.

namestring · max: 255OptionalPattern: ^[a-zA-Z0-9_.-]+$
descriptionstring · max: 4000Optional
vaultIdstring · uuidOptional

Associated vault id, if configured

propertiesone ofOptional

Partial update of connection properties. The type discriminator is always required and must match the existing connection type; all other fields are optional and keep their current values when omitted.

or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
Responses
200

Success

application/json
patch/sites/{siteId}/connections/{connectionId}
PATCH /rest/edge/v1/sites/{siteId}/connections/{connectionId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "properties": {
    "type": "ConnectionJdbc",
    "parameters": {
      "loginTimeout": {
        "type": "ValueString",
        "value": "30"
      }
    }
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "edgeSiteId": "123e4567-e89b-12d3-a456-426614174000",
  "vaultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-01-01T00:00:00.000Z",
  "lastModifiedOn": "2026-01-01T00:00:00.000Z",
  "testConnectionSupported": true,
  "properties": {
    "type": "text",
    "auth": {
      "type": "text"
    },
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "text",
        "edgeArtifactId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
}

Test a connection

post

Verifies whether a data source connection can successfully reach the target data source and returns the connectivity status. Connection types that support this operation are identified by testConnectionSupported: true on the connection response. Returns a 422 error for unsupported connection types.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
siteIdstring · uuidRequired

Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.

Example: {"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}
connectionIdstring · uuidRequired

Connection ID.

Example: {"summary":"Connection ID","value":"123e4567-e89b-12d3-a456-426614174001"}
Responses
200

Success

application/json

Test connection response body.

successbooleanRequired
messagestringOptional

Additional information about the test result.

post/sites/{siteId}/connections/{connectionId}/test
POST /rest/edge/v1/sites/{siteId}/connections/{connectionId}/test HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "success": true,
  "message": "text"
}
PreviousSites
NextVaults

Last updated

Was this helpful?