get-cloud-diagram-layer-snapshot

dci get-cloud-diagram-layer-snapshot <id> [flags]

Returns a single snapshot of the specified diagram layer identified by its ID.

• id — Layer ID: the ssid of a layer listed by dci get-cloud-diagram-components (also the ss_id field in dci get-cloud-diagrams-stats and dci search-cloud-diagrams results).

Examples

# Show one saved snapshot of a layer; snapshot IDs come from `dci list-cloud-diagram-layer-snapshots`.
dci get-cloud-diagram-layer-snapshot <layer-id> --snapshot-id <snapshot-id>

# As JSON, e.g. to follow `prevState` back through the snapshot chain.
dci get-cloud-diagram-layer-snapshot <layer-id> --snapshot-id <snapshot-id> --output json

Flags

Flag	Type	Default	Example	Description
--snapshot-id	string			Snapshot ID.

Every command also accepts the CLI-wide flags for output shaping — see Output formats and Table output options.

Output

OK - Snapshot 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
_id	string	Snapshot ID.
name	string	Snapshot name.
createdAt	string (date-time)	Timestamp when the snapshot was created.
prevState	string	ID of the previous snapshot in the chain.

Raw JSON schema

{
  "type": "object",
  "required": [
    "_id",
    "createdAt"
  ],
  "description": "A saved snapshot of a diagram layer's state.",
  "properties": {
    "_id": {
      "type": "string",
      "description": "Snapshot ID."
    },
    "name": {
      "type": "string",
      "description": "Snapshot name."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the snapshot was created."
    },
    "prevState": {
      "type": "string",
      "description": "ID of the previous snapshot in the chain."
    }
  }
}

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 to exit code mapping

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.

Related

• list-cloud-diagram-layer-snapshots — List layer snapshots
• list-cloud-diagram-activity-groups — List activity groups for a layer
• export-cloud-diagram-json — Export diagram as JSON
• API reference: GET /clouddiagrams/v1/statussheet/{id}/snapshot

Aliases: getclouddiagramlayersnapshot