Get Project Details

client.Projects.Get(ctx, projectID) (*Project, error)

GET/v1/projects/{project_id}

Get details about a project

ParametersExpand Collapse

projectID string

ReturnsExpand Collapse

type Project struct{…}

Project response.

ID string

Project ID.

CreatedAt Time

When the Project was created.

formatdate-time

ManagedBy ProjectManagedBy

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 string

Kind of thing managing the resource.

Name string

Project name.

maxLength255

minLength1

Resources ProjectResources

Resource counts for the project.

Blockchain ProjectBlockchainResources

Blockchain resources.

RPCNodesDedicated int64

Number of dedicated RPC nodes in the project.

RPCNodesFlex int64

Number of flex RPC nodes in the project.

Cloud ProjectCloudResources

Cloud infrastructure resources.

NKSClusters int64

Number of NKS clusters in the project.

NKSNodePools int64

Number of NKS node pools in the project.

VMs int64

Number of VMs in the project.

Volumes int64

Number of volumes in the project.

VPCs int64

Number of VPCs in the project.

Tags []string

Tags attached to the Project.

UpdatedAt Time

When the Project was updated.

formatdate-time

Get Project Details

package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  project, err := client.Projects.Get(context.TODO(), "project_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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_environment"
  },
  "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_environment"
  },
  "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"
}