How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UpCloud Ip Address API

The UpCloud network has public and private IP addresses.Public IP addresses are used to connect to the server from the Internet.Private Utility network addresses are available for all servers within asingle account, and can communicate with each other globally as longas the servers have the utility network interfaces configured. This isadded to servers by default.A server has a minimum of zero and a maximum of five public IPv4 and IPv6addresses. Every server can have one utility network IPv4 address only,and must have at least one IP address. The UpCloud API assigns the IP addressesautomatically in networks configured to use DHCP. IP addresses cannot bereserved for later use, except for floating IPs that can be reserved andswitched from server to another freely within their specific zone.The operating system running on the server will see a separate network interfaceper IP address. On a typical server, there are three network interfaces. Thefirst network interface is assigned to the public network and the second to theUtility network. If the server has an IPv6 address configured it will use thethird network interface. DHCP service is provided on all public IPv4 networkinterfaces and all private DHCP-enabled networks for automatic configurationof the correct IP address. IPv6 network interfaces should use statelessaddress autoconfiguration (SLAAC) with IPv6 privacy extensions disabled.On IPv6-only server DNS parameters can be obtained with stateless DHCPv6.Additionally, there are floating IPs: IPv4 addresses that can beattached to any IPv4 interface in their specific zone (eg. de-fra1 or fi-hel2).Floating IP addresses can be instantly switched from one server to another whendoing maintenance or dealing with technical issues. More information on floatingIPs and their configuration can be found from [our tutorials](https://upcloud.com/community/tutorials/floating-ip-addresses/).## Release policyThe release policy defines what happens to an IP address when its dependent resource is deleted, such as a server or service it's attached to. The following values are supported:`release`: The address is also deleted. This applies to both normal and floating IP addresses.`keep`: For normal (non-floating) IP addresses, they are converted to detached floating IPs when their dependent resource is deleted. For floating IP addresses, they remain as detached floating IPs that can be reattached elsewhere.Floating IP addresses are created with `keep` as default policy, ensuring they remain available even after dependency deletion.The release policy can be set when creating a new IP address or modified for an existing one through the API.Note that release policy functionality is currently only supported for public IPv4 addresses.## Service delegationAssign existing Floating IPv4 addresses to a service instead of a server. This enables the service to manage the IP address and use your dedicated floating IP address in the service's DNS records.Delegated IP addresses can be tracked with the `is_delegated` attribute in the API response.When an IP address is delegated to a service, it becomes subject to specific access restrictions. The IP address becomes managed by the service until you explicitly remove it. During the delegation: * You cannot delete the IP address.* You cannot modify its MAC address.* You can only update the release policy and PTR record.These restrictions ensure service stability and are automatically lifted once the IP address is removed from the service and as long as the release policy is set to `keep` so the IP address remains available in your account.Currently only Load Balancer supports IP address delegation.

UpCloud Ip Address API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

7 operations 3 paths 20 schemas 1 DELETE2 GET2 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

UpCloud Ip Address API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ip_address 7

The UpCloud network has public and private IP addresses.

GET
/1.3/ip_address
List IP addresses
listIPAddresses → 200default
POST
/1.3/ip_address
Add an IP address
addIPAddress body → 201409default
PATCH
/1.3/ip_address/bulk
Bulk modify IP addresses
bulkModifyIPAddresses body → 204default
GET
/1.3/ip_address/{address}
Get IP address
getIPAddressDetails 1 param → 200default
PUT
/1.3/ip_address/{address}
Modify IP address
modifyIPAddress 1 param body → 202default
DELETE
/1.3/ip_address/{address}
Delete IP address
deleteIPAddress 1 param → 204default
PATCH
/1.3/ip_address/{address}
Modify an IP address
patchModifyIPAddress 1 param body → 202default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ipAddressDetails (12 properties), patchIpAddressRequestV1.3 (1 property), modifyIpAddressRequestV1.0 (1 property), addIpAddressRequest (1 property). Each schema is shown below with its type and property counts.

ipAddressZone
string
Zone identifier
patchIpAddressRequestV1.3
object
Request schema for modifying an IP address
1 property 1 required
ipAddress
IP address
ipAddressError
object
A general error response indicating that the request could not be fulfilled due to a technical issue.
1 property 1 required
ipAddressIpReleasePolicy
string
Action taken when the resource using the address is deleted: release deletes the address, while keep preserves it as a detached floating IP address
ipAddressAccountId
integer
Unique numeric identifier of an account.
ipAddressIpFamily
string
IP address family
ipAddressMacAddress
string
MAC address
ipAddressUuid
string
Universally unique identifier
ipAddressesResponse
object
Request schema for IP address operations
1 property 1 required
bulkPatchIpAddressesRequestV1.3
object
Request schema for bulk patching IP addresses
1 property 1 required
ipAddressBooleanYesno
string
Boolean value represented as yes/no
ipAddressRequest
object
Request schema for IP address operations
1 property 1 required
ipAddressPtrRecord
string
ipAddressNetworkType
string
Network access type
ipAddressDetails
object
Details of an IP address
12 properties 2 required
ipAddressResponse
object
Request schema for IP address operations
1 property 1 required
addIpAddressRequest
object
Schema for adding an IP address to a server
1 property 1 required
modifyIpAddressRequestV1.0
object
Request schema for modifying an IP address
1 property 1 required
ipAddressDelegatedToAccountId
integernull
Attached to a resource that is delegated to another account. Null means not delegated.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-ip-address-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
UpCloud Account Tokens API
UpCloud Audit Logs API
UpCloud Currency API
UpCloud Database API
UpCloud Device API
UpCloud Events API
UpCloud File Storage API
UpCloud Firewall Ruleset API
UpCloud Gateway API
UpCloud Kubernetes API
UpCloud Load Balancer API
Where this information came from

This is an independent, third-party profile of UpCloud Ip Address API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.