Developer Documentation
Our new developer documentation is now available. Please check it out!

List available Images

Lists all server images available in the selected or specified app. Images can either be docker images provided by you or you can also link to a Steam App ID.

Usage

odin fleet images list [--unused]

Examples

List all images in a table format:

odin fleet images list --format="table(id,name,type)"

List the ids of unused images (useful for cleanup):

odin fleet images list --format="value(id)" --unused

List images that are being processed or have failed:

odin fleet images list --filter="status != 'ready'"

Flags

  • --unused:
    An optional flag that filters the list to show only images that are not currently in use by any deployments.

  • --filter:
    An optional flag that filters the list of deployments. The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT. You can access nested fields using dot notation, and strings should be enclosed in quotes. Learn more about filters in our filters documentation.

Global Flags

The following flags can be used with any ODIN CLI command:

  • --api-key=<string>
    The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.

  • --app-id=<string>
    The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.

  • --format=<string>
    The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.

  • --force
    Forces the command to execute without prompting for confirmation. Use with caution.

  • --quiet
    Suppresses all informational output except for errors. Useful for scripting and automation.