Sites
Edge sites.
Returns a list of Edge sites.
Collibra REST API authentication using Basic Authentication.
Success
List of Edge sites. The number of sites per environment is expected to remain small, so the full list is always returned in a single response. Pagination is intentionally omitted.
Unauthorized — authentication is required or the provided credentials are invalid.
Forbidden — insufficient permissions.
Unexpected error.
GET /rest/edge/v1/sites HTTP/1.1
Authorization: Basic username:password
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "edge-site-aws-us-east",
"description": "text",
"createdOn": "2026-01-15T09:30:00Z",
"type": "ON_PREM",
"status": "HEALTHY",
"currentVersion": "2026.05.2-15",
"pendingVersion": "2026.06.1-3"
}
]
}Create new Edge site.
Collibra REST API authentication using Basic Authentication.
An Edge site create DTO.
Human-readable name of the Edge site. Site names are unique - creating a site with a name that is already in use returns a 409 with error code siteNameAlreadyExists.
edge-site-aws-us-eastPattern: ^[a-zA-Z0-9_.-]+$Optional description of the Edge site. If provided, must not be empty - omit the field entirely when no description is wanted.
.*\S.*Optional Edge chart version to install, in the Edge release version format <year>.<month>.<patch>[-<tag>], e.g. 2026.06.1-3 (the same format reported by Site.currentVersion and Site.pendingVersion). If omitted, the site is created with the latest available version. Required for AIR_GAPPED sites.
2026.06.1-3Pattern: ^(2[0-9]{3})\.(0?[1-9]|1[0-2])(\.\d+)(-.*)?$Deployment type of the Edge site. Only ON_PREM and AIR_GAPPED sites can be
created via this endpoint; any other value (e.g. COLLIBRA_HOSTED, FEDRAMP) is
rejected with a 400 — Collibra Cloud sites are provisioned by Collibra.
Possible values are:
ON_PREMAIR_GAPPED
ON_PREMWhether the Edge site should be automatically upgraded to the latest available version as new versions are released. Defaults to true for ON_PREM sites - set to false to opt out of automatic upgrades and manage the site's version manually. For AIR_GAPPED sites this must be set explicitly to false (the true default does not apply); omitting it or setting true is rejected with a 400. The stored value is reported back as SiteDetail.autoUpgradeEnabled and drives SiteDetail.upgradeMode (AUTOMATIC/MANUAL).
trueCreated
Bad request — invalid input or validation error.
Unauthorized — authentication is required or the provided credentials are invalid.
Forbidden — insufficient permissions.
A site with the given name already exists. Site names are unique across all Edge sites; identified by error code siteNameAlreadyExists.
Unexpected error.
POST /rest/edge/v1/sites HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"name": "edge-site-aws-us-east",
"description": "text",
"version": "2026.06.1-3",
"type": "ON_PREM",
"autoUpgradeEnabled": true
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "edge-site-aws-us-east",
"description": "text",
"createdOn": "2026-01-15T09:30:00Z",
"type": "ON_PREM",
"status": "HEALTHY",
"currentVersion": "2026.05.2-15",
"pendingVersion": "2026.06.1-3",
"sparkEnabled": false,
"autoUpgradeEnabled": true,
"upgradeMode": "AUTOMATIC",
"lastModifiedOn": "2026-02-20T14:45:00Z"
}Returns the Edge site with the given ID.
Collibra REST API authentication using Basic Authentication.
Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.
{"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}Success
An Edge site.
Unique identifier of the Edge site.
123e4567-e89b-12d3-a456-426614174000Human-readable name of the Edge site.
edge-site-aws-us-eastOptional description of the Edge site.
Timestamp when the Edge site was created.
2026-01-15T09:30:00ZDeployment type of the Edge site. Possible values are:
ON_PREMCOLLIBRA_HOSTEDAIR_GAPPEDFEDRAMP
ON_PREMCurrent status of the Edge site. Values are reported in this precedence order (top-of-list wins):
PENDING— installed but has never contacted the platformOFFLINE— no recent heartbeat (overridesUPGRADING/HEALTHY/UNHEALTHY)UPGRADING— an upgrade topendingVersionis in progress (overridesHEALTHY/UNHEALTHY)HEALTHYUNHEALTHY
Note: pendingVersion may be set even when status is OFFLINE or PENDING — it
reflects the desired version regardless of whether the upgrade is currently active.
HEALTHYCurrently installed Edge version. Absent if the site has not reported a version yet.
2026.05.2-15Edge version the site should be upgrading or installing to. Absent when the site is already at its desired version.
2026.06.1-3Whether Spark-based processing is enabled on the Edge site.
falseWhether the Edge site is configured to be automatically upgraded to the latest available version as new versions are released. Reflects the autoUpgradeEnabled value from the create/update request. Note that upgradeMode values EXTERNAL and LEGACY take precedence over this setting - a site whose upgrades are managed externally is never auto-upgraded by Collibra regardless of this value.
trueHow Edge version upgrades are applied to the site. Possible values are:
AUTOMATIC— the site is upgraded automatically when a new Edge version is releasedMANUAL— upgrades must be triggered explicitlyEXTERNAL— upgrades are managed outside of Collibra. Reported for air-gapped installations and for sites explicitly marked as externally managed.LEGACY— the site predates managed upgrades and has not reported a version yet
AUTOMATIC and MANUAL reflect the site's autoUpgradeEnabled setting;
EXTERNAL and LEGACY take precedence over it.
AUTOMATICTimestamp when the site was last modified. Modification events include configuration changes, restores, upgrade-mode changes, and Edge version changes (requested or completed). Site creation itself counts as a modification, so newly-created sites have lastModifiedOn equal to createdOn. The field is absent only for legacy sites that predate the site event log and have no recorded history.
2026-02-20T14:45:00ZBad request — invalid input or validation error.
Unauthorized — authentication is required or the provided credentials are invalid.
Forbidden — insufficient permissions.
Site not found.
Unexpected error.
GET /rest/edge/v1/sites/{siteId} HTTP/1.1
Authorization: Basic username:password
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "edge-site-aws-us-east",
"description": "text",
"createdOn": "2026-01-15T09:30:00Z",
"type": "ON_PREM",
"status": "HEALTHY",
"currentVersion": "2026.05.2-15",
"pendingVersion": "2026.06.1-3",
"sparkEnabled": false,
"autoUpgradeEnabled": true,
"upgradeMode": "AUTOMATIC",
"lastModifiedOn": "2026-02-20T14:45:00Z"
}Replaces an existing edge site. This operation performs a full replacement — every field must be provided on each call, or it resets to its default value.
Collibra REST API authentication using Basic Authentication.
Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.
{"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}An Edge site update DTO.
Human-readable name of the Edge site. Must contain at least one non-whitespace character; empty or whitespace-only names are rejected with a 400.
edge-site-aws-us-eastPattern: ^[a-zA-Z0-9_.-]+$Description of the Edge site. If a string is provided, it must not be empty - use null to clear the description.
Edge chart version to target, in the Edge release version format <year>.<month>.<patch>[-<tag>], e.g. 2026.06.1-3 (the same format reported by Site.currentVersion and Site.pendingVersion).
2026.06.1-3Pattern: ^(2[0-9]{3})\.(0?[1-9]|1[0-2])(\.\d+)(-.*)?$Whether the Edge site should be auto-upgraded to the latest available version.
Whether the Edge site should enable Spark.
Success
Bad request — invalid input or validation error.
Unauthorized — authentication is required or the provided credentials are invalid.
Forbidden — insufficient permissions.
Site not found.
Unexpected error.
PUT /rest/edge/v1/sites/{siteId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"name": "edge-site-aws-us-east",
"description": null,
"version": "2026.06.1-3",
"autoUpgradeEnabled": true,
"sparkEnabled": true
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "edge-site-aws-us-east",
"description": "text",
"createdOn": "2026-01-15T09:30:00Z",
"type": "ON_PREM",
"status": "HEALTHY",
"currentVersion": "2026.05.2-15",
"pendingVersion": "2026.06.1-3",
"sparkEnabled": false,
"autoUpgradeEnabled": true,
"upgradeMode": "AUTOMATIC",
"lastModifiedOn": "2026-02-20T14:45:00Z"
}Deletes the Edge site with the given ID. Deletion removes the site's record from Edge Management; tear down the Edge cluster itself before deleting so the site is not left running and orphaned. The operation is idempotent — deleting a site that does not exist (or was already deleted) returns 204. A site that still appears online is rejected with a 409 (siteStillOnline), as are Collibra Cloud sites (hostedSiteNotDeletable), which are managed by Collibra and cannot be deleted.
Collibra REST API authentication using Basic Authentication.
Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.
{"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}Success. Returned whether or not the site existed (idempotent).
No content
Bad request — invalid input or validation error.
Unauthorized — authentication is required or the provided credentials are invalid.
Forbidden — insufficient permissions.
The site cannot be deleted. Distinguish the cause via errorCode: siteStillOnline (tear the Edge cluster down first — the status updates about a minute after tear-down) or hostedSiteNotDeletable (Collibra Cloud sites cannot be deleted).
Unexpected error.
DELETE /rest/edge/v1/sites/{siteId} HTTP/1.1
Authorization: Basic username:password
Accept: */*
No content
Returns a list of versions, available to upgrade
Collibra REST API authentication using Basic Authentication.
Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.
{"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}Success
List of versions, available to upgrade Edge site to.
Bad request — invalid input or validation error.
Unauthorized — authentication is required or the provided credentials are invalid.
Forbidden — insufficient permissions.
Site not found.
Unexpected error.
GET /rest/edge/v1/sites/{siteId}/versions HTTP/1.1
Authorization: Basic username:password
Accept: */*
{
"results": [
"text"
]
}Returns a binary that contains installer in .tgz format
Collibra REST API authentication using Basic Authentication.
Edge site ID. You can find this value in the Edge site details page in Edge Management within your Collibra Platform instance.
{"summary":"Edge site ID","value":"123e4567-e89b-12d3-a456-426614174000"}Edge site installer archive
Bad request — invalid input or validation error.
Unauthorized — authentication is required or the provided credentials are invalid.
Forbidden — insufficient permissions.
Site not found.
Unexpected error.
GET /rest/edge/v1/sites/{siteId}/installer/download HTTP/1.1
Authorization: Basic username:password
Accept: */*
binaryLast updated
Was this helpful?