list-platforms

dci list-platforms

Returns a list of all the available platforms.

Examples

# The available platforms, with the IDs that `dci list-products --platform` takes.
dci list-platforms

# As compact TOON, the agent-mode default.
dci list-platforms --output toon

Output

OK - List of available platforms 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
platforms	array of object
platforms[].displayName	string
platforms[].id	string

Raw JSON schema

{
  "type": "object",
  "properties": {
    "platforms": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Platform metadata used by product listing endpoints.",
        "properties": {
          "displayName": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        }
      }
    }
  }
}

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-products — List available products
• API reference: GET /support/v1/metadata/platforms

Aliases: listplatforms