Skip to main content

list-cloudflow-connections 

dci list-cloudflow-connections [flags]

Returns a cursor-paginated list of cloud provider connections for the authenticated tenant.

Flags​

--max-results: (integer default:50)

--page-token: (string)

Responses​

200 (application/json)​

OK

{
  "type": "object",
  "properties": {
    "connections": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A cloud provider connection used in CloudFlow workflows.",
        "properties": {
          "connectionId": {
            "type": "string",
            "description": "Unique identifier for the connection."
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "gcpConfig": {
            "allOf": [
              {
                "type": "object",
                "description": "GCP connection configuration. Server-owned fields (status, deploymentCommand) are excluded.",
                "properties": {
                  "organizationId": {
                    "type": "string"
                  },
                  "folderId": {
                    "type": "string"
                  },
                  "projectId": {
                    "type": "string"
                  },
                  "level": {
                    "type": "string",
                    "enum": [
                      "organization",
                      "folder",
                      "project"
                    ]
                  },
                  "serviceAccountName": {
                    "type": "string"
                  },
                  "predefinedRoles": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "customRole": {
                    "type": "object",
                    "properties": {
                      "roleId": {
                        "type": "string"
                      },
                      "permissions": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "infraManagerProject": {
                    "type": "string"
                  },
                  "infraManagerLocation": {
                    "type": "string"
                  },
                  "infraManagerServiceAccount": {
                    "type": "string"
                  }
                }
              },
              {
                "type": "object",
                "description": "Response extends request schema with server-owned read-only fields.",
                "properties": {
                  "status": {
                    "type": "string",
                    "description": "Server-managed GCP config status."
                  },
                  "deploymentCommand": {
                    "type": "string",
                    "description": "Generated deployment command."
                  }
                }
              }
            ]
          },
          "awsConfig": {
            "allOf": [
              {
                "type": "object",
                "description": "AWS connection configuration. Server-owned fields (context[].status, context[].nextStackOperation, stackSet) are excluded.",
                "properties": {
                  "context": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "accountId": {
                          "type": "string"
                        },
                        "regions": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  },
                  "roleName": {
                    "type": "string"
                  },
                  "permissions": {
                    "type": "object"
                  },
                  "managementAccount": {
                    "type": "string"
                  },
                  "organizationRootId": {
                    "type": "string"
                  },
                  "scopeTargetedOrganizationalUnitIds": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "scopeExplicitAccountIds": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "scopeExcludedAccountIds": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "scopeManagementAccountExplicitInScope": {
                    "type": "boolean"
                  }
                }
              },
              {
                "type": "object",
                "description": "Response extends request schema with server-owned read-only fields.",
                "properties": {
                  "context": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "accountId": {
                          "type": "string"
                        },
                        "regions": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "status": {
                          "type": "string",
                          "description": "Server-managed per-account deployment status."
                        }
                      }
                    }
                  }
                }
              }
            ]
          },
          "collaborators": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "format": "email"
                },
                "role": {
                  "type": "string",
                  "enum": [
                    "owner",
                    "editor",
                    "user"
                  ]
                }
              }
            }
          },
          "enabled": {
            "type": "boolean",
            "description": "false when the connection is disabled."
          },
          "status": {
            "type": "string",
            "description": "Overall connection status."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "nextPageToken": {
      "type": "string",
      "description": "Opaque cursor for the next page. Absent when there are no more results."
    }
  }
}

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."
    }
  }
}

500 (application/json)​

Internal Server Error - Something went wrong with the DoiT API server.

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

Aliases: list-cloudflow-connections, listcloudflowconnections