Getting Information About a Specific Project

You can get information about a specific project using Cockpit and OKS CLI.

Getting Information About a Specific Project Using Cockpit

  1. In the Projects dashboard, click the name of the project you want to get information about.
    The project details panel appears.

  2. Switch between the following tabs:

    • Clusters, to get information about the clusters created within the project.

    • OKS Public IPs, to get information about pools of public IPs allocated to the worker nodes of your clusters.

    • System, to get information about the project configuration and metadata.

Getting Information About a Specific Project Using 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 \
    --output json

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

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

  • (optional) output: The output format for the response (json | yaml). By default, the response format is JSON.

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: The CIDR block allocated for VPC subnets where cluster VMs will run.

  • region: The Region where the project is deployed.

  • status: The 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.

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

    • updating: The project is currently updating.

    • failed: The project has failed. To remedy this, contact our Support team at support@outscale.com.

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

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

  • disable-api-termination: The ability to delete the project through the API. If true, project deletion is disabled. If false, it is enabled.

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

Corresponding API Method

Export to PDF