export-cloud-diagram-json
dci export-cloud-diagram-json id
Exports the full content of a statussheet (diagram layer) as a structured JSON document, including all components and export metadata.
Responsesβ
200 (application/json)β
OK - Diagram exported as JSON.
{
"type": "object",
"required": [
"metadata"
],
"description": "Full diagram export as a structured JSON document.",
"properties": {
"statussheet": {
"type": "object",
"description": "Diagram-level metadata (scheme fields, excluding internal IDs).",
"additionalProperties": true
},
"metadata": {
"type": "object",
"required": [
"user",
"date",
"version"
],
"description": "Metadata included in a diagram JSON export.",
"properties": {
"user": {
"type": "string",
"description": "Email of the user who triggered the export."
},
"date": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of the export."
},
"version": {
"type": "string",
"description": "Export format version."
},
"connections": {
"type": "object",
"description": "Map of component ID to display label for external connections referenced by cross-diagram links.",
"additionalProperties": {
"type": "string"
}
}
}
},
"nodes": {
"type": "array",
"description": "Exported nodes.",
"items": {
"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."
}
}
}
}
}
}
]
}
},
"elements": {
"type": "array",
"description": "Exported elements.",
"items": {
"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."
}
}
}
}
}
}
]
}
},
"groups": {
"type": "array",
"description": "Exported groups.",
"items": {
"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."
}
}
}
}
}
}
]
}
},
"attachments": {
"type": "array",
"description": "Exported attachments.",
"items": {
"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."
}
}
}
}
}
}
]
}
},
"links": {
"type": "array",
"description": "Exported links.",
"items": {
"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."
}
}
}
}
}
}
]
}
},
"combiners": {
"type": "array",
"description": "Exported combiners.",
"items": {
"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."
}
}
}
}
}
}
},
"notes": {
"type": "array",
"description": "Exported notes.",
"items": {
"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."
}
}
}
}
}
}
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."
}
}
}
404 (application/json)β
Not Found - The requested resource does not exist.
{
"type": "object",
"description": "Standard error response structure.",
"properties": {
"error": {
"type": "string",
"description": "Detailed error message."
}
}
}
Aliases: export-cloud-diagram-json, exportclouddiagramjson