get-cloud-diagram-components
dci get-cloud-diagram-components [flags]
Returns diagram and statussheet data. When the request body is empty, returns all diagrams the caller has access to (scheme map only). When the body is populated, returns full diagram data including statussheet 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 statussheets to load.",
"items": {
"type": "string"
}
},
"template": {
"description": "Template type or array of template statussheet 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)
Responsesβ
200 (application/json)β
OK - Diagram and component data returned.
{
"type": "object",
"description": "Diagram and statussheet data.\nWhen called with an empty body, only the scheme map is populated.\nWhen called with a populated body, both scheme and statussheet 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 (statussheets).",
"items": {
"type": "object",
"required": [
"ssid",
"name",
"account_name",
"alarms_count",
"empty",
"color"
],
"description": "Summary of a cloud account (statussheet) connected to a diagram.",
"properties": {
"ssid": {
"type": "string",
"description": "Statussheet ID."
},
"name": {
"type": "string",
"description": "Statussheet 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 statussheet contains no components."
},
"color": {
"type": "string",
"description": "Statussheet color."
}
}
}
}
}
}
},
"statussheet": {
"type": "object",
"description": "Map of statussheet ID to statussheet metadata and component collections.\nComponents are projected to key display and cloud fields by default.",
"additionalProperties": {
"allOf": [
{
"type": "object",
"description": "Component collections of a statussheet, keyed by component ID.",
"properties": {
"node": {
"type": "object",
"description": "Map of node ID to node component.",
"additionalProperties": {
"allOf": [
{
"type": "object",
"description": "Common fields shared by all statussheet component types.",
"properties": {
"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"
}
}
}
},
{
"type": "object",
"required": [
"_id"
],
"description": "A node component (host, service, or application component).",
"properties": {
"_id": {
"type": "string",
"description": "Node ID."
},
"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 statussheet 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": {
"allOf": [
{
"type": "object",
"description": "Common fields shared by all statussheet component types.",
"properties": {
"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"
}
}
}
},
{
"type": "object",
"required": [
"_id"
],
"description": "An element component (application-layer component).",
"properties": {
"_id": {
"type": "string",
"description": "Element ID."
},
"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": {
"allOf": [
{
"type": "object",
"description": "Common fields shared by all statussheet component types.",
"properties": {
"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"
}
}
}
},
{
"type": "object",
"required": [
"_id"
],
"description": "A group component (VPC, subnet, region, cluster, etc.).",
"properties": {
"_id": {
"type": "string",
"description": "Group ID."
},
"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": {
"allOf": [
{
"type": "object",
"description": "Common fields shared by all statussheet component types.",
"properties": {
"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"
}
}
}
},
{
"type": "object",
"required": [
"_id"
],
"description": "A link component connecting two nodes or groups.",
"properties": {
"_id": {
"type": "string",
"description": "Link ID."
},
"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."
},
"owner_ss_id": {
"type": "string",
"description": "Owner statussheet 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": {
"allOf": [
{
"type": "object",
"description": "Common fields shared by all statussheet component types.",
"properties": {
"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"
}
}
}
},
{
"type": "object",
"required": [
"_id"
],
"description": "An attachment component added to a group.",
"properties": {
"_id": {
"type": "string",
"description": "Attachment ID."
},
"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."
}
}
}
}
}
},
{
"type": "object",
"required": [
"statussheet"
],
"description": "A statussheet entry with projected metadata and component collections.",
"properties": {
"statussheet": {
"type": "object",
"required": [
"_id",
"updatedAt"
],
"description": "Projected statussheet document returned inside each statussheet entry.\nFields reflect the SS_CLIENT_OPTIONS projection: _id, import, updatedAt, linksVersion.",
"properties": {
"_id": {
"type": "string",
"description": "Statussheet 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."
}
}
}
}
}
]
}
},
"template": {
"type": "object",
"description": "Map of template statussheet ID to template data.",
"additionalProperties": true
}
}
}
400 (application/json)β
Bad Request - The server cannot process the request, often due to a malformed request.
{
"type": "object",
"description": "Standard error response structure.",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}
401 (application/json)β
Unauthorized - Invalid API key.
{
"type": "object",
"description": "Standard error response structure.",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}
403 (application/json)β
Forbidden - The client is not authorized to perform the request.
{
"type": "object",
"description": "Standard error response structure.",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}
Aliases: get-cloud-diagram-components, getclouddiagramcomponents