Listing Your Projects

You can list your projects using OKS CLI.

Listing Your Projects Using OKS CLI

Before you begin: Install and configure OKS CLI. For more information, see Installing and Configuring OKS CLI.

The project list command allows you to list your projects:

Request sample
$ oks-cli project list \
    --output json

This command contains the following options that you may need to specify:

  • (optional) deleted: The ability to list deleted projects.

  • (optional) output: The output format for the response (json | yaml).

The project list command returns the following elements:

  • name: The name of the project.

  • created: The time elapsed since the project was created (e.g., "5 minutes ago").

  • status: The current state of the project (pending | ready | deploying | updating | upgrading | failed | deleting).

  • default: Indicates whether this project is the default one (with * meaning it is the default).

Result sample
+----------------+----------------+----------------+------------+---------+
|      NAME      |    CREATED     |    UPDATED     |   STATUS   | DEFAULT |
+----------------+----------------+----------------+------------+---------+
|   my-project   |  5 minutes ago |  3 minutes ago |   ready    |    *    |
+----------------+----------------+----------------+------------+---------+

Related Pages

Corresponding API Method

Export to PDF