> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get VPC Network

## Request Headers

**Content-Type** `string` *required*

Enum: `application/json`

**Authorization** `string` *required*

Bearer authentication format, for example: Bearer \{\{API Key}}.

## Query Parameters

**networkId** `string` *required*

Cluster ID. String, length limit: 1-255 characters. Only one is supported.

## Response

**network** `object[]` *required*

VPC network information.

**properties**

**Id** `string` *required*

VPC network ID.

**user** `string` *required*

User account ID.

**name** `string` *required*

VPC network name.

**state** `object[]` *required*

VPC network status.

**properties**

**state** `string` *required*

VPC network status. Possible values:

* creating: Being created.
* ready: Successfully created.

**error** `string`

Error message if VPC network creation fails or the network is unavailable.

**segment** `string` *required*

VPC network segment.

**clusterId** `string` *required*

Cluster ID.

**Addresses** `object[]` *required*

Instance information under the VPC network.

**properties**

**Id** `string` *required*

Instance ID.

**Ip** `string` *required*

Instance IP address.

**createTime** `string` *required*

VPC network creation time. Format: Unix timestamp.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.