Skip to main content

find-cloud-diagrams 

restish dci find-cloud-diagrams

Returns diagram URLs matching the provided resource IDs.

Request​

Content-Type: application/json

Schema​

{
  "type": "object",
  "required": [
    "resources"
  ],
  "properties": {
    "resources": {
      "type": "array",
      "description": "Resource IDs to find diagrams for.",
      "items": {
        "type": "string"
      }
    }
  }
}

Responses​

200 (application/json)​

OK - Diagram URLs matching the criteria returned.

{
  "type": "array",
  "description": "List of diagram URLs matching the find criteria.",
  "items": {
    "type": "string",
    "format": "uri"
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: find-cloud-diagrams, findclouddiagrams