Getting Information About a Specific Project

You can retrieve information about a specific project using OKS CLI.

Getting Information About a Specific Project Using OKS CLI

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

The project get command allows you to retrieve information about a specific project:

Request sample
$ oks-cli project get \
    --project-name NAME_OF_PROJECT

This command contains the following attribute that you need to specify:

  • project-name: The name of the project you want to retrieve information from.

The project get command returns the following elements:

  • id: The unique identifier of the project.

  • name: The name of the project.

  • description: The description of the project.

  • cidr: CIDR block allocated for VPC subnets where cluster VMs will run.

  • region: The Region where the project is deployed.

  • status: Current state of the project.

    A project can be in one of the following states:

    • Pending: The underlying resources of the project are being initialized.

    • Available: The project is fully set up and ready for use.

    • Deleting: The project is in the process of being deleted, and its associated resources are being cleaned up.

  • tags: One or more tags associated with the project.

  • disable_api_termination: Whether API termination was disabled for the project.

  • created_at: The date and time, in UTC format, at which the project was created.

  • updated_at: The date and time, in UTC format, at which the project was last updated.

  • deleted_at: The date and time, in UTC format, at which the project was deleted (null if the project is still active).

Result sample
{
    "id": "12ca0d38-2927-4cf1-93de-049135f88f00",
    "name": "NAME_OF_PROJECT",
    "description": "DESCRIPTION_OF_PROJECT",
    "cidr": "10.50.0.0/16",
    "region": "eu-west-2",
    "status": "ready",
    "tags": {
        "tag1": "this",
        "tag2": "that"
    },
    "disable_api_termination": false,
    "created_at": "2025-01-01T12:10:00.000000Z",
    "updated_at": "2025-01-01T12:12:10.000000Z",
    "deleted_at": null
}

Related Pages

Export to PDF