Sign in

v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
Cloud Diagrams

Get diagram components

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.

post/clouddiagrams/v1/scheme/get

Query parameters

componentsboolean

Include components in the layer response.

externalboolean

Include external (cross-diagram) components.

elementboolean

Include elements.

linkboolean

Include links.

groupboolean

Include groups.

noteboolean

Include notes.

combinerboolean

Include combiners.

typestring[]

Filter diagrams by type.

node_type'app_component' | 'app_group' | 'app_link' | 'attachment' | 'group' | 'host' | 'link' | 'service'

Filter components by node type.

alarms_countboolean

Include alarm counts (default true).

issues_countboolean

Include issue counts.

skip_emptyboolean

Omit diagrams that have no components.

exclude_default_vpcboolean

Exclude the default VPC group (default true).

exclude_empty_subnetsboolean

Exclude empty subnet groups (default true).

Request body

schemestring[]

IDs of diagrams to load.

statussheetstring[]

IDs of layers to load.

Response

OK - Diagram and component data returned.

schemeobject

Map of diagram ID to diagram with its connected cloud accounts.

statussheetobject

Map of layer ID to layer metadata and component collections. Components are projected to key display and cloud fields by default.

templateobject

Map of template layer ID to template data.