Developer Documentation

List available Deployments

Lists all deployments in your account. Deployments define which server configurations (and therefore which images) are being deployed at which location and with how many instances.

Usage

odin fleet deployments list

Examples

List all deployments in a table format:

odin fleet deployments list

Create a JSON file with the list of deployments:

odin fleet deployments list --format=json > deployments.json

List the deployments running in a specific location:

odin fleet deployments list --filter="placement.constraints.country = 'us'"

Flags

  • --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.