Skip to content

Public IPs

Addresses reachable from the Internet.

Paths are relative to your API address. See Authentication and Operations. Changes that answer 202 Accepted return an operation to follow.

Request and response examples are generated from the schema; the tables under Schemas are the reference.

Allocate a public IP

POST /v1/orgs/{org_id}/projects/{project_id}/floating-ips

Reserves a public IPv4 address in one location, optionally attached to an instance at once. It stays allocated, and counted in usage, until released. Accepted at once: follow the returned operation until it finishes.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
idempotency-key header string Yes
org_id path string No
project_id path string No

Request body

{
    "execute_before": "2022-04-13T15:42:05.901Z",
    "location": "string",
    "network_id": "string",
    "server_id": "string",
    "tags": {}
}

Responses

{
    "operation": {
        "href": "string",
        "id": "string",
        "state": "string"
    }
}

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Release a public IP

DELETE /v1/orgs/{org_id}/projects/{project_id}/floating-ips/{address_id}

Returns the address to the location. Accepted at once: follow the returned operation until it finishes.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
address_id path string No
idempotency-key header string Yes
org_id path string No
project_id path string No

Responses

{
    "operation": {
        "href": "string",
        "id": "string",
        "state": "string"
    }
}

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Attach a public IP

POST /v1/orgs/{org_id}/projects/{project_id}/floating-ips/{address_id}:associate

Points the address at an instance or load balancer in its location. Accepted at once: follow the returned operation until it finishes.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
address_id path string No
idempotency-key header string Yes
org_id path string No
project_id path string No

Request body

{
    "execute_before": "2022-04-13T15:42:05.901Z",
    "load_balancer_id": "string",
    "network_id": "string",
    "server_id": "string"
}

Responses

{
    "operation": {
        "href": "string",
        "id": "string",
        "state": "string"
    }
}

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Detach a public IP

POST /v1/orgs/{org_id}/projects/{project_id}/floating-ips/{address_id}:disassociate

Detaches the address; it stays allocated to the project. Accepted at once: follow the returned operation until it finishes.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
address_id path string No
idempotency-key header string Yes
org_id path string No
project_id path string No

Request body

{
    "execute_before": "2022-04-13T15:42:05.901Z"
}

Responses

{
    "operation": {
        "href": "string",
        "id": "string",
        "state": "string"
    }
}

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Set a public IP's tags

PUT /v1/orgs/{org_id}/projects/{project_id}/floating-ips/{resource_id}/tags

Replaces the public IP's tags with the whole set given and writes them to it in its location with the nx. prefix, keeping every tag set there without the prefix. Send the tags_version you read in If-Match: a set changed since is 412. Accepted at once: follow the returned operation until it finishes.

Input parameters

Parameter In Type Default Nullable Description
Authorization header string N/A No Bearer followed by a service account's API key. The console uses your signed-in session instead.
idempotency-key header string Yes
if-match header string Yes
org_id path string No
project_id path string No
resource_id path string No

Request body

{
    "execute_before": "2022-04-13T15:42:05.901Z",
    "tags": {}
}

Responses

{
    "operation": {
        "href": "string",
        "id": "string",
        "state": "string"
    }
}

{
    "detail": [
        {
            "ctx": {},
            "input": null,
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

Schemas

Accepted

Name Type Description
operation OperationLink

ActionBody

Name Type Description
execute_before string(date-time) | null

AddressBody

Name Type Description
execute_before string(date-time) | null
location string
network_id string | null
server_id string | null
tags Labels key: value NubeStack Cloud keeps and writes to the resource in its location as `nx.= (a volume's metadata key nx.), keeping its other tags. At most 20; a key is 1-32 of a-z, 0-9, _, ., -, starting with a letter; a value is 0-24 of A-Z, a-z, 0-9, _, ., :, -`. An organization uses at most 50 keys.

AssociateBody

Name Type Description
execute_before string(date-time) | null
load_balancer_id string | null
network_id string | null
server_id string | null

HTTPValidationError

Name Type Description
detail Array<ValidationError>
Name Type Description
href string Where to read the operation; also the Location header.
id string The operation's ID (op_…).
state string | null Its state when accepted, normally queued.

TagsBody

Name Type Description
execute_before string(date-time) | null
tags Labels key: value NubeStack Cloud keeps and writes to the resource in its location as `nx.= (a volume's metadata key nx.), keeping its other tags. At most 20; a key is 1-32 of a-z, 0-9, _, ., -, starting with a letter; a value is 0-24 of A-Z, a-z, 0-9, _, ., :, -`. An organization uses at most 50 keys.

ValidationError

Name Type Description
ctx
input
loc Array<>
msg string
type string