Documentation

Networks

networks

Methods

Create Network -> { tasks }
post/v1/networks/{project_id}/{region_id}

Create network

Delete Network -> { tasks }
delete/v1/networks/{project_id}/{region_id}/{network_id}

Delete network

List Networks -> OffsetPage<
Network
>
get/v1/networks/{project_id}/{region_id}

List networks

List Networks With Subnets Details -> OffsetPage<{ id, created_at, external, 15 more... }>
get/v1/availablenetworks/{project_id}/{region_id}

Retrieve the list of directly-attachable networks with subnet details. Returned entities may or may not be owned by the project

List Of Instance Ports By Network ID -> Array<{ id, instance_id, instance_name }>
get/v1/networks/{project_id}/{region_id}/{network_id}/ports

List of instance ports by network_id

Get Network ->
Network
get/v1/networks/{project_id}/{region_id}/{network_id}

Get network

Change Network Name ->
Network
patch/v1/networks/{project_id}/{region_id}/{network_id}

Change network name

Domain types

Network = { id, created_at, external, 15 more... }
Networks

Metadata

networks.metadata

Methods

Create Or Update Network Metadata ->
post/v1/networks/{project_id}/{region_id}/{network_id}/metadata

Create or update one or more metadata items for a network. If an item does not exist, it gets created. If an item already exists, it's value is overwritten

List Network Metadata -> { count, results }
get/v1/networks/{project_id}/{region_id}/{network_id}/metadata

Lists all metadata for a network

Replace Network Metadata ->
put/v1/networks/{project_id}/{region_id}/{network_id}/metadata

All existing metadata is deleted and replaced with the metadata from the request.

Networks

Metadata Item

networks.metadata_item

Methods

Delete Network Metadata Item By Key ->
delete/v1/networks/{project_id}/{region_id}/{network_id}/metadata_item

Delete network metadata item by key

Get Network Metadata Item By Key -> { key, read_only, value }
get/v1/networks/{project_id}/{region_id}/{network_id}/metadata_item

Get network metadata item by key

Parameters
project_id: number
region_id: number
network_id: string
key: string
Optional

Meta key

Response fields
key: string

Metadata item key. Maximum size is 255 bytes.

read_only: boolean

Flag that shows if metadata item can be modified or not

value: string

Metadata item value. Maximum size is 1024 bytes.

Request example
200Example