find-cloud-diagrams

dci find-cloud-diagrams

Returns diagram URLs matching the provided resource IDs.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "required": [
    "resources"
  ],
  "description": "Request body for locating cloud diagrams for given resource IDs.",
  "properties": {
    "resources": {
      "type": "array",
      "description": "Resource IDs to find diagrams for.",
      "items": {
        "type": "string"
      }
    }
  }
}

Output

OK - Diagram URLs matching the criteria 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
[].diagramUrl	string (uri)	URL to the diagram viewer.
[].imageUrl	string (uri)	URL to the diagram image.

Raw JSON schema

{
  "type": "array",
  "description": "List of diagram URLs matching the criteria.",
  "items": {
    "type": "object",
    "required": [
      "diagramUrl",
      "imageUrl"
    ],
    "properties": {
      "diagramUrl": {
        "type": "string",
        "format": "uri",
        "description": "URL to the diagram viewer."
      },
      "imageUrl": {
        "type": "string",
        "format": "uri",
        "description": "URL to the diagram image."
      }
    }
  }
}

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: findclouddiagrams