Projects

Create Project

client.projects.create(, ?): Project { id, created_at, name, 3 more }

POST/v1/projects

Get Project Details

client.projects.get(, ?): Project { id, created_at, name, 3 more }

GET/v1/projects/{project_id}

Update Project

client.projects.update(, , ?): Project { id, created_at, name, 3 more }

PATCH/v1/projects/{project_id}

Delete Project

client.projects.delete(, ?): void

DELETE/v1/projects/{project_id}

List Projects

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

GET/v1/projects

ModelsExpand 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

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.

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.

ProjectList { items, pagination }

items: Array<Project { id, created_at, name, 3 more } >

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

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string | null

previous_cursor: string | null

total_count: number

minimum0

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.