Skip to main content
API docs by Redocly

Public Network API (v1.0)

Managing public network resources: public ports (ports with direct public IP addresses).

Public ports

Managing public ports: creating, listing, getting, updating, and deleting public ports.

List public ports

Returns a list of public ports.

Authorizations:
iam_token_project_scoped
query Parameters
network_id
string <uuid>

Filters ports by network identifier.

description
string

Filters ports by description.

subnet
string

Filters ports by network subnet CIDR.

Responses

Response samples

Content type
application/json
{
  • "ports": [
    ]
}

Create public port

Creates a new public port in a service network.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
description
string or null <= 5000 characters

Public port description.

admin_state_up
boolean
Default: true

Indicates whether the port administrative state is up.

security_group_ids
Array of strings <uuid> <= 20 items [ items <uuid > ]

List of security group identifiers to associate with the port. If not provided, the default security group is assigned.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "admin_state_up": true,
  • "security_group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "port": {
    }
}

Get public port

Returns a public port by its identifier.

Authorizations:
iam_token_project_scoped
path Parameters
port_id
required
string <uuid>

Public port identifier. This ID is the same as the corresponding OpenStack port ID.

Responses

Response samples

Content type
application/json
{
  • "port": {
    }
}

Update public port

Updates a public port by its identifier. Allows changing the administrative state of the port (enable or disable) and the list of security groups assigned to the port.

Authorizations:
iam_token_project_scoped
path Parameters
port_id
required
string <uuid>

Public port identifier. This ID is the same as the corresponding OpenStack port ID.

Request Body schema: application/json
required
description
string or null <= 5000 characters

Public port description.

admin_state_up
boolean

Indicates whether the port administrative state is up.

security_group_ids
Array of strings <uuid> [ 1 .. 20 ] items [ items <uuid > ]

List of security group identifiers to associate with the port.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "admin_state_up": true,
  • "security_group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "port": {
    }
}

Delete public port

Deletes a public port by its identifier.

Authorizations:
iam_token_project_scoped
path Parameters
port_id
required
string <uuid>

Public port identifier. This ID is the same as the corresponding OpenStack port ID.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "msg": "string"
}

Project quotas

Getting the quota for the network_direct_public_ips resource within a project.

Get project quotas

Returns quotas for direct public IP addresses for the project.

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string^[a-f0-9]{32}$
Example: df6f01408bef4878a2f32307684aa6f9

Project identifier in compact UUID format (no hyphens).

Responses

Response samples

Content type
application/json
{
  • "network_direct_public_ips": [
    ]
}