object-storage-2

Create network

Creates a new service network by given {service_uuid}.

post/1.3/object-storage-2/{service-uuid}/networks

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/object-storage-2/{service-uuid}/networks
  • Auth: HTTP bearer

Path parameters

service-uuidstring uuid required

The unique identifier for the service.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

Request body

uuidstring uuid

Private network uuid. Omit for public networks.

namestring required

A resource name.

type'public' | 'private' required

Enum for the network type, indicating whether the network is public or private.

family'IPv4' | 'IPv6' required

Enum for the network family, indicating the type of IP address used.

Example request

{
  "name": "example-public-network",
  "type": "public",
  "family": "IPv4"
}

Response

Created

familystring
namestring
typestring
uuidstring uuid

Example response

{
  "family": "IPv4",
  "name": "example-private-network",
  "type": "private",
  "uuid": "03bec0ad-85c3-459e-824d-710f8f24f740"
}

Changes

No recorded changes to this operation across all 1 revision of this API.