{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/canonical/main/json-schema/canonical-cluster-link-schema.json",
  "title": "ClusterLink represents high-level information about a cluster link.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/canonical-cluster-links-api-openapi.yml#/components/schemas/ClusterLink",
  "properties": {
    "access_entitlements": {
      "description": "AccessEntitlements represents the entitlements that are granted to the requesting user on the attached entity.",
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "AccessEntitlements"
    },
    "config": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Cluster link configuration map (refer to doc/clustering.md).",
      "type": "object",
      "x-go-name": "Config"
    },
    "description": {
      "description": "Description of the cluster link.",
      "type": "string",
      "x-go-name": "Description"
    },
    "name": {
      "description": "Name of the cluster link.",
      "type": "string",
      "x-go-name": "Name"
    },
    "type": {
      "description": "Type of cluster link.",
      "type": "string",
      "x-go-name": "Type"
    },
    "used_by": {
      "description": "UsedBy is a list of LXD entity URLs that reference the cluster link.\n\nAPI extension: cluster_links_used_by",
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "UsedBy"
    }
  },
  "type": "object",
  "x-go-package": "github.com/canonical/lxd/shared/api"
}