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

Edge Artifacts

Management of edge artifact files used in connection properties (e.g. certificates (.jks, .p12, etc.), configuration files (.conf, .yaml, etc.), license files (.lic)).

Two storage tiers:

  • Artifacts (/artifacts) are stored on your Collibra Platform instance and can be used for all connected Edge sites. Use these for non-sensitive files such as SSL certificates and JCo libraries.

  • Secret artifacts (/sites/{siteId}/secretArtifacts) are stored directly on the Edge site cluster, within the customer's network boundary and require a siteId. Use these for sensitive files such as private keys, where the file content is stored and encrypted within the Edge site. Each secret artifact can only be referenced by a single connection and cannot be reused.

Get Edge artifact metadata

get

Returns metadata for the Edge artifact with the given ID in {artifactId}. Edge artifacts are stored on the Collibra platform instance and are accessible across all Edge sites. Secret artifacts, by contrast, are scoped to a specific Edge site and never leave the site cluster.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
artifactIdstring · uuidRequired

Artifact ID (driver jar, classpath jar, native library, or Edge artifact).

Example: 124e4567-e89b-12d3-a456-426614174000
Responses
200

Success

application/json

Specifies the artifact file to upload for use as a data source connection property.

idstring · uuidRequired

Unique identifier for the Edge artifact.

namestring · max: 128Required

Name of the uploaded file.

filenamestringRequired

Original filename of the uploaded file.

createdOnstring · date-timeRequired

Timestamp when the artifact was created.

lastModifiedOnstring · date-timeRequired

Timestamp when the artifact was last updated.

checksumstringRequired

SHA-256 digest of the file content, encoded as URL-safe Base64 without padding.

get/artifacts/{artifactId}
GET /rest/edge/v1/artifacts/{artifactId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "filename": "text",
  "createdOn": "2026-01-01T00:00:00.000Z",
  "lastModifiedOn": "2026-01-01T00:00:00.000Z",
  "checksum": "text"
}

Delete Edge artifact

delete

Deletes the Edge artifact with the given ID in {artifactId}. Edge artifacts are stored on the Collibra Platform instance and are not scoped to a specific Edge site. This operation is idempotent — deleting a non-existent file returns 204.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
artifactIdstring · uuidRequired

Artifact ID (driver jar, classpath jar, native library, or Edge artifact).

Example: 124e4567-e89b-12d3-a456-426614174000
Responses
204

Success

No content
delete/artifacts/{artifactId}
DELETE /rest/edge/v1/artifacts/{artifactId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

List Edge artifacts

get

Returns a paginated list of Edge artifacts available on the Collibra Platform instance.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

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

Specifies the number of items to return per page. Defaults to 100 if not provided.

Default: 100
Responses
200

Success

application/json

Paginated list of edge artifacts.

nextCursorstringOptional

Cursor for the next page of results. Absent if there are no more results.

get/artifacts
GET /rest/edge/v1/artifacts HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "nextCursor": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "filename": "text",
      "createdOn": "2026-01-01T00:00:00.000Z",
      "lastModifiedOn": "2026-01-01T00:00:00.000Z",
      "checksum": "text"
    }
  ]
}

Upload Edge artifact file

post

Uploads an Edge artifact file and returns the created file's metadata such as id, filename and checksum. Artifacts are stored on the Collibra Platform instance and are not scoped to a specific Edge site, so no siteId is required. For sensitive files that must be stored on the Edge site, use POST /sites/{siteId}/secretArtifacts. File size limit: 150 MB.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body
filestring · binary · max: 157286400Required

The artifact file.

namestring · min: 1 · max: 128Required

Logical name for the artifact, used for deduplication and referencing. Leading/trailing whitespace is trimmed; must be non-blank after trimming.

filenamestring · max: 128Optional

Original filename of the file. If omitted, the filename is taken from the Content-Disposition header of the file part.

Responses
201

Created

application/json
post/artifacts
POST /rest/edge/v1/artifacts HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 49

{
  "file": "binary",
  "name": "text",
  "filename": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "filename": "text",
  "createdOn": "2026-01-01T00:00:00.000Z",
  "lastModifiedOn": "2026-01-01T00:00:00.000Z",
  "checksum": "text"
}

Upload a secret artifact

post

Uploads a secret artifact file, directly on the specified Edge site. The file is available for one hour to be assigned to a single connection. Once assigned, the original is deleted from the Edge site cluster. If it is not assigned to a connection within one hour, the file expires automatically. This is suitable for sensitive files such as private keys. For non-sensitive files,use POST /artifacts instead, which stores artifacts on the Collibra Platform instance. File size limit: 100 KB.

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
filestring · binary · max: 102400Required

The secret artifact file. Maximum size is 100 KB.

namestring · min: 1 · max: 128Required

Logical name for the artifact, used for deduplication and referencing. Leading/trailing whitespace is trimmed; must be non-blank after trimming.

filenamestring · max: 128Optional

Original filename of the file. If omitted, the filename is taken from the Content-Disposition header of the file part.

Responses
201

Created

application/json
post/sites/{siteId}/secretArtifacts
POST /rest/edge/v1/sites/{siteId}/secretArtifacts HTTP/1.1
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 49

{
  "file": "binary",
  "name": "text",
  "filename": "text"
}
{
  "id": "text"
}
PreviousDriver Artifacts
NextModels

Last updated

Was this helpful?