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

Sites

Edge sites.

List sites

get

Returns a list of Edge sites.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Responses
200

Success

application/json

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.

get/sites
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 site

post

Create new Edge site.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

An Edge site create DTO.

namestring · min: 1 · max: 100Required

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.

Example: edge-site-aws-us-eastPattern: ^[a-zA-Z0-9_.-]+$
descriptionstring · max: 255Optional

Optional description of the Edge site. If provided, must not be empty - omit the field entirely when no description is wanted.

Pattern: .*\S.*
versionstring · max: 100Optional

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.

Example: 2026.06.1-3Pattern: ^(2[0-9]{3})\.(0?[1-9]|1[0-2])(\.\d+)(-.*)?$
typestringRequired

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_PREM
  • AIR_GAPPED
Example: ON_PREM
autoUpgradeEnabledbooleanOptional

Whether 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).

Default: true
Responses
201

Created

application/json
post/sites
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"
}

Get a site

get

Returns the Edge site with the given ID.

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"}
Responses
200

Success

application/json

An Edge site.

idstring · uuidRequired

Unique identifier of the Edge site.

Example: 123e4567-e89b-12d3-a456-426614174000
namestring · max: 100Required

Human-readable name of the Edge site.

Example: edge-site-aws-us-east
descriptionstring · max: 255Optional

Optional description of the Edge site.

createdOnstring · date-timeRequired

Timestamp when the Edge site was created.

Example: 2026-01-15T09:30:00Z
typestringRequired

Deployment type of the Edge site. Possible values are:

  • ON_PREM
  • COLLIBRA_HOSTED
  • AIR_GAPPED
  • FEDRAMP
Example: ON_PREM
statusstringRequired

Current status of the Edge site. Values are reported in this precedence order (top-of-list wins):

  • PENDING — installed but has never contacted the platform
  • OFFLINE — no recent heartbeat (overrides UPGRADING/HEALTHY/UNHEALTHY)
  • UPGRADING — an upgrade to pendingVersion is in progress (overrides HEALTHY/UNHEALTHY)
  • HEALTHY
  • UNHEALTHY

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.

Example: HEALTHY
currentVersionstring · max: 100Optional

Currently installed Edge version. Absent if the site has not reported a version yet.

Example: 2026.05.2-15
pendingVersionstring · max: 100Optional

Edge version the site should be upgrading or installing to. Absent when the site is already at its desired version.

Example: 2026.06.1-3
sparkEnabledbooleanRequired

Whether Spark-based processing is enabled on the Edge site.

Example: false
autoUpgradeEnabledbooleanRequired

Whether 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.

Example: true
upgradeModestringRequired

How Edge version upgrades are applied to the site. Possible values are:

  • AUTOMATIC — the site is upgraded automatically when a new Edge version is released
  • MANUAL — upgrades must be triggered explicitly
  • EXTERNAL — 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.

Example: AUTOMATIC
lastModifiedOnstring · date-timeOptional

Timestamp 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.

Example: 2026-02-20T14:45:00Z
get/sites/{siteId}
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"
}

Update site

put

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.

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

An Edge site update DTO.

namestring · min: 1 · max: 100Required

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.

Example: edge-site-aws-us-eastPattern: ^[a-zA-Z0-9_.-]+$
descriptionstring · min: 1 · max: 255 · nullableRequired

Description of the Edge site. If a string is provided, it must not be empty - use null to clear the description.

versionstring · max: 100Required

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).

Example: 2026.06.1-3Pattern: ^(2[0-9]{3})\.(0?[1-9]|1[0-2])(\.\d+)(-.*)?$
autoUpgradeEnabledbooleanRequired

Whether the Edge site should be auto-upgraded to the latest available version.

sparkEnabledbooleanRequired

Whether the Edge site should enable Spark.

Responses
200

Success

application/json
put/sites/{siteId}
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"
}

Delete a site

delete

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.

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"}
Responses
204

Success. Returned whether or not the site existed (idempotent).

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

No content

List available upgrade versions for a site

get

Returns a list of versions, available to upgrade

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"}
Responses
200

Success

application/json

List of versions, available to upgrade Edge site to.

resultsstring[]Required
get/sites/{siteId}/versions
GET /rest/edge/v1/sites/{siteId}/versions HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": [
    "text"
  ]
}

Download installer for a site

get

Returns a binary that contains installer in .tgz format

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"}
Responses
200

Edge site installer archive

application/gzip
Responsestring · binary
get/sites/{siteId}/installer/download
GET /rest/edge/v1/sites/{siteId}/installer/download HTTP/1.1
Authorization: Basic username:password
Accept: */*

binary
PreviousEdge API (Version 1)
NextConnections

Last updated

Was this helpful?