> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/edge/edge-artifacts.md).
# 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
> 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.
```json
{"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.2"},"tags":[{"name":"EdgeArtifacts","description":"Management of edge artifact files used in connection properties (e.g. certificates (.jks, .p12, etc.), configuration files (.conf, .yaml, etc.), license files (.lic)).\n\n**Two storage tiers:**\n- **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.\n- **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.\n"}],"servers":[{"url":"/rest/edge/v1"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"description":"Collibra REST API authentication using Basic Authentication.","scheme":"basic","type":"http"}},"schemas":{"EdgeArtifact":{"title":"Edge Artifact","description":"Specifies the artifact file to upload for use as a data source connection property.","type":"object","required":["id","name","filename","createdOn","lastModifiedOn","checksum"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the Edge artifact."},"name":{"type":"string","description":"Name of the uploaded file.","maxLength":128},"filename":{"type":"string","description":"Original filename of the uploaded file."},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was created."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."}}},"ErrorResponse":{"type":"object","description":"Standard error response returned by the API when an operation fails.","required":["statusCode","errorCode"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"titleMessage":{"type":"string","description":"Short title describing the error category."},"helpMessage":{"type":"string","description":"Additional guidance for resolving the error."},"userMessage":{"type":"string","description":"Human-readable message describing what went wrong."},"errorCode":{"type":"string","description":"Machine-readable error code for programmatic handling."}}}},"responses":{"BadRequest":{"description":"Bad request — invalid input or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Unauthorized — authentication is required or the provided credentials are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden — insufficient permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnexpectedError":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/artifacts/{artifactId}":{"get":{"operationId":"getEdgeArtifact","tags":["EdgeArtifacts"],"summary":"Get Edge artifact metadata","description":"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.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeArtifact"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/UnexpectedError"}}}}}}
```
## Delete Edge artifact
> 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.
```json
{"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.2"},"tags":[{"name":"EdgeArtifacts","description":"Management of edge artifact files used in connection properties (e.g. certificates (.jks, .p12, etc.), configuration files (.conf, .yaml, etc.), license files (.lic)).\n\n**Two storage tiers:**\n- **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.\n- **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.\n"}],"servers":[{"url":"/rest/edge/v1"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"description":"Collibra REST API authentication using Basic Authentication.","scheme":"basic","type":"http"}},"responses":{"BadRequest":{"description":"Bad request — invalid input or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Unauthorized — authentication is required or the provided credentials are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden — insufficient permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict — resource is in use or already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnexpectedError":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"type":"object","description":"Standard error response returned by the API when an operation fails.","required":["statusCode","errorCode"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"titleMessage":{"type":"string","description":"Short title describing the error category."},"helpMessage":{"type":"string","description":"Additional guidance for resolving the error."},"userMessage":{"type":"string","description":"Human-readable message describing what went wrong."},"errorCode":{"type":"string","description":"Machine-readable error code for programmatic handling."}}}}},"paths":{"/artifacts/{artifactId}":{"delete":{"operationId":"deleteArtifactFile","tags":["EdgeArtifacts"],"summary":"Delete Edge artifact","description":"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.\n","responses":{"204":{"description":"Success"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/UnexpectedError"}}}}}}
```
## List Edge artifacts
> Returns a paginated list of Edge artifacts available on the Collibra Platform instance.
```json
{"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.2"},"tags":[{"name":"EdgeArtifacts","description":"Management of edge artifact files used in connection properties (e.g. certificates (.jks, .p12, etc.), configuration files (.conf, .yaml, etc.), license files (.lic)).\n\n**Two storage tiers:**\n- **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.\n- **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.\n"}],"servers":[{"url":"/rest/edge/v1"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"description":"Collibra REST API authentication using Basic Authentication.","scheme":"basic","type":"http"}},"schemas":{"EdgeArtifactListResponse":{"type":"object","required":["results"],"properties":{"nextCursor":{"type":"string","description":"Cursor for the next page of results. Absent if there are no more results."},"results":{"type":"array","items":{"$ref":"#/components/schemas/EdgeArtifact"}}},"description":"Paginated list of edge artifacts."},"EdgeArtifact":{"title":"Edge Artifact","description":"Specifies the artifact file to upload for use as a data source connection property.","type":"object","required":["id","name","filename","createdOn","lastModifiedOn","checksum"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the Edge artifact."},"name":{"type":"string","description":"Name of the uploaded file.","maxLength":128},"filename":{"type":"string","description":"Original filename of the uploaded file."},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was created."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."}}},"ErrorResponse":{"type":"object","description":"Standard error response returned by the API when an operation fails.","required":["statusCode","errorCode"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"titleMessage":{"type":"string","description":"Short title describing the error category."},"helpMessage":{"type":"string","description":"Additional guidance for resolving the error."},"userMessage":{"type":"string","description":"Human-readable message describing what went wrong."},"errorCode":{"type":"string","description":"Machine-readable error code for programmatic handling."}}}},"responses":{"BadRequest":{"description":"Bad request — invalid input or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Unauthorized — authentication is required or the provided credentials are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden — insufficient permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnexpectedError":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/artifacts":{"get":{"operationId":"listArtifacts","tags":["EdgeArtifacts"],"summary":"List Edge artifacts","description":"Returns a paginated list of Edge artifacts available on the Collibra Platform instance.","parameters":[{"name":"cursor","in":"query","description":"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.\n","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the number of items to return per page. Defaults to 100 if not provided.","schema":{"type":"integer","default":100,"minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeArtifactListResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/UnexpectedError"}}}}}}
```
## Upload Edge artifact file
> 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.
```json
{"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.2"},"tags":[{"name":"EdgeArtifacts","description":"Management of edge artifact files used in connection properties (e.g. certificates (.jks, .p12, etc.), configuration files (.conf, .yaml, etc.), license files (.lic)).\n\n**Two storage tiers:**\n- **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.\n- **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.\n"}],"servers":[{"url":"/rest/edge/v1"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"description":"Collibra REST API authentication using Basic Authentication.","scheme":"basic","type":"http"}},"schemas":{"EdgeArtifact":{"title":"Edge Artifact","description":"Specifies the artifact file to upload for use as a data source connection property.","type":"object","required":["id","name","filename","createdOn","lastModifiedOn","checksum"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the Edge artifact."},"name":{"type":"string","description":"Name of the uploaded file.","maxLength":128},"filename":{"type":"string","description":"Original filename of the uploaded file."},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was created."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."}}},"ErrorResponse":{"type":"object","description":"Standard error response returned by the API when an operation fails.","required":["statusCode","errorCode"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"titleMessage":{"type":"string","description":"Short title describing the error category."},"helpMessage":{"type":"string","description":"Additional guidance for resolving the error."},"userMessage":{"type":"string","description":"Human-readable message describing what went wrong."},"errorCode":{"type":"string","description":"Machine-readable error code for programmatic handling."}}}},"responses":{"BadRequest":{"description":"Bad request — invalid input or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Unauthorized — authentication is required or the provided credentials are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden — insufficient permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"PayloadTooLarge":{"description":"Payload too large — file size exceeds the allowed limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnexpectedError":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/artifacts":{"post":{"operationId":"uploadArtifactFile","tags":["EdgeArtifacts"],"summary":"Upload Edge artifact file","description":"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.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file","name"],"properties":{"file":{"type":"string","format":"binary","description":"The artifact file.","maxLength":157286400},"name":{"type":"string","minLength":1,"maxLength":128,"description":"Logical name for the artifact, used for deduplication and referencing. Leading/trailing whitespace is trimmed; must be non-blank after trimming."},"filename":{"type":"string","maxLength":128,"description":"Original filename of the file. If omitted, the filename is taken from the Content-Disposition header of the file part.\n"}}}}}},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"URL of the created edge artifact.","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeArtifact"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"500":{"$ref":"#/components/responses/UnexpectedError"}}}}}}
```
## Upload a secret artifact
> 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.
```json
{"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.2"},"tags":[{"name":"EdgeArtifacts","description":"Management of edge artifact files used in connection properties (e.g. certificates (.jks, .p12, etc.), configuration files (.conf, .yaml, etc.), license files (.lic)).\n\n**Two storage tiers:**\n- **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.\n- **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.\n"}],"servers":[{"url":"/rest/edge/v1"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"description":"Collibra REST API authentication using Basic Authentication.","scheme":"basic","type":"http"}},"parameters":{"SiteId":{"name":"siteId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance."}},"schemas":{"EdgeSecretArtifact":{"title":"Edge Secret Artifact","description":"Secret artifact file stored directly on the Edge site. File content never leaves the site.","type":"object","required":["id"],"properties":{"id":{"type":"string","maxLength":512,"description":"Base64url-encoded identifier for the secret artifact. Use this value directly in `secretEdgeArtifactId` connection parameters to reference the secret.\n"}}},"ErrorResponse":{"type":"object","description":"Standard error response returned by the API when an operation fails.","required":["statusCode","errorCode"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"titleMessage":{"type":"string","description":"Short title describing the error category."},"helpMessage":{"type":"string","description":"Additional guidance for resolving the error."},"userMessage":{"type":"string","description":"Human-readable message describing what went wrong."},"errorCode":{"type":"string","description":"Machine-readable error code for programmatic handling."}}}},"responses":{"BadRequest":{"description":"Bad request — invalid input or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Unauthorized — authentication is required or the provided credentials are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden — insufficient permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"SiteNotFound":{"description":"Site not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"PayloadTooLarge":{"description":"Payload too large — file size exceeds the allowed limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnexpectedError":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/sites/{siteId}/secretArtifacts":{"post":{"operationId":"uploadSecretFile","tags":["EdgeArtifacts"],"summary":"Upload a secret artifact","description":"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.\n","parameters":[{"$ref":"#/components/parameters/SiteId"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file","name"],"properties":{"file":{"type":"string","format":"binary","maxLength":102400,"description":"The secret artifact file. Maximum size is 100 KB."},"name":{"type":"string","minLength":1,"maxLength":128,"description":"Logical name for the artifact, used for deduplication and referencing. Leading/trailing whitespace is trimmed; must be non-blank after trimming."},"filename":{"type":"string","maxLength":128,"description":"Original filename of the file. If omitted, the filename is taken from the Content-Disposition header of the file part.\n"}}}}}},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"Specifies the URL of the newly created secret artifact, used to reference the artifact when configuring a connection.","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeSecretArtifact"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/SiteNotFound"},"413":{"$ref":"#/components/responses/PayloadTooLarge"},"500":{"$ref":"#/components/responses/UnexpectedError"}}}}}}
```