get-cloud-diagram-components
dci get-cloud-diagram-components [flags]
Returns diagram and layer data. When the request body is empty, returns all diagrams the caller has access to. When the body is populated, returns full diagram data including layer components projected to key display and cloud fields.
Request
Content-Type: application/json
Schema
{
"type": "object",
"description": "Request body for getting diagram components.\nLeave empty to retrieve all accessible diagrams (returns scheme map only).",
"properties": {
"scheme": {
"type": "array",
"description": "IDs of diagrams to load.",
"items": {
"type": "string"
}
},
"statussheet": {
"type": "array",
"description": "IDs of layers to load.",
"items": {
"type": "string"
}
},
"template": {
"description": "Template type or array of template layer IDs to include.",
"oneOf": [
{
"type": "string",
"enum": [
"component",
"statussheet"
]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
}
Flags
--components: (boolean)
--external: (boolean)
--element: (boolean)
--link: (boolean)
--group: (boolean)
--note: (boolean)
--combiner: (boolean)
--type: (array)
--node-type: (string enum:"app_component","app_group","app_link","attachment","group","host","link","service")
--alarms-count: (boolean)
--issues-count: (boolean)
--skip-empty: (boolean)
--exclude-default-vpc: (boolean)
--exclude-empty-subnets: (boolean)
Output
OK - Diagram and component data returned.
By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.
| Field | Type | Description |
|---|---|---|
scheme | map of object | Map of diagram ID to diagram with its connected cloud accounts. |
scheme.*._id | string | Diagram ID. |
scheme.*.name | string | Diagram name. |
scheme.*.color | string | Diagram color. |
scheme.*.type | string | Diagram type. One of: "application", "infrastructure", "network", "template". |
scheme.*.statussheet | array of object | Connected cloud accounts (layers). |
scheme.*.statussheet[].ssid | string | Layer ID. |
scheme.*.statussheet[].name | string | Layer name. |
scheme.*.statussheet[].account_name | string | Connected cloud account name. |
scheme.*.statussheet[].alarms_count | integer | Number of active alarms. |
scheme.*.statussheet[].empty | boolean | True when the layer contains no components. |
scheme.*.statussheet[].color | string | Layer color. |
statussheet | map of object | Map of layer ID to layer metadata and component collections. Components are projected to key display and cloud fields by default. |
statussheet.*.statussheet | object | Projected layer metadata returned inside each layer entry. Contains import state, last updated timestamp, and links version. |
statussheet.*.statussheet._id | string | Layer ID. |
statussheet.*.statussheet.import | object | Current import/sync state for a cloud-connected diagram. Nested fields omitted — see the raw JSON schema. |
statussheet.*.statussheet.updatedAt | string (date-time) | Timestamp of the last update. |
statussheet.*.statussheet.linksVersion | integer | Links version counter, incremented on every link change. |
statussheet.*.node | map of object | Map of node ID to node component. |
statussheet.*.node.*._id | string | Node ID. |
statussheet.*.node.*.name | string | Component name. |
statussheet.*.node.*.props | object | Custom component properties (key-value pairs). |
statussheet.*.node.*.cld_id | string | Cloud resource ID (set on cloud-imported components). |
statussheet.*.node.*.cld_type | string | Cloud account type. One of: "AWS", "GCP", "AZURE". |
statussheet.*.node.*.cld_sync | boolean | Whether this component is synced with cloud. |
statussheet.*.node.*.cld_account | string | Cloud account ID. |
statussheet.*.node.*.tags | array of string | Tags assigned to the component. |
statussheet.*.node.*.color | string | Node color. |
statussheet.*.node.*.icon | string | Node icon identifier. |
statussheet.*.node.*.parent | string | Parent node ID. |
statussheet.*.node.*.infra_node | object | Reference to a linked infrastructure node in another diagram. Nested fields omitted — see the raw JSON schema. |
statussheet.*.node.*.instance_count | integer | Number of instances represented by this node. |
statussheet.*.node.*.running | boolean | Whether the node is currently running. |
statussheet.*.node.*.issues | array of object | Issues associated with this node. Nested fields omitted — see the raw JSON schema. |
statussheet.*.element | map of object | Map of element ID to element component. |
statussheet.*.element.*._id | string | Element ID. |
statussheet.*.element.*.name | string | Component name. |
statussheet.*.element.*.props | object | Custom component properties (key-value pairs). |
statussheet.*.element.*.cld_id | string | Cloud resource ID (set on cloud-imported components). |
statussheet.*.element.*.cld_type | string | Cloud account type. One of: "AWS", "GCP", "AZURE". |
statussheet.*.element.*.cld_sync | boolean | Whether this component is synced with cloud. |
statussheet.*.element.*.cld_account | string | Cloud account ID. |
statussheet.*.element.*.tags | array of string | Tags assigned to the component. |
statussheet.*.element.*.color | string | Element color. |
statussheet.*.element.*.icon | string | Element icon identifier. |
statussheet.*.element.*.parent | string | Parent element ID. |
statussheet.*.element.*.issues | array of object | Issues associated with this element. Nested fields omitted — see the raw JSON schema. |
statussheet.*.group | map of object | Map of group ID to group component. |
statussheet.*.group.*._id | string | Group ID. |
statussheet.*.group.*.name | string | Component name. |
statussheet.*.group.*.props | object | Custom component properties (key-value pairs). |
statussheet.*.group.*.cld_id | string | Cloud resource ID (set on cloud-imported components). |
statussheet.*.group.*.cld_type | string | Cloud account type. One of: "AWS", "GCP", "AZURE". |
statussheet.*.group.*.cld_sync | boolean | Whether this component is synced with cloud. |
statussheet.*.group.*.cld_account | string | Cloud account ID. |
statussheet.*.group.*.tags | array of string | Tags assigned to the component. |
statussheet.*.group.*.group_type | string | Group type. One of: "account", "az", "azure_subscription", "customer_gateway", "ecs", "eks", "aks", "k8s_namespace", "k8s_pod", "k8s_deployment", "k8s_daemon_set", "k8s_replica_set", …. |
statussheet.*.group.*.color | string | Group color. |
statussheet.*.group.*.icon | string | Group icon identifier. |
statussheet.*.group.*.items | array of object | Components contained in the group. Nested fields omitted — see the raw JSON schema. |
statussheet.*.group.*.issues | array of object | Issues associated with this group. Nested fields omitted — see the raw JSON schema. |
statussheet.*.link | map of object | Map of link ID to link component. |
statussheet.*.link.*._id | string | Link ID. |
statussheet.*.link.*.name | string | Component name. |
statussheet.*.link.*.props | object | Custom component properties (key-value pairs). |
statussheet.*.link.*.cld_id | string | Cloud resource ID (set on cloud-imported components). |
statussheet.*.link.*.cld_type | string | Cloud account type. One of: "AWS", "GCP", "AZURE". |
statussheet.*.link.*.cld_sync | boolean | Whether this component is synced with cloud. |
statussheet.*.link.*.cld_account | string | Cloud account ID. |
statussheet.*.link.*.tags | array of string | Tags assigned to the component. |
statussheet.*.link.*.connection_type | string | Link connection type. One of: "normal", "tunnel", "private", "VPN", "VPC Peering", "Network Connectivity Center", "Private Service Connect", "Private Google Access", "Serverless VPC", "Serverless VPC Access Connector", "Cross Cloud Interconnect", "Partner Interconnect", …. |
statussheet.*.link.*.origin | object | Reference to a diagram component, including its parent diagram and layer. Nested fields omitted — see the raw JSON schema. |
statussheet.*.link.*.destination | object | Reference to a diagram component, including its parent diagram and layer. Nested fields omitted — see the raw JSON schema. |
statussheet.*.link.*.owner_ss_id | string | Owner layer ID for cross-diagram links. |
statussheet.*.link.*.issues | array of object | Issues associated with this link. Nested fields omitted — see the raw JSON schema. |
statussheet.*.attachment | map of object | Map of attachment ID to attachment component. |
statussheet.*.attachment.*._id | string | Attachment ID. |
statussheet.*.attachment.*.name | string | Component name. |
statussheet.*.attachment.*.props | object | Custom component properties (key-value pairs). |
statussheet.*.attachment.*.cld_id | string | Cloud resource ID (set on cloud-imported components). |
statussheet.*.attachment.*.cld_type | string | Cloud account type. One of: "AWS", "GCP", "AZURE". |
statussheet.*.attachment.*.cld_sync | boolean | Whether this component is synced with cloud. |
statussheet.*.attachment.*.cld_account | string | Cloud account ID. |
statussheet.*.attachment.*.tags | array of string | Tags assigned to the component. |
statussheet.*.attachment.*.color | string | Attachment color. |
statussheet.*.attachment.*.icon | string | Attachment icon identifier. |
statussheet.*.attachment.*.group | string | Parent group ID. |
statussheet.*.attachment.*.issues | array of object | Issues associated with this attachment. Nested fields omitted — see the raw JSON schema. |
statussheet.*.combiner | map of object | Map of combiner ID to combiner component. |
statussheet.*.combiner.*._id | string | Combiner ID. |
statussheet.*.combiner.*.name | string | Combiner name. |
statussheet.*.combiner.*.color | string | Combiner color. |
statussheet.*.combiner.*.icon | string | Combiner icon identifier. |
statussheet.*.combiner.*.items | array of object | Components contained in the combiner. Nested fields omitted — see the raw JSON schema. |
statussheet.*.note | map of object | Map of note ID to note component. |
statussheet.*.note.*._id | string | Note ID. |
statussheet.*.note.*.text | string | Note text content. |
statussheet.*.note.*.color | string | Note background color. |
statussheet.*.note.*.font_size | number | Note font size. |
template | object | Map of template layer ID to template data. |
Raw JSON schema
{
"type": "object",
"description": "Diagram and layer data.\nWhen called with an empty body, only the diagram map is populated.\nWhen called with a populated body, both diagram and layer maps are returned\nwith components projected to key display and cloud fields by default.",
"properties": {
"scheme": {
"type": "object",
"description": "Map of diagram ID to diagram with its connected cloud accounts.",
"additionalProperties": {
"type": "object",
"required": [
"_id",
"name",
"type",
"statussheet"
],
"description": "A diagram with its connected cloud accounts.",
"properties": {
"_id": {
"type": "string",
"description": "Diagram ID."
},
"name": {
"type": "string",
"description": "Diagram name."
},
"color": {
"type": "string",
"description": "Diagram color."
},
"type": {
"type": "string",
"enum": [
"application",
"infrastructure",
"network",
"template"
],
"description": "Diagram type."
},
"statussheet": {
"type": "array",
"description": "Connected cloud accounts (layers).",
"items": {
"type": "object",
"required": [
"ssid",
"name",
"account_name",
"alarms_count",
"empty",
"color"
],
"description": "Summary of a cloud account (layer) connected to a diagram.",
"properties": {
"ssid": {
"type": "string",
"description": "Layer ID."
},
"name": {
"type": "string",
"description": "Layer name."
},
"account_name": {
"type": "string",
"description": "Connected cloud account name."
},
"alarms_count": {
"type": "integer",
"description": "Number of active alarms."
},
"empty": {
"type": "boolean",
"description": "True when the layer contains no components."
},
"color": {
"type": "string",
"description": "Layer color."
}
}
}
}
}
}
},
"statussheet": {
"type": "object",
"description": "Map of layer ID to layer metadata and component collections.\nComponents are projected to key display and cloud fields by default.",
"additionalProperties": {
"type": "object",
"required": [
"statussheet"
],
"description": "A layer entry with projected metadata and component collections.",
"properties": {
"statussheet": {
"type": "object",
"required": [
"_id",
"updatedAt"
],
"description": "Projected layer metadata returned inside each layer entry.\nContains import state, last updated timestamp, and links version.",
"properties": {
"_id": {
"type": "string",
"description": "Layer ID."
},
"import": {
"type": "object",
"description": "Current import/sync state for a cloud-connected diagram.",
"properties": {
"status": {
"type": "string",
"enum": [
"queued",
"in_progress",
"success",
"failure"
],
"description": "Import status."
},
"type": {
"type": "string",
"enum": [
"AWS",
"GCP",
"AZURE"
],
"description": "Connected cloud account type."
},
"account": {
"type": "string",
"description": "Connected account ID."
},
"cloudId": {
"type": "string",
"description": "Cloud account ID."
},
"errorMessage": {
"type": "string",
"description": "Error message if the import failed."
},
"syncedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the last successful sync."
}
}
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the last update."
},
"linksVersion": {
"type": "integer",
"description": "Links version counter, incremented on every link change."
}
}
},
"node": {
"type": "object",
"description": "Map of node ID to node component.",
"additionalProperties": {
"type": "object",
"required": [
"_id"
],
"description": "A node component (host, service, or application component).",
"properties": {
"_id": {
"type": "string",
"description": "Node ID."
},
"name": {
"type": "string",
"description": "Component name."
},
"props": {
"type": "object",
"additionalProperties": true,
"description": "Custom component properties (key-value pairs)."
},
"cld_id": {
"type": "string",
"description": "Cloud resource ID (set on cloud-imported components)."
},
"cld_type": {
"type": "string",
"enum": [
"AWS",
"GCP",
"AZURE"
],
"description": "Cloud account type."
},
"cld_sync": {
"type": "boolean",
"description": "Whether this component is synced with cloud."
},
"cld_account": {
"type": "string",
"description": "Cloud account ID."
},
"tags": {
"type": "array",
"description": "Tags assigned to the component.",
"items": {
"type": "string"
}
},
"color": {
"type": "string",
"description": "Node color."
},
"icon": {
"type": "string",
"description": "Node icon identifier."
},
"parent": {
"type": "string",
"description": "Parent node ID."
},
"infra_node": {
"type": "object",
"required": [
"_id",
"scheme_id",
"ss_id"
],
"description": "Reference to a linked infrastructure node in another diagram.",
"properties": {
"_id": {
"type": "string",
"description": "Infrastructure node ID."
},
"scheme_id": {
"type": "string",
"description": "Parent diagram ID."
},
"ss_id": {
"type": "string",
"description": "Parent layer ID."
}
}
},
"instance_count": {
"type": "integer",
"description": "Number of instances represented by this node."
},
"running": {
"type": "boolean",
"description": "Whether the node is currently running."
},
"issues": {
"type": "array",
"description": "Issues associated with this node.",
"items": {
"type": "object",
"description": "Issue annotation linked to a component.",
"properties": {
"_id": {
"type": "string",
"description": "Issue reference ID."
},
"comment": {
"type": "string",
"description": "Optional comment on the issue."
},
"snoozed": {
"type": "number",
"description": "Snooze duration in seconds."
},
"jira": {
"type": "string",
"description": "Linked Jira ticket key or URL."
}
}
}
}
}
}
},
"element": {
"type": "object",
"description": "Map of element ID to element component.",
"additionalProperties": {
"type": "object",
"required": [
"_id"
],
"description": "An element component (application-layer component).",
"properties": {
"_id": {
"type": "string",
"description": "Element ID."
},
"name": {
"type": "string",
"description": "Component name."
},
"props": {
"type": "object",
"additionalProperties": true,
"description": "Custom component properties (key-value pairs)."
},
"cld_id": {
"type": "string",
"description": "Cloud resource ID (set on cloud-imported components)."
},
"cld_type": {
"type": "string",
"enum": [
"AWS",
"GCP",
"AZURE"
],
"description": "Cloud account type."
},
"cld_sync": {
"type": "boolean",
"description": "Whether this component is synced with cloud."
},
"cld_account": {
"type": "string",
"description": "Cloud account ID."
},
"tags": {
"type": "array",
"description": "Tags assigned to the component.",
"items": {
"type": "string"
}
},
"color": {
"type": "string",
"description": "Element color."
},
"icon": {
"type": "string",
"description": "Element icon identifier."
},
"parent": {
"type": "string",
"description": "Parent element ID."
},
"issues": {
"type": "array",
"description": "Issues associated with this element.",
"items": {
"type": "object",
"description": "Issue annotation linked to a component.",
"properties": {
"_id": {
"type": "string",
"description": "Issue reference ID."
},
"comment": {
"type": "string",
"description": "Optional comment on the issue."
},
"snoozed": {
"type": "number",
"description": "Snooze duration in seconds."
},
"jira": {
"type": "string",
"description": "Linked Jira ticket key or URL."
}
}
}
}
}
}
},
"group": {
"type": "object",
"description": "Map of group ID to group component.",
"additionalProperties": {
"type": "object",
"required": [
"_id"
],
"description": "A group component (VPC, subnet, region, cluster, etc.).",
"properties": {
"_id": {
"type": "string",
"description": "Group ID."
},
"name": {
"type": "string",
"description": "Component name."
},
"props": {
"type": "object",
"additionalProperties": true,
"description": "Custom component properties (key-value pairs)."
},
"cld_id": {
"type": "string",
"description": "Cloud resource ID (set on cloud-imported components)."
},
"cld_type": {
"type": "string",
"enum": [
"AWS",
"GCP",
"AZURE"
],
"description": "Cloud account type."
},
"cld_sync": {
"type": "boolean",
"description": "Whether this component is synced with cloud."
},
"cld_account": {
"type": "string",
"description": "Cloud account ID."
},
"tags": {
"type": "array",
"description": "Tags assigned to the component.",
"items": {
"type": "string"
}
},
"group_type": {
"type": "string",
"enum": [
"account",
"az",
"azure_subscription",
"customer_gateway",
"ecs",
"eks",
"aks",
"k8s_namespace",
"k8s_pod",
"k8s_deployment",
"k8s_daemon_set",
"k8s_replica_set",
"k8s_stateful_set",
"project",
"region",
"security_group",
"subnet",
"vpc",
"gcp_instance_group",
"gcp_managed_zone",
"gke_cluster",
"azure_dns_zone",
"azure_cdn_profile",
"azure_resource_group"
],
"description": "Group type."
},
"color": {
"type": "string",
"description": "Group color."
},
"icon": {
"type": "string",
"description": "Group icon identifier."
},
"items": {
"type": "array",
"description": "Components contained in the group.",
"items": {
"type": "object",
"required": [
"_id",
"type"
],
"description": "Reference to a component contained within a group.",
"properties": {
"_id": {
"type": "string",
"description": "Component ID."
},
"type": {
"type": "string",
"enum": [
"attachment",
"combiner",
"element",
"group",
"link",
"node",
"note",
"scheme",
"statussheet"
],
"description": "Component type."
}
}
}
},
"issues": {
"type": "array",
"description": "Issues associated with this group.",
"items": {
"type": "object",
"description": "Issue annotation linked to a component.",
"properties": {
"_id": {
"type": "string",
"description": "Issue reference ID."
},
"comment": {
"type": "string",
"description": "Optional comment on the issue."
},
"snoozed": {
"type": "number",
"description": "Snooze duration in seconds."
},
"jira": {
"type": "string",
"description": "Linked Jira ticket key or URL."
}
}
}
}
}
}
},
"link": {
"type": "object",
"description": "Map of link ID to link component.",
"additionalProperties": {
"type": "object",
"required": [
"_id",
"origin",
"destination"
],
"description": "A link component connecting two nodes or groups.",
"properties": {
"_id": {
"type": "string",
"description": "Link ID."
},
"name": {
"type": "string",
"description": "Component name."
},
"props": {
"type": "object",
"additionalProperties": true,
"description": "Custom component properties (key-value pairs)."
},
"cld_id": {
"type": "string",
"description": "Cloud resource ID (set on cloud-imported components)."
},
"cld_type": {
"type": "string",
"enum": [
"AWS",
"GCP",
"AZURE"
],
"description": "Cloud account type."
},
"cld_sync": {
"type": "boolean",
"description": "Whether this component is synced with cloud."
},
"cld_account": {
"type": "string",
"description": "Cloud account ID."
},
"tags": {
"type": "array",
"description": "Tags assigned to the component.",
"items": {
"type": "string"
}
},
"connection_type": {
"type": "string",
"enum": [
"normal",
"tunnel",
"private",
"VPN",
"VPC Peering",
"Network Connectivity Center",
"Private Service Connect",
"Private Google Access",
"Serverless VPC",
"Serverless VPC Access Connector",
"Cross Cloud Interconnect",
"Partner Interconnect",
"Dedicated Interconnect"
],
"description": "Link connection type."
},
"origin": {
"type": "object",
"required": [
"_id",
"type",
"scheme_id",
"ss_id"
],
"description": "Reference to a diagram component, including its parent diagram and layer.",
"properties": {
"_id": {
"type": "string",
"description": "Component ID."
},
"type": {
"type": "string",
"enum": [
"attachment",
"combiner",
"element",
"group",
"link",
"node",
"note",
"scheme",
"statussheet"
],
"description": "Component type."
},
"scheme_id": {
"type": "string",
"description": "Parent diagram ID."
},
"ss_id": {
"type": "string",
"description": "Parent layer ID."
}
}
},
"destination": {
"type": "object",
"required": [
"_id",
"type",
"scheme_id",
"ss_id"
],
"description": "Reference to a diagram component, including its parent diagram and layer.",
"properties": {
"_id": {
"type": "string",
"description": "Component ID."
},
"type": {
"type": "string",
"enum": [
"attachment",
"combiner",
"element",
"group",
"link",
"node",
"note",
"scheme",
"statussheet"
],
"description": "Component type."
},
"scheme_id": {
"type": "string",
"description": "Parent diagram ID."
},
"ss_id": {
"type": "string",
"description": "Parent layer ID."
}
}
},
"owner_ss_id": {
"type": "string",
"description": "Owner layer ID for cross-diagram links."
},
"issues": {
"type": "array",
"description": "Issues associated with this link.",
"items": {
"type": "object",
"description": "Issue annotation linked to a component.",
"properties": {
"_id": {
"type": "string",
"description": "Issue reference ID."
},
"comment": {
"type": "string",
"description": "Optional comment on the issue."
},
"snoozed": {
"type": "number",
"description": "Snooze duration in seconds."
},
"jira": {
"type": "string",
"description": "Linked Jira ticket key or URL."
}
}
}
}
}
}
},
"attachment": {
"type": "object",
"description": "Map of attachment ID to attachment component.",
"additionalProperties": {
"type": "object",
"required": [
"_id"
],
"description": "An attachment component added to a group.",
"properties": {
"_id": {
"type": "string",
"description": "Attachment ID."
},
"name": {
"type": "string",
"description": "Component name."
},
"props": {
"type": "object",
"additionalProperties": true,
"description": "Custom component properties (key-value pairs)."
},
"cld_id": {
"type": "string",
"description": "Cloud resource ID (set on cloud-imported components)."
},
"cld_type": {
"type": "string",
"enum": [
"AWS",
"GCP",
"AZURE"
],
"description": "Cloud account type."
},
"cld_sync": {
"type": "boolean",
"description": "Whether this component is synced with cloud."
},
"cld_account": {
"type": "string",
"description": "Cloud account ID."
},
"tags": {
"type": "array",
"description": "Tags assigned to the component.",
"items": {
"type": "string"
}
},
"color": {
"type": "string",
"description": "Attachment color."
},
"icon": {
"type": "string",
"description": "Attachment icon identifier."
},
"group": {
"type": "string",
"description": "Parent group ID."
},
"issues": {
"type": "array",
"description": "Issues associated with this attachment.",
"items": {
"type": "object",
"description": "Issue annotation linked to a component.",
"properties": {
"_id": {
"type": "string",
"description": "Issue reference ID."
},
"comment": {
"type": "string",
"description": "Optional comment on the issue."
},
"snoozed": {
"type": "number",
"description": "Snooze duration in seconds."
},
"jira": {
"type": "string",
"description": "Linked Jira ticket key or URL."
}
}
}
}
}
}
},
"combiner": {
"type": "object",
"description": "Map of combiner ID to combiner component.",
"additionalProperties": {
"type": "object",
"required": [
"_id"
],
"description": "A combiner component that visually groups multiple components.",
"properties": {
"_id": {
"type": "string",
"description": "Combiner ID."
},
"name": {
"type": "string",
"description": "Combiner name."
},
"color": {
"type": "string",
"description": "Combiner color."
},
"icon": {
"type": "string",
"description": "Combiner icon identifier."
},
"items": {
"type": "array",
"description": "Components contained in the combiner.",
"items": {
"type": "object",
"required": [
"_id",
"type"
],
"description": "A component reference contained within a combiner.",
"properties": {
"_id": {
"type": "string",
"description": "Component ID."
},
"type": {
"type": "string",
"enum": [
"attachment",
"combiner",
"element",
"group",
"link",
"node",
"note",
"scheme",
"statussheet"
],
"description": "Component type."
}
}
}
}
}
}
},
"note": {
"type": "object",
"description": "Map of note ID to note component.",
"additionalProperties": {
"type": "object",
"required": [
"_id"
],
"description": "A text note placed on the diagram.",
"properties": {
"_id": {
"type": "string",
"description": "Note ID."
},
"text": {
"type": "string",
"description": "Note text content."
},
"color": {
"type": "string",
"description": "Note background color."
},
"font_size": {
"type": "number",
"description": "Note font size."
}
}
}
}
}
}
},
"template": {
"type": "object",
"description": "Map of template layer ID to template data.",
"additionalProperties": true
}
}
}
Errors
On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.
| HTTP status | Exit code | Error code | Meaning |
|---|---|---|---|
| 400 | 30 | VALIDATION_ERROR | The arguments or request body were rejected. Review the command's flags and payload. |
| 401 | 10 | AUTHENTICATION_FAILED | Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY. |
| 403 | 11 | PERMISSION_DENIED | The DoiT user or the active customer context does not have access. |
Aliases: getclouddiagramcomponents