Skip to content
DocsOpenAPI spec

    Get Project Details

    $ nirvana projects get
    GET/v1/projects/{project_id}

    Get details about a project

    ParametersExpand Collapse
    --project-id: string

    Project ID

    ReturnsExpand Collapse
    project: object { id, created_at, managed_by, 4 more }

    Project response.

    id: string

    Project ID.

    created_at: string

    When the Project was created.

    managed_by: object { id, type }

    What manages the resource, or null when nothing does. A managed resource can be read but not changed.

    id: string

    ID of the thing managing the resource.

    type: "sandbox_cluster"

    Kind of thing managing the resource.

    "sandbox_cluster"
    name: string

    Project name.

    resources: object { blockchain, cloud }

    Resource counts for the project.

    blockchain: object { rpc_nodes_dedicated, rpc_nodes_flex }

    Blockchain resources.

    rpc_nodes_dedicated: number

    Number of dedicated RPC nodes in the project.

    rpc_nodes_flex: number

    Number of flex RPC nodes in the project.

    cloud: object { nks_clusters, nks_node_pools, vms, 2 more }

    Cloud infrastructure resources.

    nks_clusters: number

    Number of NKS clusters in the project.

    nks_node_pools: number

    Number of NKS node pools in the project.

    vms: number

    Number of VMs in the project.

    volumes: number

    Number of volumes in the project.

    vpcs: number

    Number of VPCs in the project.

    tags: array of string

    Tags attached to the Project.

    updated_at: string

    When the Project was updated.

    Get Project Details

    nirvana projects get \
      --api-key 'My API Key' \
      --project-id project_id
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "managed_by": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "sandbox_cluster"
      },
      "name": "My Project",
      "resources": {
        "blockchain": {
          "rpc_nodes_dedicated": 1,
          "rpc_nodes_flex": 3
        },
        "cloud": {
          "nks_clusters": 2,
          "nks_node_pools": 4,
          "vms": 5,
          "volumes": 10,
          "vpcs": 2
        }
      },
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }
    Returns Examples
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "managed_by": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "sandbox_cluster"
      },
      "name": "My Project",
      "resources": {
        "blockchain": {
          "rpc_nodes_dedicated": 1,
          "rpc_nodes_flex": 3
        },
        "cloud": {
          "nks_clusters": 2,
          "nks_node_pools": 4,
          "vms": 5,
          "volumes": 10,
          "vpcs": 2
        }
      },
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }