Skip to content
Nirvana LabsNirvana Labs API
Docs
    Overview

    API Reference

    Libraries

    TypeScript
    1.97.4
    npm install @nirvana-labs/nirvana
    Read Docs
    Go
    1.93.1
    go get -u 'github.com/nirvana-labs/nirvana-go@v1.93.1'
    Read Docs
    Terraform
    1.52.24
    nirvana = { source = "nirvana-labs/nirvana" }
    Read Docs
    CLI tool
    0.53.3
    brew install nirvana-labs/tap/nirvana
    Read Docs

    API Overview

    User

    Get User Details
    GET/v1/user

    UserSecurity

    Get User Security Settings
    GET/v1/user/security
    Update User Security Settings
    PATCH/v1/user/security

    API Keys

    Create API Key
    POST/v1/api_keys
    Get API Key Details
    GET/v1/api_keys/{api_key_id}
    Update API Key
    PATCH/v1/api_keys/{api_key_id}
    Delete API Key
    DELETE/v1/api_keys/{api_key_id}
    List API Keys
    GET/v1/api_keys

    Operations

    Get Operation Details
    GET/v1/operations/{operation_id}
    List Operations
    GET/v1/operations

    Organizations

    Create Organization
    POST/v1/organizations
    Get Organization Details
    GET/v1/organizations/{organization_id}
    Update Organization
    PATCH/v1/organizations/{organization_id}
    List Organizations
    GET/v1/organizations
    Leave Organization
    POST/v1/organizations/{organization_id}/leave

    OrganizationsMemberships

    Get Organization Membership
    GET/v1/organizations/{organization_id}/memberships/{membership_id}
    List Organization Memberships
    GET/v1/organizations/{organization_id}/memberships

    OrganizationsAddress

    Create Organization Address
    POST/v1/organizations/{organization_id}/address
    Get Organization Address
    GET/v1/organizations/{organization_id}/address
    Update Organization Address
    PATCH/v1/organizations/{organization_id}/address

    OrganizationsBilling

    Get Organization Billing Summary
    GET/v1/organizations/{organization_id}/billing/summary
    Get Organization Daily Cost
    GET/v1/organizations/{organization_id}/billing/cost
    List Organization Billing History
    GET/v1/organizations/{organization_id}/billing/history
    Top Up Organization Prepaid Balance
    POST/v1/organizations/{organization_id}/billing/topup
    Re-trigger Organization Prepaid Recharge
    POST/v1/organizations/{organization_id}/billing/recharge
    Get Organization Usage Statement
    GET/v1/organizations/{organization_id}/billing/statements

    OrganizationsBillingRecharge Policy

    Get Organization Recharge Policy
    GET/v1/organizations/{organization_id}/billing/recharge_policy
    Update Organization Recharge Policy
    PATCH/v1/organizations/{organization_id}/billing/recharge_policy

    Quotas

    Get Region Quota
    GET/v1/quotas/{region}
    List Quotas
    GET/v1/quotas

    Usage

    Get Usage Record
    GET/v1/usage/{resource_id}
    List Usage Records
    GET/v1/usage

    Audit Logs

    Get Audit Log
    GET/v1/audit_logs/{audit_log_id}
    List Audit Logs
    GET/v1/audit_logs

    Projects

    Create Project
    POST/v1/projects
    Get Project Details
    GET/v1/projects/{project_id}
    Update Project
    PATCH/v1/projects/{project_id}
    Delete Project
    DELETE/v1/projects/{project_id}
    List Projects
    GET/v1/projects

    Regions

    Get Region
    GET/v1/regions/{name}
    List Regions
    GET/v1/regions

    Instance Types

    Get Instance Type
    GET/v1/instance_types/{region}/{name}
    List Instance Types
    GET/v1/instance_types

    Compute

    ComputeVMs

    Create VM
    POST/v1/compute/vms
    Get VM Details
    GET/v1/compute/vms/{vm_id}
    Update VM
    PATCH/v1/compute/vms/{vm_id}
    Delete VM
    DELETE/v1/compute/vms/{vm_id}
    List VMs
    GET/v1/compute/vms
    Restart VM
    POST/v1/compute/vms/{vm_id}/restart

    ComputeVMsAvailability

    Check VM Create Availability
    POST/v1/compute/vms/availability
    Check VM Update Availability
    PATCH/v1/compute/vms/{vm_id}/availability

    ComputeVMsCost

    Estimate VM Create Cost
    POST/v1/compute/vms/cost
    Estimate VM Update Cost
    PATCH/v1/compute/vms/{vm_id}/cost

    ComputeVMsVolumes

    List VM's Volumes
    GET/v1/compute/vms/{vm_id}/volumes

    ComputeVMsOS Images

    List OS Images
    GET/v1/compute/vms/os_images

    ComputeVolumes

    Create Volume
    POST/v1/compute/volumes
    Get Volume
    GET/v1/compute/volumes/{volume_id}
    Update Volume
    PATCH/v1/compute/volumes/{volume_id}
    Delete Volume
    DELETE/v1/compute/volumes/{volume_id}
    List Volumes
    GET/v1/compute/volumes
    Attach Volume
    POST/v1/compute/volumes/{volume_id}/attach
    Detach Volume
    POST/v1/compute/volumes/{volume_id}/detach

    ComputeVolumesAvailability

    Check Volume Create Availability
    POST/v1/compute/volumes/availability
    Check Volume Update Availability
    PATCH/v1/compute/volumes/{volume_id}/availability

    ComputeVolumesCost

    Estimate Volume Create Cost
    POST/v1/compute/volumes/cost
    Estimate Volume Update Cost
    PATCH/v1/compute/volumes/{volume_id}/cost

    Networking

    NetworkingVPCs

    Create VPC
    POST/v1/networking/vpcs
    Get VPC Details
    GET/v1/networking/vpcs/{vpc_id}
    Update VPC
    PATCH/v1/networking/vpcs/{vpc_id}
    Delete VPC
    DELETE/v1/networking/vpcs/{vpc_id}
    List VPCs
    GET/v1/networking/vpcs

    NetworkingVPCsAvailability

    Check Create VPC Availability
    POST/v1/networking/vpcs/availability
    Check Update VPC Availability
    PATCH/v1/networking/vpcs/{vpc_id}/availability

    NetworkingVPCsCost

    Estimate VPC Create Cost
    POST/v1/networking/vpcs/cost
    Estimate VPC Update Cost
    PATCH/v1/networking/vpcs/{vpc_id}/cost

    NetworkingFirewall Rules

    Create Firewall Rule
    POST/v1/networking/vpcs/{vpc_id}/firewall_rules
    Firewall Rule Details
    GET/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
    Update Firewall Rule
    PATCH/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
    Delete Firewall Rule
    DELETE/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
    List Firewall Rules
    GET/v1/networking/vpcs/{vpc_id}/firewall_rules

    NetworkingConnect

    NetworkingConnectConnections

    Create Connect Connection
    POST/v1/networking/connect/connections
    Get Connect Connection
    GET/v1/networking/connect/connections/{connection_id}
    Update Connect Connection
    PATCH/v1/networking/connect/connections/{connection_id}
    Delete Connect Connection
    DELETE/v1/networking/connect/connections/{connection_id}
    List Connect Connection
    GET/v1/networking/connect/connections

    NetworkingConnectConnectionsCost

    Estimate Connect Connection Create Cost
    POST/v1/networking/connect/connections/cost
    Estimate Connect Connection Update Cost
    PATCH/v1/networking/connect/connections/{connection_id}/cost

    NetworkingConnectRoutes

    List Connect Supported Routes
    GET/v1/networking/connect/routes

    RPC Nodes

    RPC NodesFlex

    Create RPC Node Flex
    POST/v1/rpc_nodes/flex
    Get RPC Node Flex Details
    GET/v1/rpc_nodes/flex/{node_id}
    Update RPC Node Flex
    PATCH/v1/rpc_nodes/flex/{node_id}
    Delete RPC Node Flex
    DELETE/v1/rpc_nodes/flex/{node_id}
    List RPC Node Flex
    GET/v1/rpc_nodes/flex

    RPC NodesFlexBlockchains

    List Flex Blockchains
    GET/v1/rpc_nodes/flex/blockchains

    RPC NodesDedicated

    Get RPC Node Dedicated Details
    GET/v1/rpc_nodes/dedicated/{node_id}
    List RPC Node Dedicated
    GET/v1/rpc_nodes/dedicated

    RPC NodesDedicatedBlockchains

    List Dedicated Blockchains
    GET/v1/rpc_nodes/dedicated/blockchains

    NKS

    NKSKubernetes Versions

    List NKS Kubernetes Versions
    GET/v1/nks/kubernetes_versions

    NKSClusters

    Create NKS Cluster
    POST/v1/nks/clusters
    Get NKS Cluster Details
    GET/v1/nks/clusters/{cluster_id}
    Update NKS Cluster
    PATCH/v1/nks/clusters/{cluster_id}
    Delete NKS Cluster
    DELETE/v1/nks/clusters/{cluster_id}
    List NKS Clusters
    GET/v1/nks/clusters

    NKSClustersAvailability

    Check Create NKS Cluster Availability
    POST/v1/nks/clusters/availability
    Check Update NKS Cluster Availability
    PATCH/v1/nks/clusters/{cluster_id}/availability

    NKSClustersCost

    Estimate NKS Cluster Create Cost
    POST/v1/nks/clusters/cost
    Estimate NKS Cluster Update Cost
    PATCH/v1/nks/clusters/{cluster_id}/cost

    NKSClustersPersistent Volume Claims

    Get NKS Persistent Volume Claim Details
    GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims/{persistent_volume_claim_id}
    List NKS Persistent Volume Claims
    GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims

    NKSClustersKubeconfig

    Get NKS Cluster Kubeconfig
    GET/v1/nks/clusters/{cluster_id}/kubeconfig

    NKSClustersControllers

    Get NKS Controller Details
    GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}
    List NKS Controllers
    GET/v1/nks/clusters/{cluster_id}/controllers

    NKSClustersControllersVolumes

    Get NKS Controller Volume Details
    GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes/{volume_id}
    List NKS Controller Volumes
    GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes

    NKSClustersLoad Balancers

    Get NKS Load Balancer Details
    GET/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}
    Update NKS Load Balancer
    PATCH/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}
    List NKS Load Balancers
    GET/v1/nks/clusters/{cluster_id}/load_balancers

    NKSClustersPools

    Create NKS Node Pool
    POST/v1/nks/clusters/{cluster_id}/pools
    Get NKS Node Pool Details
    GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}
    Update NKS Node Pool
    PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}
    Delete NKS Node Pool
    DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}
    List NKS Node Pools
    GET/v1/nks/clusters/{cluster_id}/pools

    NKSClustersPoolsAvailability

    Check Create NKS Node Pool Availability
    POST/v1/nks/clusters/{cluster_id}/pools/availability
    Check Update NKS Node Pool Availability
    PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}/availability

    NKSClustersPoolsCost

    Estimate NKS Node Pool Create Cost
    POST/v1/nks/clusters/{cluster_id}/pools/cost
    Estimate NKS Node Pool Update Cost
    PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}/cost

    NKSClustersPoolsNodes

    Get NKS Node Details
    GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}
    Delete NKS Node
    DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}
    List NKS Nodes
    GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes

    NKSClustersPoolsNodesVolumes

    Get NKS Node Volume Details
    GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes/{volume_id}
    List NKS Node Volumes
    GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes