List Projects

client.projects.list(?, ?): Cursor<Project { id, created_at, name, 3 more } >

GET/v1/projects

List all projects

ParametersExpand Collapse

query: ProjectListParams { cursor, limit }

cursor?: string

Pagination cursor returned by a previous request

limit?: number

Maximum number of items to return

maximum100

minimum10

ReturnsExpand Collapse

Project { id, created_at, name, 3 more }

Project response.

id: string

Project ID.

created_at: string

When the Project was created.

formatdate-time

name: string

Project name.

maxLength255

minLength1

resources: ProjectResources { blockchain, cloud }

Resource counts for the project.

blockchain: ProjectBlockchainResources { 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: ProjectCloudResources { connect_connections, nks_clusters, nks_node_pools, 3 more }

Cloud infrastructure resources.

connect_connections: number

Number of Connect connections in the project.

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<string>

Tags attached to the Project.

updated_at: string

When the Project was updated.

formatdate-time

List Projects

import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const project of client.projects.list()) {
  console.log(project.id);
}

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "name": "My Project",
      "resources": {
        "blockchain": {
          "rpc_nodes_dedicated": 1,
          "rpc_nodes_flex": 3
        },
        "cloud": {
          "connect_connections": 1,
          "nks_clusters": 2,
          "nks_node_pools": 4,
          "vms": 5,
          "volumes": 10,
          "vpcs": 2
        }
      },
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "name": "My Project",
      "resources": {
        "blockchain": {
          "rpc_nodes_dedicated": 1,
          "rpc_nodes_flex": 3
        },
        "cloud": {
          "connect_connections": 1,
          "nks_clusters": 2,
          "nks_node_pools": 4,
          "vms": 5,
          "volumes": 10,
          "vpcs": 2
        }
      },
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}