Get network

curl --request GET \
  --url https://api.example.com/api/v2/networks/{networkID} \
  --header 'Authorization: Bearer <token>'

{
  "metadata": {
    "id": "a64f9269-36e0-4312-b8d1-52d93d569b7b",
    "name": "my-network",
    "organizationId": "9a8c6370-4065-4d4a-9da0-7678df40cd9d",
    "projectId": "e36c058a-8eba-4f5b-91f4-f6ffb983795c",
    "creationTime": "2024-05-31T14:11:00Z",
    "createdBy": "[email protected]",
    "provisioningStatus": "provisioned",
    "healthStatus": "healthy"
  },
  "spec": {
    "dnsNameservers": [
      "8.8.8.8"
    ]
  },
  "status": {
    "regionId": "d891dbf0-0a01-4efc-ae3a-5d77f6d3424b",
    "prefix": "192.168.0.0/24"
  }
}

GET

api

networks

{networkID}

Get network

curl --request GET \
  --url https://api.example.com/api/v2/networks/{networkID} \
  --header 'Authorization: Bearer <token>'

{
  "metadata": {
    "id": "a64f9269-36e0-4312-b8d1-52d93d569b7b",
    "name": "my-network",
    "organizationId": "9a8c6370-4065-4d4a-9da0-7678df40cd9d",
    "projectId": "e36c058a-8eba-4f5b-91f4-f6ffb983795c",
    "creationTime": "2024-05-31T14:11:00Z",
    "createdBy": "[email protected]",
    "provisioningStatus": "provisioned",
    "healthStatus": "healthy"
  },
  "spec": {
    "dnsNameservers": [
      "8.8.8.8"
    ]
  },
  "status": {
    "regionId": "d891dbf0-0a01-4efc-ae3a-5d77f6d3424b",
    "prefix": "192.168.0.0/24"
  }
}

Authorizations

Authorization

string

header

required

Operation requires OAuth 2.0 bearer token authentication.

Path Parameters

networkID

string

required

The network ID. A Kubernetes name. Must be a valid DNS containing only lower case characters, numbers or hyphens, start and end with a character or number, and be at most 63 characters in length.

Required string length: 1 - 63

Response

A layer 3 network.

A network.

metadata

object

required

Metadata required by project scoped resource reads.

Show child attributes

metadata.name

string

required

A valid Kubernetes label value, typically used for resource names that can be indexed in the database.

metadata.id

string

required

The unique resource ID.

metadata.creationTime

string<date-time>

required

The time the resource was created.

metadata.provisioningStatus

enum<string>

required

The provisioning state of a resource.

Available options:

unknown,

provisioning,

provisioned,

deprovisioning,

error

metadata.healthStatus

enum<string>

required

The health state of a resource.

Available options:

unknown,

healthy,

degraded,

error

metadata.organizationId

string

required

The organization identifier the resource belongs to.

metadata.projectId

string

required

The project identifier the resource belongs to.

metadata.description

string

The resource description, this optionally augments the name with more context.

metadata.tags

object[]

A list of tags.

Show child attributes

metadata.tags.name

string

required

A unique tag name.

metadata.tags.value

string

required

The value of the tag.

metadata.createdBy

string

The user who created the resource.

metadata.modifiedTime

string<date-time>

The time a resource was updated.

metadata.modifiedBy

string

The user who updated the resource.

metadata.deletionTime

string<date-time>

The time the resource was deleted.

spec

object

required

A network's specification.

Show child attributes

spec.dnsNameservers

string<ipv4>[]

required

A list of IPv4 addresses.

An IPv4 address.

spec.routes

object[]

A list of network routes.

Show child attributes

spec.routes.prefix

string

required

An IPv4 prefix for the route.

spec.routes.nexthop

string

required

An IPv4 address for the route's next hop.

status

object

required

Read only status about a network.

Show child attributes

status.regionId

string

required

The region a network is provisioned in.

status.prefix

string

required

An IPv4 prefix for the network.

Create network Update network

⌘I

Serverless Inference

Fine Tuning

Compute

Networking and Storage

Organization

Get network

Authorizations

Path Parameters

Response