Network¶

Version:

2.0

None

extensions¶

GET

/v2.0/extensions

List extensions

Lists available extensions.

Lists available Networking API v2.0 extensions and shows details for an extension.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

GET

/v2.0/extensions/{id}

Show extension details

Shows details for an extension, by alias. The response shows the extension name and its alias. To show details for an extension, you specify the alias.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
extension	body	object	An `extension` object.
extension.alias	body	string	The alias for the extension. For example “quotas” or “security-group”.
extension.description	body	string	The human-readable description for the resource.
extension.name	body	string	Human-readable name of the resource.
extension.namespace	body	string	A URL pointing to the namespace for this extension.
extension.updated	body	string	The date and timestamp when the extension was last updated.

address-groups¶

GET

/v2.0/address-groups

List address groups

Lists address groups that the project has access to.

Default policy settings return only the address groups owned by the project of the user submitting the request, unless the user has administrative role.

Use the fields query parameter to control which fields are returned in the response body. Additionally, you can filter results by using query string parameters. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/address-groups

Create address group

Creates an address group.

Normal response codes: 201

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
address_group	body	object	An `address group` object.
address_group.name	body	string	Human-readable name of the resource. Default is an empty string.
address_group.description	body	string	A human-readable description for the resource.
address_group.project_id	body	string

Schema

{
  "type": "object",
  "description": "Request of the address-groups:post operation",
  "properties": {
    "address_group": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 1024,
          "description": "A human-readable description for the resource."
        },
        "project_id": {
          "type": "string",
          "maxLength": 255
        },
        "addresses": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "A list of IP addresses."
        }
      },
      "description": "An `address group` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
address_group	body	object	An `address group` object.
address_group.id	body	string	The ID of the address group.
address_group.name	body	string	Human-readable name of the resource.
address_group.description	body	string	A human-readable description for the resource.
address_group.project_id	body	string	The ID of the project.

PUT

/v2.0/address-groups/{id}/add_addresses

Request of the address-groups/id/add_addresses:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/address-groups/{id} API

Schema

{
  "type": "object",
  "description": "Request of the address-groups/id/add_addresses:put operation"
}

Responses¶

200¶

PUT

/v2.0/address-groups/{id}/remove_addresses

Request of the address-groups/id/remove_addresses:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/address-groups/{id} API

Schema

{
  "type": "object",
  "description": "Request of the address-groups/id/remove_addresses:put operation"
}

Responses¶

200¶

GET

/v2.0/address-groups/{id}

Show address group

Shows information for an address group.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
address_group	body	object	An `address group` object.
address_group.id	body	string	The ID of the address group.
address_group.name	body	string	Human-readable name of the resource.
address_group.description	body	string	A human-readable description for the resource.
address_group.project_id	body	string	The ID of the project.

PUT

/v2.0/address-groups/{id}

Update an address group

Updates an address group.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/address-groups/{id} API
address_group	body	object	An `address group` object.
address_group.name	body	string	Human-readable name of the resource. Default is an empty string.
address_group.description	body	string	A human-readable description for the resource.

Schema

{
  "type": "object",
  "description": "Request of the address-groups/id:put operation",
  "properties": {
    "address_group": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 1024,
          "description": "A human-readable description for the resource."
        }
      },
      "description": "An `address group` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
address_group	body	object	An `address group` object.
address_group.id	body	string	The ID of the address group.
address_group.name	body	string	Human-readable name of the resource.
address_group.description	body	string	A human-readable description for the resource.
address_group.project_id	body	string	The ID of the project.

DELETE

/v2.0/address-groups/{id}

Delete an address group

Deletes an address group.

Normal response codes: 204

Error response codes: 401, 404, 412

Responses¶

204¶

address-scopes¶

GET

/v2.0/address-scopes

List address scopes

Lists address scopes that the project has access to.

Default policy settings return only the address scopes owned by the project of the user submitting the request, unless the user has administrative role.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/address-scopes

Create address scope

Creates an address scope.

Normal response codes: 201

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
address_scope	body	object	An `address scope` object.
address_scope.name	body	string	Human-readable name of the resource. Default is an empty string.
address_scope.tenant_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
address_scope.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.
address_scope.ip_version	body	integer	The IP protocol version. Valid value is `4` or `6`.

Schema

{
  "type": "object",
  "description": "Request of the address-scopes:post operation",
  "properties": {
    "address_scope": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this resource is shared across all projects.\nBy default, only administrative users can change this value."
        },
        "ip_version": {
          "type": "integer",
          "enum": [
            4,
            6
          ],
          "description": "The IP protocol version. Valid value is `4` or `6`."
        }
      },
      "description": "An `address scope` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
address_scope	body	object	An `address scope` object.
address_scope.id	body	string	The ID of the address scope.
address_scope.name	body	string	Human-readable name of the resource.
address_scope.tenant_id	body	string	The ID of the project.
address_scope.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects.
address_scope.ip_version	body	integer	The IP protocol version. Valid value is `4` or `6`. Default is `4`.

GET

/v2.0/address-scopes/{id}

Show address scope

Shows information for an address scope.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
address_scope	body	object	An `address scope` object.
address_scope.id	body	string	The ID of the address scope.
address_scope.name	body	string	Human-readable name of the resource.
address_scope.tenant_id	body	string	The ID of the project.
address_scope.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects.
address_scope.ip_version	body	integer	The IP protocol version. Valid value is `4` or `6`. Default is `4`.

PUT

/v2.0/address-scopes/{id}

Update an address scope

Updates an address scope.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/address-scopes/{id} API
address_scope	body	object	An `address scope` object.
address_scope.name	body	string	Human-readable name of the resource. Default is an empty string.
address_scope.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.

Schema

{
  "type": "object",
  "description": "Request of the address-scopes/id:put operation",
  "properties": {
    "address_scope": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this resource is shared across all projects.\nBy default, only administrative users can change this value."
        }
      },
      "description": "An `address scope` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
address_scope	body	object	An `address scope` object.
address_scope.id	body	string	The ID of the address scope.
address_scope.name	body	string	Human-readable name of the resource.
address_scope.tenant_id	body	string	The ID of the project.
address_scope.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects.
address_scope.ip_version	body	integer	The IP protocol version. Valid value is `4` or `6`. Default is `4`.

DELETE

/v2.0/address-scopes/{id}

Delete an address scope

Deletes an address scope.

Normal response codes: 204

Error response codes: 401, 404, 412

Responses¶

204¶

networking-agents¶

Lists, shows details for, updates, and deletes agents.

GET

/v2.0/agents

List all agents

Shows details for an agent.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/agents

Request of the agents:post operation

Request¶

Description

Name

Location

Type

Description

agent

body

object

Schema

{
  "type": "object",
  "description": "Request of the agents:post operation",
  "properties": {
    "agent": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
agent	body	object
agent.id	body	string
agent.agent_type	body	string
agent.binary	body	string
agent.topic	body	string
agent.host	body	string
agent.admin_state_up	body	[‘string’, ‘boolean’]
agent.created_at	body	string
agent.started_at	body	string
agent.heartbeat_timestamp	body	string
agent.alive	body	string
agent.configurations	body	string
agent.description	body	[‘string’, ‘null’]
agent.resources_synced	body	string
agent.availability_zone	body	string

GET

/v2.0/agents/{id}

Show agent details

Shows details for an agent.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
agent	body	object	An `agent` object.
agent.id	body	string	The ID of the resource.
agent.agent_type	body	string	The type of agent such as `Open vSwitch agent` or `DHCP agent`.
agent.binary	body	string	The executable command used to start the agent such as `neutron-openvswitch-agent` or `neutron-dhcp-agent`.
agent.topic	body	string	The name of AMQP topic the agent is listening on such as `dhcp_agent`. A special value of `N/A` is used when the agent doesn’t use an AMQP topic.
agent.host	body	string	The hostname of the system the agent is running on.
agent.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
agent.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
agent.started_at	body	string	Time at which the agent was started.
agent.heartbeat_timestamp	body	string	Time at which the last heartbeat was received.
agent.alive	body	string	Indicates the agent is alive and running.
agent.configurations	body	string	An object containing configuration specific key/value pairs; the semantics of which are determined by the binary name and type.
agent.description	body	[‘string’, ‘null’]	A human-readable description for the resource.
agent.resources_synced	body	string	The value `null` means no resource view synchronization to Placement was attempted. `true` / `false` values signify the success of the last synchronization attempt. Therefore the relevant resources in Placement can only be considered up to date if this attribute is `true`. This attribute is read-only, it is only supposed to be updated internally, but it is readable for debugging purposes. Not all agent types track resources via Placement, therefore the value `null` does not necessarily means there is an error in the system.
agent.availability_zone	body	string	The availability zone of the agent.

PUT

/v2.0/agents/{id}

Update agent

Updates an agent.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/agents/{id} API
agent	body	object
agent.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
agent.description	body	[‘string’, ‘null’]	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the agents/id:put operation",
  "properties": {
    "agent": {
      "type": "object",
      "properties": {
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`).\nDefault is `true`."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
agent	body	object	An `agent` object.
agent.id	body	string	The ID of the resource.
agent.agent_type	body	string	The type of agent such as `Open vSwitch agent` or `DHCP agent`.
agent.binary	body	string	The executable command used to start the agent such as `neutron-openvswitch-agent` or `neutron-dhcp-agent`.
agent.topic	body	string	The name of AMQP topic the agent is listening on such as `dhcp_agent`. A special value of `N/A` is used when the agent doesn’t use an AMQP topic.
agent.host	body	string	The hostname of the system the agent is running on.
agent.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
agent.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
agent.started_at	body	string	Time at which the agent was started.
agent.heartbeat_timestamp	body	string	Time at which the last heartbeat was received.
agent.alive	body	string	Indicates the agent is alive and running.
agent.configurations	body	string	An object containing configuration specific key/value pairs; the semantics of which are determined by the binary name and type.
agent.description	body	[‘string’, ‘null’]	A human-readable description for the resource.
agent.resources_synced	body	string	The value `null` means no resource view synchronization to Placement was attempted. `true` / `false` values signify the success of the last synchronization attempt. Therefore the relevant resources in Placement can only be considered up to date if this attribute is `true`. This attribute is read-only, it is only supposed to be updated internally, but it is readable for debugging purposes. Not all agent types track resources via Placement, therefore the value `null` does not necessarily means there is an error in the system.
agent.availability_zone	body	string	The availability zone of the agent.

DELETE

/v2.0/agents/{id}

Delete agent

Agents that won’t be used anymore can be removed. Before deleting agents via API, the agent should be stopped/disabled.

Normal response codes: 204

Error response codes: 401, 404, 409

Responses¶

204¶

GET

/v2.0/agents/{agent_id}/l3-routers

List routers hosted by an L3 agent

Lists routers that an l3 agent hosts.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

POST

/v2.0/agents/{agent_id}/l3-routers

Schedule router to an l3 agent

Add a router to an l3 agent.

Normal response codes: 201

Error response codes: 400, 401, 404

Request¶

Description

Name

Location

Type

Description

agent_id

path

string

agent_id parameter for /v2.0/agents/{agent_id}/l3-routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the agents/agent_id/l3-routers:post operation"
}

Responses¶

201¶

GET

/v2.0/agents/{agent_id}/l3-routers/{id}

Responses¶

200¶

PUT

/v2.0/agents/{agent_id}/l3-routers/{id}

Request of the agents/agent_id/l3-routers/id:put operation

Request¶

Description

Name	Location	Type	Description
agent_id	path	string	agent_id parameter for /v2.0/agents/{agent_id}/l3-routers/{id} API
id	path	string	id parameter for /v2.0/agents/{agent_id}/l3-routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the agents/agent_id/l3-routers/id:put operation"
}

Responses¶

200¶

DELETE

/v2.0/agents/{agent_id}/l3-routers/{id}

Remove l3 router from an l3 agent

Removes a router from an l3 agent.

Normal response codes: 204

Error response codes: 401, 404

Responses¶

204¶

auto-allocated-topology¶

GET

/v2.0/auto-allocated-topology

Responses¶

200¶

POST

/v2.0/auto-allocated-topology

Request of the auto-allocated-topology:post operation

Request¶

Description

Name

Location

Type

Description

auto_allocated_topology

body

object

Schema

{
  "type": "object",
  "description": "Request of the auto-allocated-topology:post operation",
  "properties": {
    "auto_allocated_topology": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
auto_allocated_topology	body	object
auto_allocated_topology.id	body	string
auto_allocated_topology.tenant_id	body	string

GET

/v2.0/auto-allocated-topology/{id}

Show auto allocated topology details

Shows details for an auto allocated topology.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
auto_allocated_topology	body	object
auto_allocated_topology.id	body	string	The ID of the network for the auto allocated topology.
auto_allocated_topology.tenant_id	body	string	The ID of the project owning the auto allocated topology.

PUT

/v2.0/auto-allocated-topology/{id}

Request of the auto-allocated-topology/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/auto-allocated-topology/{id} API

auto_allocated_topology

body

object

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/auto-allocated-topology/{id} API
auto_allocated_topology	body	object

Schema

{
  "type": "object",
  "description": "Request of the auto-allocated-topology/id:put operation",
  "properties": {
    "auto_allocated_topology": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
auto_allocated_topology	body	object
auto_allocated_topology.id	body	string
auto_allocated_topology.tenant_id	body	string

DELETE

/v2.0/auto-allocated-topology/{id}

Delete the auto allocated topology

Deletes the auto allocated topology.

Normal response codes: 204

Error response codes: 401, 403, 404

Responses¶

204¶

availability_zones¶

GET

/v2.0/availability_zones

List all availability zones

Lists all availability zones.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

dhcp-agent-scheduler¶

GET

/v2.0/agents/{agent_id}/dhcp-networks

List networks hosted by a DHCP agent

Lists networks that a DHCP agent hosts.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

POST

/v2.0/agents/{agent_id}/dhcp-networks

Schedule a network to a DHCP agent

Add a network to a DHCP agent

Normal response codes: 201

Error response codes: 400, 403, 409, 404

Request¶

Description

Name

Location

Type

Description

agent_id

path

string

agent_id parameter for /v2.0/agents/{agent_id}/l3-routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the agents/agent_id/dhcp-networks:post operation"
}

Responses¶

201¶

GET

/v2.0/agents/{agent_id}/dhcp-networks/{id}

Responses¶

200¶

PUT

/v2.0/agents/{agent_id}/dhcp-networks/{id}

Request of the agents/agent_id/dhcp-networks/id:put operation

Request¶

Description

Name	Location	Type	Description
agent_id	path	string	agent_id parameter for /v2.0/agents/{agent_id}/l3-routers/{id} API
id	path	string	id parameter for /v2.0/agents/{agent_id}/dhcp-networks/{id} API

Schema

{
  "type": "object",
  "description": "Request of the agents/agent_id/dhcp-networks/id:put operation"
}

Responses¶

200¶

DELETE

/v2.0/agents/{agent_id}/dhcp-networks/{id}

Remove network from a DHCP agent

Removes a network from a dhcp agent.

Normal response codes: 204

Error response codes: 401, 403, 404, 409

Responses¶

204¶

networks¶

GET

/v2.0/networks/{network_id}/dhcp-agents

List DHCP agents hosting a network

Lists DHCP agents hosting a network.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

POST

/v2.0/networks/{network_id}/dhcp-agents

Request of the networks/network_id/dhcp-agents:post operation

Request¶

Description

Name

Location

Type

Description

network_id

path

string

network_id parameter for /v2.0/networks/{network_id} API

Schema

{
  "type": "object",
  "description": "Request of the networks/network_id/dhcp-agents:post operation"
}

Responses¶

201¶

GET

/v2.0/networks/{network_id}/dhcp-agents/{id}

Responses¶

200¶

PUT

/v2.0/networks/{network_id}/dhcp-agents/{id}

Request of the networks/network_id/dhcp-agents/id:put operation

Request¶

Description

Name

Location

Type

Description

network_id

path

string

network_id parameter for /v2.0/networks/{network_id} API

id

path

string

id parameter for /v2.0/networks/{network_id}/dhcp-agents/{id} API

Schema

{
  "type": "object",
  "description": "Request of the networks/network_id/dhcp-agents/id:put operation"
}

Responses¶

200¶

DELETE

/v2.0/networks/{network_id}/dhcp-agents/{id}

Responses¶

204¶

GET

/v2.0/networks/{network_id}/tags

Responses¶

200¶

PUT

/v2.0/networks/{network_id}/tags

Request of the networks/network_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

network_id

path

string

network_id parameter for /v2.0/networks/{network_id} API

Schema

{
  "type": "object",
  "description": "Request of the networks/network_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/networks/{network_id}/tags

Responses¶

204¶

GET

/v2.0/networks/{network_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/networks/{network_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/networks/{network_id}/tags/{id}

Responses¶

204¶

GET

/v2.0/networks

List networks

Lists networks to which the project has access.

Default policy settings return only networks that the project who submits the request owns, unless an administrative user submits the request. In addition, networks shared with the project who submits the request are also returned.

You can also use the tags, tags-any, not-tags, not-tags-any query parameter to filter the response with tags. For information, see REST API Impact.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/networks

Create network

Creates a network.

A request body is optional. An administrative user can specify another project ID, which is the project that owns the network, in the request body.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
network	body	object	A `network` object.
network.name	body	string	Human-readable name of the network.
network.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the network, which is up (`true`) or down (`false`).
network.tenant_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
network.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.
network.router:external	body	[‘string’, ‘boolean’]	Indicates whether the network has an external routing facility that’s not managed by the networking service.
network.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
network.ha	body	[‘string’, ‘boolean’]
network.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status of the network. Valid values are enabled (`true`) and disabled (`false`). This value is used as the default value of `port_security_enabled` field of a newly created port.
network.provider:network_type	body	string
network.provider:physical_network	body	string
network.provider:segmentation_id	body	[‘string’, ‘integer’]
network.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the network.
network.is_default	body	[‘string’, ‘boolean’]	The network is default or not.
network.dns_domain	body	string	A valid DNS domain.
network.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the networks:post operation",
  "properties": {
    "network": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the network."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the network, which is\nup (`true`) or down (`false`)."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this resource is shared across all projects.\nBy default, only administrative users can change this value."
        },
        "router:external": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether the network has an external routing facility that\u2019s not\nmanaged by the networking service."
        },
        "segments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "provider:segmentation_id": {
                "type": "integer",
                "description": "The ID of the isolated segment on the physical network.\nThe `network_type` attribute defines the segmentation model.\nFor example, if the `network_type` value is vlan, this ID is a vlan\nidentifier. If the `network_type` value is gre, this ID is a gre key."
              },
              "provider:physical_network": {
                "type": "string",
                "description": "The physical network where this network should be implemented.\nThe Networking API v2.0 does not provide a way to list available\nphysical networks. For example, the Open vSwitch plug-in configuration\nfile defines a symbolic name that maps to specific bridges on each\ncompute host."
              },
              "provider:network_type": {
                "type": "string",
                "description": "The type of physical network that this network should be mapped to.\nFor example, `flat`, `vlan`, `vxlan`, or `gre`.\nValid values depend on a networking back-end."
              }
            }
          },
          "description": "A list of provider `segment` objects."
        },
        "mtu": {
          "type": "integer",
          "minimum": 0,
          "description": "The maximum transmission unit (MTU) value to\naddress fragmentation. Minimum value is 68 for IPv4, and 1280 for\nIPv6."
        },
        "availability_zone_hints": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The availability zone candidate for the network."
        },
        "ha": {
          "type": [
            "string",
            "boolean"
          ]
        },
        "port_security_enabled": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The port security status of the network. Valid values are\nenabled (`true`) and disabled (`false`).\nThis value is used as the default value of `port_security_enabled`\nfield of a newly created port."
        },
        "provider:network_type": {
          "type": "string",
          "maxLength": 32
        },
        "provider:physical_network": {
          "type": "string",
          "maxLength": 64
        },
        "provider:segmentation_id": {
          "type": [
            "string",
            "integer"
          ]
        },
        "qos_policy_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of the QoS policy associated with the network."
        },
        "is_default": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The network is default or not."
        },
        "dns_domain": {
          "type": "string",
          "format": "hostname",
          "maxLength": 255,
          "description": "A valid DNS domain."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `network` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
network	body	object	A `network` object.
network.id	body	string	The ID of the network.
network.name	body	string	Human-readable name of the network.
network.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the network, which is up (`true`) or down (`false`).
network.status	body	string	The network status. Values are `ACTIVE`, `DOWN`, `BUILD` or `ERROR`.
network.tenant_id	body	string	The ID of the project.
network.shared	body	[‘string’, ‘boolean’]	Indicates whether this network is shared across all tenants. By default, only administrative users can change this value.
network.ipv4_address_scope	body	string	The ID of the IPv4 address scope that the network is associated with.
network.ipv6_address_scope	body	string	The ID of the IPv6 address scope that the network is associated with.
network.router:external	body	[‘string’, ‘boolean’]	Defines whether the network may be used for creation of floating IPs. Only networks with this flag may be an external gateway for routers. The network must have an external routing facility that is not managed by the networking service. If the network is updated from external to internal the unused floating IPs of this network are automatically deleted when extension `floatingip-autodelete-internal` is present.
network.l2_adjacency	body	string	Indicates whether L2 connectivity is available throughout the `network`.
network.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
network.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status of the network. Valid values are enabled (`true`) and disabled (`false`). This value is used as the default value of `port_security_enabled` field of a newly created port.
network.provider:network_type	body	string
network.provider:physical_network	body	string
network.provider:segmentation_id	body	[‘string’, ‘integer’]
network.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the network.
network.revision_number	body	integer	The revision number of the resource.
network.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
network.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
network.is_default	body	[‘string’, ‘boolean’]	The network is default pool or not.
network.dns_domain	body	string	A valid DNS domain.
network.description	body	string	A human-readable description for the resource.

GET

/v2.0/networks/{network_id}

Show network details

Shows details for a network.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
network	body	object	A `network` object.
network.id	body	string	The ID of the network.
network.name	body	string	Human-readable name of the network.
network.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the network, which is up (`true`) or down (`false`).
network.status	body	string	The network status. Values are `ACTIVE`, `DOWN`, `BUILD` or `ERROR`.
network.tenant_id	body	string	The ID of the project.
network.shared	body	[‘string’, ‘boolean’]	Indicates whether this network is shared across all tenants. By default, only administrative users can change this value.
network.ipv4_address_scope	body	string	The ID of the IPv4 address scope that the network is associated with.
network.ipv6_address_scope	body	string	The ID of the IPv6 address scope that the network is associated with.
network.router:external	body	[‘string’, ‘boolean’]	Defines whether the network may be used for creation of floating IPs. Only networks with this flag may be an external gateway for routers. The network must have an external routing facility that is not managed by the networking service. If the network is updated from external to internal the unused floating IPs of this network are automatically deleted when extension `floatingip-autodelete-internal` is present.
network.l2_adjacency	body	string	Indicates whether L2 connectivity is available throughout the `network`.
network.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
network.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status of the network. Valid values are enabled (`true`) and disabled (`false`). This value is used as the default value of `port_security_enabled` field of a newly created port.
network.provider:network_type	body	string
network.provider:physical_network	body	string
network.provider:segmentation_id	body	[‘string’, ‘integer’]
network.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the network.
network.revision_number	body	integer	The revision number of the resource.
network.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
network.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
network.is_default	body	[‘string’, ‘boolean’]	The network is default pool or not.
network.dns_domain	body	string	A valid DNS domain.
network.description	body	string	A human-readable description for the resource.

PUT

/v2.0/networks/{network_id}

Update network

Updates a network.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 412

Request¶

Description

Name	Location	Type	Description
network_id	path	string	network_id parameter for /v2.0/networks/{network_id} API
network	body	object	A `network` object.
network.name	body	string	Human-readable name of the network.
network.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the network, which is up (`true`) or down (`false`).
network.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.
network.router:external	body	[‘string’, ‘boolean’]	Indicates whether the network has an external routing facility that’s not managed by the networking service.
network.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
network.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status of the network. Valid values are enabled (`true`) and disabled (`false`). This value is used as the default value of `port_security_enabled` field of a newly created port.
network.provider:network_type	body	string
network.provider:physical_network	body	string
network.provider:segmentation_id	body	[‘string’, ‘integer’]
network.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the network.
network.is_default	body	[‘string’, ‘boolean’]	The network is default or not.
network.dns_domain	body	string	A valid DNS domain.
network.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the networks/network_id:put operation",
  "properties": {
    "network": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the network."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the network, which is\nup (`true`) or down (`false`)."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this resource is shared across all projects.\nBy default, only administrative users can change this value."
        },
        "router:external": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether the network has an external routing facility that\u2019s not\nmanaged by the networking service."
        },
        "segments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "provider:segmentation_id": {
                "type": "integer",
                "description": "The ID of the isolated segment on the physical network.\nThe `network_type` attribute defines the segmentation model.\nFor example, if the `network_type` value is vlan, this ID is a vlan\nidentifier. If the `network_type` value is gre, this ID is a gre key.\n`Note` that only the segmentation-id of VLAN type networks can be\nchanged!"
              },
              "provider:physical_network": {
                "type": "string",
                "description": "The physical network where this network/segment is implemented."
              },
              "provider:network_type": {
                "type": "string",
                "description": "The type of physical network that this network is mapped to.\nFor example, `flat`, `vlan`, `vxlan`, or `gre`.\nValid values depend on a networking back-end."
              }
            }
          },
          "description": "A list of provider `segment` objects."
        },
        "mtu": {
          "type": "integer",
          "minimum": 0,
          "description": "The maximum transmission unit (MTU) value to\naddress fragmentation. Minimum value is 68 for IPv4, and 1280 for\nIPv6."
        },
        "port_security_enabled": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The port security status of the network. Valid values are\nenabled (`true`) and disabled (`false`).\nThis value is used as the default value of `port_security_enabled`\nfield of a newly created port."
        },
        "provider:network_type": {
          "type": "string",
          "maxLength": 32
        },
        "provider:physical_network": {
          "type": "string",
          "maxLength": 64
        },
        "provider:segmentation_id": {
          "type": [
            "string",
            "integer"
          ]
        },
        "qos_policy_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of the QoS policy associated with the network."
        },
        "is_default": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The network is default or not."
        },
        "dns_domain": {
          "type": "string",
          "format": "hostname",
          "maxLength": 255,
          "description": "A valid DNS domain."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `network` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
network	body	object	A `network` object.
network.id	body	string	The ID of the network.
network.name	body	string	Human-readable name of the network.
network.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the network, which is up (`true`) or down (`false`).
network.status	body	string	The network status. Values are `ACTIVE`, `DOWN`, `BUILD` or `ERROR`.
network.tenant_id	body	string	The ID of the project.
network.shared	body	[‘string’, ‘boolean’]	Indicates whether this network is shared across all tenants. By default, only administrative users can change this value.
network.ipv4_address_scope	body	string	The ID of the IPv4 address scope that the network is associated with.
network.ipv6_address_scope	body	string	The ID of the IPv6 address scope that the network is associated with.
network.router:external	body	[‘string’, ‘boolean’]	Defines whether the network may be used for creation of floating IPs. Only networks with this flag may be an external gateway for routers. The network must have an external routing facility that is not managed by the networking service. If the network is updated from external to internal the unused floating IPs of this network are automatically deleted when extension `floatingip-autodelete-internal` is present.
network.l2_adjacency	body	string	Indicates whether L2 connectivity is available throughout the `network`.
network.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
network.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status of the network. Valid values are enabled (`true`) and disabled (`false`). This value is used as the default value of `port_security_enabled` field of a newly created port.
network.provider:network_type	body	string
network.provider:physical_network	body	string
network.provider:segmentation_id	body	[‘string’, ‘integer’]
network.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the network.
network.revision_number	body	integer	The revision number of the resource.
network.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
network.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
network.is_default	body	[‘string’, ‘boolean’]	The network is default pool or not.
network.dns_domain	body	string	A valid DNS domain.
network.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/networks/{network_id}

Delete network

Deletes a network and its associated resources.

Normal response codes: 204

Error response codes: 401, 404, 409, 412

Responses¶

204¶

routers¶

GET

/v2.0/routers

List routers

Lists logical routers that the project who submits the request can access.

Default policy settings return only those routers that the project who submits the request owns, unless an administrative user submits the request.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/routers

Create router

Creates a logical router.

This operation creates a logical router. The logical router does not have any internal interface and it is not associated with any subnet. You can optionally specify an external gateway for a router at create time. The external gateway for the router must be plugged into an external network. An external network has its router:external extended field set to true. To specify an external gateway, the ID of the external network must be passed in the network_id parameter of the external_gateway_info attribute in the request body.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
router	body	object	A `router` object.
router.name	body	string	Human-readable name of the resource. Default is an empty string.
router.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
router.tenant_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
router.external_gateway_info	body	object	The external gateway information of the router. If the router has an external gateway, this would be a dict with `network_id`, `enable_snat`, `external_fixed_ips` and `qos_policy_id`. Otherwise, this would be `null`.
router.external_gateway_info.network_id	body	string
router.external_gateway_info.enable_snat	body	boolean
router.ha	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a highly-available router. It is available when `l3-ha` extension is enabled.
router.enable_ndp_proxy	body	[‘string’, ‘boolean’, ‘null’]	Enable NDP proxy attribute. Default is `false`, To persist this attribute value, set the `enable_ndp_proxy_by_default` option in the `neutron.conf` file. It is available when `router-extend-ndp-proxy` extension is enabled.
router.flavor_id	body	string	The ID of the flavor associated with the router.
router.distributed	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a distributed router. It is available when `dvr` extension is enabled.
router.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the routers:post operation",
  "properties": {
    "router": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`).\nDefault is `true`."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "external_gateway_info": {
          "type": "object",
          "properties": {
            "network_id": {
              "type": "string",
              "format": "uuid"
            },
            "enable_snat": {
              "type": "boolean"
            },
            "external_fixed_ips": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "ip_address": {
                    "type": "string"
                  },
                  "subnet_id": {
                    "type": "string",
                    "format": "uuid"
                  }
                }
              }
            }
          },
          "required": [
            "network_id"
          ],
          "description": "The external gateway information of the router.\nIf the router has an external gateway, this would be a dict with\n`network_id`, `enable_snat`, `external_fixed_ips` and\n`qos_policy_id`.\nOtherwise, this would be `null`."
        },
        "ha": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "`true` indicates a highly-available router.\nIt is available when `l3-ha` extension is enabled."
        },
        "enable_ndp_proxy": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "Enable NDP proxy attribute. Default is `false`, To persist this attribute\nvalue, set the `enable_ndp_proxy_by_default` option in the\n`neutron.conf` file. It is available when `router-extend-ndp-proxy`\nextension is enabled."
        },
        "flavor_id": {
          "type": "string",
          "description": "The ID of the flavor associated with the router."
        },
        "availability_zone_hints": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The availability zone candidates for the router.\nIt is available when `router_availability_zone` extension is enabled."
        },
        "distributed": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "`true` indicates a distributed router.\nIt is available when `dvr` extension is enabled."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `router` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
router	body	object	A `router` object.
router.id	body	string	The ID of the router.
router.name	body	string	Human-readable name of the resource.
router.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
router.status	body	string	The router status.
router.tenant_id	body	string	The ID of the project.
router.external_gateway_info	body	object	The external gateway information of the router. If the router has an external gateway, this would be a dict with `network_id`, `enable_snat`, `external_fixed_ips`, `qos_policy_id`, `enable_default_route_ecmp` and `enable_default_route_bfd`. Otherwise, this would be `null`.
router.external_gateway_info.network_id	body	string
router.external_gateway_info.enable_snat	body	boolean
router.ha	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a highly-available router. It is available when `l3-ha` extension is enabled.
router.enable_ndp_proxy	body	[‘string’, ‘boolean’, ‘null’]	Enable NDP proxy attribute. `true` means NDP proxy is enabled for the router, the IPv6 address of internal subnets attached to the router can be published to external by create `ndp_proxy`. `false` means NDP proxy is disabled, the IPv6 address of internal subnets attached to the router can not be published to external by `ndp_proxy`. It is available when `router-extend-ndp-proxy` extension is enabled.
router.flavor_id	body	string	The ID of the flavor associated with the router.
router.revision_number	body	integer	The revision number of the resource.
router.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
router.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
router.distributed	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a distributed router. It is available when `dvr` extension is enabled.
router.conntrack_helpers	body	string	The associated conntrack helper resources for the roter. If the router has multiple conntrack helper resources, this field has multiple entries. Each entry consists of netfilter conntrack helper (`helper`), the network protocol (`protocol`), the network port (`port`).
router.description	body	string	A human-readable description for the resource.

PUT

/v2.0/routers/{id}/add_router_interface

Add interface to router

Adds an internal interface to a logical router. This means a specified subnet is attached to a router as an internal router interface.

Specify the ID of a subnet or port in the request body:

When you specify an IPv6 subnet, this operation adds the subnet to an existing internal port with same network ID, on the router. If a port with the same network ID does not exist, this operation creates a port on the router for that subnet.

The limitation of one IPv4 subnet per router port remains, though a port can contain any number of IPv6 subnets that belong to the same network ID.

When you use the port-create command to add a port and then call router-interface-add with this port ID, this operation adds the port to the router if the following conditions are met:

If you specify both subnet ID and port ID, this operation returns the Bad Request (400) response code.

If the port is already in use, this operation returns the Conflict (409) response code.

This operation returns a port ID that is either:

After you run this operation, the operation sets:

Normal response codes: 200

Error response codes: 400, 401, 404, 409

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/id/add_router_interface:put operation"
}

Responses¶

200¶

PUT

/v2.0/routers/{id}/remove_router_interface

Remove interface from router

Deletes an internal interface from a logical router.

This operation deletes an internal router interface, which detaches a subnet from the router. If this subnet ID is the last subnet on the port, this operation deletes the port itself. You must specify either a subnet ID or port ID in the request body; the operation uses this value to identify which router interface to deletes.

You can also specify both a subnet ID and port ID. If you specify both IDs, the subnet ID must correspond to the subnet ID of the first IP address on the port. Otherwise, this operation returns the Conflict (409) response code with information about the affected router and interface.

If you try to delete the router interface for subnets that are used by one or more routes, this operation returns the Conflict (409) response. In this case, you first need to delete such routes from the router.

If the router or the subnet and port do not exist or are not visible to you, this operation returns the Not Found (404) response code. As a consequence of this operation, the operation removes the port connecting the router with the subnet from the subnet for the network.

Normal response codes: 200

Error response codes: 400, 401, 404, 409

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/id/remove_router_interface:put operation"
}

Responses¶

200¶

PUT

/v2.0/routers/{id}/add_extraroutes

Add extra routes to router

Atomically adds a set of extra routes to the router’s already existing extra routes.

This operation is a variation on updating the router’s routes parameter. In all ways it works the same, except the extra routes sent in the request body do not replace the existing set of extra routes. Instead the extra routes sent are added to the existing set of extra routes.

The use of the add_extraroutes/remove_extraroutes member actions is preferred to updating the routes attribute in all cases when concurrent updates to the set of extra routes are possible.

The addition’s corner cases behave the following way:

The format of the request body is the same as the format of a PUT request to the router changing the routes parameter only.

The response codes and response body are the same as to the update of the routes parameter. That is the whole router object is returned including the routes parameter which represents the result of the addition.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/id/add_extraroutes:put operation"
}

Responses¶

200¶

PUT

/v2.0/routers/{id}/remove_extraroutes

Remove extra routes from router

Atomically removes a set of extra routes from the router’s already existing extra routes.

This operation is a variation on updating the router’s routes parameter. In all ways it works the same, except the extra routes sent in the request body do not replace the existing set of extra routes. Instead the the extra routes sent are removed from the existing set of extra routes.

The use of the add_extraroutes/remove_extraroutes member actions is preferred to updating the routes attribute in all cases when concurrent updates to the set of extra routes are possible.

The removal’s corner cases behave the following way:

The format of the request body is the same as the format of a PUT request to the router changing the routes parameter only. However the routes sent are not meant to overwrite the whole routes parameter, but they are meant to be removed from the existing set.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/id/remove_extraroutes:put operation"
}

Responses¶

200¶

PUT

/v2.0/routers/{id}/add_external_gateways

Add external gateways to router

Add external gateways to a router in addition to the ones it already has.

Multiple gateways attached to the same network can be added to the same router.

The add/update/remove external gateways operations extend the use of router.external_gateway_info to manage multiple external gateways. The full set of external gateways is exposed in the read-only router.external_gateways parameter. router.external_gateways contains a list of external_gateway_info structures like:

The first item (index 0) of the external_gateways list is special if a router does not have any gateway ports yet:

The order of the the rest of the list (indexes 1, 2, …) is irrelevant and ignored.

The first external gateway can be managed in two ways: via router.external_gateway_info or via add/update/remove_external_gateways. The other external gateways can only be managed via add/update/remove_external_gateways.

The format of the request body is the same as the format of the read-only router.external_gateways parameter, but wrapped as follows:

The response codes and response body are the same as to the update of the router. That is the whole router object is returned including the external_gateway_info and external_gateways parameters which represents the result of the operation.

Changes in router.external_gateway_info are reflected in router.external_gateways and vice versa. Updating external_gateway_info also updates the first element of external_gateways and it leaves the rest of external_gateways unchanged. Setting external_gateway_info to an empty value removes a single gateway and one of the extra gateways takes its place instead.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/id/add_external_gateways:put operation"
}

Responses¶

200¶

PUT

/v2.0/routers/{id}/update_external_gateways

Update external gateways of router

Update some external gateways of router.

For general information on the add/update/remove external gateways operations see add_external_gateways above.

The external gateways to be updated are identified by the network_ids found in the PUT request. The external_fixed_ips, enable_snat, fields can be updated. The network_id field cannot be updated - any changes will cause a gateway port to be removed and recreated.

The format of the request body is the same as the format of the read-only router.external_gateways parameter, but wrapped as follows:

The enable_snat field does not have any effect for extra gateways except for the first external gateway in the list.

The network_id field is used to identify a particular gateway port along with the external_fixed_ips field. Specifying just the network_id field is ambiguous: Neutron will attempt to find the matching gateway port but if there are multiple matches it will return an error response code.

The enable_snat field can be omitted from the request. Specifying external_fixed_ips will result in matching ports based on those fixed IPs. If a gateway port has a subset of the specified fixed IPs, then the set of IPs will be updated to match the ones in the request. Alternatively, if a gateway port has a superset of fixed IPs from the request the IPs will be removed from the gateway port.

Please note that updating external_gateway_info also updates the first element of external_gateways and it leaves the rest of external_gateways unchanged.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/id/update_external_gateways:put operation"
}

Responses¶

200¶

PUT

/v2.0/routers/{id}/remove_external_gateways

Remove external gateways from router

Remove some external gateways from router.

For general information on the add/update/remove external gateways operations see add_external_gateways above.

The format of the request body is the same as the format of the read-only router.external_gateways parameter, but wrapped as follows:

However the request body can be partial. Only the network_id and external_fixed_ips fields from the external_gateway_info structure is used in order to match the specific gateway ports. The enable_snat key can be present but its value is ignored.

Please note that setting external_gateway_info to an empty value also resets external_gateways to the empty list.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/routers/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/id/remove_external_gateways:put operation"
}

Responses¶

200¶

GET

/v2.0/routers/{id}

Show router details

Shows details for a router.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
router	body	object	A `router` object.
router.id	body	string	The ID of the router.
router.name	body	string	Human-readable name of the resource.
router.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
router.status	body	string	The router status.
router.tenant_id	body	string	The ID of the project.
router.external_gateway_info	body	object	The external gateway information of the router. If the router has an external gateway, this would be a dict with `network_id`, `enable_snat`, `external_fixed_ips`, `qos_policy_id`, `enable_default_route_ecmp` and `enable_default_route_bfd`. Otherwise, this would be `null`.
router.external_gateway_info.network_id	body	string
router.external_gateway_info.enable_snat	body	boolean
router.ha	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a highly-available router. It is available when `l3-ha` extension is enabled.
router.enable_ndp_proxy	body	[‘string’, ‘boolean’, ‘null’]	Enable NDP proxy attribute. `true` means NDP proxy is enabled for the router, the IPv6 address of internal subnets attached to the router can be published to external by create `ndp_proxy`. `false` means NDP proxy is disabled, the IPv6 address of internal subnets attached to the router can not be published to external by `ndp_proxy`. It is available when `router-extend-ndp-proxy` extension is enabled.
router.flavor_id	body	string	The ID of the flavor associated with the router.
router.revision_number	body	integer	The revision number of the resource.
router.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
router.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
router.distributed	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a distributed router. It is available when `dvr` extension is enabled.
router.conntrack_helpers	body	string	The associated conntrack helper resources for the roter. If the router has multiple conntrack helper resources, this field has multiple entries. Each entry consists of netfilter conntrack helper (`helper`), the network protocol (`protocol`), the network port (`port`).
router.description	body	string	A human-readable description for the resource.

PUT

/v2.0/routers/{id}

Update router

Updates a logical router.

This operation does not enable the update of router interfaces. To update a router interface, use the add router interface and remove router interface operations.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/routers/{id} API
router	body	object	A `router` object.
router.name	body	string	Human-readable name of the resource.
router.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
router.external_gateway_info	body	object	The external gateway information of the router. If the router has an external gateway, this would be a dict with `network_id`, `enable_snat`, `external_fixed_ips` and `qos_policy_id`. Otherwise, this would be `null`.
router.external_gateway_info.network_id	body	string
router.external_gateway_info.enable_snat	body	boolean
router.ha	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a highly-available router. It is available when `l3-ha` extension is enabled.
router.enable_ndp_proxy	body	[‘string’, ‘boolean’, ‘null’]	Enable NDP proxy attribute. Default is `false`, To persist this attribute value, set the `enable_ndp_proxy_by_default` option in the `neutron.conf` file. It is available when `router-extend-ndp-proxy` extension is enabled.
router.distributed	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a distributed router. It is available when `dvr` extension is enabled.
router.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the routers/id:put operation",
  "properties": {
    "router": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`)."
        },
        "external_gateway_info": {
          "type": "object",
          "properties": {
            "network_id": {
              "type": "string",
              "format": "uuid"
            },
            "enable_snat": {
              "type": "boolean"
            },
            "external_fixed_ips": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "ip_address": {
                    "type": "string"
                  },
                  "subnet_id": {
                    "type": "string",
                    "format": "uuid"
                  }
                }
              }
            }
          },
          "required": [
            "network_id"
          ],
          "description": "The external gateway information of the router.\nIf the router has an external gateway, this would be a dict with\n`network_id`, `enable_snat`, `external_fixed_ips` and\n`qos_policy_id`.\nOtherwise, this would be `null`."
        },
        "ha": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "`true` indicates a highly-available router.\nIt is available when `l3-ha` extension is enabled."
        },
        "enable_ndp_proxy": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "Enable NDP proxy attribute. Default is `false`, To persist this attribute\nvalue, set the `enable_ndp_proxy_by_default` option in the\n`neutron.conf` file. It is available when `router-extend-ndp-proxy`\nextension is enabled."
        },
        "distributed": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "`true` indicates a distributed router.\nIt is available when `dvr` extension is enabled."
        },
        "routes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "destination": {
                "type": "string"
              },
              "nexthop": {
                "type": "string"
              }
            }
          },
          "description": "The extra routes configuration for L3 router.\nA list of dictionaries with `destination` and `nexthop` parameters.\nIt is available when `extraroute` extension is enabled.\nDefault is an empty list (`[]`)."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `router` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
router	body	object	A `router` object.
router.id	body	string	The ID of the router.
router.name	body	string	Human-readable name of the resource.
router.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
router.status	body	string	The router status.
router.tenant_id	body	string	The ID of the project.
router.external_gateway_info	body	object	The external gateway information of the router. If the router has an external gateway, this would be a dict with `network_id`, `enable_snat`, `external_fixed_ips`, `qos_policy_id`, `enable_default_route_ecmp` and `enable_default_route_bfd`. Otherwise, this would be `null`.
router.external_gateway_info.network_id	body	string
router.external_gateway_info.enable_snat	body	boolean
router.ha	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a highly-available router. It is available when `l3-ha` extension is enabled.
router.enable_ndp_proxy	body	[‘string’, ‘boolean’, ‘null’]	Enable NDP proxy attribute. `true` means NDP proxy is enabled for the router, the IPv6 address of internal subnets attached to the router can be published to external by create `ndp_proxy`. `false` means NDP proxy is disabled, the IPv6 address of internal subnets attached to the router can not be published to external by `ndp_proxy`. It is available when `router-extend-ndp-proxy` extension is enabled.
router.flavor_id	body	string	The ID of the flavor associated with the router.
router.revision_number	body	integer	The revision number of the resource.
router.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
router.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
router.distributed	body	[‘string’, ‘boolean’, ‘null’]	`true` indicates a distributed router. It is available when `dvr` extension is enabled.
router.conntrack_helpers	body	string	The associated conntrack helper resources for the roter. If the router has multiple conntrack helper resources, this field has multiple entries. Each entry consists of netfilter conntrack helper (`helper`), the network protocol (`protocol`), the network port (`port`).
router.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/routers/{id}

Delete router

Deletes a logical router and, if present, its external gateway interface.

This operation fails if the router has attached interfaces. Use the remove router interface operation to remove all router interfaces before you delete the router.

Normal response codes: 204

Error response codes: 401, 404, 409, 412

Responses¶

204¶

GET

/v2.0/routers/{router_id}/conntrack_helpers

List router conntrack helpers

Lists router conntrack helpers associated with a router.

Normal response codes: 200

Error response codes: 400, 404

Responses¶

200¶

POST

/v2.0/routers/{router_id}/conntrack_helpers

Create conntrack helper

Creates a router conntrack helper.

Normal response codes: 201

Error response codes: 400, 404

Request¶

Description

Name	Location	Type	Description
router_id	path	string	router_id parameter for /v2.0/routers/{router_id}/tags/{id} API
conntrack_helper	body	object	A router `conntrack helper` object.
conntrack_helper.project_id	body	string
conntrack_helper.protocol	body	string	The network protocol for the netfilter conntrack target rule.
conntrack_helper.port	body	number	The network port for the netfilter conntrack target rule.
conntrack_helper.helper	body	string	The netfilter conntrack helper module.

Schema

{
  "type": "object",
  "description": "Request of the routers/router_id/conntrack_helpers:post operation",
  "properties": {
    "conntrack_helper": {
      "type": "object",
      "properties": {
        "project_id": {
          "type": "string",
          "maxLength": 255
        },
        "protocol": {
          "type": "string",
          "enum": [
            "dccp",
            "icmp",
            "ipv6-icmp",
            "sctp",
            "tcp",
            "udp"
          ],
          "description": "The network protocol for the netfilter conntrack target rule."
        },
        "port": {
          "type": "number",
          "minimum": 1,
          "maximum": 65535,
          "description": "The network port for the netfilter conntrack target rule."
        },
        "helper": {
          "type": "string",
          "maxLength": 64,
          "description": "The netfilter conntrack helper module."
        }
      },
      "description": "A router `conntrack helper` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
conntrack_helper	body	object	A router `conntrack helper` object.
conntrack_helper.id	body	string	The ID of the conntrack helper.
conntrack_helper.protocol	body	string	The network protocol for the netfilter conntrack target rule.
conntrack_helper.port	body	number	The network port for the netfilter conntrack target rule.
conntrack_helper.helper	body	string	The netfilter conntrack helper module.

GET

/v2.0/routers/{router_id}/l3-agents

List L3 agents hosting a router

Lists l3 agents hosting a specific router.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

POST

/v2.0/routers/{router_id}/l3-agents

Request of the routers/router_id/l3-agents:post operation

Request¶

Description

Name

Location

Type

Description

router_id

path

string

router_id parameter for /v2.0/routers/{router_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/router_id/l3-agents:post operation"
}

Responses¶

201¶

GET

/v2.0/routers/{router_id}/l3-agents/{id}

Responses¶

200¶

PUT

/v2.0/routers/{router_id}/l3-agents/{id}

Request of the routers/router_id/l3-agents/id:put operation

Request¶

Description

Name	Location	Type	Description
router_id	path	string	router_id parameter for /v2.0/routers/{router_id}/tags/{id} API
id	path	string	id parameter for /v2.0/routers/{router_id}/l3-agents/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/router_id/l3-agents/id:put operation"
}

Responses¶

200¶

DELETE

/v2.0/routers/{router_id}/l3-agents/{id}

Responses¶

204¶

GET

/v2.0/routers/{router_id}/tags

Responses¶

200¶

PUT

/v2.0/routers/{router_id}/tags

Request of the routers/router_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

router_id

path

string

router_id parameter for /v2.0/routers/{router_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the routers/router_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/routers/{router_id}/tags

Responses¶

204¶

GET

/v2.0/routers/{router_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/routers/{router_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/routers/{router_id}/tags/{id}

Responses¶

204¶

flavors¶

GET

/v2.0/flavors

List flavors

Lists all flavors visible to the project.

The list can be empty.

Standard query parameters are supported on the URI. Use the fields query parameter to control which fields are returned in the response body. Additionally, you can filter results by using query string parameters. For information, see Filtering and Column Selection. If Neutron configuration supports pagination by overriding allow_pagination = false, the marker query parameter can set the last element id the client has seen and limit set the maximum number of items to return. if Neutron configuration has allow_sorting = true, sort_key and sort_dir pairs can be used where sort direction is ‘asc’ or ‘desc’.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/flavors

Create flavor

Creates a flavor.

This operation establishes a new flavor.

The service_type to which the flavor applies is a required parameter. The corresponding service plugin must have been activated as part of the configuration. Check Service providers for how to see currently loaded service types. Additionally the service plugin needs to support the use of flavors.

Creation currently limited to administrators. Other users will receive a Forbidden 403 response code with a response body NeutronError message expressing that creation is disallowed by policy.

Until one or more service profiles are associated with the flavor by the operator, attempts to use the flavor during resource creations will currently return a Not Found 404 with a response body that indicates no service profile could be found.

If the API cannot fulfill the request due to insufficient data or data that is not valid, the service returns the HTTP Bad Request (400) response code with information about the failure in the response body. Validation errors require that you correct the error and submit the request again.

Normal response codes: 201

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
flavor	body	object	A `flavor` object.
flavor.name	body	string	Name of the flavor.
flavor.description	body	[‘string’, ‘null’]	The human-readable description for the flavor.
flavor.service_type	body	string	Service type for the flavor. Example: FIREWALL.
flavor.tenant_id	body	string
flavor.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether the flavor is enabled or not. Default is true.

Schema

{
  "type": "object",
  "description": "Request of the flavors:post operation",
  "properties": {
    "flavor": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Name of the flavor."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 1024,
          "description": "The human-readable description for the flavor."
        },
        "service_type": {
          "type": "string",
          "description": "Service type for the flavor. Example: FIREWALL."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        },
        "service_profiles": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        },
        "enabled": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "Indicates whether the flavor is enabled or not. Default is true."
        }
      },
      "description": "A `flavor` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
flavor	body	object	A `flavor` object.
flavor.id	body	string	The ID of the flavor.
flavor.name	body	string	Name of the flavor.
flavor.description	body	[‘string’, ‘null’]	The human-readable description for the flavor.
flavor.service_type	body	string	Service type for the flavor. Example: FIREWALL.
flavor.tenant_id	body	string
flavor.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether the flavor is enabled or not. Default is true.

GET

/v2.0/flavors/{id}

Show flavor details

Shows details for a flavor.

This operation returns a flavor object by ID. If you are not an administrative user and the flavor object is not visible to your project account, the service returns the HTTP Forbidden (403) response code.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
flavor	body	object	A `flavor` object.
flavor.id	body	string	The ID of the flavor.
flavor.name	body	string	Name of the flavor.
flavor.description	body	[‘string’, ‘null’]	The human-readable description for the flavor.
flavor.service_type	body	string	Service type for the flavor. Example: FIREWALL.
flavor.tenant_id	body	string
flavor.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether the flavor is enabled or not. Default is true.

PUT

/v2.0/flavors/{id}

Update flavor

Updates a flavor.

The service_type cannot be updated as there may be associated service profiles and consumers depending on the value.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/flavors/{id} API
flavor	body	object	A `flavor` object.
flavor.name	body	string	Name of the flavor.
flavor.description	body	[‘string’, ‘null’]	The human-readable description for the flavor.
flavor.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether the flavor is enabled or not. Default is true.

Schema

{
  "type": "object",
  "description": "Request of the flavors/id:put operation",
  "properties": {
    "flavor": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Name of the flavor."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 1024,
          "description": "The human-readable description for the flavor."
        },
        "service_profiles": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        },
        "enabled": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "Indicates whether the flavor is enabled or not. Default is true."
        }
      },
      "description": "A `flavor` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
flavor	body	object	A `flavor` object.
flavor.id	body	string	The ID of the flavor.
flavor.name	body	string	Name of the flavor.
flavor.description	body	[‘string’, ‘null’]	The human-readable description for the flavor.
flavor.service_type	body	string	Service type for the flavor. Example: FIREWALL.
flavor.tenant_id	body	string
flavor.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether the flavor is enabled or not. Default is true.

DELETE

/v2.0/flavors/{id}

Delete flavor

Deletes a flavor.

Normal response codes: 204

Error response codes: 401, 403, 404

Responses¶

204¶

GET

/v2.0/flavors/{flavor_id}/next_providers

Responses¶

200¶

POST

/v2.0/flavors/{flavor_id}/next_providers

Request of the flavors/flavor_id/next_providers:post operation

Request¶

Description

Name	Location	Type	Description
flavor_id	path	string	flavor_id parameter for /v2.0/flavors/{flavor_id}/service_profiles/{id} API
next_provider	body	object
next_provider.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Request of the flavors/flavor_id/next_providers:post operation",
  "properties": {
    "next_provider": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
next_provider	body	object
next_provider.provider	body	string
next_provider.driver	body	string
next_provider.metainfo	body	string
next_provider.tenant_id	body	string

GET

/v2.0/flavors/{flavor_id}/next_providers/{id}

Responses¶

200¶

Name	Location	Type
next_provider	body	object
next_provider.provider	body	string
next_provider.driver	body	string
next_provider.metainfo	body	string
next_provider.tenant_id	body	string

PUT

/v2.0/flavors/{flavor_id}/next_providers/{id}

Request of the flavors/flavor_id/next_providers/id:put operation

Request¶

Description

Name	Location	Type	Description
flavor_id	path	string	flavor_id parameter for /v2.0/flavors/{flavor_id}/service_profiles/{id} API
id	path	string	id parameter for /v2.0/flavors/{flavor_id}/next_providers/{id} API
next_provider	body	object

Schema

{
  "type": "object",
  "description": "Request of the flavors/flavor_id/next_providers/id:put operation",
  "properties": {
    "next_provider": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
next_provider	body	object
next_provider.provider	body	string
next_provider.driver	body	string
next_provider.metainfo	body	string
next_provider.tenant_id	body	string

DELETE

/v2.0/flavors/{flavor_id}/next_providers/{id}

Responses¶

204¶

GET

/v2.0/flavors/{flavor_id}/service_profiles

Responses¶

200¶

POST

/v2.0/flavors/{flavor_id}/service_profiles

Associate flavor with a service profile

Associate a flavor with a service profile.

A flavor can be associated with more than one profile.

Will return 409 Conflict if association already exists.

Normal response codes: 201

Error response codes: 400, 401, 403, 404, 409

Request¶

Description

Name	Location	Type	Description
flavor_id	path	string	flavor_id parameter for /v2.0/flavors/{flavor_id}/service_profiles/{id} API
service_profile	body	object	A `service_profile` object.
service_profile.id	body	string	The UUID of the service profile.
service_profile.tenant_id	body	string

Schema

{
  "type": "object",
  "description": "Request of the flavors/flavor_id/service_profiles:post operation",
  "properties": {
    "service_profile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The UUID of the service profile."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        }
      },
      "description": "A `service_profile` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
service_profile	body	object	A `service_profile` object.
service_profile.id	body	string	The ID of the resource.
service_profile.tenant_id	body	string

GET

/v2.0/flavors/{flavor_id}/service_profiles/{id}

Responses¶

200¶

Name	Location	Type
service_profile	body	object
service_profile.id	body	string
service_profile.tenant_id	body	string

PUT

/v2.0/flavors/{flavor_id}/service_profiles/{id}

Request of the flavors/flavor_id/service_profiles/id:put operation

Request¶

Description

Name	Location	Type	Description
flavor_id	path	string	flavor_id parameter for /v2.0/flavors/{flavor_id}/service_profiles/{id} API
id	path	string	id parameter for /v2.0/flavors/{flavor_id}/service_profiles/{id} API
service_profile	body	object

Schema

{
  "type": "object",
  "description": "Request of the flavors/flavor_id/service_profiles/id:put operation",
  "properties": {
    "service_profile": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
service_profile	body	object
service_profile.id	body	string
service_profile.tenant_id	body	string

DELETE

/v2.0/flavors/{flavor_id}/service_profiles/{id}

Disassociate a flavor.

Disassociate a flavor from a service profile.

Normal response codes: 204

Error response codes: 401, 403, 404

Responses¶

204¶

service_profiles¶

GET

/v2.0/service_profiles

List service profiles

Lists all service profiles visible for the tenant account.

The list can be empty.

Standard query parameters are supported on the URI.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/service_profiles

Create service profile

Creates a service profile.

This operation establishes a new service profile that can be associated with one or more flavors.

Either metadata or a driver is required.

If a driver is specified but does not exist, call will return a Not found 404 error with the response body explaining that the driver could not be found.

Creation currently limited to administrators. Other users will receive a Forbidden 403 response code with a response body NeutronError message expressing that creation is disallowed by policy.

Normal response codes: 201

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
service_profile	body	object	A `service_profile` object.
service_profile.description	body	[‘string’, ‘null’]	The human-readable description for the service profile.
service_profile.driver	body	string	Provider driver to use for this profile.
service_profile.metainfo	body	string	JSON-formatted meta information of the service profile.
service_profile.tenant_id	body	string
service_profile.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether this service profile is enabled or not. Default is `true`.

Schema

{
  "type": "object",
  "description": "Request of the service_profiles:post operation",
  "properties": {
    "service_profile": {
      "type": "object",
      "properties": {
        "description": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 1024,
          "description": "The human-readable description for the service profile."
        },
        "driver": {
          "type": "string",
          "maxLength": 1024,
          "description": "Provider driver to use for this profile."
        },
        "metainfo": {
          "type": "string",
          "description": "JSON-formatted meta information of the service profile."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        },
        "enabled": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "Indicates whether this service profile is enabled or not.\nDefault is `true`."
        }
      },
      "description": "A `service_profile` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
service_profile	body	object	A `service_profile` object.
service_profile.id	body	string	The UUID of the service profile.
service_profile.description	body	[‘string’, ‘null’]	The human-readable description for the service profile.
service_profile.driver	body	string	Provider driver to use for this profile.
service_profile.metainfo	body	string	JSON-formatted meta information of the service profile.
service_profile.tenant_id	body	string
service_profile.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether this service profile is enabled or not. Default is `true`.

GET

/v2.0/service_profiles/{id}

Show service profile details

Shows details for a service profile.

This operation returns a service profile object by ID. If you are not an administrative user and the object is not visible to your tenant account, the service returns the HTTP Forbidden (403) response code.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
service_profile	body	object	A `service_profile` object.
service_profile.id	body	string	The UUID of the service profile.
service_profile.description	body	[‘string’, ‘null’]	The human-readable description for the service profile.
service_profile.driver	body	string	Provider driver to use for this profile.
service_profile.metainfo	body	string	JSON-formatted meta information of the service profile.
service_profile.tenant_id	body	string
service_profile.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether this service profile is enabled or not. Default is `true`.

PUT

/v2.0/service_profiles/{id}

Update service profile

Updates a service profile.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/service_profiles/{id} API
service_profile	body	object	A `service_profile` object.
service_profile.description	body	[‘string’, ‘null’]	The human-readable description for the service profile.
service_profile.driver	body	string	Provider driver to use for this profile.
service_profile.metainfo	body	string	JSON-formatted meta information of the service profile.
service_profile.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether this service profile is enabled or not. Default is `true`.

Schema

{
  "type": "object",
  "description": "Request of the service_profiles/id:put operation",
  "properties": {
    "service_profile": {
      "type": "object",
      "properties": {
        "description": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 1024,
          "description": "The human-readable description for the service profile."
        },
        "driver": {
          "type": "string",
          "maxLength": 1024,
          "description": "Provider driver to use for this profile."
        },
        "metainfo": {
          "type": "string",
          "description": "JSON-formatted meta information of the service profile."
        },
        "enabled": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "Indicates whether this service profile is enabled or not.\nDefault is `true`."
        }
      },
      "description": "A `service_profile` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
service_profile	body	object	A `service_profile` object.
service_profile.id	body	string	The UUID of the service profile.
service_profile.description	body	[‘string’, ‘null’]	The human-readable description for the service profile.
service_profile.driver	body	string	Provider driver to use for this profile.
service_profile.metainfo	body	string	JSON-formatted meta information of the service profile.
service_profile.tenant_id	body	string
service_profile.enabled	body	[‘string’, ‘boolean’, ‘null’]	Indicates whether this service profile is enabled or not. Default is `true`.

DELETE

/v2.0/service_profiles/{id}

Delete service profile

Deletes a service profile.

Attempting to delete a service profile that is currently associated with a flavor will return a Conflict 409 with a response body containing an in use message.

Either metadata or a driver is required.

Normal response codes: 204

Error response codes: 401, 403, 404, 409

Responses¶

204¶

floatingips¶

GET

/v2.0/floatingips/{floatingip_id}/port_forwardings

List floating IP port forwardings

Lists floating IP port forwardings that the project has access to.

Default policy settings return only the port forwardings associated to floating IPs owned by the project of the user submitting the request, unless the user has administrative role.

Normal response codes: 200

Error response codes: 400, 404

Responses¶

200¶

POST

/v2.0/floatingips/{floatingip_id}/port_forwardings

Create port forwarding

Creates a floating IP port forwarding.

Normal response codes: 201

Error response codes: 400, 404

Request¶

Description

Name	Location	Type	Description
floatingip_id	path	string	floatingip_id parameter for /v2.0/floatingips/{floatingip_id}/tags/{id} API
port_forwarding	body	object	A `floating IP port forwarding` object.
port_forwarding.project_id	body	string
port_forwarding.external_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the port forwarding’s floating IP address.
port_forwarding.internal_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the floating ip port forwarding.
port_forwarding.internal_ip_address	body	string	The fixed IPv4 address of the Neutron port associated to the floating IP port forwarding.
port_forwarding.protocol	body	string	The IP protocol used in the floating IP port forwarding.
port_forwarding.internal_port_id	body	string	The ID of the Neutron port associated to the floating IP port forwarding.
port_forwarding.description	body	string	A text describing the rule, which helps users to manage/find easily theirs rules.
port_forwarding.external_port_range	body	number	The TCP/UDP/other protocol port range of the port forwarding’s floating IP address.
port_forwarding.internal_port_range	body	number	The TCP/UDP/other protocol port range of the Neutron port fixed IP address associated to the floating ip port forwarding.

Schema

{
  "type": "object",
  "description": "Request of the floatingips/floatingip_id/port_forwardings:post operation",
  "properties": {
    "port_forwarding": {
      "type": "object",
      "properties": {
        "project_id": {
          "type": "string",
          "maxLength": 255
        },
        "external_port": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port number of the port forwarding\u2019s floating IP\naddress."
        },
        "internal_port": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port number of the Neutron port fixed IP\naddress associated to the floating ip port forwarding."
        },
        "internal_ip_address": {
          "type": "string",
          "description": "The fixed IPv4 address of the Neutron port associated to the floating IP\nport forwarding."
        },
        "protocol": {
          "type": "string",
          "enum": [
            "dccp",
            "icmp",
            "ipv6-icmp",
            "sctp",
            "tcp",
            "udp"
          ],
          "description": "The IP protocol used in the floating IP port forwarding."
        },
        "internal_port_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the Neutron port associated to the floating IP port forwarding."
        },
        "description": {
          "type": "string",
          "maxLength": 1024,
          "description": "A text describing the rule, which helps users to\nmanage/find easily theirs rules."
        },
        "external_port_range": {
          "type": "number",
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port range of the port forwarding\u2019s floating IP\naddress."
        },
        "internal_port_range": {
          "type": "number",
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port range of the Neutron port fixed IP\naddress associated to the floating ip port forwarding."
        }
      },
      "description": "A `floating IP port forwarding` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
port_forwarding	body	object	A `floating IP port forwarding` object.
port_forwarding.id	body	string	The ID of the floating IP port forwarding.
port_forwarding.external_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the port forwarding’s floating IP address.
port_forwarding.internal_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the floating ip port forwarding.
port_forwarding.internal_ip_address	body	string	The fixed IPv4 address of the Neutron port associated to the floating IP port forwarding.
port_forwarding.protocol	body	string	The IP protocol used in the floating IP port forwarding.
port_forwarding.internal_port_id	body	string	The ID of the Neutron port associated to the floating IP port forwarding.
port_forwarding.description	body	string	A text describing the rule, which helps users to manage/find easily theirs rules.
port_forwarding.external_port_range	body	number	The TCP/UDP/other protocol port range of the port forwarding’s floating IP address.
port_forwarding.internal_port_range	body	number	The TCP/UDP/other protocol port range of the Neutron port fixed IP address associated to the floating ip port forwarding.

GET

/v2.0/floatingips

List floating IPs

Lists floating IPs visible to the user.

Default policy settings return only the floating IPs owned by the user’s project, unless the user has admin role.

This example request lists floating IPs in JSON format:

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/floatingips

Create floating IP

Creates a floating IP, and, if you specify port information, associates the floating IP with an internal port.

To associate the floating IP with an internal port, specify the port ID attribute in the request body. If you do not specify a port ID in the request, you can issue a PUT request instead of a POST request.

Default policy settings enable only administrative users to set floating IP addresses and some non-administrative users might require a floating IP address. If you do not specify a floating IP address in the request, the operation automatically allocates one.

By default, this operation associates the floating IP address with a single fixed IP address that is configured on an OpenStack Networking port. If a port has multiple IP addresses, you must specify the fixed_ip_address attribute in the request body to associate a fixed IP address with the floating IP address.

You can create floating IPs on only external networks. When you create a floating IP, you must specify the ID of the network on which you want to create the floating IP. Alternatively, you can create a floating IP on a subnet in the external network, based on the costs and quality of that subnet.

You must configure an IP address with the internal OpenStack Networking port that is associated with the floating IP address.

The operation returns the Bad Request (400) response code for one of reasons:

If the port ID is not valid, this operation returns 404 response code.

The operation returns the Conflict (409) response code for one of reasons:

Normal response codes: 201

Error response codes: 400, 401, 404, 409

Request¶

Description

Name	Location	Type	Description
floatingip	body	object	A `floatingip` object. When you associate a floating IP address with a VM, the instance has the same public IP address each time that it boots, basically to maintain a consistent IP address for maintaining DNS assignment.
floatingip.floating_ip_address	body	string	The floating IP address.
floatingip.subnet_id	body	[‘string’, ‘null’]	The subnet ID on which you want to create the floating IP.
floatingip.floating_network_id	body	string	The ID of the network associated with the floating IP.
floatingip.port_id	body	[‘string’, ‘null’]	The ID of a port associated with the floating IP. To associate the floating IP with a fixed IP at creation time, you must specify the identifier of the internal port.
floatingip.fixed_ip_address	body	string	The fixed IP address that is associated with the floating IP. If an internal port has multiple associated IP addresses, the service chooses the first IP address unless you explicitly define a fixed IP address in the `fixed_ip_address` parameter.
floatingip.tenant_id	body	string	The ID of the project.
floatingip.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the floating IP.
floatingip.dns_name	body	string	A valid DNS name.
floatingip.dns_domain	body	string	A valid DNS domain.
floatingip.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the floatingips:post operation",
  "properties": {
    "floatingip": {
      "type": "object",
      "properties": {
        "floating_ip_address": {
          "type": "string",
          "description": "The floating IP address."
        },
        "subnet_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The subnet ID on which you want to create the floating IP."
        },
        "floating_network_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the network associated with the\nfloating IP."
        },
        "port_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of a port associated with the floating IP.\nTo associate the floating IP with a fixed IP at creation time,\nyou must specify the identifier of the internal port."
        },
        "fixed_ip_address": {
          "type": "string",
          "description": "The fixed IP address that is associated with the floating IP.\nIf an internal port has multiple associated IP addresses,\nthe service chooses the first IP address unless you explicitly\ndefine a fixed IP address in the `fixed_ip_address` parameter."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "qos_policy_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of the QoS policy associated with the floating IP."
        },
        "dns_name": {
          "type": "string",
          "maxLength": 255,
          "description": "A valid DNS name."
        },
        "dns_domain": {
          "type": "string",
          "format": "hostname",
          "maxLength": 255,
          "description": "A valid DNS domain."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "required": [
        "floating_network_id"
      ],
      "description": "A `floatingip` object. When you associate a\nfloating IP address with a VM, the instance has the same public IP\naddress each time that it boots, basically to maintain a\nconsistent IP address for maintaining DNS assignment."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
floatingip	body	object	A `floatingip` object. When you associate a floating IP address with a VM, the instance has the same public IP address each time that it boots, basically to maintain a consistent IP address for maintaining DNS assignment.
floatingip.id	body	string	The ID of the floating IP address.
floatingip.floating_ip_address	body	string	The floating IP address.
floatingip.floating_network_id	body	string	The ID of the network associated with the floating IP.
floatingip.router_id	body	[‘string’, ‘null’]	The ID of the router for the floating IP.
floatingip.port_id	body	[‘string’, ‘null’]	The ID of a port associated with the floating IP.
floatingip.fixed_ip_address	body	string	The fixed IP address that is associated with the floating IP address.
floatingip.tenant_id	body	string	The ID of the project.
floatingip.status	body	string	The status of the floating IP. Values are `ACTIVE`, `DOWN` and `ERROR`.
floatingip.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the floating IP.
floatingip.revision_number	body	integer	The revision number of the resource.
floatingip.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
floatingip.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
floatingip.dns_name	body	string	A valid DNS name.
floatingip.dns_domain	body	string	A valid DNS domain.
floatingip.port_details	body	string	The information of the port that this floating IP associates with. In particular, if the floating IP is associated with a port, this field contains some attributes of the associated port, including `name`, `network_id`, `mac_address`, `admin_state_up`, `status`, `device_id` and `device_owner`. If the floating IP is not associated with a port, this field is `null`.
floatingip.port_forwardings	body	string	The associated port forwarding resources for the floating IP. If the floating IP has multiple port forwarding resources, this field has multiple entries. Each entry consists of network IP protocol (`protocol`), the fixed IP address of internal neutron port (`internal_ip_address`), the TCP or UDP port or port range used by internal neutron port (`internal_port`) or (`internal_port_range`) and the TCP or UDP port or port range used by floating IP (`external_port`) or (`external_port_range`).
floatingip.description	body	string	A human-readable description for the resource.

GET

/v2.0/floatingips/{id}

Show floating IP details

Shows details for a floating IP.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

This example request shows details for a floating IP in JSON format. This example also filters the result by the fixed_ip_address and floating_ip_address fields.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
floatingip	body	object	A `floatingip` object. When you associate a floating IP address with a VM, the instance has the same public IP address each time that it boots, basically to maintain a consistent IP address for maintaining DNS assignment.
floatingip.id	body	string	The ID of the floating IP address.
floatingip.floating_ip_address	body	string	The floating IP address.
floatingip.floating_network_id	body	string	The ID of the network associated with the floating IP.
floatingip.router_id	body	[‘string’, ‘null’]	The ID of the router for the floating IP.
floatingip.port_id	body	[‘string’, ‘null’]	The ID of a port associated with the floating IP.
floatingip.fixed_ip_address	body	string	The fixed IP address that is associated with the floating IP address.
floatingip.tenant_id	body	string	The ID of the project.
floatingip.status	body	string	The status of the floating IP. Values are `ACTIVE`, `DOWN` and `ERROR`.
floatingip.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the floating IP.
floatingip.revision_number	body	integer	The revision number of the resource.
floatingip.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
floatingip.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
floatingip.dns_name	body	string	A valid DNS name.
floatingip.dns_domain	body	string	A valid DNS domain.
floatingip.port_details	body	string	The information of the port that this floating IP associates with. In particular, if the floating IP is associated with a port, this field contains some attributes of the associated port, including `name`, `network_id`, `mac_address`, `admin_state_up`, `status`, `device_id` and `device_owner`. If the floating IP is not associated with a port, this field is `null`.
floatingip.port_forwardings	body	string	The associated port forwarding resources for the floating IP. If the floating IP has multiple port forwarding resources, this field has multiple entries. Each entry consists of network IP protocol (`protocol`), the fixed IP address of internal neutron port (`internal_ip_address`), the TCP or UDP port or port range used by internal neutron port (`internal_port`) or (`internal_port_range`) and the TCP or UDP port or port range used by floating IP (`external_port`) or (`external_port_range`).
floatingip.description	body	string	A human-readable description for the resource.

PUT

/v2.0/floatingips/{id}

Update floating IP

Updates a floating IP and its association with an internal port.

The association process is the same as the process for the create floating IP operation.

To disassociate a floating IP from a port, set the port_id attribute to null or omit it from the request body.

This example updates a floating IP:

Depending on the request body that you submit, this request associates a port with or disassociates a port from a floating IP.

Normal response codes: 200

Error response codes: 400, 401, 404, 409, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/floatingips/{id} API
floatingip	body	object	A `floatingip` object. When you associate a floating IP address with a VM, the instance has the same public IP address each time that it boots, basically to maintain a consistent IP address for maintaining DNS assignment.
floatingip.port_id	body	[‘string’, ‘null’]	The ID of a port associated with the floating IP. To associate the floating IP with a fixed IP, you must specify the ID of the internal port. To disassociate the floating IP, `null` should be specified.
floatingip.fixed_ip_address	body	string	The fixed IP address that is associated with the floating IP. If an internal port has multiple associated IP addresses, the service chooses the first IP address unless you explicitly define a fixed IP address in the `fixed_ip_address` parameter.
floatingip.qos_policy_id	body	[‘string’, ‘null’]
floatingip.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the floatingips/id:put operation",
  "properties": {
    "floatingip": {
      "type": "object",
      "properties": {
        "port_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of a port associated with the floating IP.\nTo associate the floating IP with a fixed IP,\nyou must specify the ID of the internal port.\nTo disassociate the floating IP, `null` should be specified."
        },
        "fixed_ip_address": {
          "type": "string",
          "description": "The fixed IP address that is associated with the floating IP.\nIf an internal port has multiple associated IP addresses,\nthe service chooses the first IP address unless you explicitly\ndefine a fixed IP address in the `fixed_ip_address` parameter."
        },
        "qos_policy_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid"
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `floatingip` object. When you associate a\nfloating IP address with a VM, the instance has the same public IP\naddress each time that it boots, basically to maintain a\nconsistent IP address for maintaining DNS assignment."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
floatingip	body	object	A `floatingip` object. When you associate a floating IP address with a VM, the instance has the same public IP address each time that it boots, basically to maintain a consistent IP address for maintaining DNS assignment.
floatingip.id	body	string	The ID of the floating IP address.
floatingip.floating_ip_address	body	string	The floating IP address.
floatingip.floating_network_id	body	string	The ID of the network associated with the floating IP.
floatingip.router_id	body	[‘string’, ‘null’]	The ID of the router for the floating IP.
floatingip.port_id	body	[‘string’, ‘null’]	The ID of a port associated with the floating IP.
floatingip.fixed_ip_address	body	string	The fixed IP address that is associated with the floating IP address.
floatingip.tenant_id	body	string	The ID of the project.
floatingip.status	body	string	The status of the floating IP. Values are `ACTIVE`, `DOWN` and `ERROR`.
floatingip.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the floating IP.
floatingip.revision_number	body	integer	The revision number of the resource.
floatingip.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
floatingip.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
floatingip.dns_name	body	string	A valid DNS name.
floatingip.dns_domain	body	string	A valid DNS domain.
floatingip.port_details	body	string	The information of the port that this floating IP associates with. In particular, if the floating IP is associated with a port, this field contains some attributes of the associated port, including `name`, `network_id`, `mac_address`, `admin_state_up`, `status`, `device_id` and `device_owner`. If the floating IP is not associated with a port, this field is `null`.
floatingip.port_forwardings	body	string	The associated port forwarding resources for the floating IP. If the floating IP has multiple port forwarding resources, this field has multiple entries. Each entry consists of network IP protocol (`protocol`), the fixed IP address of internal neutron port (`internal_ip_address`), the TCP or UDP port or port range used by internal neutron port (`internal_port`) or (`internal_port_range`) and the TCP or UDP port or port range used by floating IP (`external_port`) or (`external_port_range`).
floatingip.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/floatingips/{id}

Delete floating IP

Deletes a floating IP and, if present, its associated port.

This example deletes a floating IP:

Normal response codes: 204

Error response codes: 401, 404, 412

Responses¶

204¶

GET

/v2.0/floatingips/{floatingip_id}/tags

Responses¶

200¶

PUT

/v2.0/floatingips/{floatingip_id}/tags

Request of the floatingips/floatingip_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

floatingip_id

path

string

floatingip_id parameter for /v2.0/floatingips/{floatingip_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the floatingips/floatingip_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/floatingips/{floatingip_id}/tags

Responses¶

204¶

GET

/v2.0/floatingips/{floatingip_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/floatingips/{floatingip_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/floatingips/{floatingip_id}/tags/{id}

Responses¶

204¶

floatingips-port-forwardings¶

GET

/v2.0/floatingips/{floatingip_id}/port_forwardings/{id}

Show port forwarding

Shows information for a floating IP port forwarding.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 400, 404

Responses¶

200¶

Name	Location	Type	Description
port_forwarding	body	object	A `floating IP port forwarding` object.
port_forwarding.id	body	string	The ID of the floating IP port forwarding.
port_forwarding.external_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the port forwarding’s floating IP address.
port_forwarding.internal_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the floating ip port forwarding.
port_forwarding.internal_ip_address	body	string	The fixed IPv4 address of the Neutron port associated to the floating IP port forwarding.
port_forwarding.protocol	body	string	The IP protocol used in the floating IP port forwarding.
port_forwarding.internal_port_id	body	string	The ID of the Neutron port associated to the floating IP port forwarding.
port_forwarding.description	body	string	A text describing the rule, which helps users to manage/find easily theirs rules.
port_forwarding.external_port_range	body	number	The TCP/UDP/other protocol port range of the port forwarding’s floating IP address.
port_forwarding.internal_port_range	body	number	The TCP/UDP/other protocol port range of the Neutron port fixed IP address associated to the floating ip port forwarding.

PUT

/v2.0/floatingips/{floatingip_id}/port_forwardings/{id}

Update a port forwarding

Updates a floating IP port forwarding.

Normal response codes: 200

Error response codes: 400, 404

Request¶

Description

Name	Location	Type	Description
floatingip_id	path	string	floatingip_id parameter for /v2.0/floatingips/{floatingip_id}/tags/{id} API
id	path	string	id parameter for /v2.0/floatingips/{floatingip_id}/port_forwardings/{id} API
port_forwarding	body	object	A `floating IP port forwarding` object.
port_forwarding.external_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the port forwarding’s floating IP address.
port_forwarding.internal_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the floating ip port forwarding.
port_forwarding.internal_ip_address	body	string	The fixed IPv4 address of the Neutron port associated to the floating IP port forwarding.
port_forwarding.protocol	body	string	The IP protocol used in the floating IP port forwarding.
port_forwarding.internal_port_id	body	string	The ID of the Neutron port associated to the floating IP port forwarding.
port_forwarding.description	body	string
port_forwarding.external_port_range	body	number	The TCP/UDP/other protocol port range of the port forwarding’s floating IP address.
port_forwarding.internal_port_range	body	number	The TCP/UDP/other protocol port range of the Neutron port fixed IP address associated to the floating ip port forwarding.

Schema

{
  "type": "object",
  "description": "Request of the floatingips/floatingip_id/port_forwardings/id:put operation",
  "properties": {
    "port_forwarding": {
      "type": "object",
      "properties": {
        "external_port": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port number of the port forwarding\u2019s floating IP\naddress."
        },
        "internal_port": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port number of the Neutron port fixed IP\naddress associated to the floating ip port forwarding."
        },
        "internal_ip_address": {
          "type": "string",
          "description": "The fixed IPv4 address of the Neutron port associated to the floating IP\nport forwarding."
        },
        "protocol": {
          "type": "string",
          "enum": [
            "dccp",
            "icmp",
            "ipv6-icmp",
            "sctp",
            "tcp",
            "udp"
          ],
          "description": "The IP protocol used in the floating IP port forwarding."
        },
        "internal_port_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the Neutron port associated to the floating IP port forwarding."
        },
        "description": {
          "type": "string",
          "maxLength": 1024
        },
        "external_port_range": {
          "type": "number",
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port range of the port forwarding\u2019s floating IP\naddress."
        },
        "internal_port_range": {
          "type": "number",
          "minimum": 1,
          "maximum": 65535,
          "description": "The TCP/UDP/other protocol port range of the Neutron port fixed IP\naddress associated to the floating ip port forwarding."
        }
      },
      "description": "A `floating IP port forwarding` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
port_forwarding	body	object	A `floating IP port forwarding` object.
port_forwarding.id	body	string	The ID of the floating IP port forwarding.
port_forwarding.external_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the port forwarding’s floating IP address.
port_forwarding.internal_port	body	[‘number’, ‘null’]	The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the floating ip port forwarding.
port_forwarding.internal_ip_address	body	string	The fixed IPv4 address of the Neutron port associated to the floating IP port forwarding.
port_forwarding.protocol	body	string	The IP protocol used in the floating IP port forwarding.
port_forwarding.internal_port_id	body	string	The ID of the Neutron port associated to the floating IP port forwarding.
port_forwarding.description	body	string	A text describing the rule, which helps users to manage/find easily theirs rules.
port_forwarding.external_port_range	body	number	The TCP/UDP/other protocol port range of the port forwarding’s floating IP address.
port_forwarding.internal_port_range	body	number	The TCP/UDP/other protocol port range of the Neutron port fixed IP address associated to the floating ip port forwarding.

DELETE

/v2.0/floatingips/{floatingip_id}/port_forwardings/{id}

Delete a floating IP port forwarding

Deletes a floating IP port forwarding.

Normal response codes: 204

Error response codes: 404

Responses¶

204¶

floatingip-pools¶

GET

/v2.0/floatingip-pools

Responses¶

200¶

POST

/v2.0/floatingip-pools

Request of the floatingip-pools:post operation

Request¶

Description

Name

Location

Type

Description

floatingip_pool

body

object

Schema

{
  "type": "object",
  "description": "Request of the floatingip-pools:post operation",
  "properties": {
    "floatingip_pool": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
floatingip_pool	body	object
floatingip_pool.subnet_id	body	string
floatingip_pool.subnet_name	body	string
floatingip_pool.network_id	body	string
floatingip_pool.cidr	body	[‘string’, ‘null’]
floatingip_pool.project_id	body	string

GET

/v2.0/floatingip-pools/{id}

Responses¶

200¶

Name	Location	Type
floatingip_pool	body	object
floatingip_pool.subnet_id	body	string
floatingip_pool.subnet_name	body	string
floatingip_pool.network_id	body	string
floatingip_pool.cidr	body	[‘string’, ‘null’]
floatingip_pool.project_id	body	string

PUT

/v2.0/floatingip-pools/{id}

Request of the floatingip-pools/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/floatingip-pools/{id} API

floatingip_pool

body

object

Schema

{
  "type": "object",
  "description": "Request of the floatingip-pools/id:put operation",
  "properties": {
    "floatingip_pool": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
floatingip_pool	body	object
floatingip_pool.subnet_id	body	string
floatingip_pool.subnet_name	body	string
floatingip_pool.network_id	body	string
floatingip_pool.cidr	body	[‘string’, ‘null’]
floatingip_pool.project_id	body	string

DELETE

/v2.0/floatingip-pools/{id}

Responses¶

204¶

routers-conntrack-helper¶

GET

/v2.0/routers/{router_id}/conntrack_helpers/{id}

Show conntrack helper

Shows information for a router conntrack helper.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 400, 404

Responses¶

200¶

Name	Location	Type	Description
conntrack_helper	body	object	A router `conntrack helper` object.
conntrack_helper.id	body	string	The ID of the conntrack helper.
conntrack_helper.protocol	body	string	The network protocol for the netfilter conntrack target rule.
conntrack_helper.port	body	number	The network port for the netfilter conntrack target rule.
conntrack_helper.helper	body	string	The netfilter conntrack helper module.

PUT

/v2.0/routers/{router_id}/conntrack_helpers/{id}

Update a conntrack helper

Updates a router conntrack helper.

Normal response codes: 200

Error response codes: 400, 404

Request¶

Description

Name	Location	Type	Description
router_id	path	string	router_id parameter for /v2.0/routers/{router_id}/tags/{id} API
id	path	string	id parameter for /v2.0/routers/{router_id}/conntrack_helpers/{id} API
conntrack_helper	body	object
conntrack_helper.protocol	body	string	The network protocol for the netfilter conntrack target rule.
conntrack_helper.port	body	number	The network port for the netfilter conntrack target rule.
conntrack_helper.helper	body	string	The netfilter conntrack helper module.

Schema

{
  "type": "object",
  "description": "Request of the routers/router_id/conntrack_helpers/id:put operation",
  "properties": {
    "conntrack_helper": {
      "type": "object",
      "properties": {
        "protocol": {
          "type": "string",
          "enum": [
            "dccp",
            "icmp",
            "ipv6-icmp",
            "sctp",
            "tcp",
            "udp"
          ],
          "description": "The network protocol for the netfilter conntrack target rule."
        },
        "port": {
          "type": "number",
          "minimum": 1,
          "maximum": 65535,
          "description": "The network port for the netfilter conntrack target rule."
        },
        "helper": {
          "type": "string",
          "maxLength": 64,
          "description": "The netfilter conntrack helper module."
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
conntrack_helper	body	object	A router `conntrack helper` object.
conntrack_helper.id	body	string	The ID of the conntrack helper.
conntrack_helper.protocol	body	string	The network protocol for the netfilter conntrack target rule.
conntrack_helper.port	body	number	The network port for the netfilter conntrack target rule.
conntrack_helper.helper	body	string	The netfilter conntrack helper module.

DELETE

/v2.0/routers/{router_id}/conntrack_helpers/{id}

Delete a conntrack helper

Deletes a router conntrack helper.

Normal response codes: 204

Error response codes: 404

Responses¶

204¶

ndp-proxies¶

GET

/v2.0/ndp-proxies

Responses¶

200¶

POST

/v2.0/ndp-proxies

Request of the ndp-proxies:post operation

Request¶

Description

Name	Location	Type
ndp_proxy	body	object
ndp_proxy.name	body	string
ndp_proxy.project_id	body	string
ndp_proxy.router_id	body	string
ndp_proxy.port_id	body	string
ndp_proxy.ip_address	body	string
ndp_proxy.description	body	string

Schema

{
  "type": "object",
  "description": "Request of the ndp-proxies:post operation",
  "properties": {
    "ndp_proxy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "project_id": {
          "type": "string",
          "maxLength": 255
        },
        "router_id": {
          "type": "string",
          "format": "uuid"
        },
        "port_id": {
          "type": "string",
          "format": "uuid"
        },
        "ip_address": {
          "type": "string"
        },
        "description": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
ndp_proxy	body	object
ndp_proxy.id	body	string
ndp_proxy.name	body	string
ndp_proxy.project_id	body	string
ndp_proxy.router_id	body	string
ndp_proxy.port_id	body	string
ndp_proxy.ip_address	body	string
ndp_proxy.description	body	string
ndp_proxy.revision_number	body	integer
ndp_proxy.created_at	body	string
ndp_proxy.updated_at	body	string

GET

/v2.0/ndp-proxies/{id}

Responses¶

200¶

Name	Location	Type
ndp_proxy	body	object
ndp_proxy.id	body	string
ndp_proxy.name	body	string
ndp_proxy.project_id	body	string
ndp_proxy.router_id	body	string
ndp_proxy.port_id	body	string
ndp_proxy.ip_address	body	string
ndp_proxy.description	body	string
ndp_proxy.revision_number	body	integer
ndp_proxy.created_at	body	string
ndp_proxy.updated_at	body	string

PUT

/v2.0/ndp-proxies/{id}

Request of the ndp-proxies/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/ndp-proxies/{id} API

ndp_proxy

body

object

ndp_proxy.name

body

string

ndp_proxy.description

body

string

Schema

{
  "type": "object",
  "description": "Request of the ndp-proxies/id:put operation",
  "properties": {
    "ndp_proxy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
ndp_proxy	body	object
ndp_proxy.id	body	string
ndp_proxy.name	body	string
ndp_proxy.project_id	body	string
ndp_proxy.router_id	body	string
ndp_proxy.port_id	body	string
ndp_proxy.ip_address	body	string
ndp_proxy.description	body	string
ndp_proxy.revision_number	body	integer
ndp_proxy.created_at	body	string
ndp_proxy.updated_at	body	string

DELETE

/v2.0/ndp-proxies/{id}

Responses¶

204¶

local-ips¶

GET

/v2.0/local-ips

Responses¶

200¶

POST

/v2.0/local-ips

Request of the local-ips:post operation

Request¶

Description

Name	Location	Type
local_ip	body	object
local_ip.name	body	string
local_ip.description	body	string
local_ip.project_id	body	string
local_ip.local_port_id	body	string
local_ip.network_id	body	string
local_ip.local_ip_address	body	string
local_ip.ip_mode	body	string

Schema

{
  "type": "object",
  "description": "Request of the local-ips:post operation",
  "properties": {
    "local_ip": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 255
        },
        "project_id": {
          "type": "string",
          "maxLength": 255
        },
        "local_port_id": {
          "type": "string",
          "format": "uuid"
        },
        "network_id": {
          "type": "string",
          "format": "uuid"
        },
        "local_ip_address": {
          "type": "string"
        },
        "ip_mode": {
          "type": "string",
          "enum": [
            "translate",
            "passthrough"
          ]
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
local_ip	body	object
local_ip.id	body	string
local_ip.name	body	string
local_ip.description	body	string
local_ip.project_id	body	string
local_ip.local_port_id	body	string
local_ip.network_id	body	string
local_ip.local_ip_address	body	string
local_ip.ip_mode	body	string
local_ip.revision_number	body	integer
local_ip.created_at	body	string
local_ip.updated_at	body	string

GET

/v2.0/local-ips/{id}

Responses¶

200¶

Name	Location	Type
local_ip	body	object
local_ip.id	body	string
local_ip.name	body	string
local_ip.description	body	string
local_ip.project_id	body	string
local_ip.local_port_id	body	string
local_ip.network_id	body	string
local_ip.local_ip_address	body	string
local_ip.ip_mode	body	string
local_ip.revision_number	body	integer
local_ip.created_at	body	string
local_ip.updated_at	body	string

PUT

/v2.0/local-ips/{id}

Request of the local-ips/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/local-ips/{id} API

local_ip

body

object

local_ip.name

body

string

local_ip.description

body

string

Schema

{
  "type": "object",
  "description": "Request of the local-ips/id:put operation",
  "properties": {
    "local_ip": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
local_ip	body	object
local_ip.id	body	string
local_ip.name	body	string
local_ip.description	body	string
local_ip.project_id	body	string
local_ip.local_port_id	body	string
local_ip.network_id	body	string
local_ip.local_ip_address	body	string
local_ip.ip_mode	body	string
local_ip.revision_number	body	integer
local_ip.created_at	body	string
local_ip.updated_at	body	string

DELETE

/v2.0/local-ips/{id}

Responses¶

204¶

local_ips¶

GET

/v2.0/local_ips/{local_ip_id}/port_associations

List Local IP Associations

Lists Associations for the given Local IP.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/local_ips/{local_ip_id}/port_associations

Create Local IP Association

Creates a Local IP association with a given Port. If a Port has multiple fixed IPs user must specify which IP to use for association.

The operation returns the Conflict (409) response code for one of reasons:

Normal response codes: 201

Error response codes: 400, 401, 404, 409

Request¶

Description

Name	Location	Type	Description
local_ip_id	path	string	local_ip_id parameter for /v2.0/local_ips/{local_ip_id}/port_associations/{id} API
port_association	body	object
port_association.fixed_port_id	body	string	The requested ID of the port associated with the Local IP.
port_association.fixed_ip	body	string	The requested IP of the port associated with the Local IP.
port_association.project_id	body	string

Schema

{
  "type": "object",
  "description": "Request of the local_ips/local_ip_id/port_associations:post operation",
  "properties": {
    "port_association": {
      "type": "object",
      "properties": {
        "fixed_port_id": {
          "type": "string",
          "format": "uuid",
          "description": "The requested ID of the port associated with the Local IP."
        },
        "fixed_ip": {
          "type": "string",
          "description": "The requested IP of the port associated with the Local IP."
        },
        "project_id": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
port_association	body	object
port_association.local_ip_id	body	string	The ID of the associated Local IP.
port_association.local_ip_address	body	string
port_association.fixed_port_id	body	string	The ID of the port associated with the Local IP.
port_association.fixed_ip	body	string	The IP of the port associated with the Local IP.
port_association.host	body	string	The host of the port associated with the Local IP.

GET

/v2.0/local_ips/{local_ip_id}/port_associations/{id}

Responses¶

200¶

Name	Location	Type
port_association	body	object
port_association.local_ip_id	body	string
port_association.local_ip_address	body	string
port_association.fixed_port_id	body	string
port_association.fixed_ip	body	string
port_association.host	body	string

PUT

/v2.0/local_ips/{local_ip_id}/port_associations/{id}

Request of the local_ips/local_ip_id/port_associations/id:put operation

Request¶

Description

Name	Location	Type	Description
local_ip_id	path	string	local_ip_id parameter for /v2.0/local_ips/{local_ip_id}/port_associations/{id} API
id	path	string	id parameter for /v2.0/local_ips/{local_ip_id}/port_associations/{id} API
port_association	body	object

Schema

{
  "type": "object",
  "description": "Request of the local_ips/local_ip_id/port_associations/id:put operation",
  "properties": {
    "port_association": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
port_association	body	object
port_association.local_ip_id	body	string
port_association.local_ip_address	body	string
port_association.fixed_port_id	body	string
port_association.fixed_ip	body	string
port_association.host	body	string

DELETE

/v2.0/local_ips/{local_ip_id}/port_associations/{id}

Delete Local IP Association

Deletes a Local IP association.

Normal response codes: 204

Error response codes: 400, 401, 403, 404

Responses¶

204¶

log¶

GET

/v2.0/log/logs

List logs

Lists all log resources associated with your project.

The list might be empty.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/log/logs

Create log

Creates a log resource.

Creates a log resource by using the configuration that you define in the request object. A response object is returned. The object contains a unique ID.

If the caller is not an administrative user, this call returns the HTTP Forbidden (403) response code.

Users with an administrative role can create policies on behalf of other projects by specifying a project ID that is different than their own.

Normal response codes: 201

Error response codes: 400, 401, 403, 409

Request¶

Description

Name	Location	Type	Description
log	body	object	A `log` object.
log.project_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
log.name	body	string	Human-readable name of the resource. Default is an empty string.
log.resource_type	body	string	The resource log type such as ‘security_group’.
log.resource_id	body	[‘string’, ‘null’]	The ID of resource log (e.g security group ID).
log.event	body	string	Type of security events to log. `ACCEPT`, `DROP`, or `ALL`. Default is `ALL`.
log.target_id	body	[‘string’, ‘null’]	The ID of resource target log such as port ID.
log.enabled	body	[‘string’, ‘boolean’]	Indicates whether this log object is enabled or disabled. Default is true.
log.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the log/logs:post operation",
  "properties": {
    "log": {
      "type": "object",
      "properties": {
        "project_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "resource_type": {
          "type": "string",
          "maxLength": 255,
          "description": "The resource log type such as \u2018security_group\u2019."
        },
        "resource_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of resource log (e.g security group ID)."
        },
        "event": {
          "type": "string",
          "enum": [
            "ACCEPT",
            "DROP",
            "ALL"
          ],
          "description": "Type of security events to log.\n`ACCEPT`, `DROP`, or `ALL`.\nDefault is `ALL`."
        },
        "target_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of resource target log such as port ID."
        },
        "enabled": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this log object is enabled or disabled.\nDefault is true."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `log` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
log	body	object	A `log` object.
log.id	body	string	The ID of the log object.
log.project_id	body	string	The ID of the project.
log.name	body	string	Human-readable name of the resource.
log.resource_type	body	string	The resource log type such as ‘security_group’.
log.resource_id	body	[‘string’, ‘null’]	The ID of resource log (e.g security group ID).
log.event	body	string	Type of security events to log. `ACCEPT`, `DROP`, or `ALL`.
log.target_id	body	[‘string’, ‘null’]	The ID of resource target log such as port ID.
log.enabled	body	[‘string’, ‘boolean’]	Indicates whether this log object is enabled or disabled.
log.revision_number	body	integer	The revision number of the resource.
log.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
log.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
log.description	body	string	A human-readable description for the resource.

GET

/v2.0/log/logs/{id}

Show log

Shows details log resource.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
log	body	object	A `log` object.
log.id	body	string	The ID of the log object.
log.project_id	body	string	The ID of the project.
log.name	body	string	Human-readable name of the resource.
log.resource_type	body	string	The resource log type such as ‘security_group’.
log.resource_id	body	[‘string’, ‘null’]	The ID of resource log (e.g security group ID).
log.event	body	string	Type of security events to log. `ACCEPT`, `DROP`, or `ALL`.
log.target_id	body	[‘string’, ‘null’]	The ID of resource target log such as port ID.
log.enabled	body	[‘string’, ‘boolean’]	Indicates whether this log object is enabled or disabled.
log.revision_number	body	integer	The revision number of the resource.
log.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
log.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
log.description	body	string	A human-readable description for the resource.

PUT

/v2.0/log/logs/{id}

Update log

Updates a log resource.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/log/logs/{id} API
log	body	object	A `log` object.
log.name	body	string	Human-readable name of the resource. Default is an empty string.
log.enabled	body	[‘string’, ‘boolean’]	Indicates whether this log object is enabled or disabled.
log.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the log/logs/id:put operation",
  "properties": {
    "log": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "enabled": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this log object is enabled or disabled."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `log` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
log	body	object	A `log` object.
log.id	body	string	The ID of the log object.
log.project_id	body	string	The ID of the project.
log.name	body	string	Human-readable name of the resource.
log.resource_type	body	string	The resource log type such as ‘security_group’.
log.resource_id	body	[‘string’, ‘null’]	The ID of resource log (e.g security group ID).
log.event	body	string	Type of security events to log. `ACCEPT`, `DROP`, or `ALL`.
log.target_id	body	[‘string’, ‘null’]	The ID of resource target log such as port ID.
log.enabled	body	[‘string’, ‘boolean’]	Indicates whether this log object is enabled or disabled.
log.revision_number	body	integer	The revision number of the resource.
log.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
log.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
log.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/log/logs/{id}

Delete log

Deletes a log resource.

Normal response codes: 204

Error response codes: 400, 401, 404, 412

Responses¶

204¶

GET

/v2.0/log/loggable-resources

List loggable resources

Lists all resource log types are supporting.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/log/loggable-resources

Request of the log/loggable-resources:post operation

Request¶

Description

Name

Location

Type

Description

loggable_resource

body

object

Schema

{
  "type": "object",
  "description": "Request of the log/loggable-resources:post operation",
  "properties": {
    "loggable_resource": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
loggable_resource	body	object
loggable_resource.type	body	string

GET

/v2.0/log/loggable-resources/{id}

Responses¶

200¶

Name	Location	Type	Description
loggable_resource	body	object
loggable_resource.type	body	string

PUT

/v2.0/log/loggable-resources/{id}

Request of the log/loggable-resources/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/log/loggable-resources/{id} API

loggable_resource

body

object

Schema

{
  "type": "object",
  "description": "Request of the log/loggable-resources/id:put operation",
  "properties": {
    "loggable_resource": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
loggable_resource	body	object
loggable_resource.type	body	string

DELETE

/v2.0/log/loggable-resources/{id}

Responses¶

204¶

metering¶

GET

/v2.0/metering/metering-labels

List metering labels

Lists all L3 metering labels that belong to the project.

The list shows the ID for each metering label.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/metering/metering-labels

Create metering label

Creates an L3 metering label.

Normal response codes: 201

Error response codes: 400, 401, 403

Request¶

Description

Name	Location	Type	Description
metering_label	body	object	A `metering_label` object.
metering_label.name	body	string	Human-readable name of the resource. Default is an empty string.
metering_label.description	body	string	A human-readable description for the resource. Default is an empty string.
metering_label.tenant_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
metering_label.shared	body	[‘string’, ‘boolean’]	Indicates whether this metering label is shared across all projects.

Schema

{
  "type": "object",
  "description": "Request of the metering/metering-labels:post operation",
  "properties": {
    "metering_label": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 1024,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this metering label is shared\nacross all projects."
        }
      },
      "description": "A `metering_label` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
metering_label	body	object	A `metering_label` object.
metering_label.id	body	string	The ID of the metering label.
metering_label.name	body	string	Human-readable name of the resource.
metering_label.description	body	string	A human-readable description for the resource.
metering_label.tenant_id	body	string	The ID of the project.
metering_label.shared	body	[‘string’, ‘boolean’]	Indicates whether this metering label is shared across all projects.

GET

/v2.0/metering/metering-labels/{id}

Show metering label details

Shows details for a metering label.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
metering_label	body	object	A `metering_label` object.
metering_label.id	body	string	The ID of the metering label.
metering_label.name	body	string	Human-readable name of the resource.
metering_label.description	body	string	A human-readable description for the resource.
metering_label.tenant_id	body	string	The ID of the project.
metering_label.shared	body	[‘string’, ‘boolean’]	Indicates whether this metering label is shared across all projects.

PUT

/v2.0/metering/metering-labels/{id}

Request of the metering/metering-labels/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/metering/metering-labels/{id} API

metering_label

body

object

Schema

{
  "type": "object",
  "description": "Request of the metering/metering-labels/id:put operation",
  "properties": {
    "metering_label": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
metering_label	body	object
metering_label.id	body	string
metering_label.name	body	string
metering_label.description	body	string
metering_label.tenant_id	body	string
metering_label.shared	body	[‘string’, ‘boolean’]

DELETE

/v2.0/metering/metering-labels/{id}

Delete metering label

Deletes an L3 metering label.

Normal response codes: 204

Error response codes: 401, 404

Responses¶

204¶

GET

/v2.0/metering/metering-label-rules

List metering label rules

Lists a summary of all L3 metering label rules that belong to the project.

The list shows the ID for each metering label rule.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/metering/metering-label-rules

Create metering label rule

Creates an L3 metering label rule.

Normal response codes: 201

Error response codes: 400, 401, 403, 404, 409

Request¶

Description

Name	Location	Type	Description
metering_label_rule	body	object	A `metering_label_rule` object.
metering_label_rule.metering_label_id	body	string	The metering label ID associated with this metering rule.
metering_label_rule.direction	body	string	Ingress or egress, which is the direction in which the metering rule is applied.
metering_label_rule.excluded	body	[‘string’, ‘boolean’]	Indicates whether to count the traffic of a specific IP address with the `remote_ip_prefix`, `source_ip_prefix`, or `destination_ip_prefix` values. Default is `false`.
metering_label_rule.remote_ip_prefix	body	string	(deprecated) The source IP prefix that is matched by this metering rule. By source IP prefix, one should read the internal/private IPs used in OpenStack.
metering_label_rule.tenant_id	body	string
metering_label_rule.source_ip_prefix	body	string
metering_label_rule.destination_ip_prefix	body	string

Schema

{
  "type": "object",
  "description": "Request of the metering/metering-label-rules:post operation",
  "properties": {
    "metering_label_rule": {
      "type": "object",
      "properties": {
        "metering_label_id": {
          "type": "string",
          "format": "uuid",
          "description": "The metering label ID associated with this\nmetering rule."
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ],
          "description": "Ingress or egress, which is the direction in\nwhich the metering rule is applied."
        },
        "excluded": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether to count the traffic of a specific IP address with the\n`remote_ip_prefix`, `source_ip_prefix`, or `destination_ip_prefix`\nvalues. Default is `false`."
        },
        "remote_ip_prefix": {
          "type": "string",
          "description": "(deprecated) The source IP prefix that is matched by this metering rule. By\nsource IP prefix, one should read the internal/private IPs used in\nOpenStack."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        },
        "source_ip_prefix": {
          "type": "string"
        },
        "destination_ip_prefix": {
          "type": "string"
        }
      },
      "description": "A `metering_label_rule` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
metering_label_rule	body	object	A `metering_label_rule` object.
metering_label_rule.id	body	string	The ID of the metering label rule.
metering_label_rule.metering_label_id	body	string	The metering label ID associated with this metering rule.
metering_label_rule.direction	body	string	Ingress or egress, which is the direction in which the metering rule is applied.
metering_label_rule.excluded	body	[‘string’, ‘boolean’]	Indicates whether to count the traffic of a specific IP address with the `remote_ip_prefix`, `source_ip_prefix`, or `destination_ip_prefix` values.
metering_label_rule.remote_ip_prefix	body	string	(deprecated) The source IP prefix that is matched by this metering rule. By source IP prefix, one should read the internal/private IPs used in OpenStack.
metering_label_rule.tenant_id	body	string
metering_label_rule.source_ip_prefix	body	string
metering_label_rule.destination_ip_prefix	body	string

GET

/v2.0/metering/metering-label-rules/{id}

Show metering label rule details

Shows details for a metering label rule.

The response body shows this information for each metering label rule:

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type
metering_label_rule	body	object
metering_label_rule.id	body	string
metering_label_rule.metering_label_id	body	string
metering_label_rule.direction	body	string
metering_label_rule.excluded	body	[‘string’, ‘boolean’]
metering_label_rule.remote_ip_prefix	body	string
metering_label_rule.tenant_id	body	string
metering_label_rule.source_ip_prefix	body	string
metering_label_rule.destination_ip_prefix	body	string

PUT

/v2.0/metering/metering-label-rules/{id}

Request of the metering/metering-label-rules/id:put operation

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/metering/metering-label-rules/{id} API
metering_label_rule	body	object
metering_label_rule.source_ip_prefix	body	string
metering_label_rule.destination_ip_prefix	body	string

Schema

{
  "type": "object",
  "description": "Request of the metering/metering-label-rules/id:put operation",
  "properties": {
    "metering_label_rule": {
      "type": "object",
      "properties": {
        "source_ip_prefix": {
          "type": "string"
        },
        "destination_ip_prefix": {
          "type": "string"
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
metering_label_rule	body	object
metering_label_rule.id	body	string
metering_label_rule.metering_label_id	body	string
metering_label_rule.direction	body	string
metering_label_rule.excluded	body	[‘string’, ‘boolean’]
metering_label_rule.remote_ip_prefix	body	string
metering_label_rule.tenant_id	body	string
metering_label_rule.source_ip_prefix	body	string
metering_label_rule.destination_ip_prefix	body	string

DELETE

/v2.0/metering/metering-label-rules/{id}

Delete metering label rule

Deletes an L3 metering label rule.

Normal response codes: 204

Error response codes: 401, 404

Responses¶

204¶

network-ip-availabilities¶

GET

/v2.0/network-ip-availabilities

List Network IP Availability

Lists network IP availability of all networks.

By default policy configuration, only administrative users can retrieve IP availabilities. Otherwise, an empty list will be returned.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/network-ip-availabilities

Request of the network-ip-availabilities:post operation

Request¶

Description

Name

Location

Type

Description

network_ip_availability

body

object

Schema

{
  "type": "object",
  "description": "Request of the network-ip-availabilities:post operation",
  "properties": {
    "network_ip_availability": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
network_ip_availability	body	object
network_ip_availability.network_id	body	string
network_ip_availability.network_name	body	string
network_ip_availability.tenant_id	body	string
network_ip_availability.total_ips	body	string
network_ip_availability.used_ips	body	string
network_ip_availability.subnet_ip_availability	body	string

GET

/v2.0/network-ip-availabilities/{id}

Show Network IP Availability

Shows network IP availability details for a network.

By default policy configuration, only administrative users can retrieve IP availability. Otherwise, Not Found (404) will be returned.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
network_ip_availability	body	object	A `network_ip_availability` object.
network_ip_availability.network_id	body	string	The ID of the network whose IP availability detail is reported.
network_ip_availability.network_name	body	string	Human-readable name of the network.
network_ip_availability.tenant_id	body	string	The ID of the project.
network_ip_availability.total_ips	body	string	The total number of IP addresses in a network.
network_ip_availability.used_ips	body	string	The number of used IP addresses of all subnets in a network.
network_ip_availability.subnet_ip_availability	body	string	A list of dictionaries showing subnet IP availability. It contains information for every subnet associated to the network.

PUT

/v2.0/network-ip-availabilities/{id}

Request of the network-ip-availabilities/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/network-ip-availabilities/{id} API

network_ip_availability

body

object

Schema

{
  "type": "object",
  "description": "Request of the network-ip-availabilities/id:put operation",
  "properties": {
    "network_ip_availability": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
network_ip_availability	body	object
network_ip_availability.network_id	body	string
network_ip_availability.network_name	body	string
network_ip_availability.tenant_id	body	string
network_ip_availability.total_ips	body	string
network_ip_availability.used_ips	body	string
network_ip_availability.subnet_ip_availability	body	string

DELETE

/v2.0/network-ip-availabilities/{id}

Responses¶

204¶

network-segment-ranges¶

GET

/v2.0/network-segment-ranges

Responses¶

200¶

POST

/v2.0/network-segment-ranges

Request of the network-segment-ranges:post operation

Request¶

Description

Name	Location	Type
network_segment_range	body	object
network_segment_range.name	body	string
network_segment_range.shared	body	[‘string’, ‘boolean’]
network_segment_range.project_id	body	string
network_segment_range.network_type	body	string
network_segment_range.physical_network	body	string
network_segment_range.minimum	body	number
network_segment_range.maximum	body	number
network_segment_range.description	body	string

Schema

{
  "type": "object",
  "description": "Request of the network-segment-ranges:post operation",
  "properties": {
    "network_segment_range": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ]
        },
        "project_id": {
          "type": "string",
          "maxLength": 255
        },
        "network_type": {
          "type": "string",
          "enum": [
            "vlan",
            "vxlan",
            "gre",
            "geneve"
          ]
        },
        "physical_network": {
          "type": "string",
          "maxLength": 64
        },
        "minimum": {
          "type": "number",
          "minimum": 1,
          "maximum": 4294967295
        },
        "maximum": {
          "type": "number",
          "minimum": 1,
          "maximum": 4294967295
        },
        "description": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
network_segment_range	body	object
network_segment_range.id	body	string
network_segment_range.name	body	string
network_segment_range.default	body	[‘string’, ‘boolean’]
network_segment_range.shared	body	[‘string’, ‘boolean’]
network_segment_range.project_id	body	string
network_segment_range.network_type	body	string
network_segment_range.physical_network	body	string
network_segment_range.minimum	body	number
network_segment_range.maximum	body	number
network_segment_range.used	body	string
network_segment_range.available	body	string
network_segment_range.revision_number	body	integer
network_segment_range.created_at	body	string
network_segment_range.updated_at	body	string
network_segment_range.description	body	string

GET

/v2.0/network-segment-ranges/{id}

Responses¶

200¶

Name	Location	Type
network_segment_range	body	object
network_segment_range.id	body	string
network_segment_range.name	body	string
network_segment_range.default	body	[‘string’, ‘boolean’]
network_segment_range.shared	body	[‘string’, ‘boolean’]
network_segment_range.project_id	body	string
network_segment_range.network_type	body	string
network_segment_range.physical_network	body	string
network_segment_range.minimum	body	number
network_segment_range.maximum	body	number
network_segment_range.used	body	string
network_segment_range.available	body	string
network_segment_range.revision_number	body	integer
network_segment_range.created_at	body	string
network_segment_range.updated_at	body	string
network_segment_range.description	body	string

PUT

/v2.0/network-segment-ranges/{id}

Request of the network-segment-ranges/id:put operation

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/network-segment-ranges/{id} API
network_segment_range	body	object
network_segment_range.name	body	string
network_segment_range.minimum	body	number
network_segment_range.maximum	body	number
network_segment_range.description	body	string

Schema

{
  "type": "object",
  "description": "Request of the network-segment-ranges/id:put operation",
  "properties": {
    "network_segment_range": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "minimum": {
          "type": "number",
          "minimum": 1,
          "maximum": 4294967295
        },
        "maximum": {
          "type": "number",
          "minimum": 1,
          "maximum": 4294967295
        },
        "description": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
network_segment_range	body	object
network_segment_range.id	body	string
network_segment_range.name	body	string
network_segment_range.default	body	[‘string’, ‘boolean’]
network_segment_range.shared	body	[‘string’, ‘boolean’]
network_segment_range.project_id	body	string
network_segment_range.network_type	body	string
network_segment_range.physical_network	body	string
network_segment_range.minimum	body	number
network_segment_range.maximum	body	number
network_segment_range.used	body	string
network_segment_range.available	body	string
network_segment_range.revision_number	body	integer
network_segment_range.created_at	body	string
network_segment_range.updated_at	body	string
network_segment_range.description	body	string

DELETE

/v2.0/network-segment-ranges/{id}

Responses¶

204¶

port-bindings¶

GET

/v2.0/ports/{port_id}/bindings

Show Port Binding of a Port

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

POST

/v2.0/ports/{port_id}/bindings

Request of the ports/port_id/bindings:post operation

Request¶

Description

Name	Location	Type	Description
port_id	path	string	port_id parameter for /v2.0/ports/{port_id}/add_allowed_address_pairs API
binding	body	object
binding.host	body	string
binding.vnic_type	body	string
binding.profile	body	[‘object’, ‘null’]
binding.project_id	body	string

Schema

{
  "type": "object",
  "description": "Request of the ports/port_id/bindings:post operation",
  "properties": {
    "binding": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string"
        },
        "vnic_type": {
          "type": "string",
          "enum": [
            "normal",
            "direct",
            "macvtap",
            "baremetal",
            "direct-physical",
            "virtio-forwarder",
            "smart-nic",
            "vdpa",
            "accelerator-direct",
            "accelerator-direct-physical",
            "remote-managed"
          ]
        },
        "profile": {
          "type": [
            "object",
            "null"
          ]
        },
        "project_id": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
binding	body	object
binding.host	body	string
binding.vif_type	body	string
binding.vif_details	body	string
binding.vnic_type	body	string
binding.profile	body	[‘object’, ‘null’]
binding.status	body	string
binding.project_id	body	string

PUT

/v2.0/ports/{port_id}/bindings/{id}/activate

Activate Port binding

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name	Location	Type	Description
port_id	path	string	port_id parameter for /v2.0/ports/{port_id}/add_allowed_address_pairs API
id	path	string	id parameter for /v2.0/ports/{port_id}/bindings/{id} API

Schema

{
  "type": "object",
  "description": "Request of the ports/port_id/bindings/id/activate:put operation"
}

Responses¶

200¶

GET

/v2.0/ports/{port_id}/bindings/{id}

Responses¶

200¶

Name	Location	Type
binding	body	object
binding.host	body	string
binding.vif_type	body	string
binding.vif_details	body	string
binding.vnic_type	body	string
binding.profile	body	[‘object’, ‘null’]
binding.status	body	string
binding.project_id	body	string

PUT

/v2.0/ports/{port_id}/bindings/{id}

Request of the ports/port_id/bindings/id:put operation

Request¶

Description

Name	Location	Type	Description
port_id	path	string	port_id parameter for /v2.0/ports/{port_id}/add_allowed_address_pairs API
id	path	string	id parameter for /v2.0/ports/{port_id}/bindings/{id} API
binding	body	object
binding.host	body	string
binding.vnic_type	body	string
binding.profile	body	[‘object’, ‘null’]

Schema

{
  "type": "object",
  "description": "Request of the ports/port_id/bindings/id:put operation",
  "properties": {
    "binding": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string"
        },
        "vnic_type": {
          "type": "string",
          "enum": [
            "normal",
            "direct",
            "macvtap",
            "baremetal",
            "direct-physical",
            "virtio-forwarder",
            "smart-nic",
            "vdpa",
            "accelerator-direct",
            "accelerator-direct-physical",
            "remote-managed"
          ]
        },
        "profile": {
          "type": [
            "object",
            "null"
          ]
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
binding	body	object
binding.host	body	string
binding.vif_type	body	string
binding.vif_details	body	string
binding.vnic_type	body	string
binding.profile	body	[‘object’, ‘null’]
binding.status	body	string
binding.project_id	body	string

DELETE

/v2.0/ports/{port_id}/bindings/{id}

Responses¶

204¶

qos¶

GET

/v2.0/qos/policies

List QoS policies

Lists all QoS policies associated with your project. One policy can contain more than one rule type.

The list might be empty.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/qos/policies

Create QoS policy

Creates a QoS policy.

Creates a QoS policy by using the configuration that you define in the request object. A response object is returned. The object contains a unique ID.

By the default policy configuration, if the caller is not an administrative user, this call returns the HTTP Forbidden (403) response code.

Users with an administrative role can create policies on behalf of other projects by specifying a project ID that is different than their own.

Normal response codes: 201

Error response codes: 401, 403, 404, 409

Request¶

Description

Name	Location	Type	Description
policy	body	object	A QoS `policy` object.
policy.name	body	string	Human-readable name of the resource.
policy.shared	body	[‘string’, ‘boolean’]	Set to `true` to share this policy with other projects. Default is `false`.
policy.tenant_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
policy.is_default	body	[‘string’, ‘boolean’]	If `true`, the QoS `policy` is the default policy.
policy.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies:post operation",
  "properties": {
    "policy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Set to `true` to share this policy with other\nprojects. Default is `false`."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "is_default": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "If `true`, the QoS `policy` is the default policy."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A QoS `policy` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
policy	body	object	A QoS `policy` object.
policy.id	body	string	The ID of the QoS policy.
policy.name	body	string	Human-readable name of the resource.
policy.shared	body	[‘string’, ‘boolean’]	Indicates whether this policy is shared across all projects.
policy.tenant_id	body	string	The ID of the project.
policy.rules	body	string	A set of zero or more policy rules.
policy.is_default	body	[‘string’, ‘boolean’]	If `true`, the QoS `policy` is the default policy.
policy.revision_number	body	integer	The revision number of the resource.
policy.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
policy.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
policy.description	body	string	A human-readable description for the resource.

GET

/v2.0/qos/policies/{id}

Show QoS policy details

Shows details for a QoS policy. One policy can contain more than one rule type.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
policy	body	object	A QoS `policy` object.
policy.id	body	string	The ID of the QoS policy.
policy.name	body	string	Human-readable name of the resource.
policy.shared	body	[‘string’, ‘boolean’]	Indicates whether this policy is shared across all projects.
policy.tenant_id	body	string	The ID of the project.
policy.rules	body	string	A set of zero or more policy rules.
policy.is_default	body	[‘string’, ‘boolean’]	If `true`, the QoS `policy` is the default policy.
policy.revision_number	body	integer	The revision number of the resource.
policy.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
policy.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
policy.description	body	string	A human-readable description for the resource.

PUT

/v2.0/qos/policies/{id}

Update QoS policy

Updates a QoS policy.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/qos/policies/{id} API
policy	body	object	A QoS `policy` object.
policy.name	body	string	Human-readable name of the resource.
policy.shared	body	[‘string’, ‘boolean’]	Set to `true` to share this policy with other projects. Default is `false`.
policy.is_default	body	[‘string’, ‘boolean’]	If `true`, the QoS `policy` is the default policy.
policy.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/id:put operation",
  "properties": {
    "policy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Set to `true` to share this policy with other\nprojects. Default is `false`."
        },
        "is_default": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "If `true`, the QoS `policy` is the default policy."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A QoS `policy` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
policy	body	object	A QoS `policy` object.
policy.id	body	string	The ID of the QoS policy.
policy.name	body	string	Human-readable name of the resource.
policy.shared	body	[‘string’, ‘boolean’]	Indicates whether this policy is shared across all projects.
policy.tenant_id	body	string	The ID of the project.
policy.rules	body	string	A set of zero or more policy rules.
policy.is_default	body	[‘string’, ‘boolean’]	If `true`, the QoS `policy` is the default policy.
policy.revision_number	body	integer	The revision number of the resource.
policy.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
policy.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
policy.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/qos/policies/{id}

Delete QoS policy

Deletes a QoS policy.

Normal response codes: 204

Error response codes: 400, 401, 404, 412

Responses¶

204¶

GET

/v2.0/qos/rule-types

List QoS rule types

Lists available qos rule types.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/qos/rule-types

Request of the qos/rule-types:post operation

Request¶

Description

Name	Location	Type
rule_type	body	object
rule_type.all_rules	body	[‘string’, ‘boolean’, ‘null’]
rule_type.all_supported	body	[‘string’, ‘boolean’, ‘null’]

Schema

{
  "type": "object",
  "description": "Request of the qos/rule-types:post operation",
  "properties": {
    "rule_type": {
      "type": "object",
      "properties": {
        "all_rules": {
          "type": [
            "string",
            "boolean",
            "null"
          ]
        },
        "all_supported": {
          "type": [
            "string",
            "boolean",
            "null"
          ]
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
rule_type	body	object
rule_type.type	body	string
rule_type.drivers	body	string

GET

/v2.0/qos/rule-types/{id}

Show QoS rule type details

Shows details for an available QoS rule type.

You can control which response parameters are returned by using the fields query parameter. For information, see Filtering and column selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
rule_type	body	object
rule_type.type	body	string	The type of QoS rule.
rule_type.drivers	body	string	List of loaded QoS drivers with supported rule type parameters with possible values for each. Each driver is represented by a dict with the keys `name` and `supported_parameters`. Field `name` contains the name of a backend driver. Field `supported_parameters` contains a list of dicts with `parameter_name`, `parameter_type` and `parameter_values` fields. The valid values for `parameter_type` are `choices` or `range`. If `parameter_type` is `choices` then `parameter_values` contains a list of acceptable values, otherwise it contains a dict with keys of `start` and `end` which define the range of acceptable values.

PUT

/v2.0/qos/rule-types/{id}

Request of the qos/rule-types/id:put operation

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/qos/rule-types/{id} API
rule_type	body	object
rule_type.all_rules	body	[‘string’, ‘boolean’, ‘null’]
rule_type.all_supported	body	[‘string’, ‘boolean’, ‘null’]

Schema

{
  "type": "object",
  "description": "Request of the qos/rule-types/id:put operation",
  "properties": {
    "rule_type": {
      "type": "object",
      "properties": {
        "all_rules": {
          "type": [
            "string",
            "boolean",
            "null"
          ]
        },
        "all_supported": {
          "type": [
            "string",
            "boolean",
            "null"
          ]
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
rule_type	body	object
rule_type.type	body	string
rule_type.drivers	body	string

DELETE

/v2.0/qos/rule-types/{id}

Responses¶

204¶

GET

/v2.0/qos/policies/{policy_id}/bandwidth_limit_rules

List bandwidth limit rules for QoS policy

Lists all bandwidth limit rules for a QoS policy.

The list might be empty.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

POST

/v2.0/qos/policies/{policy_id}/bandwidth_limit_rules

Create bandwidth limit rule

Creates a bandwidth limit rule for a QoS policy.

Normal response codes: 201

Error response codes: 400, 401, 404, 409

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
bandwidth_limit_rule	body	object	A `bandwidth_limit_rule` object.
bandwidth_limit_rule.tenant_id	body	string
bandwidth_limit_rule.max_kbps	body	number	The maximum KBPS (kilobits per second) value. If you specify this value, must be greater than 0 otherwise max_kbps will have no value.
bandwidth_limit_rule.max_burst_kbps	body	number	The maximum burst size (in kilobits). Default is `0`.
bandwidth_limit_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`. Default value is `egress`.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/bandwidth_limit_rules:post operation",
  "properties": {
    "bandwidth_limit_rule": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string"
        },
        "max_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647,
          "description": "The maximum KBPS (kilobits per second) value. If you specify this\nvalue, must be greater than 0 otherwise max_kbps will have no value."
        },
        "max_burst_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647,
          "description": "The maximum burst size (in kilobits). Default is `0`."
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ],
          "description": "The direction of the traffic to which the QoS\nrule is applied, as seen from the point of view\nof the `port`.\nValid values are `egress` and `ingress`.\nDefault value is `egress`."
        }
      },
      "description": "A `bandwidth_limit_rule` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
bandwidth_limit_rule	body	object	A `bandwidth_limit_rule` object.
bandwidth_limit_rule.id	body	string	The ID of the QoS Bandwidth limit rule.
bandwidth_limit_rule.tenant_id	body	string
bandwidth_limit_rule.max_kbps	body	number	The maximum KBPS (kilobits per second) value. If you specify this value, must be greater than 0 otherwise max_kbps will have no value.
bandwidth_limit_rule.max_burst_kbps	body	number	The maximum burst size (in kilobits).
bandwidth_limit_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`. Default value is `egress`.

GET

/v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{id}

Show bandwidth limit rule details

Shows details for a bandwidth limit rule for a QoS policy.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
bandwidth_limit_rule	body	object	A `bandwidth_limit_rule` object.
bandwidth_limit_rule.id	body	string	The ID of the QoS Bandwidth limit rule.
bandwidth_limit_rule.tenant_id	body	string
bandwidth_limit_rule.max_kbps	body	number	The maximum KBPS (kilobits per second) value. If you specify this value, must be greater than 0 otherwise max_kbps will have no value.
bandwidth_limit_rule.max_burst_kbps	body	number	The maximum burst size (in kilobits).
bandwidth_limit_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`. Default value is `egress`.

PUT

/v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{id}

Update bandwidth limit rule

Updates a bandwidth limit rule for a QoS policy.

Normal response codes: 200

Error response codes: 400, 401, 404

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
id	path	string	id parameter for /v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{id} API
bandwidth_limit_rule	body	object	A `bandwidth_limit_rule` object.
bandwidth_limit_rule.max_kbps	body	number	The maximum KBPS (kilobits per second) value. If you specify this value, must be greater than 0 otherwise max_kbps will have no value.
bandwidth_limit_rule.max_burst_kbps	body	number	The maximum burst size (in kilobits). Default is `0`.
bandwidth_limit_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/bandwidth_limit_rules/id:put operation",
  "properties": {
    "bandwidth_limit_rule": {
      "type": "object",
      "properties": {
        "max_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647,
          "description": "The maximum KBPS (kilobits per second) value. If you specify this\nvalue, must be greater than 0 otherwise max_kbps will have no value."
        },
        "max_burst_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647,
          "description": "The maximum burst size (in kilobits). Default is `0`."
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ],
          "description": "The direction of the traffic to which the QoS\nrule is applied, as seen from the point of view\nof the `port`.\nValid values are `egress` and `ingress`."
        }
      },
      "description": "A `bandwidth_limit_rule` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
bandwidth_limit_rule	body	object	A `bandwidth_limit_rule` object.
bandwidth_limit_rule.id	body	string	The ID of the QoS Bandwidth limit rule.
bandwidth_limit_rule.tenant_id	body	string
bandwidth_limit_rule.max_kbps	body	number	The maximum KBPS (kilobits per second) value. If you specify this value, must be greater than 0 otherwise max_kbps will have no value.
bandwidth_limit_rule.max_burst_kbps	body	number	The maximum burst size (in kilobits).
bandwidth_limit_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`.

DELETE

/v2.0/qos/policies/{policy_id}/bandwidth_limit_rules/{id}

Delete bandwidth limit rule

Deletes a bandwidth limit rule for a QoS policy.

Normal response codes: 204

Error response codes: 400, 401, 404

Responses¶

204¶

GET

/v2.0/qos/policies/{policy_id}/dscp_marking_rules

List DSCP marking rules for QoS policy

Lists all DSCP marking rules for a QoS policy.

The list may be empty.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

POST

/v2.0/qos/policies/{policy_id}/dscp_marking_rules

Create DSCP marking rule

Creates a DSCP marking rule for a QoS policy.

Normal response codes: 201

Error response codes: 400, 401, 404, 409

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
dscp_marking_rule	body	object	A `dscp_marking_rule` object.
dscp_marking_rule.tenant_id	body	string
dscp_marking_rule.dscp_mark	body	integer	The DSCP mark value.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/dscp_marking_rules:post operation",
  "properties": {
    "dscp_marking_rule": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string"
        },
        "dscp_mark": {
          "type": "integer",
          "enum": [
            0,
            8,
            10,
            12,
            14,
            16,
            18,
            20,
            22,
            24,
            26,
            28,
            30,
            32,
            34,
            36,
            38,
            40,
            44,
            46,
            48,
            56
          ],
          "description": "The DSCP mark value."
        }
      },
      "description": "A `dscp_marking_rule` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
dscp_marking_rule	body	object	A `dscp_marking_rule` object.
dscp_marking_rule.id	body	string	The ID of the QoS DSCP marking rule.
dscp_marking_rule.tenant_id	body	string
dscp_marking_rule.dscp_mark	body	integer	The DSCP mark value.

GET

/v2.0/qos/policies/{policy_id}/dscp_marking_rules/{id}

Show DSCP marking rule details

Shows details for a DSCP marking rule for a QoS policy.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
dscp_marking_rule	body	object	A `dscp_marking_rule` object.
dscp_marking_rule.id	body	string	The ID of the QoS DSCP marking rule.
dscp_marking_rule.tenant_id	body	string
dscp_marking_rule.dscp_mark	body	integer	The DSCP mark value.

PUT

/v2.0/qos/policies/{policy_id}/dscp_marking_rules/{id}

Update DSCP marking rule

Updates a DSCP marking rule for a QoS policy.

Normal response codes: 200

Error response codes: 400, 401, 404

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
id	path	string	id parameter for /v2.0/qos/policies/{policy_id}/dscp_marking_rules/{id} API
dscp_marking_rule	body	object	A `dscp_marking_rule` object.
dscp_marking_rule.dscp_mark	body	integer	The DSCP mark value.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/dscp_marking_rules/id:put operation",
  "properties": {
    "dscp_marking_rule": {
      "type": "object",
      "properties": {
        "dscp_mark": {
          "type": "integer",
          "enum": [
            0,
            8,
            10,
            12,
            14,
            16,
            18,
            20,
            22,
            24,
            26,
            28,
            30,
            32,
            34,
            36,
            38,
            40,
            44,
            46,
            48,
            56
          ],
          "description": "The DSCP mark value."
        }
      },
      "description": "A `dscp_marking_rule` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
dscp_marking_rule	body	object	A `dscp_marking_rule` object.
dscp_marking_rule.id	body	string	The ID of the QoS DSCP marking rule.
dscp_marking_rule.tenant_id	body	string
dscp_marking_rule.dscp_mark	body	integer	The DSCP mark value.

DELETE

/v2.0/qos/policies/{policy_id}/dscp_marking_rules/{id}

Delete DSCP marking rule

Deletes a DSCP marking rule for a QoS policy.

Normal response codes: 204

Error response codes: 400, 401, 404

Responses¶

204¶

GET

/v2.0/qos/policies/{policy_id}/minimum_bandwidth_rules

List minimum bandwidth rules for QoS policy

Lists all minimum bandwidth rules for a QoS policy.

The list might be empty.

You can control which response parameters are returned by using the fields query parameter. For information, see Filtering and column selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

POST

/v2.0/qos/policies/{policy_id}/minimum_bandwidth_rules

Create minimum bandwidth rule

Creates a minimum bandwidth rule for a QoS policy.

Normal response codes: 201

Error response codes: 400, 401, 404, 409

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
minimum_bandwidth_rule	body	object	A `minimum_bandwidth_rule` object.
minimum_bandwidth_rule.tenant_id	body	string
minimum_bandwidth_rule.min_kbps	body	number	The minimum KBPS (kilobits per second) value which should be available for port.
minimum_bandwidth_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`. Default value is `egress`.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/minimum_bandwidth_rules:post operation",
  "properties": {
    "minimum_bandwidth_rule": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string"
        },
        "min_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647,
          "description": "The minimum KBPS (kilobits per second) value which should be available for\nport."
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ],
          "description": "The direction of the traffic to which the QoS\nrule is applied, as seen from the point of view\nof the `port`.\nValid values are `egress` and `ingress`.\nDefault value is `egress`."
        }
      },
      "description": "A `minimum_bandwidth_rule` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
minimum_bandwidth_rule	body	object	A `minimum_bandwidth_rule` object.
minimum_bandwidth_rule.id	body	string	The ID of the QoS minimum bandwidth rule.
minimum_bandwidth_rule.tenant_id	body	string
minimum_bandwidth_rule.min_kbps	body	number	The minimum KBPS (kilobits per second) value which should be available for port.
minimum_bandwidth_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`. Default value is `egress`.

GET

/v2.0/qos/policies/{policy_id}/minimum_bandwidth_rules/{id}

Show minimum bandwidth rule details

Shows details for a minimum bandwidth rule for a QoS policy.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
minimum_bandwidth_rule	body	object	A `minimum_bandwidth_rule` object.
minimum_bandwidth_rule.id	body	string	The ID of the QoS minimum bandwidth rule.
minimum_bandwidth_rule.tenant_id	body	string
minimum_bandwidth_rule.min_kbps	body	number	The minimum KBPS (kilobits per second) value which should be available for port.
minimum_bandwidth_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`. Default value is `egress`.

PUT

/v2.0/qos/policies/{policy_id}/minimum_bandwidth_rules/{id}

Update minimum bandwidth rule

Updates a minimum bandwidth rule for a QoS policy.

Note that the rule cannot be updated, and the update is rejected with error code 501, if there is any bound port referring to the rule via the qos policy.

Normal response codes: 200

Error response codes: 400, 401, 404, 501

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
id	path	string	id parameter for /v2.0/qos/policies/{policy_id}/minimum_bandwidth_rules/{id} API
minimum_bandwidth_rule	body	object	A `minimum_bandwidth_rule` object.
minimum_bandwidth_rule.min_kbps	body	number	The minimum KBPS (kilobits per second) value which should be available for port.
minimum_bandwidth_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`.

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/minimum_bandwidth_rules/id:put operation",
  "properties": {
    "minimum_bandwidth_rule": {
      "type": "object",
      "properties": {
        "min_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647,
          "description": "The minimum KBPS (kilobits per second) value which should be available for\nport."
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ],
          "description": "The direction of the traffic to which the QoS\nrule is applied, as seen from the point of view\nof the `port`.\nValid values are `egress` and `ingress`."
        }
      },
      "description": "A `minimum_bandwidth_rule` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
minimum_bandwidth_rule	body	object	A `minimum_bandwidth_rule` object.
minimum_bandwidth_rule.id	body	string	The ID of the QoS minimum bandwidth rule.
minimum_bandwidth_rule.tenant_id	body	string
minimum_bandwidth_rule.min_kbps	body	number	The minimum KBPS (kilobits per second) value which should be available for port.
minimum_bandwidth_rule.direction	body	string	The direction of the traffic to which the QoS rule is applied, as seen from the point of view of the `port`. Valid values are `egress` and `ingress`.

DELETE

/v2.0/qos/policies/{policy_id}/minimum_bandwidth_rules/{id}

Delete minimum bandwidth rule

Deletes a minimum bandwidth rule for a QoS policy.

Normal response codes: 204

Error response codes: 400, 401, 404

Responses¶

204¶

GET

/v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules

Responses¶

200¶

POST

/v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules

Request of the qos/policies/policy_id/minimum-packet-rate-rules:post operation

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
minimum_packet_rate_rule	body	object
minimum_packet_rate_rule.tenant_id	body	string
minimum_packet_rate_rule.min_kpps	body	number
minimum_packet_rate_rule.direction	body	string

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/minimum-packet-rate-rules:post operation",
  "properties": {
    "minimum_packet_rate_rule": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string"
        },
        "min_kpps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "direction": {
          "type": "string",
          "enum": [
            "any",
            "ingress",
            "egress"
          ]
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
minimum_packet_rate_rule	body	object
minimum_packet_rate_rule.id	body	string
minimum_packet_rate_rule.tenant_id	body	string
minimum_packet_rate_rule.min_kpps	body	number
minimum_packet_rate_rule.direction	body	string

GET

/v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id}

Responses¶

200¶

Name	Location	Type
minimum_packet_rate_rule	body	object
minimum_packet_rate_rule.id	body	string
minimum_packet_rate_rule.tenant_id	body	string
minimum_packet_rate_rule.min_kpps	body	number
minimum_packet_rate_rule.direction	body	string

PUT

/v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id}

Request of the qos/policies/policy_id/minimum-packet-rate-rules/id:put operation

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
id	path	string	id parameter for /v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id} API
minimum_packet_rate_rule	body	object
minimum_packet_rate_rule.min_kpps	body	number
minimum_packet_rate_rule.direction	body	string

Schema

{
  "type": "object",
  "description": "Request of the qos/policies/policy_id/minimum-packet-rate-rules/id:put operation",
  "properties": {
    "minimum_packet_rate_rule": {
      "type": "object",
      "properties": {
        "min_kpps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "direction": {
          "type": "string",
          "enum": [
            "any",
            "ingress",
            "egress"
          ]
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
minimum_packet_rate_rule	body	object
minimum_packet_rate_rule.id	body	string
minimum_packet_rate_rule.tenant_id	body	string
minimum_packet_rate_rule.min_kpps	body	number
minimum_packet_rate_rule.direction	body	string

DELETE

/v2.0/qos/policies/{policy_id}/minimum-packet-rate-rules/{id}

Responses¶

204¶

GET

/v2.0/qos/alias-minimum-packet-rate-rules

Responses¶

200¶

POST

/v2.0/qos/alias-minimum-packet-rate-rules

Request of the qos/alias-minimum-packet-rate-rules:post operation

Request¶

Description

Name

Location

Type

Description

alias_minimum_packet_rate_rule

body

object

alias_minimum_packet_rate_rule.tenant_id

body

string

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-minimum-packet-rate-rules:post operation",
  "properties": {
    "alias_minimum_packet_rate_rule": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string"
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
alias_minimum_packet_rate_rule	body	object
alias_minimum_packet_rate_rule.id	body	string
alias_minimum_packet_rate_rule.tenant_id	body	string
alias_minimum_packet_rate_rule.min_kpps	body	number
alias_minimum_packet_rate_rule.direction	body	string

GET

/v2.0/qos/alias-minimum-packet-rate-rules/{id}

Responses¶

200¶

Name	Location	Type
alias_minimum_packet_rate_rule	body	object
alias_minimum_packet_rate_rule.id	body	string
alias_minimum_packet_rate_rule.tenant_id	body	string
alias_minimum_packet_rate_rule.min_kpps	body	number
alias_minimum_packet_rate_rule.direction	body	string

PUT

/v2.0/qos/alias-minimum-packet-rate-rules/{id}

Request of the qos/alias-minimum-packet-rate-rules/id:put operation

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/qos/alias-minimum-packet-rate-rules/{id} API
alias_minimum_packet_rate_rule	body	object
alias_minimum_packet_rate_rule.min_kpps	body	number
alias_minimum_packet_rate_rule.direction	body	string

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-minimum-packet-rate-rules/id:put operation",
  "properties": {
    "alias_minimum_packet_rate_rule": {
      "type": "object",
      "properties": {
        "min_kpps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "direction": {
          "type": "string",
          "enum": [
            "any",
            "ingress",
            "egress"
          ]
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
alias_minimum_packet_rate_rule	body	object
alias_minimum_packet_rate_rule.id	body	string
alias_minimum_packet_rate_rule.tenant_id	body	string
alias_minimum_packet_rate_rule.min_kpps	body	number
alias_minimum_packet_rate_rule.direction	body	string

DELETE

/v2.0/qos/alias-minimum-packet-rate-rules/{id}

Responses¶

204¶

GET

/v2.0/qos/alias-bandwidth-limit-rules

Responses¶

200¶

POST

/v2.0/qos/alias-bandwidth-limit-rules

Request of the qos/alias-bandwidth-limit-rules:post operation

Request¶

Description

Name

Location

Type

Description

alias_bandwidth_limit_rule

body

object

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-bandwidth-limit-rules:post operation",
  "properties": {
    "alias_bandwidth_limit_rule": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
alias_bandwidth_limit_rule	body	object
alias_bandwidth_limit_rule.id	body	string
alias_bandwidth_limit_rule.tenant_id	body	string
alias_bandwidth_limit_rule.max_kbps	body	number
alias_bandwidth_limit_rule.direction	body	string
alias_bandwidth_limit_rule.max_burst_kbps	body	number

GET

/v2.0/qos/alias-bandwidth-limit-rules/{id}

Responses¶

200¶

Name	Location	Type
alias_bandwidth_limit_rule	body	object
alias_bandwidth_limit_rule.id	body	string
alias_bandwidth_limit_rule.tenant_id	body	string
alias_bandwidth_limit_rule.max_kbps	body	number
alias_bandwidth_limit_rule.direction	body	string
alias_bandwidth_limit_rule.max_burst_kbps	body	number

PUT

/v2.0/qos/alias-bandwidth-limit-rules/{id}

Request of the qos/alias-bandwidth-limit-rules/id:put operation

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/qos/alias-bandwidth-limit-rules/{id} API
alias_bandwidth_limit_rule	body	object
alias_bandwidth_limit_rule.max_kbps	body	number
alias_bandwidth_limit_rule.direction	body	string
alias_bandwidth_limit_rule.max_burst_kbps	body	number

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-bandwidth-limit-rules/id:put operation",
  "properties": {
    "alias_bandwidth_limit_rule": {
      "type": "object",
      "properties": {
        "max_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ]
        },
        "max_burst_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
alias_bandwidth_limit_rule	body	object
alias_bandwidth_limit_rule.id	body	string
alias_bandwidth_limit_rule.tenant_id	body	string
alias_bandwidth_limit_rule.max_kbps	body	number
alias_bandwidth_limit_rule.direction	body	string
alias_bandwidth_limit_rule.max_burst_kbps	body	number

DELETE

/v2.0/qos/alias-bandwidth-limit-rules/{id}

Responses¶

204¶

GET

/v2.0/qos/alias-dscp-marking-rules

Responses¶

200¶

POST

/v2.0/qos/alias-dscp-marking-rules

Request of the qos/alias-dscp-marking-rules:post operation

Request¶

Description

Name

Location

Type

Description

alias_dscp_marking_rule

body

object

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-dscp-marking-rules:post operation",
  "properties": {
    "alias_dscp_marking_rule": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
alias_dscp_marking_rule	body	object
alias_dscp_marking_rule.id	body	string
alias_dscp_marking_rule.tenant_id	body	string
alias_dscp_marking_rule.dscp_mark	body	integer

GET

/v2.0/qos/alias-dscp-marking-rules/{id}

Responses¶

200¶

Name	Location	Type
alias_dscp_marking_rule	body	object
alias_dscp_marking_rule.id	body	string
alias_dscp_marking_rule.tenant_id	body	string
alias_dscp_marking_rule.dscp_mark	body	integer

PUT

/v2.0/qos/alias-dscp-marking-rules/{id}

Request of the qos/alias-dscp-marking-rules/id:put operation

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/qos/alias-dscp-marking-rules/{id} API
alias_dscp_marking_rule	body	object
alias_dscp_marking_rule.dscp_mark	body	integer

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-dscp-marking-rules/id:put operation",
  "properties": {
    "alias_dscp_marking_rule": {
      "type": "object",
      "properties": {
        "dscp_mark": {
          "type": "integer",
          "enum": [
            0,
            8,
            10,
            12,
            14,
            16,
            18,
            20,
            22,
            24,
            26,
            28,
            30,
            32,
            34,
            36,
            38,
            40,
            44,
            46,
            48,
            56
          ]
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
alias_dscp_marking_rule	body	object
alias_dscp_marking_rule.id	body	string
alias_dscp_marking_rule.tenant_id	body	string
alias_dscp_marking_rule.dscp_mark	body	integer

DELETE

/v2.0/qos/alias-dscp-marking-rules/{id}

Responses¶

204¶

GET

/v2.0/qos/alias-minimum-bandwidth-rules

Responses¶

200¶

POST

/v2.0/qos/alias-minimum-bandwidth-rules

Request of the qos/alias-minimum-bandwidth-rules:post operation

Request¶

Description

Name

Location

Type

Description

alias_minimum_bandwidth_rule

body

object

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-minimum-bandwidth-rules:post operation",
  "properties": {
    "alias_minimum_bandwidth_rule": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
alias_minimum_bandwidth_rule	body	object
alias_minimum_bandwidth_rule.id	body	string
alias_minimum_bandwidth_rule.tenant_id	body	string
alias_minimum_bandwidth_rule.min_kbps	body	number
alias_minimum_bandwidth_rule.direction	body	string

GET

/v2.0/qos/alias-minimum-bandwidth-rules/{id}

Responses¶

200¶

Name	Location	Type
alias_minimum_bandwidth_rule	body	object
alias_minimum_bandwidth_rule.id	body	string
alias_minimum_bandwidth_rule.tenant_id	body	string
alias_minimum_bandwidth_rule.min_kbps	body	number
alias_minimum_bandwidth_rule.direction	body	string

PUT

/v2.0/qos/alias-minimum-bandwidth-rules/{id}

Request of the qos/alias-minimum-bandwidth-rules/id:put operation

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/qos/alias-minimum-bandwidth-rules/{id} API
alias_minimum_bandwidth_rule	body	object
alias_minimum_bandwidth_rule.min_kbps	body	number
alias_minimum_bandwidth_rule.direction	body	string

Schema

{
  "type": "object",
  "description": "Request of the qos/alias-minimum-bandwidth-rules/id:put operation",
  "properties": {
    "alias_minimum_bandwidth_rule": {
      "type": "object",
      "properties": {
        "min_kbps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ]
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
alias_minimum_bandwidth_rule	body	object
alias_minimum_bandwidth_rule.id	body	string
alias_minimum_bandwidth_rule.tenant_id	body	string
alias_minimum_bandwidth_rule.min_kbps	body	number
alias_minimum_bandwidth_rule.direction	body	string

DELETE

/v2.0/qos/alias-minimum-bandwidth-rules/{id}

Responses¶

204¶

policies¶

GET

/v2.0/policies/{policy_id}/packet_rate_limit_rules

Responses¶

200¶

POST

/v2.0/policies/{policy_id}/packet_rate_limit_rules

Request of the policies/policy_id/packet_rate_limit_rules:post operation

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/policies/{policy_id}/tags/{id} API
packet_rate_limit_rule	body	object
packet_rate_limit_rule.tenant_id	body	string
packet_rate_limit_rule.max_kpps	body	number
packet_rate_limit_rule.max_burst_kpps	body	number
packet_rate_limit_rule.direction	body	string

Schema

{
  "type": "object",
  "description": "Request of the policies/policy_id/packet_rate_limit_rules:post operation",
  "properties": {
    "packet_rate_limit_rule": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string"
        },
        "max_kpps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "max_burst_kpps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ]
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type
packet_rate_limit_rule	body	object
packet_rate_limit_rule.id	body	string
packet_rate_limit_rule.tenant_id	body	string
packet_rate_limit_rule.max_kpps	body	number
packet_rate_limit_rule.max_burst_kpps	body	number
packet_rate_limit_rule.direction	body	string

GET

/v2.0/policies/{policy_id}/packet_rate_limit_rules/{id}

Responses¶

200¶

Name	Location	Type
packet_rate_limit_rule	body	object
packet_rate_limit_rule.id	body	string
packet_rate_limit_rule.tenant_id	body	string
packet_rate_limit_rule.max_kpps	body	number
packet_rate_limit_rule.max_burst_kpps	body	number
packet_rate_limit_rule.direction	body	string

PUT

/v2.0/policies/{policy_id}/packet_rate_limit_rules/{id}

Request of the policies/policy_id/packet_rate_limit_rules/id:put operation

Request¶

Description

Name	Location	Type	Description
policy_id	path	string	policy_id parameter for /v2.0/policies/{policy_id}/tags/{id} API
id	path	string	id parameter for /v2.0/policies/{policy_id}/packet_rate_limit_rules/{id} API
packet_rate_limit_rule	body	object
packet_rate_limit_rule.max_kpps	body	number
packet_rate_limit_rule.max_burst_kpps	body	number
packet_rate_limit_rule.direction	body	string

Schema

{
  "type": "object",
  "description": "Request of the policies/policy_id/packet_rate_limit_rules/id:put operation",
  "properties": {
    "packet_rate_limit_rule": {
      "type": "object",
      "properties": {
        "max_kpps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "max_burst_kpps": {
          "type": "number",
          "minimum": 0,
          "maximum": 2147483647
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ]
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
packet_rate_limit_rule	body	object
packet_rate_limit_rule.id	body	string
packet_rate_limit_rule.tenant_id	body	string
packet_rate_limit_rule.max_kpps	body	number
packet_rate_limit_rule.max_burst_kpps	body	number
packet_rate_limit_rule.direction	body	string

DELETE

/v2.0/policies/{policy_id}/packet_rate_limit_rules/{id}

Responses¶

204¶

GET

/v2.0/policies/{policy_id}/tags

Responses¶

200¶

PUT

/v2.0/policies/{policy_id}/tags

Request of the policies/policy_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

policy_id

path

string

policy_id parameter for /v2.0/policies/{policy_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the policies/policy_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/policies/{policy_id}/tags

Responses¶

204¶

GET

/v2.0/policies/{policy_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/policies/{policy_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/policies/{policy_id}/tags/{id}

Responses¶

204¶

quotas¶

GET

/v2.0/quotas

List quotas for projects with non-default quota values

Lists quotas for projects with non-default quota values.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

GET

/v2.0/quotas/{id}/default

List default quotas for a project

Lists default quotas for a project.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

Name	Location	Type	Description
quota	body	object	A `quota` object.
quota.floatingip	body	integer	The number of floating IP addresses allowed for each project. A value of `-1` means no limit.
quota.network	body	integer	The number of networks allowed for each project. A value of `-1` means no limit.
quota.port	body	integer	The number of ports allowed for each project. A value of `-1` means no limit.
quota.rbac_policy	body	integer	The number of role-based access control (RBAC) policies for each project. A value of `-1` means no limit.
quota.router	body	integer	The number of routers allowed for each project. A value of `-1` means no limit.
quota.security_group	body	integer	The number of security groups allowed for each project. A value of `-1` means no limit.
quota.security_group_rule	body	integer	The number of security group rules allowed for each project. A value of `-1` means no limit.
quota.subnet	body	integer	The number of subnets allowed for each project. A value of `-1` means no limit.
quota.subnetpool	body	integer	The number of subnet pools allowed for each project. A value of `-1` means no limit.
quota.project_id	body	string	The ID of the project.

GET

/v2.0/quotas/{id}

List quotas for a project

Lists quotas for a project.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

Name	Location	Type	Description
quota	body	object	A `quota` object.
quota.floatingip	body	integer	The number of floating IP addresses allowed for each project. A value of `-1` means no limit.
quota.network	body	integer	The number of networks allowed for each project. A value of `-1` means no limit.
quota.port	body	integer	The number of ports allowed for each project. A value of `-1` means no limit.
quota.rbac_policy	body	integer	The number of role-based access control (RBAC) policies for each project. A value of `-1` means no limit.
quota.router	body	integer	The number of routers allowed for each project. A value of `-1` means no limit.
quota.security_group	body	integer	The number of security groups allowed for each project. A value of `-1` means no limit.
quota.security_group_rule	body	integer	The number of security group rules allowed for each project. A value of `-1` means no limit.
quota.subnet	body	integer	The number of subnets allowed for each project. A value of `-1` means no limit.
quota.subnetpool	body	integer	The number of subnet pools allowed for each project. A value of `-1` means no limit.
quota.project_id	body	string	The ID of the project.

PUT

/v2.0/quotas/{id}

Update quota for a project

Updates quotas for a project. Use when non-default quotas are desired.

Normal response codes: 200

Error response codes: 401, 403

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/quotas/{id}/details API
quota	body	object	A `quota` object.
quota.floatingip	body	integer	The number of floating IP addresses allowed for each project. A value of `-1` means no limit.
quota.network	body	integer	The number of networks allowed for each project. A value of `-1` means no limit.
quota.port	body	integer	The number of ports allowed for each project. A value of `-1` means no limit.
quota.rbac_policy	body	integer	The number of role-based access control (RBAC) policies for each project. A value of `-1` means no limit.
quota.router	body	integer	The number of routers allowed for each project. A value of `-1` means no limit.
quota.security_group	body	integer	The number of security groups allowed for each project. A value of `-1` means no limit.
quota.security_group_rule	body	integer	The number of security group rules allowed for each project. A value of `-1` means no limit.
quota.subnet	body	integer	The number of subnets allowed for each project. A value of `-1` means no limit.
quota.subnetpool	body	integer	The number of subnet pools allowed for each project. A value of `-1` means no limit.
quota.project_id	body	string	The ID of the project.

Schema

{
  "type": "object",
  "description": "Request of the quotas/id:put operation",
  "properties": {
    "quota": {
      "type": "object",
      "properties": {
        "floatingip": {
          "type": "integer",
          "description": "The number of floating IP addresses allowed for\neach project. A value of `-1` means no limit."
        },
        "network": {
          "type": "integer",
          "description": "The number of networks allowed for each project.\nA value of `-1` means no limit."
        },
        "port": {
          "type": "integer",
          "description": "The number of ports allowed for each project.\nA value of `-1` means no limit."
        },
        "rbac_policy": {
          "type": "integer",
          "description": "The number of role-based access control (RBAC)\npolicies for each project. A value of `-1` means\nno limit."
        },
        "router": {
          "type": "integer",
          "description": "The number of routers allowed for each project.\nA value of `-1` means no limit."
        },
        "security_group": {
          "type": "integer",
          "description": "The number of security groups allowed for each\nproject. A value of `-1` means no limit."
        },
        "security_group_rule": {
          "type": "integer",
          "description": "The number of security group rules allowed for\neach project. A value of `-1` means no limit."
        },
        "subnet": {
          "type": "integer",
          "description": "The number of subnets allowed for each project.\nA value of `-1` means no limit."
        },
        "subnetpool": {
          "type": "integer",
          "description": "The number of subnet pools allowed for each\nproject. A value of `-1` means no limit."
        },
        "project_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the project."
        }
      },
      "description": "A `quota` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
quota	body	object	A `quota` object.
quota.floatingip	body	integer	The number of floating IP addresses allowed for each project. A value of `-1` means no limit.
quota.network	body	integer	The number of networks allowed for each project. A value of `-1` means no limit.
quota.port	body	integer	The number of ports allowed for each project. A value of `-1` means no limit.
quota.rbac_policy	body	integer	The number of role-based access control (RBAC) policies for each project. A value of `-1` means no limit.
quota.router	body	integer	The number of routers allowed for each project. A value of `-1` means no limit.
quota.security_group	body	integer	The number of security groups allowed for each project. A value of `-1` means no limit.
quota.security_group_rule	body	integer	The number of security group rules allowed for each project. A value of `-1` means no limit.
quota.subnet	body	integer	The number of subnets allowed for each project. A value of `-1` means no limit.
quota.subnetpool	body	integer	The number of subnet pools allowed for each project. A value of `-1` means no limit.
quota.project_id	body	string	The ID of the project.

DELETE

/v2.0/quotas/{id}

Reset quota for a project

Resets quotas to default values for a project.

Normal response codes: 204

Error response codes: 401, 403, 404

Responses¶

204¶

GET

/v2.0/quotas/{id}/details

Responses¶

200¶

Name	Location	Type	Description
quota	body	object
quota.floatingip	body	object	The number of floating IP addresses allowed for each project.
quota.floatingip.used	body	integer	Used quota
quota.floatingip.limit	body	integer	Current quota limit
quota.floatingip.reserved	body	integer	Reserved quota
quota.network	body	object	The number of networks allowed for each project.
quota.network.used	body	integer	Used quota
quota.network.limit	body	integer	Current quota limit
quota.network.reserved	body	integer	Reserved quota
quota.port	body	object	The number of ports allowed for each project.
quota.port.used	body	integer	Used quota
quota.port.limit	body	integer	Current quota limit
quota.port.reserved	body	integer	Reserved quota
quota.rbac_policy	body	object	The number of role-based access control (RBAC) policies for each project.
quota.rbac_policy.used	body	integer	Used quota
quota.rbac_policy.limit	body	integer	Current quota limit
quota.rbac_policy.reserved	body	integer	Reserved quota
quota.router	body	object	The number of routers allowed for each project.
quota.router.used	body	integer	Used quota
quota.router.limit	body	integer	Current quota limit
quota.router.reserved	body	integer	Reserved quota
quota.security_group	body	object	The number of security groups allowed for each project.
quota.security_group.used	body	integer	Used quota
quota.security_group.limit	body	integer	Current quota limit
quota.security_group.reserved	body	integer	Reserved quota
quota.security_group_rule	body	object	The number of security group rules allowed for each project.
quota.security_group_rule.used	body	integer	Used quota
quota.security_group_rule.limit	body	integer	Current quota limit
quota.security_group_rule.reserved	body	integer	Reserved quota
quota.subnet	body	object	The number of subnets allowed for each project.
quota.subnet.used	body	integer	Used quota
quota.subnet.limit	body	integer	Current quota limit
quota.subnet.reserved	body	integer	Reserved quota
quota.subnetpool	body	object	The number of subnet pools allowed for each project.
quota.subnetpool.used	body	integer	Used quota
quota.subnetpool.limit	body	integer	Current quota limit
quota.subnetpool.reserved	body	integer	Reserved quota

rbac-policies¶

GET

/v2.0/rbac-policies

List RBAC policies

List RBAC policies that belong to a given tenant.

Use the fields query parameter to filter the response. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/rbac-policies

Create RBAC policy

Create RBAC policy for given tenant.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
rbac_policy	body	object
rbac_policy.object_type	body	string	The type of the object that the RBAC policy affects. Types include `qos-policy`, `network`, `security-group`, `address-scope`, `subnetpool` or `address-group`.
rbac_policy.object_id	body	string	The ID of the `object_type` resource. An `object_type` of `network` returns a network ID, an `object_type` of `qos-policy` returns a QoS policy ID, an `object_type` of `security-group` returns a security group ID, an `object_type` of `address-scope` returns a address scope ID, an `object_type` of `subnetpool` returns a subnetpool ID and an `object_type` of `address-group` returns an address group ID.
rbac_policy.target_tenant	body	string	The ID of the tenant to which the RBAC policy will be enforced.
rbac_policy.tenant_id	body	string
rbac_policy.action	body	string	Action for the RBAC policy which is `access_as_external` or `access_as_shared`.

Schema

{
  "type": "object",
  "description": "Request of the rbac-policies:post operation",
  "properties": {
    "rbac_policy": {
      "type": "object",
      "properties": {
        "object_type": {
          "type": "string",
          "description": "The type of the object that the RBAC policy affects. Types include\n`qos-policy`, `network`, `security-group`, `address-scope`,\n`subnetpool` or `address-group`."
        },
        "object_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the `object_type` resource. An `object_type` of `network`\nreturns a network ID, an `object_type` of `qos-policy` returns a QoS\npolicy ID, an `object_type` of `security-group` returns a security\ngroup ID, an `object_type` of `address-scope` returns a address scope\nID, an `object_type` of `subnetpool` returns a subnetpool ID and\nan `object_type` of `address-group` returns an address group ID."
        },
        "target_tenant": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the tenant to which the RBAC policy will be enforced."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        },
        "action": {
          "type": "string",
          "maxLength": 255,
          "description": "Action for the RBAC policy which is `access_as_external` or\n`access_as_shared`."
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
rbac_policy	body	object
rbac_policy.id	body	string	The ID of the RBAC policy.
rbac_policy.object_type	body	string	The type of the object that the RBAC policy affects. Types include `qos-policy`, `network`, `security-group`, `address-scope`, `subnetpool` or `address-group`.
rbac_policy.object_id	body	string	The ID of the `object_type` resource. An `object_type` of `network` returns a network ID, an `object_type` of `qos-policy` returns a QoS policy ID, an `object_type` of `security-group` returns a security group ID, an `object_type` of `address-scope` returns a address scope ID, an `object_type` of `subnetpool` returns a subnetpool ID and an `object_type` of `address-group` returns an address group ID.
rbac_policy.target_tenant	body	string	The ID of the tenant to which the RBAC policy will be enforced.
rbac_policy.tenant_id	body	string	The ID of the project that owns the resource.
rbac_policy.action	body	string	Action for the RBAC policy which is `access_as_external` or `access_as_shared`.

GET

/v2.0/rbac-policies/{id}

Show RBAC policy details

Show details for a given RBAC policy.

You can control which response parameters are returned by using the fields query parameter. For information, see Filtering and column selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
rbac_policy	body	object
rbac_policy.id	body	string	The ID of the RBAC policy.
rbac_policy.object_type	body	string	The type of the object that the RBAC policy affects. Types include `qos-policy`, `network`, `security-group`, `address-scope`, `subnetpool` or `address-group`.
rbac_policy.object_id	body	string	The ID of the `object_type` resource. An `object_type` of `network` returns a network ID, an `object_type` of `qos-policy` returns a QoS policy ID, an `object_type` of `security-group` returns a security group ID, an `object_type` of `address-scope` returns a address scope ID, an `object_type` of `subnetpool` returns a subnetpool ID and an `object_type` of `address-group` returns an address group ID.
rbac_policy.target_tenant	body	string	The ID of the tenant to which the RBAC policy will be enforced.
rbac_policy.tenant_id	body	string	The ID of the project that owns the resource.
rbac_policy.action	body	string	Action for the RBAC policy which is `access_as_external` or `access_as_shared`.

PUT

/v2.0/rbac-policies/{id}

Update RBAC policy

Update RBAC policy for given tenant.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/rbac-policies/{id} API
rbac_policy	body	object
rbac_policy.target_tenant	body	string	The ID of the tenant to which the RBAC policy will be enforced.

Schema

{
  "type": "object",
  "description": "Request of the rbac-policies/id:put operation",
  "properties": {
    "rbac_policy": {
      "type": "object",
      "properties": {
        "target_tenant": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the tenant to which the RBAC policy will be enforced."
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
rbac_policy	body	object
rbac_policy.id	body	string	The ID of the RBAC policy.
rbac_policy.object_type	body	string	The type of the object that the RBAC policy affects. Types include `qos-policy`, `network`, `security-group`, `address-scope`, `subnetpool` or `address-group`.
rbac_policy.object_id	body	string	The ID of the `object_type` resource. An `object_type` of `network` returns a network ID, an `object_type` of `qos-policy` returns a QoS policy ID, an `object_type` of `security-group` returns a security group ID, an `object_type` of `address-scope` returns a address scope ID, an `object_type` of `subnetpool` returns a subnetpool ID and an `object_type` of `address-group` returns an address group ID.
rbac_policy.target_tenant	body	string	The ID of the tenant to which the RBAC policy will be enforced.
rbac_policy.tenant_id	body	string	The ID of the project that owns the resource.
rbac_policy.action	body	string	Action for the RBAC policy which is `access_as_external` or `access_as_shared`.

DELETE

/v2.0/rbac-policies/{id}

Delete RBAC policy

Delete an RBAC policy.

Normal response codes: 204

Error response codes: 401, 404, 409

Responses¶

204¶

default-security-group-rules¶

GET

/v2.0/default-security-group-rules

List security group default rules

Lists a summary of all OpenStack Networking security group rules that are used for every newly created Security Group.

The list provides the ID for each security group default rule.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/default-security-group-rules

Create security group default rule

Creates an Openstack Networking security group rule template.

Normal response codes: 201

Error response codes: 400, 401, 404, 409

Request¶

Description

Name	Location	Type	Description
default_security_group_rule	body	object	A `default_security_group_rule` object.
default_security_group_rule.tenant_id	body	string
default_security_group_rule.description	body	string	A human-readable description for the resource. Default is an empty string.
default_security_group_rule.remote_group_id	body	string	The remote group UUID to associate with this security group rule. You can specify either the `remote_group_id` or `remote_ip_prefix` attribute in the request body.
default_security_group_rule.remote_address_group_id	body	string
default_security_group_rule.direction	body	string	Ingress or egress, which is the direction in which the security group rule is applied.
default_security_group_rule.protocol	body	string	The IP protocol can be represented by a string, an integer, or `null`. Valid string or integer values are `any` or `0`, `ah` or `51`, `dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`, `icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`, `ipip` or `4`, `ipv6-encap` or `41`, `ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`, `ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`, `pgm` or `113`, `rsvp` or `46`, `sctp` or `132`, `tcp` or `6`, `udp` or `17`, `udplite` or `136`, `vrrp` or `112`. Additionally, any integer value between [0-255] is also valid. The string `any` (or integer `0`) means `all` IP protocols. See the constants in `neutron_lib.constants` for the most up-to-date list of supported strings.
default_security_group_rule.port_range_min	body	string	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the `port_range_max` attribute value. If the protocol is ICMP, this value must be an ICMP type.
default_security_group_rule.port_range_max	body	string	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the `port_range_min` attribute value. If the protocol is ICMP, this value must be an ICMP code.
default_security_group_rule.ethertype	body	string	Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.
default_security_group_rule.remote_ip_prefix	body	string	The remote IP prefix that is matched by this security group rule.
default_security_group_rule.used_in_default_sg	body	[‘string’, ‘boolean’]	Whether this security group rule template should be used in default security group created automatically for each new project. Default value is `False`.
default_security_group_rule.used_in_non_default_sg	body	[‘string’, ‘boolean’]	Whether this security group rule template should be used in custom security groups created by project user. Default value is `True`.

Schema

{
  "type": "object",
  "description": "Request of the default-security-group-rules:post operation",
  "properties": {
    "default_security_group_rule": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 1024,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "remote_group_id": {
          "type": "string",
          "description": "The remote group UUID to associate with this\nsecurity group rule. You can specify either the\n`remote_group_id` or `remote_ip_prefix` attribute in the\nrequest body."
        },
        "remote_address_group_id": {
          "type": "string"
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ],
          "description": "Ingress or egress, which is the direction in\nwhich the security group rule is applied."
        },
        "protocol": {
          "type": "string",
          "description": "The IP protocol can be represented by a string, an integer, or `null`.\nValid string or integer values are `any` or `0`, `ah` or `51`,\n`dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`,\n`icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`,\n`ipip` or `4`, `ipv6-encap` or `41`,\n`ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`,\n`ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`,\n`pgm` or `113`, `rsvp` or `46`, `sctp` or `132`,\n`tcp` or `6`, `udp` or `17`, `udplite` or `136`,\n`vrrp` or `112`. Additionally, any integer value between [0-255] is\nalso valid. The string `any` (or integer `0`) means `all` IP\nprotocols. See the constants in `neutron_lib.constants` for the most\nup-to-date list of supported strings."
        },
        "port_range_min": {
          "type": "string",
          "description": "The minimum port number in the range that is\nmatched by the security group rule. If the protocol is TCP, UDP,\nDCCP, SCTP or UDP-Lite this value must be less than or equal to\nthe `port_range_max` attribute value. If the protocol is ICMP,\nthis value must be an ICMP type."
        },
        "port_range_max": {
          "type": "string",
          "description": "The maximum port number in the range that is\nmatched by the security group rule. If the protocol is TCP, UDP,\nDCCP, SCTP or UDP-Lite this value must be greater than or equal to\nthe `port_range_min` attribute value. If the protocol is ICMP,\nthis value must be an ICMP code."
        },
        "ethertype": {
          "type": "string",
          "enum": [
            "IPv4",
            "IPv6"
          ],
          "description": "Must be IPv4 or IPv6, and addresses represented\nin CIDR must match the ingress or egress rules."
        },
        "remote_ip_prefix": {
          "type": "string",
          "description": "The remote IP prefix that is matched by this security group rule."
        },
        "used_in_default_sg": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Whether this security group rule template should be used in default\nsecurity group created automatically for each new project. Default value\nis `False`."
        },
        "used_in_non_default_sg": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Whether this security group rule template should be used in custom\nsecurity groups created by project user. Default value is `True`."
        }
      },
      "description": "A `default_security_group_rule` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
default_security_group_rule	body	object
default_security_group_rule.id	body	string	The ID of the security group default rule.
default_security_group_rule.description	body	string	A human-readable description for the resource.
default_security_group_rule.remote_group_id	body	string	The remote group UUID to associate with this security group rule. You can specify either the `remote_group_id` or `remote_ip_prefix` attribute in the request body.
default_security_group_rule.remote_address_group_id	body	string	The remote address group UUID to associate with this security group rule.
default_security_group_rule.direction	body	string	Ingress or egress, which is the direction in which the security group rule is applied.
default_security_group_rule.protocol	body	string	The IP protocol can be represented by a string, an integer, or `null`. Valid string or integer values are `any` or `0`, `ah` or `51`, `dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`, `icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`, `ipip` or `4`, `ipv6-encap` or `41`, `ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`, `ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`, `pgm` or `113`, `rsvp` or `46`, `sctp` or `132`, `tcp` or `6`, `udp` or `17`, `udplite` or `136`, `vrrp` or `112`. Additionally, any integer value between [0-255] is also valid. The string `any` (or integer `0`) means `all` IP protocols. See the constants in `neutron_lib.constants` for the most up-to-date list of supported strings.
default_security_group_rule.port_range_min	body	string	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the `port_range_max` attribute value. If the protocol is ICMP, this value must be an ICMP type.
default_security_group_rule.port_range_max	body	string	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the `port_range_min` attribute value. If the protocol is ICMP, this value must be an ICMP code.
default_security_group_rule.ethertype	body	string	Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.
default_security_group_rule.remote_ip_prefix	body	string	The remote IP prefix that is matched by this security group rule.
default_security_group_rule.used_in_default_sg	body	[‘string’, ‘boolean’]	Whether this security group rule template should be used in default security group created automatically for each new project. Default value is `False`.
default_security_group_rule.used_in_non_default_sg	body	[‘string’, ‘boolean’]	Whether this security group rule template should be used in custom security groups created by project user. Default value is `True`.

GET

/v2.0/default-security-group-rules/{id}

Show security group default rule

Shows detailed information for a security group default rule.

The response body contains the following information about the security group rule:

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
default_security_group_rule	body	object	A `default_security_group_rule` object.
default_security_group_rule.id	body	string	The ID of the security group default rule.
default_security_group_rule.description	body	string	A human-readable description for the resource.
default_security_group_rule.remote_group_id	body	string	The remote group UUID to associate with this security group rule. You can specify either the `remote_group_id` or `remote_ip_prefix` attribute in the request body.
default_security_group_rule.remote_address_group_id	body	string	The remote address group UUID to associate with this security group rule.
default_security_group_rule.direction	body	string	Ingress or egress, which is the direction in which the security group rule is applied.
default_security_group_rule.protocol	body	string	The IP protocol can be represented by a string, an integer, or `null`. Valid string or integer values are `any` or `0`, `ah` or `51`, `dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`, `icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`, `ipip` or `4`, `ipv6-encap` or `41`, `ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`, `ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`, `pgm` or `113`, `rsvp` or `46`, `sctp` or `132`, `tcp` or `6`, `udp` or `17`, `udplite` or `136`, `vrrp` or `112`. Additionally, any integer value between [0-255] is also valid. The string `any` (or integer `0`) means `all` IP protocols. See the constants in `neutron_lib.constants` for the most up-to-date list of supported strings.
default_security_group_rule.port_range_min	body	string	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the `port_range_max` attribute value. If the protocol is ICMP, this value must be an ICMP type.
default_security_group_rule.port_range_max	body	string	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the `port_range_min` attribute value. If the protocol is ICMP, this value must be an ICMP code.
default_security_group_rule.ethertype	body	string	Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.
default_security_group_rule.remote_ip_prefix	body	string	The remote IP prefix that is matched by this security group rule.
default_security_group_rule.used_in_default_sg	body	[‘string’, ‘boolean’]	Whether this security group rule template should be used in default security group created automatically for each new project. Default value is `False`.
default_security_group_rule.used_in_non_default_sg	body	[‘string’, ‘boolean’]	Whether this security group rule template should be used in custom security groups created by project user. Default value is `True`.

PUT

/v2.0/default-security-group-rules/{id}

Request of the default-security-group-rules/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/default-security-group-rules/{id} API

default_security_group_rule

body

object

Schema

{
  "type": "object",
  "description": "Request of the default-security-group-rules/id:put operation",
  "properties": {
    "default_security_group_rule": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
default_security_group_rule	body	object
default_security_group_rule.id	body	string
default_security_group_rule.description	body	string
default_security_group_rule.remote_group_id	body	string
default_security_group_rule.remote_address_group_id	body	string
default_security_group_rule.direction	body	string
default_security_group_rule.protocol	body	string
default_security_group_rule.port_range_min	body	string
default_security_group_rule.port_range_max	body	string
default_security_group_rule.ethertype	body	string
default_security_group_rule.remote_ip_prefix	body	string
default_security_group_rule.used_in_default_sg	body	[‘string’, ‘boolean’]
default_security_group_rule.used_in_non_default_sg	body	[‘string’, ‘boolean’]

DELETE

/v2.0/default-security-group-rules/{id}

Delete security group default rule

Deletes an OpenStack Networking security group rule template.

Normal response codes: 204

Error response codes: 401, 404, 412

Responses¶

204¶

security-groups¶

GET

/v2.0/security-groups

List security groups

Lists OpenStack Networking security groups to which the project has access.

The response is an array of security_group objects which contains a list of security_group_rules objects.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/security-groups

Create security group

Creates an OpenStack Networking security group.

This operation creates a security group with default security group rules for the IPv4 and IPv6 ether types.

Normal response codes: 201

Error response codes: 400, 401, 409

Request¶

Description

Name	Location	Type	Description
security_group	body	object	A `security_group` object.
security_group.name	body	string	Human-readable name of the resource.
security_group.tenant_id	body	string	The ID of the project.
security_group.description	body	string	A human-readable description for the resource. Default is an empty string.
security_group.stateful	body	[‘string’, ‘boolean’]	Indicates if the security group is stateful or stateless.

Schema

{
  "type": "object",
  "description": "Request of the security-groups:post operation",
  "properties": {
    "security_group": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "stateful": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates if the security group is stateful or stateless."
        }
      },
      "description": "A `security_group` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
security_group	body	object	A `security_group` object.
security_group.id	body	string	The ID of the security group.
security_group.name	body	string	Human-readable name of the resource.
security_group.tenant_id	body	string	The ID of the project.
security_group.security_group_rules	body	string	A list of `security_group_rule` objects. Refer to Security group rules for details.
security_group.revision_number	body	integer	The revision number of the resource.
security_group.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
security_group.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
security_group.description	body	string	A human-readable description for the resource.
security_group.stateful	body	[‘string’, ‘boolean’]	Indicates if the security group is stateful or stateless.
security_group.shared	body	[‘string’, ‘boolean’]	Indicates whether this security group is shared to the requester’s project.

GET

/v2.0/security-groups/{id}

Show security group

Shows details for a security group.

The associated security group rules are contained in the response.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
security_group	body	object	A `security_group` object.
security_group.id	body	string	The ID of the security group.
security_group.name	body	string	Human-readable name of the resource.
security_group.tenant_id	body	string	The ID of the project.
security_group.security_group_rules	body	string	A list of `security_group_rule` objects. Refer to Security group rules for details.
security_group.revision_number	body	integer	The revision number of the resource.
security_group.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
security_group.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
security_group.description	body	string	A human-readable description for the resource.
security_group.stateful	body	[‘string’, ‘boolean’]	Indicates if the security group is stateful or stateless.
security_group.shared	body	[‘string’, ‘boolean’]	Indicates whether this security group is shared to the requester’s project.

PUT

/v2.0/security-groups/{id}

Update security group

Updates a security group.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/security-groups/{id} API
security_group	body	object	A `security_group` object.
security_group.name	body	string	Human-readable name of the resource.
security_group.description	body	string	A human-readable description for the resource. Default is an empty string.
security_group.stateful	body	[‘string’, ‘boolean’]

Schema

{
  "type": "object",
  "description": "Request of the security-groups/id:put operation",
  "properties": {
    "security_group": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "stateful": {
          "type": [
            "string",
            "boolean"
          ]
        }
      },
      "description": "A `security_group` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
security_group	body	object	A `security_group` object.
security_group.id	body	string	The ID of the security group.
security_group.name	body	string	Human-readable name of the resource.
security_group.tenant_id	body	string	The ID of the project.
security_group.security_group_rules	body	string	A list of `security_group_rule` objects. Refer to Security group rules for details.
security_group.revision_number	body	integer	The revision number of the resource.
security_group.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
security_group.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
security_group.description	body	string	A human-readable description for the resource.
security_group.stateful	body	[‘string’, ‘boolean’]	Indicates if the security group is stateful or stateless.
security_group.shared	body	[‘string’, ‘boolean’]	Indicates whether this security group is shared to the requester’s project.

DELETE

/v2.0/security-groups/{id}

Delete security group

Deletes an OpenStack Networking security group.

This operation deletes an OpenStack Networking security group and its associated security group rules, provided that a port is not associated with the security group. If a port is associated with the security group 409 (Conflict) is returned.

This operation does not require a request body. This operation does not return a response body.

Normal response codes: 204

Error response codes: 401, 404, 409, 412

Responses¶

204¶

GET

/v2.0/security-groups/{security_group_id}/tags

Responses¶

200¶

PUT

/v2.0/security-groups/{security_group_id}/tags

Request of the security-groups/security_group_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

security_group_id

path

string

security_group_id parameter for /v2.0/security-groups/{security_group_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the security-groups/security_group_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/security-groups/{security_group_id}/tags

Responses¶

204¶

GET

/v2.0/security-groups/{security_group_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/security-groups/{security_group_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/security-groups/{security_group_id}/tags/{id}

Responses¶

204¶

security-group-rules¶

GET

/v2.0/security-group-rules

List security group rules

Lists a summary of all OpenStack Networking security group rules that the project can access.

The list provides the ID for each security group rule.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/security-group-rules

Create security group rule

Creates an OpenStack Networking security group rule.

Normal response codes: 201

Error response codes: 400, 401, 404, 409

Request¶

Description

Name	Location	Type	Description
security_group_rule	body	object	A `security_group_rule` object.
security_group_rule.security_group_id	body	string	The security group ID to associate with this security group rule.
security_group_rule.remote_group_id	body	string	The remote group UUID to associate with this security group rule. You can specify either the `remote_group_id` or `remote_ip_prefix` attribute in the request body.
security_group_rule.direction	body	string	Ingress or egress, which is the direction in which the security group rule is applied.
security_group_rule.protocol	body	string	The IP protocol can be represented by a string, an integer, or `null`. Valid string or integer values are `any` or `0`, `ah` or `51`, `dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`, `icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`, `ipip` or `4`, `ipv6-encap` or `41`, `ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`, `ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`, `pgm` or `113`, `rsvp` or `46`, `sctp` or `132`, `tcp` or `6`, `udp` or `17`, `udplite` or `136`, `vrrp` or `112`. Additionally, any integer value between [0-255] is also valid. The string `any` (or integer `0`) means `all` IP protocols. See the constants in `neutron_lib.constants` for the most up-to-date list of supported strings.
security_group_rule.port_range_min	body	string	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the `port_range_max` attribute value. If the protocol is ICMP, this value must be an ICMP type.
security_group_rule.port_range_max	body	string	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the `port_range_min` attribute value. If the protocol is ICMP, this value must be an ICMP code.
security_group_rule.ethertype	body	string	Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.
security_group_rule.remote_ip_prefix	body	string	The remote IP prefix that is matched by this security group rule.
security_group_rule.tenant_id	body	string
security_group_rule.description	body	string	A human-readable description for the resource. Default is an empty string.
security_group_rule.remote_address_group_id	body	string

Schema

{
  "type": "object",
  "description": "Request of the security-group-rules:post operation",
  "properties": {
    "security_group_rule": {
      "type": "object",
      "properties": {
        "security_group_id": {
          "type": "string",
          "maxLength": 36,
          "description": "The security group ID to associate with this\nsecurity group rule."
        },
        "remote_group_id": {
          "type": "string",
          "description": "The remote group UUID to associate with this\nsecurity group rule. You can specify either the\n`remote_group_id` or `remote_ip_prefix` attribute in the\nrequest body."
        },
        "direction": {
          "type": "string",
          "enum": [
            "ingress",
            "egress"
          ],
          "description": "Ingress or egress, which is the direction in\nwhich the security group rule is applied."
        },
        "protocol": {
          "type": "string",
          "description": "The IP protocol can be represented by a string, an integer, or `null`.\nValid string or integer values are `any` or `0`, `ah` or `51`,\n`dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`,\n`icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`,\n`ipip` or `4`, `ipv6-encap` or `41`,\n`ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`,\n`ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`,\n`pgm` or `113`, `rsvp` or `46`, `sctp` or `132`,\n`tcp` or `6`, `udp` or `17`, `udplite` or `136`,\n`vrrp` or `112`. Additionally, any integer value between [0-255] is\nalso valid. The string `any` (or integer `0`) means `all` IP\nprotocols. See the constants in `neutron_lib.constants` for the most\nup-to-date list of supported strings."
        },
        "port_range_min": {
          "type": "string",
          "description": "The minimum port number in the range that is\nmatched by the security group rule. If the protocol is TCP, UDP,\nDCCP, SCTP or UDP-Lite this value must be less than or equal to\nthe `port_range_max` attribute value. If the protocol is ICMP,\nthis value must be an ICMP type."
        },
        "port_range_max": {
          "type": "string",
          "description": "The maximum port number in the range that is\nmatched by the security group rule. If the protocol is TCP, UDP,\nDCCP, SCTP or UDP-Lite this value must be greater than or equal to\nthe `port_range_min` attribute value. If the protocol is ICMP,\nthis value must be an ICMP code."
        },
        "ethertype": {
          "type": "string",
          "enum": [
            "IPv4",
            "IPv6"
          ],
          "description": "Must be IPv4 or IPv6, and addresses represented\nin CIDR must match the ingress or egress rules."
        },
        "remote_ip_prefix": {
          "type": "string",
          "description": "The remote IP prefix that is matched by this security group rule."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "remote_address_group_id": {
          "type": "string"
        }
      },
      "description": "A `security_group_rule` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
security_group_rule	body	object	A `security_group_rule` object.
security_group_rule.id	body	string	The ID of the security group rule.
security_group_rule.security_group_id	body	string	The security group ID to associate with this security group rule.
security_group_rule.remote_group_id	body	string	The remote group UUID to associate with this security group rule. You can specify either the `remote_group_id` or `remote_ip_prefix` attribute in the request body.
security_group_rule.direction	body	string	Ingress or egress, which is the direction in which the security group rule is applied.
security_group_rule.protocol	body	string	The IP protocol can be represented by a string, an integer, or `null`. Valid string or integer values are `any` or `0`, `ah` or `51`, `dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`, `icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`, `ipip` or `4`, `ipv6-encap` or `41`, `ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`, `ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`, `pgm` or `113`, `rsvp` or `46`, `sctp` or `132`, `tcp` or `6`, `udp` or `17`, `udplite` or `136`, `vrrp` or `112`. Additionally, any integer value between [0-255] is also valid. The string `any` (or integer `0`) means `all` IP protocols. See the constants in `neutron_lib.constants` for the most up-to-date list of supported strings.
security_group_rule.port_range_min	body	string	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the `port_range_max` attribute value. If the protocol is ICMP, this value must be an ICMP type.
security_group_rule.port_range_max	body	string	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the `port_range_min` attribute value. If the protocol is ICMP, this value must be an ICMP code.
security_group_rule.ethertype	body	string	Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.
security_group_rule.remote_ip_prefix	body	string	The remote IP prefix that is matched by this security group rule.
security_group_rule.tenant_id	body	string	The ID of the project.
security_group_rule.revision_number	body	integer	The revision number of the resource.
security_group_rule.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
security_group_rule.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
security_group_rule.description	body	string	A human-readable description for the resource.
security_group_rule.normalized_cidr	body	[‘string’, ‘null’]
security_group_rule.remote_address_group_id	body	string

GET

/v2.0/security-group-rules/{id}

Show security group rule

Shows detailed information for a security group rule.

The response body contains the following information about the security group rule:

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
security_group_rule	body	object	A `security_group_rule` object.
security_group_rule.id	body	string	The ID of the security group rule.
security_group_rule.security_group_id	body	string	The security group ID to associate with this security group rule.
security_group_rule.remote_group_id	body	string	The remote group UUID to associate with this security group rule. You can specify either the `remote_group_id` or `remote_ip_prefix` attribute in the request body.
security_group_rule.direction	body	string	Ingress or egress, which is the direction in which the security group rule is applied.
security_group_rule.protocol	body	string	The IP protocol can be represented by a string, an integer, or `null`. Valid string or integer values are `any` or `0`, `ah` or `51`, `dccp` or `33`, `egp` or `8`, `esp` or `50`, `gre` or `47`, `icmp` or `1`, `icmpv6` or `58`, `igmp` or `2`, `ipip` or `4`, `ipv6-encap` or `41`, `ipv6-frag` or `44`, `ipv6-icmp` or `58`, `ipv6-nonxt` or `59`, `ipv6-opts` or `60`, `ipv6-route` or `43`, `ospf` or `89`, `pgm` or `113`, `rsvp` or `46`, `sctp` or `132`, `tcp` or `6`, `udp` or `17`, `udplite` or `136`, `vrrp` or `112`. Additionally, any integer value between [0-255] is also valid. The string `any` (or integer `0`) means `all` IP protocols. See the constants in `neutron_lib.constants` for the most up-to-date list of supported strings.
security_group_rule.port_range_min	body	string	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the `port_range_max` attribute value. If the protocol is ICMP, this value must be an ICMP type.
security_group_rule.port_range_max	body	string	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the `port_range_min` attribute value. If the protocol is ICMP, this value must be an ICMP code.
security_group_rule.ethertype	body	string	Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.
security_group_rule.remote_ip_prefix	body	string	The remote IP prefix that is matched by this security group rule.
security_group_rule.tenant_id	body	string	The ID of the project.
security_group_rule.revision_number	body	integer	The revision number of the resource.
security_group_rule.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
security_group_rule.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
security_group_rule.description	body	string	A human-readable description for the resource.
security_group_rule.normalized_cidr	body	[‘string’, ‘null’]
security_group_rule.remote_address_group_id	body	string

PUT

/v2.0/security-group-rules/{id}

Request of the security-group-rules/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/security-group-rules/{id} API

security_group_rule

body

object

security_group_rule.description

body

string

Schema

{
  "type": "object",
  "description": "Request of the security-group-rules/id:put operation",
  "properties": {
    "security_group_rule": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "maxLength": 255
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type
security_group_rule	body	object
security_group_rule.id	body	string
security_group_rule.security_group_id	body	string
security_group_rule.remote_group_id	body	string
security_group_rule.direction	body	string
security_group_rule.protocol	body	string
security_group_rule.port_range_min	body	string
security_group_rule.port_range_max	body	string
security_group_rule.ethertype	body	string
security_group_rule.remote_ip_prefix	body	string
security_group_rule.tenant_id	body	string
security_group_rule.revision_number	body	integer
security_group_rule.created_at	body	string
security_group_rule.updated_at	body	string
security_group_rule.description	body	string
security_group_rule.normalized_cidr	body	[‘string’, ‘null’]
security_group_rule.remote_address_group_id	body	string

DELETE

/v2.0/security-group-rules/{id}

Delete security group rule

Deletes a rule from an OpenStack Networking security group.

Normal response codes: 204

Error response codes: 401, 404, 412

Responses¶

204¶

segments¶

GET

/v2.0/segments

List segments

Lists segments to which the project has access.

Use the fields query parameter to filter the response. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/segments

Create segment

Creates a segment.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
segment	body	object
segment.tenant_id	body	string
segment.network_id	body	string	The ID of the attached network.
segment.physical_network	body	string	The physical network where this network/segment is implemented.
segment.network_type	body	string	The type of physical network that maps to this network resource. For example, `flat`, `vlan`, `vxlan`, or `gre`.
segment.segmentation_id	body	[‘string’, ‘integer’]	The ID of the isolated segment on the physical network. The `network_type` attribute defines the segmentation model. For example, if the `network_type` value is vlan, this ID is a vlan identifier. If the `network_type` value is gre, this ID is a gre key. `Note` that only the segmentation-id of VLAN type networks can be changed!
segment.name	body	[‘string’, ‘null’]	Human-readable name of the segment.
segment.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the segments:post operation",
  "properties": {
    "segment": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255
        },
        "network_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the attached network."
        },
        "physical_network": {
          "type": "string",
          "maxLength": 64,
          "description": "The physical network where this network/segment is implemented."
        },
        "network_type": {
          "type": "string",
          "maxLength": 32,
          "description": "The type of physical network that maps to this\nnetwork resource. For example, `flat`, `vlan`, `vxlan`, or\n`gre`."
        },
        "segmentation_id": {
          "type": [
            "string",
            "integer"
          ],
          "description": "The ID of the isolated segment on the physical network.\nThe `network_type` attribute defines the segmentation model.\nFor example, if the `network_type` value is vlan, this ID is a vlan\nidentifier. If the `network_type` value is gre, this ID is a gre key.\n`Note` that only the segmentation-id of VLAN type networks can be\nchanged!"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255,
          "description": "Human-readable name of the segment."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
segment	body	object
segment.id	body	string	The UUID of the segment.
segment.network_id	body	string	The ID of the attached network.
segment.physical_network	body	string	The physical network where this network/segment is implemented.
segment.network_type	body	string	The type of physical network that maps to this network resource. For example, `flat`, `vlan`, `vxlan`, or `gre`.
segment.segmentation_id	body	[‘string’, ‘integer’]	The ID of the isolated segment on the physical network. The `network_type` attribute defines the segmentation model. For example, if the `network_type` value is vlan, this ID is a vlan identifier. If the `network_type` value is gre, this ID is a gre key. `Note` that only the segmentation-id of VLAN type networks can be changed!
segment.name	body	[‘string’, ‘null’]	Human-readable name of the resource.
segment.revision_number	body	integer	The revision number of the resource.
segment.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
segment.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
segment.description	body	string	A human-readable description for the resource.

GET

/v2.0/segments/{id}

Show segment details

Shows details for a segment.

You can control which response parameters are returned by using the fields query parameter. For information, see Filtering and column selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
segment	body	object
segment.id	body	string	The UUID of the segment.
segment.network_id	body	string	The ID of the attached network.
segment.physical_network	body	string	The physical network where this network/segment is implemented.
segment.network_type	body	string	The type of physical network that maps to this network resource. For example, `flat`, `vlan`, `vxlan`, or `gre`.
segment.segmentation_id	body	[‘string’, ‘integer’]	The ID of the isolated segment on the physical network. The `network_type` attribute defines the segmentation model. For example, if the `network_type` value is vlan, this ID is a vlan identifier. If the `network_type` value is gre, this ID is a gre key. `Note` that only the segmentation-id of VLAN type networks can be changed!
segment.name	body	[‘string’, ‘null’]	Human-readable name of the resource.
segment.revision_number	body	integer	The revision number of the resource.
segment.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
segment.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
segment.description	body	string	A human-readable description for the resource.

PUT

/v2.0/segments/{id}

Update segment

Updates a segment.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/segments/{id} API
segment	body	object
segment.name	body	[‘string’, ‘null’]	Human-readable name of the segment.
segment.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the segments/id:put operation",
  "properties": {
    "segment": {
      "type": "object",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255,
          "description": "Human-readable name of the segment."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
segment	body	object
segment.id	body	string	The UUID of the segment.
segment.network_id	body	string	The ID of the attached network.
segment.physical_network	body	string	The physical network where this network/segment is implemented.
segment.network_type	body	string	The type of physical network that maps to this network resource. For example, `flat`, `vlan`, `vxlan`, or `gre`.
segment.segmentation_id	body	[‘string’, ‘integer’]	The ID of the isolated segment on the physical network. The `network_type` attribute defines the segmentation model. For example, if the `network_type` value is vlan, this ID is a vlan identifier. If the `network_type` value is gre, this ID is a gre key. `Note` that only the segmentation-id of VLAN type networks can be changed!
segment.name	body	[‘string’, ‘null’]	Human-readable name of the resource.
segment.revision_number	body	integer	The revision number of the resource.
segment.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
segment.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
segment.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/segments/{id}

Delete segment

Deletes a segment and its associated resources.

Normal response codes: 204

Error response codes: 401, 404, 409, 412

Responses¶

204¶

service-providers¶

GET

/v2.0/service-providers

List service providers

Lists service providers and their associated service types.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/service-providers

Request of the service-providers:post operation

Request¶

Description

Name

Location

Type

Description

service_provider

body

object

Schema

{
  "type": "object",
  "description": "Request of the service-providers:post operation",
  "properties": {
    "service_provider": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

201¶

Name	Location	Type
service_provider	body	object
service_provider.service_type	body	string
service_provider.name	body	string
service_provider.default	body	string

GET

/v2.0/service-providers/{id}

Responses¶

200¶

Name	Location	Type
service_provider	body	object
service_provider.service_type	body	string
service_provider.name	body	string
service_provider.default	body	string

PUT

/v2.0/service-providers/{id}

Request of the service-providers/id:put operation

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/service-providers/{id} API

service_provider

body

object

Schema

{
  "type": "object",
  "description": "Request of the service-providers/id:put operation",
  "properties": {
    "service_provider": {
      "type": "object",
      "properties": {}
    }
  }
}

Responses¶

200¶

Name	Location	Type
service_provider	body	object
service_provider.service_type	body	string
service_provider.name	body	string
service_provider.default	body	string

DELETE

/v2.0/service-providers/{id}

Responses¶

204¶

subnetpools¶

GET

/v2.0/subnetpools

List subnet pools

Lists subnet pools that the project has access to.

Default policy settings return only the subnet pools owned by the project of the user submitting the request, unless the user has administrative role.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/subnetpools

Create subnet pool

Creates a subnet pool.

Normal response codes: 201

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
subnetpool	body	object	A `subnetpool` object.
subnetpool.name	body	string	Human-readable name of the resource.
subnetpool.tenant_id	body	string	The ID of the project.
subnetpool.default_quota	body	integer	A per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. Default is no quota is enforced on allocations from the subnet pool. For IPv4 subnet pools, `default_quota` is measured in units of /32. For IPv6 subnet pools, `default_quota` is measured units of /64. All projects that use the subnet pool have the same prefix quota applied.
subnetpool.default_prefixlen	body	integer	The size of the prefix to allocate when the `cidr` or `prefixlen` attributes are omitted when you create the subnet. Default is `min_prefixlen`.
subnetpool.min_prefixlen	body	integer	The smallest prefix that can be allocated from a subnet pool. For IPv4 subnet pools, default is `8`. For IPv6 subnet pools, default is `64`.
subnetpool.max_prefixlen	body	integer	The maximum prefix size that can be allocated from the subnet pool. For IPv4 subnet pools, default is `32`. For IPv6 subnet pools, default is `128`.
subnetpool.is_default	body	[‘string’, ‘boolean’]	The subnetpool is default pool or not.
subnetpool.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.
subnetpool.address_scope_id	body	[‘string’, ‘null’]	An address scope to assign to the subnet pool.
subnetpool.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the subnetpools:post operation",
  "properties": {
    "subnetpool": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Human-readable name of the resource."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "prefixes": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "A list of subnet prefixes to assign to the subnet\npool. The API merges adjacent prefixes and treats them as a single\nprefix. Each subnet prefix must be unique among all subnet\nprefixes in all subnet pools that are associated with the address\nscope."
        },
        "default_quota": {
          "type": "integer",
          "minimum": 0,
          "description": "A per-project quota on the prefix space that can\nbe allocated from the subnet pool for project subnets. Default is\nno quota is enforced on allocations from the subnet pool. For IPv4\nsubnet pools, `default_quota` is measured in units of /32. For\nIPv6 subnet pools, `default_quota` is measured units of /64. All\nprojects that use the subnet pool have the same prefix quota\napplied."
        },
        "default_prefixlen": {
          "type": "integer",
          "minimum": 0,
          "description": "The size of the prefix to allocate when the\n`cidr` or `prefixlen` attributes are omitted when you create\nthe subnet. Default is `min_prefixlen`."
        },
        "min_prefixlen": {
          "type": "integer",
          "minimum": 0,
          "description": "The smallest prefix that can be allocated from a\nsubnet pool. For IPv4 subnet pools, default is `8`. For IPv6\nsubnet pools, default is `64`."
        },
        "max_prefixlen": {
          "type": "integer",
          "minimum": 0,
          "description": "The maximum prefix size that can be allocated\nfrom the subnet pool. For IPv4 subnet pools, default is `32`.\nFor IPv6 subnet pools, default is `128`."
        },
        "is_default": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The subnetpool is default pool or not."
        },
        "shared": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether this resource is shared across all projects.\nBy default, only administrative users can change this value."
        },
        "address_scope_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "An address scope to assign to the subnet pool."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `subnetpool` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
subnetpool	body	object	A `subnetpool` object.
subnetpool.id	body	string	The ID of the subnet pool.
subnetpool.name	body	string	Human-readable name of the resource.
subnetpool.tenant_id	body	string	The ID of the project.
subnetpool.default_quota	body	integer	A per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. Default is no quota is enforced on allocations from the subnet pool. For IPv4 subnet pools, `default_quota` is measured in units of /32. For IPv6 subnet pools, `default_quota` is measured units of /64. All projects that use the subnet pool have the same prefix quota applied.
subnetpool.ip_version	body	string	The IP protocol version. Valid value is `4` or `6`. Default is `4`.
subnetpool.default_prefixlen	body	integer	The size of the prefix to allocate when the `cidr` or `prefixlen` attributes are omitted when you create the subnet. Default is `min_prefixlen`.
subnetpool.min_prefixlen	body	integer	The smallest prefix that can be allocated from a subnet pool. For IPv4 subnet pools, default is `8`. For IPv6 subnet pools, default is `64`.
subnetpool.max_prefixlen	body	integer	The maximum prefix size that can be allocated from the subnet pool. For IPv4 subnet pools, default is `32`. For IPv6 subnet pools, default is `128`.
subnetpool.is_default	body	[‘string’, ‘boolean’]	The subnetpool is default pool or not.
subnetpool.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.
subnetpool.address_scope_id	body	[‘string’, ‘null’]	An address scope to assign to the subnet pool.
subnetpool.revision_number	body	integer	The revision number of the resource.
subnetpool.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
subnetpool.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
subnetpool.description	body	string	A human-readable description for the resource.

PUT

/v2.0/subnetpools/{id}/onboard_network_subnets

Onboard subnets

Onboard network subnets to a subnet pool.

Normal response codes: 200

Error response codes: 400

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/subnetpools/{id}/remove_prefixes API

Schema

{
  "type": "object",
  "description": "Request of the subnetpools/id/onboard_network_subnets:put operation"
}

Responses¶

200¶

GET

/v2.0/subnetpools/{id}

Show subnet pool

Shows information for a subnet pool.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
subnetpool	body	object	A `subnetpool` object.
subnetpool.id	body	string	The ID of the subnet pool.
subnetpool.name	body	string	Human-readable name of the resource.
subnetpool.tenant_id	body	string	The ID of the project.
subnetpool.default_quota	body	integer	A per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. Default is no quota is enforced on allocations from the subnet pool. For IPv4 subnet pools, `default_quota` is measured in units of /32. For IPv6 subnet pools, `default_quota` is measured units of /64. All projects that use the subnet pool have the same prefix quota applied.
subnetpool.ip_version	body	string	The IP protocol version. Valid value is `4` or `6`. Default is `4`.
subnetpool.default_prefixlen	body	integer	The size of the prefix to allocate when the `cidr` or `prefixlen` attributes are omitted when you create the subnet. Default is `min_prefixlen`.
subnetpool.min_prefixlen	body	integer	The smallest prefix that can be allocated from a subnet pool. For IPv4 subnet pools, default is `8`. For IPv6 subnet pools, default is `64`.
subnetpool.max_prefixlen	body	integer	The maximum prefix size that can be allocated from the subnet pool. For IPv4 subnet pools, default is `32`. For IPv6 subnet pools, default is `128`.
subnetpool.is_default	body	[‘string’, ‘boolean’]	The subnetpool is default pool or not.
subnetpool.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.
subnetpool.address_scope_id	body	[‘string’, ‘null’]	An address scope to assign to the subnet pool.
subnetpool.revision_number	body	integer	The revision number of the resource.
subnetpool.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
subnetpool.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
subnetpool.description	body	string	A human-readable description for the resource.

PUT

/v2.0/subnetpools/{id}

Update subnet pool

Updates a subnet pool.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 412

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/subnetpools/{id}/remove_prefixes API
subnetpool	body	object	A `subnetpool` object.
subnetpool.name	body	string	Human-readable name of the resource.
subnetpool.default_quota	body	integer	A per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. Default is no quota is enforced on allocations from the subnet pool. For IPv4 subnet pools, `default_quota` is measured in units of /32. For IPv6 subnet pools, `default_quota` is measured units of /64. All projects that use the subnet pool have the same prefix quota applied.
subnetpool.default_prefixlen	body	integer	The size of the prefix to allocate when the `cidr` or `prefixlen` attributes are omitted when you create the subnet. Default is `min_prefixlen`.
subnetpool.min_prefixlen	body	integer	The smallest prefix that can be allocated from a subnet pool. For IPv4 subnet pools, default is `8`. For IPv6 subnet pools, default is `64`.
subnetpool.max_prefixlen	body	integer	The maximum prefix size that can be allocated from the subnet pool. For IPv4 subnet pools, default is `32`. For IPv6 subnet pools, default is `128`.
subnetpool.is_default	body	[‘string’, ‘boolean’]	The subnetpool is default pool or not.
subnetpool.address_scope_id	body	[‘string’, ‘null’]	An address scope to assign to the subnet pool.
subnetpool.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the subnetpools/id:put operation",
  "properties": {
    "subnetpool": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Human-readable name of the resource."
        },
        "prefixes": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "A list of subnet prefixes to assign to the subnet\npool. The API merges adjacent prefixes and treats them as a single\nprefix. Each subnet prefix must be unique among all subnet\nprefixes in all subnet pools that are associated with the address\nscope."
        },
        "default_quota": {
          "type": "integer",
          "minimum": 0,
          "description": "A per-project quota on the prefix space that can\nbe allocated from the subnet pool for project subnets. Default is\nno quota is enforced on allocations from the subnet pool. For IPv4\nsubnet pools, `default_quota` is measured in units of /32. For\nIPv6 subnet pools, `default_quota` is measured units of /64. All\nprojects that use the subnet pool have the same prefix quota\napplied."
        },
        "default_prefixlen": {
          "type": "integer",
          "minimum": 0,
          "description": "The size of the prefix to allocate when the\n`cidr` or `prefixlen` attributes are omitted when you create\nthe subnet. Default is `min_prefixlen`."
        },
        "min_prefixlen": {
          "type": "integer",
          "minimum": 0,
          "description": "The smallest prefix that can be allocated from a\nsubnet pool. For IPv4 subnet pools, default is `8`. For IPv6\nsubnet pools, default is `64`."
        },
        "max_prefixlen": {
          "type": "integer",
          "minimum": 0,
          "description": "The maximum prefix size that can be allocated\nfrom the subnet pool. For IPv4 subnet pools, default is `32`.\nFor IPv6 subnet pools, default is `128`."
        },
        "is_default": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The subnetpool is default pool or not."
        },
        "address_scope_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "An address scope to assign to the subnet pool."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      },
      "description": "A `subnetpool` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
subnetpool	body	object	A `subnetpool` object.
subnetpool.id	body	string	The ID of the subnet pool.
subnetpool.name	body	string	Human-readable name of the resource.
subnetpool.tenant_id	body	string	The ID of the project.
subnetpool.default_quota	body	integer	A per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. Default is no quota is enforced on allocations from the subnet pool. For IPv4 subnet pools, `default_quota` is measured in units of /32. For IPv6 subnet pools, `default_quota` is measured units of /64. All projects that use the subnet pool have the same prefix quota applied.
subnetpool.ip_version	body	string	The IP protocol version. Valid value is `4` or `6`. Default is `4`.
subnetpool.default_prefixlen	body	integer	The size of the prefix to allocate when the `cidr` or `prefixlen` attributes are omitted when you create the subnet. Default is `min_prefixlen`.
subnetpool.min_prefixlen	body	integer	The smallest prefix that can be allocated from a subnet pool. For IPv4 subnet pools, default is `8`. For IPv6 subnet pools, default is `64`.
subnetpool.max_prefixlen	body	integer	The maximum prefix size that can be allocated from the subnet pool. For IPv4 subnet pools, default is `32`. For IPv6 subnet pools, default is `128`.
subnetpool.is_default	body	[‘string’, ‘boolean’]	The subnetpool is default pool or not.
subnetpool.shared	body	[‘string’, ‘boolean’]	Indicates whether this resource is shared across all projects. By default, only administrative users can change this value.
subnetpool.address_scope_id	body	[‘string’, ‘null’]	An address scope to assign to the subnet pool.
subnetpool.revision_number	body	integer	The revision number of the resource.
subnetpool.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
subnetpool.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
subnetpool.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/subnetpools/{id}

Delete subnet pool

Deletes a subnet pool.

The operation fails if any subnets allocated from the subnet pool are still in use.

Normal response codes: 204

Error response codes: 401, 404, 412

Responses¶

204¶

PUT

/v2.0/subnetpools/{id}/add_prefixes

Add prefixes

Adds prefixes to a subnet pool.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 409, 412

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/subnetpools/{id}/remove_prefixes API

Schema

{
  "type": "object",
  "description": "Request of the subnetpools/id/add_prefixes:put operation"
}

Responses¶

200¶

PUT

/v2.0/subnetpools/{id}/remove_prefixes

Remove prefixes

Remove prefixes from a subnet pool.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 409, 412

Request¶

Description

Name

Location

Type

Description

id

path

string

id parameter for /v2.0/subnetpools/{id}/remove_prefixes API

Schema

{
  "type": "object",
  "description": "Request of the subnetpools/id/remove_prefixes:put operation"
}

Responses¶

200¶

GET

/v2.0/subnetpools/{subnetpool_id}/tags

Responses¶

200¶

PUT

/v2.0/subnetpools/{subnetpool_id}/tags

Request of the subnetpools/subnetpool_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

subnetpool_id

path

string

subnetpool_id parameter for /v2.0/subnetpools/{subnetpool_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the subnetpools/subnetpool_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/subnetpools/{subnetpool_id}/tags

Responses¶

204¶

GET

/v2.0/subnetpools/{subnetpool_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/subnetpools/{subnetpool_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/subnetpools/{subnetpool_id}/tags/{id}

Responses¶

204¶

ports¶

GET

/v2.0/ports/{port_id}/tags

Responses¶

200¶

PUT

/v2.0/ports/{port_id}/tags

Request of the ports/port_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

port_id

path

string

port_id parameter for /v2.0/ports/{port_id}/add_allowed_address_pairs API

Schema

{
  "type": "object",
  "description": "Request of the ports/port_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/ports/{port_id}/tags

Responses¶

204¶

GET

/v2.0/ports/{port_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/ports/{port_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/ports/{port_id}/tags/{id}

Responses¶

204¶

GET

/v2.0/ports

List ports

Lists ports to which the user has access.

Default policy settings return only those ports that are owned by the project of the user who submits the request, unless the request is submitted by a user with administrative rights.

If the ip-substring-filtering extension is enabled, the Neutron API supports IP address substring filtering on the fixed_ips attribute. If you specify an IP address substring (ip_address_substr) in an entry of the fixed_ips attribute, the Neutron API will list all ports that have an IP address matching the substring.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/ports

Create port

Creates a port on a network.

To define the network in which to create the port, specify the network_id attribute in the request body.

Normal response codes: 201

Error response codes: 400, 401, 403, 404

Request¶

Description

Name	Location	Type	Description
port	body	object	A `port` object.
port.name	body	string	Human-readable name of the resource. Default is an empty string.
port.network_id	body	string	The ID of the attached network.
port.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
port.mac_address	body	string	The MAC address of the port. If unspecified, a MAC address is automatically generated.
port.device_id	body	string	The ID of the device that uses this port. For example, a server instance or a logical router.
port.device_owner	body	string	The entity type that uses this port. For example, `compute:nova` (server instance), `network:dhcp` (DHCP agent) or `network:router_interface` (router interface).
port.tenant_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
port.device_profile	body	[‘string’, ‘null’]
port.hints	body	[‘object’, ‘null’]	Admin-only. A dict, at the top level keyed by mechanism driver aliases (as defined in setup.cfg). To following values can be used to control Open vSwitch’s Userspace Tx packet steering feature: `{"openvswitch": {"other_config": {"tx-steering": "hash"}}}` `{"openvswitch": {"other_config": {"tx-steering": "thread"}}}` If omitted the default is defined by Open vSwitch. The field cannot be longer than 4095 characters.
port.numa_affinity_policy	body	string	The port NUMA affinity policy requested during the virtual machine scheduling. Values: `None`, `required`, `preferred` or `legacy`.
port.binding:vnic_type	body	string	The type of vNIC which this port should be attached to. This is used to determine which mechanism driver(s) to be used to bind the port. The valid values are `normal`, `macvtap`, `direct`, `baremetal`, `direct-physical`, `virtio-forwarder`, `smart-nic` and `remote-managed`. What type of vNIC is actually available depends on deployments. The default is `normal`.
port.binding:host_id	body	string	The ID of the host where the port resides. The default is an empty string.
port.binding:profile	body	[‘object’, ‘null’]	A dictionary that enables the application running on the specific host to pass and receive vif port information specific to the networking back-end. This field is only meant for machine-machine communication for compute services like Nova, Ironic or Zun to pass information to a Neutron back-end. It should not be used by multiple services concurrently or by cloud end users. The existing counterexamples (`capabilities: [switchdev]` for Open vSwitch hardware offload and `trusted=true` for Trusted Virtual Functions) are due to be cleaned up. The networking API does not define a specific format of this field. The default is an empty dictionary. If you update it with null then it is treated like {} in the response. Since the port-mac-address-override extension the `device_mac_address` field of the binding:profile can be used to provide the MAC address of the physical device a direct-physical port is being bound to. If provided, then the `mac_address` field of the port resource will be updated to the MAC from the active binding.
port.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status. A valid value is enabled (`true`) or disabled (`false`). If port security is enabled for the port, security group rules and anti-spoofing rules are applied to the traffic on the port. If disabled, no such rules are applied.
port.qos_policy_id	body	[‘string’, ‘null’]	QoS policy associated with the port.
port.propagate_uplink_status	body	[‘string’, ‘boolean’]	The uplink status propagation of the port. Valid values are enabled (`true`) and disabled (`false`).
port.dns_name	body	string	A valid DNS name.
port.dns_domain	body	string	A valid DNS domain.
port.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the ports:post operation",
  "properties": {
    "port": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "network_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the attached network."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`).\nDefault is `true`."
        },
        "mac_address": {
          "type": "string",
          "description": "The MAC address of the port.\nIf unspecified, a MAC address is automatically generated."
        },
        "fixed_ips": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ip_address": {
                "type": "string",
                "description": "IP Address"
              },
              "subnet_id": {
                "type": "string",
                "description": "The subnet ID from which the IP address is assigned"
              }
            }
          },
          "description": "The IP addresses for the port.\nIf you would like to assign multiple IP addresses for the port,\nspecify multiple entries in this field.\nEach entry consists of IP address (`ip_address`) and the subnet ID\nfrom which the IP address is assigned (`subnet_id`).\n\n\n* If you specify both a subnet ID and an IP address, OpenStack Networking\ntries to allocate the IP address on that subnet to the port.\n* If you specify only a subnet ID, OpenStack Networking allocates\nan available IP from that subnet to the port.\n* If you specify only an IP address, OpenStack Networking\ntries to allocate the IP address if the address is a valid IP\nfor any of the subnets on the specified network."
        },
        "device_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the device that uses this port.\nFor example, a server instance or a logical router."
        },
        "device_owner": {
          "type": "string",
          "maxLength": 255,
          "description": "The entity type that uses this port.\nFor example, `compute:nova` (server instance), `network:dhcp`\n(DHCP agent) or `network:router_interface` (router interface)."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "allowed_address_pairs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ip_address": {
                "type": "string"
              },
              "max_address": {
                "type": "string"
              }
            }
          },
          "description": "A set of zero or more allowed address pair objects each where address pair\nobject contains an `ip_address` and `mac_address`. While the\n`ip_address` is required, the `mac_address` will be taken from the\nport if not specified. The value of `ip_address` can be an IP Address\nor a CIDR (if supported by the underlying extension plugin).\nA server connected to the port can send a packet with source address which\nmatches one of the specified allowed address pairs."
        },
        "extra_dhcp_opts": {
          "type": "array",
          "items": {
            "type": "object",
            "extraProperties": true
          },
          "x-openstack": {
            "todo": "implementme"
          },
          "description": "A set of zero or more extra DHCP option pairs. An\noption pair consists of an option value and name."
        },
        "device_profile": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255
        },
        "hints": {
          "type": [
            "object",
            "null"
          ],
          "description": "Admin-only. A dict, at the top level keyed by mechanism driver\naliases (as defined in setup.cfg). To following values can be used to\ncontrol Open vSwitch\u2019s Userspace Tx packet steering feature:\n\n\n* `{\"openvswitch\": {\"other_config\": {\"tx-steering\": \"hash\"}}}`\n* `{\"openvswitch\": {\"other_config\": {\"tx-steering\": \"thread\"}}}`\n\n\nIf omitted the default is defined by Open vSwitch.\nThe field cannot be longer than 4095 characters."
        },
        "numa_affinity_policy": {
          "type": "string",
          "enum": [
            "required",
            "preferred",
            "legacy",
            null
          ],
          "description": "The port NUMA affinity policy requested during the virtual machine\nscheduling. Values: `None`, `required`, `preferred` or `legacy`."
        },
        "binding:vnic_type": {
          "type": "string",
          "enum": [
            "normal",
            "direct",
            "macvtap",
            "baremetal",
            "direct-physical",
            "virtio-forwarder",
            "smart-nic",
            "vdpa",
            "accelerator-direct",
            "accelerator-direct-physical",
            "remote-managed"
          ],
          "description": "The type of vNIC which this port should be attached to. This is used to\ndetermine which mechanism driver(s) to be used to bind the port.\nThe valid values are `normal`, `macvtap`, `direct`, `baremetal`,\n`direct-physical`, `virtio-forwarder`, `smart-nic`\nand `remote-managed`.\nWhat type of vNIC is actually available depends on deployments.\nThe default is `normal`."
        },
        "binding:host_id": {
          "type": "string",
          "description": "The ID of the host where the port resides.\nThe default is an empty string."
        },
        "binding:profile": {
          "type": [
            "object",
            "null"
          ],
          "description": "A dictionary that enables the application running on the specific host to\npass and receive vif port information specific to the networking back-end.\nThis field is only meant for machine-machine communication for compute\nservices like Nova, Ironic or Zun to pass information to a Neutron\nback-end. It should not be used by multiple services concurrently or by\ncloud end users. The existing counterexamples\n(`capabilities: [switchdev]` for Open vSwitch hardware offload and\n`trusted=true` for Trusted Virtual Functions) are due to be cleaned up.\nThe networking API does not define a specific format of this field.\nThe default is an empty dictionary.\nIf you update it with null then it is treated like {} in the response.\nSince the port-mac-address-override extension the `device_mac_address`\nfield of the binding:profile can be used to provide the MAC address of the\nphysical device a direct-physical port is being bound to. If provided, then\nthe `mac_address` field of the port resource will be updated to the MAC\nfrom the active binding."
        },
        "port_security_enabled": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The port security status. A valid value is\nenabled (`true`) or disabled (`false`).\nIf port security is enabled for the port,\nsecurity group rules and anti-spoofing rules are applied to\nthe traffic on the port. If disabled, no such rules are applied."
        },
        "qos_policy_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "QoS policy associated with the port."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "uniqueItems": true
        },
        "propagate_uplink_status": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The uplink status propagation of the port. Valid values are\nenabled (`true`) and disabled (`false`)."
        },
        "dns_name": {
          "type": "string",
          "format": "hostname",
          "maxLength": 255,
          "description": "A valid DNS name."
        },
        "dns_domain": {
          "type": "string",
          "format": "hostname",
          "maxLength": 255,
          "description": "A valid DNS domain."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "security_groups": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "The IDs of security groups applied to the port."
        }
      },
      "description": "A `port` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
port	body	object	A `port` object.
port.id	body	string	The ID of the resource.
port.name	body	string	Human-readable name of the resource.
port.network_id	body	string	The ID of the attached network.
port.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
port.mac_address	body	string	The MAC address of the port. If the port uses the `direct-physical` `vnic_type` then the value of this field is overwritten with the MAC address provided in the active binding:profile if any.
port.device_id	body	string	The ID of the device that uses this port. For example, a server instance or a logical router.
port.device_owner	body	string	The entity type that uses this port. For example, `compute:nova` (server instance), `network:dhcp` (DHCP agent) or `network:router_interface` (router interface).
port.tenant_id	body	string	The ID of the project.
port.status	body	string	The port status. Values are `ACTIVE`, `DOWN`, `BUILD` and `ERROR`.
port.data_plane_status	body	string	Status of the underlying data plane of a port.
port.ip_allocation	body	string	Indicates when ports use either `deferred`, `immediate` or no IP allocation (`none`).
port.device_profile	body	[‘string’, ‘null’]
port.hints	body	[‘object’, ‘null’]	Admin-only. The following values control Open vSwitch’s Userspace Tx packet steering feature: `{"openvswitch": {"other_config": {"tx-steering": "hash\|thread"}}}`
port.numa_affinity_policy	body	string	The port NUMA affinity policy requested during the virtual machine scheduling. Values: `None`, `required`, `preferred` or `legacy`.
port.resource_request	body	string	Expose Placement resources (i.e.: `minimum-bandwidth`) and traits (i.e.: `vnic-type`, `physnet`) requested by a port to Nova and Placement. A `resource_request` object contains `request_groups` and `same_subtree` keys. `request_groups` is a list of dicts, where each dict represents one group of resources and traits that needs to be fulfilled from a single resource provider. Every dict in the list must contain `id`, `required` and `resources` keys. The `id` field is a string which represents a unique UUID that is generated for each group by combining the `port_id` and UUIDs of the QoS rules contributing to the group via the UUID5 method. `required` key contains the traits (generated from the `vnic_type` and the `physnet`) required by the port, and a `resources` key contains a mapping of requested resource class name and requested amount from the QoS policy. `same_subtree` key contains a list of `id` values from every resource group.
port.binding:vif_type	body	string	The type of which mechanism is used for the port. An API consumer like nova can use this to determine an appropriate way to attach a device (for example an interface of a virtual server) to the port. Available values currently defined includes `ovs`, `bridge`, `macvtap`, `hw_veb`, `hostdev_physical`, `vhostuser`, `distributed` and `other`. There are also special values: `unbound` and `binding_failed`. `unbound` means the port is not bound to a networking back-end. `binding_failed` means an error that the port failed to be bound to a networking back-end.
port.binding:vif_details	body	object	A dictionary which contains additional information on the port. Currently the following fields are defined: `port_filter` and `ovs_hybrid_plug`. `port_filter` is a boolean indicating the networking service provides port filtering features such as security group and/or anti MAC/IP spoofing. `ovs_hybrid_plug` is a boolean used to inform an API consumer like nova that the hybrid plugging strategy for OVS should be used.
port.binding:vnic_type	body	string	The type of vNIC which this port should be attached to. This is used to determine which mechanism driver(s) to be used to bind the port. The valid values are `normal`, `macvtap`, `direct`, `baremetal`, `direct-physical`, `virtio-forwarder`, `smart-nic` and `remote-managed`. What type of vNIC is actually available depends on deployments.
port.binding:host_id	body	string	The ID of the host where the port resides.
port.binding:profile	body	[‘object’, ‘null’]	A dictionary that enables the application running on the specific host to pass and receive vif port information specific to the networking back-end. The networking API does not define a specific format of this field. If the update request is null this response field will be {}.
port.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status. A valid value is enabled (`true`) or disabled (`false`). If port security is enabled for the port, security group rules and anti-spoofing rules are applied to the traffic on the port. If disabled, no such rules are applied.
port.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the port.
port.qos_network_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy of the network where this port is plugged.
port.revision_number	body	integer	The revision number of the resource.
port.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
port.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
port.propagate_uplink_status	body	[‘string’, ‘boolean’]	The uplink status propagation of the port. Valid values are enabled (`true`) and disabled (`false`).
port.dns_name	body	string	A valid DNS name.
port.dns_assignment	body	string	Data assigned to a port by the Networking internal DNS including the `hostname`, `ip_address` and `fqdn`.
port.dns_domain	body	string	A valid DNS domain.
port.description	body	string	A human-readable description for the resource.

GET

/v2.0/ports/{port_id}

Show port details

Shows details for a port.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
port	body	object	A `port` object.
port.id	body	string	The ID of the resource.
port.name	body	string	Human-readable name of the resource.
port.network_id	body	string	The ID of the attached network.
port.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
port.mac_address	body	string	The MAC address of the port. If the port uses the `direct-physical` `vnic_type` then the value of this field is overwritten with the MAC address provided in the active binding:profile if any.
port.device_id	body	string	The ID of the device that uses this port. For example, a server instance or a logical router.
port.device_owner	body	string	The entity type that uses this port. For example, `compute:nova` (server instance), `network:dhcp` (DHCP agent) or `network:router_interface` (router interface).
port.tenant_id	body	string	The ID of the project.
port.status	body	string	The port status. Values are `ACTIVE`, `DOWN`, `BUILD` and `ERROR`.
port.data_plane_status	body	string	Status of the underlying data plane of a port.
port.ip_allocation	body	string	Indicates when ports use either `deferred`, `immediate` or no IP allocation (`none`).
port.device_profile	body	[‘string’, ‘null’]
port.hints	body	[‘object’, ‘null’]	Admin-only. The following values control Open vSwitch’s Userspace Tx packet steering feature: `{"openvswitch": {"other_config": {"tx-steering": "hash\|thread"}}}`
port.numa_affinity_policy	body	string	The port NUMA affinity policy requested during the virtual machine scheduling. Values: `None`, `required`, `preferred` or `legacy`.
port.resource_request	body	string	Expose Placement resources (i.e.: `minimum-bandwidth`) and traits (i.e.: `vnic-type`, `physnet`) requested by a port to Nova and Placement. A `resource_request` object contains `request_groups` and `same_subtree` keys. `request_groups` is a list of dicts, where each dict represents one group of resources and traits that needs to be fulfilled from a single resource provider. Every dict in the list must contain `id`, `required` and `resources` keys. The `id` field is a string which represents a unique UUID that is generated for each group by combining the `port_id` and UUIDs of the QoS rules contributing to the group via the UUID5 method. `required` key contains the traits (generated from the `vnic_type` and the `physnet`) required by the port, and a `resources` key contains a mapping of requested resource class name and requested amount from the QoS policy. `same_subtree` key contains a list of `id` values from every resource group.
port.binding:vif_type	body	string	The type of which mechanism is used for the port. An API consumer like nova can use this to determine an appropriate way to attach a device (for example an interface of a virtual server) to the port. Available values currently defined includes `ovs`, `bridge`, `macvtap`, `hw_veb`, `hostdev_physical`, `vhostuser`, `distributed` and `other`. There are also special values: `unbound` and `binding_failed`. `unbound` means the port is not bound to a networking back-end. `binding_failed` means an error that the port failed to be bound to a networking back-end.
port.binding:vif_details	body	object	A dictionary which contains additional information on the port. Currently the following fields are defined: `port_filter` and `ovs_hybrid_plug`. `port_filter` is a boolean indicating the networking service provides port filtering features such as security group and/or anti MAC/IP spoofing. `ovs_hybrid_plug` is a boolean used to inform an API consumer like nova that the hybrid plugging strategy for OVS should be used.
port.binding:vnic_type	body	string	The type of vNIC which this port should be attached to. This is used to determine which mechanism driver(s) to be used to bind the port. The valid values are `normal`, `macvtap`, `direct`, `baremetal`, `direct-physical`, `virtio-forwarder`, `smart-nic` and `remote-managed`. What type of vNIC is actually available depends on deployments.
port.binding:host_id	body	string	The ID of the host where the port resides.
port.binding:profile	body	[‘object’, ‘null’]	A dictionary that enables the application running on the specific host to pass and receive vif port information specific to the networking back-end. The networking API does not define a specific format of this field. If the update request is null this response field will be {}.
port.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status. A valid value is enabled (`true`) or disabled (`false`). If port security is enabled for the port, security group rules and anti-spoofing rules are applied to the traffic on the port. If disabled, no such rules are applied.
port.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the port.
port.qos_network_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy of the network where this port is plugged.
port.revision_number	body	integer	The revision number of the resource.
port.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
port.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
port.propagate_uplink_status	body	[‘string’, ‘boolean’]	The uplink status propagation of the port. Valid values are enabled (`true`) and disabled (`false`).
port.dns_name	body	string	A valid DNS name.
port.dns_assignment	body	string	Data assigned to a port by the Networking internal DNS including the `hostname`, `ip_address` and `fqdn`.
port.dns_domain	body	string	A valid DNS domain.
port.description	body	string	A human-readable description for the resource.

PUT

/v2.0/ports/{port_id}

Update port

Updates a port.

You can update information for a port, such as its symbolic name and associated IPs. When you update IPs for a port, any previously associated IPs are removed, returned to the respective subnet allocation pools, and replaced by the IPs in the request body. Therefore, this operation replaces the fixed_ip attribute when you specify it in the request body. If the updated IP addresses are not valid or are already in use, the operation fails and the existing IP addresses are not removed from the port.

When you update security groups for a port and the operation succeeds, any associated security groups are removed and replaced by the security groups in the request body. Therefore, this operation replaces the security_groups attribute when you specify it in the request body. If the security groups are not valid, the operation fails and the existing security groups are not removed from the port.

When you update binding:profile of a port with null it is treated as {} in the response.

Only admins and users with a specific role can update the data plane status (default role: data_plane_integrator).

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 409, 412

Request¶

Description

Name	Location	Type	Description
port_id	path	string	port_id parameter for /v2.0/ports/{port_id}/add_allowed_address_pairs API
port	body	object	A `port` object.
port.name	body	string	Human-readable name of the resource. Default is an empty string.
port.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`). Default is `true`.
port.mac_address	body	string	The MAC address of the port. By default, only administrative users and users with advsvc role can change this value.
port.device_id	body	string	The ID of the device that uses this port. For example, a server instance or a logical router.
port.device_owner	body	string	The entity type that uses this port. For example, `compute:nova` (server instance), `network:dhcp` (DHCP agent) or `network:router_interface` (router interface).
port.data_plane_status	body	string	Status of the underlying data plane of a port.
port.hints	body	[‘object’, ‘null’]	Admin-only. A dict, at the top level keyed by mechanism driver aliases (as defined in setup.cfg). To following values can be used to control Open vSwitch’s Userspace Tx packet steering feature: `{"openvswitch": {"other_config": {"tx-steering": "hash"}}}` `{"openvswitch": {"other_config": {"tx-steering": "thread"}}}` If omitted the default is defined by Open vSwitch. The field cannot be longer than 4095 characters.
port.numa_affinity_policy	body	string	The port NUMA affinity policy requested during the virtual machine scheduling. Values: `None`, `required`, `preferred` or `legacy`.
port.binding:vnic_type	body	string	The type of vNIC which this port should be attached to. This is used to determine which mechanism driver(s) to be used to bind the port. The valid values are `normal`, `macvtap`, `direct`, `baremetal`, `direct-physical`, `virtio-forwarder`, `smart-nic` and `remote-managed`. What type of vNIC is actually available depends on deployments. The default is `normal`.
port.binding:host_id	body	string	The ID of the host where the port resides. The default is an empty string.
port.binding:profile	body	[‘object’, ‘null’]	A dictionary that enables the application running on the specific host to pass and receive vif port information specific to the networking back-end. This field is only meant for machine-machine communication for compute services like Nova, Ironic or Zun to pass information to a Neutron back-end. It should not be used by multiple services concurrently or by cloud end users. The existing counterexamples (`capabilities: [switchdev]` for Open vSwitch hardware offload and `trusted=true` for Trusted Virtual Functions) are due to be cleaned up. The networking API does not define a specific format of this field. The default is an empty dictionary. If you update it with null then it is treated like {} in the response. Since the port-mac-address-override extension the `device_mac_address` field of the binding:profile can be used to provide the MAC address of the physical device a direct-physical port is being bound to. If provided, then the `mac_address` field of the port resource will be updated to the MAC from the active binding.
port.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status. A valid value is enabled (`true`) or disabled (`false`). If port security is enabled for the port, security group rules and anti-spoofing rules are applied to the traffic on the port. If disabled, no such rules are applied.
port.qos_policy_id	body	[‘string’, ‘null’]	QoS policy associated with the port.
port.dns_name	body	string	A valid DNS name.
port.dns_domain	body	string	A valid DNS domain.
port.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the ports/port_id:put operation",
  "properties": {
    "port": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`).\nDefault is `true`."
        },
        "mac_address": {
          "type": "string",
          "description": "The MAC address of the port.\nBy default, only administrative users and users with advsvc role\ncan change this value."
        },
        "fixed_ips": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ip_address": {
                "type": "string",
                "description": "IP Address"
              },
              "subnet_id": {
                "type": "string",
                "description": "The subnet ID from which the IP address is assigned"
              }
            }
          },
          "description": "The IP addresses for the port.\nIf you would like to assign multiple IP addresses for the port,\nspecify multiple entries in this field.\nEach entry consists of IP address (`ip_address`) and the subnet ID\nfrom which the IP address is assigned (`subnet_id`).\n\n\n* If you specify both a subnet ID and an IP address, OpenStack Networking\ntries to allocate the IP address on that subnet to the port.\n* If you specify only a subnet ID, OpenStack Networking allocates\nan available IP from that subnet to the port.\n* If you specify only an IP address, OpenStack Networking\ntries to allocate the IP address if the address is a valid IP\nfor any of the subnets on the specified network."
        },
        "device_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the device that uses this port.\nFor example, a server instance or a logical router."
        },
        "device_owner": {
          "type": "string",
          "maxLength": 255,
          "description": "The entity type that uses this port.\nFor example, `compute:nova` (server instance), `network:dhcp`\n(DHCP agent) or `network:router_interface` (router interface)."
        },
        "allowed_address_pairs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ip_address": {
                "type": "string"
              },
              "max_address": {
                "type": "string"
              }
            }
          },
          "description": "A set of zero or more allowed address pair objects each where address pair\nobject contains an `ip_address` and `mac_address`. While the\n`ip_address` is required, the `mac_address` will be taken from the\nport if not specified. The value of `ip_address` can be an IP Address\nor a CIDR (if supported by the underlying extension plugin).\nA server connected to the port can send a packet with source address which\nmatches one of the specified allowed address pairs."
        },
        "data_plane_status": {
          "type": "string",
          "enum": [
            null,
            "ACTIVE",
            "DOWN"
          ],
          "description": "Status of the underlying data plane of a port."
        },
        "extra_dhcp_opts": {
          "type": "array",
          "items": {
            "type": "object",
            "extraProperties": true
          },
          "x-openstack": {
            "todo": "implementme"
          },
          "description": "A set of zero or more extra DHCP option pairs. An\noption pair consists of an option value and name."
        },
        "hints": {
          "type": [
            "object",
            "null"
          ],
          "description": "Admin-only. A dict, at the top level keyed by mechanism driver\naliases (as defined in setup.cfg). To following values can be used to\ncontrol Open vSwitch\u2019s Userspace Tx packet steering feature:\n\n\n* `{\"openvswitch\": {\"other_config\": {\"tx-steering\": \"hash\"}}}`\n* `{\"openvswitch\": {\"other_config\": {\"tx-steering\": \"thread\"}}}`\n\n\nIf omitted the default is defined by Open vSwitch.\nThe field cannot be longer than 4095 characters."
        },
        "numa_affinity_policy": {
          "type": "string",
          "enum": [
            "required",
            "preferred",
            "legacy",
            null
          ],
          "description": "The port NUMA affinity policy requested during the virtual machine\nscheduling. Values: `None`, `required`, `preferred` or `legacy`."
        },
        "binding:vnic_type": {
          "type": "string",
          "enum": [
            "normal",
            "direct",
            "macvtap",
            "baremetal",
            "direct-physical",
            "virtio-forwarder",
            "smart-nic",
            "vdpa",
            "accelerator-direct",
            "accelerator-direct-physical",
            "remote-managed"
          ],
          "description": "The type of vNIC which this port should be attached to. This is used to\ndetermine which mechanism driver(s) to be used to bind the port.\nThe valid values are `normal`, `macvtap`, `direct`, `baremetal`,\n`direct-physical`, `virtio-forwarder`, `smart-nic`\nand `remote-managed`.\nWhat type of vNIC is actually available depends on deployments.\nThe default is `normal`."
        },
        "binding:host_id": {
          "type": "string",
          "description": "The ID of the host where the port resides.\nThe default is an empty string."
        },
        "binding:profile": {
          "type": [
            "object",
            "null"
          ],
          "description": "A dictionary that enables the application running on the specific host to\npass and receive vif port information specific to the networking back-end.\nThis field is only meant for machine-machine communication for compute\nservices like Nova, Ironic or Zun to pass information to a Neutron\nback-end. It should not be used by multiple services concurrently or by\ncloud end users. The existing counterexamples\n(`capabilities: [switchdev]` for Open vSwitch hardware offload and\n`trusted=true` for Trusted Virtual Functions) are due to be cleaned up.\nThe networking API does not define a specific format of this field.\nThe default is an empty dictionary.\nIf you update it with null then it is treated like {} in the response.\nSince the port-mac-address-override extension the `device_mac_address`\nfield of the binding:profile can be used to provide the MAC address of the\nphysical device a direct-physical port is being bound to. If provided, then\nthe `mac_address` field of the port resource will be updated to the MAC\nfrom the active binding."
        },
        "port_security_enabled": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The port security status. A valid value is\nenabled (`true`) or disabled (`false`).\nIf port security is enabled for the port,\nsecurity group rules and anti-spoofing rules are applied to\nthe traffic on the port. If disabled, no such rules are applied."
        },
        "qos_policy_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "QoS policy associated with the port."
        },
        "dns_name": {
          "type": "string",
          "format": "hostname",
          "maxLength": 255,
          "description": "A valid DNS name."
        },
        "dns_domain": {
          "type": "string",
          "format": "hostname",
          "maxLength": 255,
          "description": "A valid DNS domain."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "security_groups": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "The IDs of security groups applied to the port."
        }
      },
      "description": "A `port` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
port	body	object	A `port` object.
port.id	body	string	The ID of the resource.
port.name	body	string	Human-readable name of the resource.
port.network_id	body	string	The ID of the attached network.
port.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
port.mac_address	body	string	The MAC address of the port. If the port uses the `direct-physical` `vnic_type` then the value of this field is overwritten with the MAC address provided in the active binding:profile if any.
port.device_id	body	string	The ID of the device that uses this port. For example, a server instance or a logical router.
port.device_owner	body	string	The entity type that uses this port. For example, `compute:nova` (server instance), `network:dhcp` (DHCP agent) or `network:router_interface` (router interface).
port.tenant_id	body	string	The ID of the project.
port.status	body	string	The port status. Values are `ACTIVE`, `DOWN`, `BUILD` and `ERROR`.
port.data_plane_status	body	string	Status of the underlying data plane of a port.
port.ip_allocation	body	string	Indicates when ports use either `deferred`, `immediate` or no IP allocation (`none`).
port.device_profile	body	[‘string’, ‘null’]
port.hints	body	[‘object’, ‘null’]	Admin-only. The following values control Open vSwitch’s Userspace Tx packet steering feature: `{"openvswitch": {"other_config": {"tx-steering": "hash\|thread"}}}`
port.numa_affinity_policy	body	string	The port NUMA affinity policy requested during the virtual machine scheduling. Values: `None`, `required`, `preferred` or `legacy`.
port.resource_request	body	string	Expose Placement resources (i.e.: `minimum-bandwidth`) and traits (i.e.: `vnic-type`, `physnet`) requested by a port to Nova and Placement. A `resource_request` object contains `request_groups` and `same_subtree` keys. `request_groups` is a list of dicts, where each dict represents one group of resources and traits that needs to be fulfilled from a single resource provider. Every dict in the list must contain `id`, `required` and `resources` keys. The `id` field is a string which represents a unique UUID that is generated for each group by combining the `port_id` and UUIDs of the QoS rules contributing to the group via the UUID5 method. `required` key contains the traits (generated from the `vnic_type` and the `physnet`) required by the port, and a `resources` key contains a mapping of requested resource class name and requested amount from the QoS policy. `same_subtree` key contains a list of `id` values from every resource group.
port.binding:vif_type	body	string	The type of which mechanism is used for the port. An API consumer like nova can use this to determine an appropriate way to attach a device (for example an interface of a virtual server) to the port. Available values currently defined includes `ovs`, `bridge`, `macvtap`, `hw_veb`, `hostdev_physical`, `vhostuser`, `distributed` and `other`. There are also special values: `unbound` and `binding_failed`. `unbound` means the port is not bound to a networking back-end. `binding_failed` means an error that the port failed to be bound to a networking back-end.
port.binding:vif_details	body	object	A dictionary which contains additional information on the port. Currently the following fields are defined: `port_filter` and `ovs_hybrid_plug`. `port_filter` is a boolean indicating the networking service provides port filtering features such as security group and/or anti MAC/IP spoofing. `ovs_hybrid_plug` is a boolean used to inform an API consumer like nova that the hybrid plugging strategy for OVS should be used.
port.binding:vnic_type	body	string	The type of vNIC which this port should be attached to. This is used to determine which mechanism driver(s) to be used to bind the port. The valid values are `normal`, `macvtap`, `direct`, `baremetal`, `direct-physical`, `virtio-forwarder`, `smart-nic` and `remote-managed`. What type of vNIC is actually available depends on deployments.
port.binding:host_id	body	string	The ID of the host where the port resides.
port.binding:profile	body	[‘object’, ‘null’]	A dictionary that enables the application running on the specific host to pass and receive vif port information specific to the networking back-end. The networking API does not define a specific format of this field. If the update request is null this response field will be {}.
port.port_security_enabled	body	[‘string’, ‘boolean’]	The port security status. A valid value is enabled (`true`) or disabled (`false`). If port security is enabled for the port, security group rules and anti-spoofing rules are applied to the traffic on the port. If disabled, no such rules are applied.
port.qos_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy associated with the port.
port.qos_network_policy_id	body	[‘string’, ‘null’]	The ID of the QoS policy of the network where this port is plugged.
port.revision_number	body	integer	The revision number of the resource.
port.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
port.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
port.propagate_uplink_status	body	[‘string’, ‘boolean’]	The uplink status propagation of the port. Valid values are enabled (`true`) and disabled (`false`).
port.dns_name	body	string	A valid DNS name.
port.dns_assignment	body	string	Data assigned to a port by the Networking internal DNS including the `hostname`, `ip_address` and `fqdn`.
port.dns_domain	body	string	A valid DNS domain.
port.description	body	string	A human-readable description for the resource.

DELETE

/v2.0/ports/{port_id}

Delete port

Deletes a port.

Any IP addresses that are associated with the port are returned to the respective subnets allocation pools.

Normal response codes: 204

Error response codes: 401, 403, 404, 412

Responses¶

204¶

PUT

/v2.0/ports/{port_id}/add_allowed_address_pairs

Add allowed_address_pairs to port

Atomically adds a set of allowed_address_pairs to the port’s already existing allowed_address_pairs.

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request¶

Description

Name

Location

Type

Description

port_id

path

string

port_id parameter for /v2.0/ports/{port_id}/add_allowed_address_pairs API

Schema

{
  "type": "object",
  "description": "Request of the ports/port_id/add_allowed_address_pairs:put operation"
}

Responses¶

200¶

subnets¶

GET

/v2.0/subnets/{subnet_id}/tags

Responses¶

200¶

PUT

/v2.0/subnets/{subnet_id}/tags

Request of the subnets/subnet_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

subnet_id

path

string

subnet_id parameter for /v2.0/subnets/{subnet_id} API

Schema

{
  "type": "object",
  "description": "Request of the subnets/subnet_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/subnets/{subnet_id}/tags

Responses¶

204¶

GET

/v2.0/subnets/{subnet_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/subnets/{subnet_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/subnets/{subnet_id}/tags/{id}

Responses¶

204¶

GET

/v2.0/subnets

List subnets

Lists subnets that the project has access to.

Default policy settings return only subnets owned by the project of the user submitting the request, unless the user has administrative role. You can control which attributes are returned by using the fields query parameter. You can filter results by using query string parameters.

Normal response codes: 200

Error response codes: 401

Responses¶

200¶

POST

/v2.0/subnets

Create subnet

Creates a subnet on a network.

OpenStack Networking does not try to derive the correct IP version from the CIDR. If you do not specify the gateway_ip attribute, OpenStack Networking allocates an address from the CIDR for the gateway for the subnet.

To specify a subnet without a gateway, set the gateway_ip attribute to null in the request body. If you do not specify the allocation_pools attribute, OpenStack Networking automatically allocates pools for covering all IP addresses in the CIDR, excluding the address reserved for the subnet gateway. Otherwise, you can explicitly specify allocation pools as shown in the following example.

When you specify both the allocation_pools and gateway_ip attributes, you must ensure that the gateway IP does not overlap with the allocation pools; otherwise, the call returns the Conflict (409) response code.

A subnet can have one or more name servers and host routes. Hosts in this subnet use the name servers. Devices with IP addresses from this subnet, not including the local subnet route, use the host routes.

Specify the ipv6_ra_mode and ipv6_address_mode attributes to create subnets that support IPv6 configurations, such as stateless address autoconfiguration (SLAAC), DHCPv6 stateful, and DHCPv6 stateless configurations.

A subnet can optionally be associated with a network segment when it is created by specifying the segment_id of a valid segment on the specified network. A network with subnets associated in this way is called a routed network. On any given network, all of the subnets must be associated with segments or none of them can be. Neutron enforces this invariant. Currently, routed networks are only supported for provider networks.

Normal response codes: 201

Error response codes: 400, 401, 403, 404, 409

Request¶

Description

Name	Location	Type	Description
subnet	body	object	A `subnet` object.
subnet.name	body	string	Human-readable name of the resource. Default is an empty string.
subnet.ip_version	body	integer	The IP protocol version. Value is `4` or `6`.
subnet.network_id	body	string	The ID of the network to which the subnet belongs.
subnet.subnetpool_id	body	[‘string’, ‘null’]	The ID of the subnet pool associated with the subnet.
subnet.prefixlen	body	integer	The prefix length to use for subnet allocation from a subnet pool. If not specified, the `default_prefixlen` value of the subnet pool will be used.
subnet.cidr	body	[‘string’, ‘null’]	The CIDR of the subnet.
subnet.gateway_ip	body	string	Gateway IP of this subnet. If the value is `null` that implies no gateway is associated with the subnet. If the gateway_ip is not specified, OpenStack Networking allocates an address from the CIDR for the gateway for the subnet by default.
subnet.tenant_id	body	string	The ID of the project that owns the resource. Only administrative and users with advsvc role can specify a project ID other than their own. You cannot change this value through authorization policies.
subnet.enable_dhcp	body	[‘string’, ‘boolean’]	Indicates whether dhcp is enabled or disabled for the subnet. Default is `true`.
subnet.ipv6_ra_mode	body	string	The IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless`.
subnet.ipv6_address_mode	body	string	The IPv6 address modes specifies mechanisms for assigning IP addresses. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless`.
subnet.use_default_subnetpool	body	[‘string’, ‘boolean’]	Whether to allocate this subnet from the default subnet pool.
subnet.dns_publish_fixed_ip	body	[‘string’, ‘boolean’]	Whether to publish DNS records for IPs from this subnet. Default is `false`.
subnet.description	body	string	A human-readable description for the resource. Default is an empty string.
subnet.segment_id	body	[‘string’, ‘null’]	The ID of a network segment the subnet is associated with. It is available when `segment` extension is enabled.

Schema

{
  "type": "object",
  "description": "Request of the subnets:post operation",
  "properties": {
    "subnet": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource. Default is an empty string."
        },
        "ip_version": {
          "type": "integer",
          "enum": [
            4,
            6
          ],
          "description": "The IP protocol version. Value is `4` or `6`."
        },
        "network_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the network to which the subnet belongs."
        },
        "subnetpool_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID of the subnet pool associated with the subnet."
        },
        "prefixlen": {
          "type": "integer",
          "minimum": 0,
          "description": "The prefix length to use for subnet allocation from a subnet pool.\nIf not specified, the `default_prefixlen` value of the subnet pool\nwill be used."
        },
        "cidr": {
          "type": [
            "string",
            "null"
          ],
          "description": "The CIDR of the subnet."
        },
        "gateway_ip": {
          "type": "string",
          "description": "Gateway IP of this subnet. If the value is `null` that implies no\ngateway is associated with the subnet. If the gateway_ip is not\nspecified, OpenStack Networking allocates an address from the CIDR\nfor the gateway for the subnet by default."
        },
        "allocation_pools": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "start": {
                "type": "string"
              },
              "end": {
                "type": "string"
              }
            }
          },
          "description": "Allocation pools with `start` and `end` IP addresses\nfor this subnet. If allocation_pools are not specified, OpenStack\nNetworking automatically allocates pools for covering all IP addresses\nin the CIDR, excluding the address reserved for the subnet gateway by\ndefault."
        },
        "dns_nameservers": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of dns name servers associated with the subnet. Default is an\nempty list."
        },
        "host_routes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "destination": {
                "type": "string"
              },
              "nexthop": {
                "type": "string"
              }
            }
          },
          "description": "Additional routes for the subnet. A list of dictionaries with\n`destination` and `nexthop` parameters. Default value is\nan empty list."
        },
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project that owns the resource.\nOnly administrative and users with advsvc role can specify\na project ID other than their own.\nYou cannot change this value through authorization policies."
        },
        "enable_dhcp": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether dhcp is enabled or disabled\nfor the subnet. Default is `true`."
        },
        "ipv6_ra_mode": {
          "type": "string",
          "enum": [
            "dhcpv6-stateful",
            "dhcpv6-stateless",
            "slaac"
          ],
          "description": "The IPv6 router advertisement specifies whether the networking service\nshould transmit ICMPv6 packets, for a subnet. Value is `slaac`,\n`dhcpv6-stateful`, `dhcpv6-stateless`."
        },
        "ipv6_address_mode": {
          "type": "string",
          "enum": [
            "dhcpv6-stateful",
            "dhcpv6-stateless",
            "slaac"
          ],
          "description": "The IPv6 address modes specifies mechanisms for assigning IP addresses.\nValue is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless`."
        },
        "service_types": {
          "type": "array",
          "description": "The service types associated with the subnet.",
          "items": {
            "type": "string"
          }
        },
        "use_default_subnetpool": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Whether to allocate this subnet from the default subnet pool."
        },
        "dns_publish_fixed_ip": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Whether to publish DNS records for IPs from this subnet. Default\nis `false`."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "segment_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of a network segment the subnet is associated with.\nIt is available when `segment` extension is enabled."
        }
      },
      "required": [
        "network_id",
        "ip_version"
      ],
      "description": "A `subnet` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
subnet	body	object	A `subnet` object.
subnet.id	body	string	The ID of the subnet.
subnet.name	body	string	Human-readable name of the resource.
subnet.ip_version	body	integer	The IP protocol version. Value is `4` or `6`.
subnet.network_id	body	string	The ID of the network to which the subnet belongs.
subnet.subnetpool_id	body	[‘string’, ‘null’]	The ID of the subnet pool associated with the subnet.
subnet.cidr	body	[‘string’, ‘null’]	The CIDR of the subnet.
subnet.gateway_ip	body	string	Gateway IP of this subnet. If the value is `null` that implies no gateway is associated with the subnet.
subnet.tenant_id	body	string	The ID of the project.
subnet.enable_dhcp	body	[‘string’, ‘boolean’]	Indicates whether dhcp is enabled or disabled for the subnet.
subnet.ipv6_ra_mode	body	string	The IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless` or `null`.
subnet.ipv6_address_mode	body	string	The IPv6 address modes specifies mechanisms for assigning IP addresses. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless` or `null`.
subnet.revision_number	body	integer	The revision number of the resource.
subnet.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
subnet.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
subnet.dns_publish_fixed_ip	body	[‘string’, ‘boolean’]	Whether to publish DNS records for IPs from this subnet.
subnet.description	body	string	A human-readable description for the resource.
subnet.segment_id	body	[‘string’, ‘null’]	The ID of a network segment the subnet is associated with. It is available when `segment` extension is enabled.

GET

/v2.0/subnets/{subnet_id}

Show subnet details

Shows details for a subnet.

Use the fields query parameter to filter the results.

Normal response codes: 200

Error response codes: 401, 404

Responses¶

200¶

Name	Location	Type	Description
subnet	body	object	A `subnet` object.
subnet.id	body	string	The ID of the subnet.
subnet.name	body	string	Human-readable name of the resource.
subnet.ip_version	body	integer	The IP protocol version. Value is `4` or `6`.
subnet.network_id	body	string	The ID of the network to which the subnet belongs.
subnet.subnetpool_id	body	[‘string’, ‘null’]	The ID of the subnet pool associated with the subnet.
subnet.cidr	body	[‘string’, ‘null’]	The CIDR of the subnet.
subnet.gateway_ip	body	string	Gateway IP of this subnet. If the value is `null` that implies no gateway is associated with the subnet.
subnet.tenant_id	body	string	The ID of the project.
subnet.enable_dhcp	body	[‘string’, ‘boolean’]	Indicates whether dhcp is enabled or disabled for the subnet.
subnet.ipv6_ra_mode	body	string	The IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless` or `null`.
subnet.ipv6_address_mode	body	string	The IPv6 address modes specifies mechanisms for assigning IP addresses. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless` or `null`.
subnet.revision_number	body	integer	The revision number of the resource.
subnet.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
subnet.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
subnet.dns_publish_fixed_ip	body	[‘string’, ‘boolean’]	Whether to publish DNS records for IPs from this subnet.
subnet.description	body	string	A human-readable description for the resource.
subnet.segment_id	body	[‘string’, ‘null’]	The ID of a network segment the subnet is associated with. It is available when `segment` extension is enabled.

PUT

/v2.0/subnets/{subnet_id}

Update subnet

Updates a subnet.

Some attributes, such as IP version (ip_version), CIDR (cidr), and segment (segment_id) cannot be updated. Attempting to update these attributes results in a 400 Bad Request error.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 412

Request¶

Description

Name	Location	Type	Description
subnet_id	path	string	subnet_id parameter for /v2.0/subnets/{subnet_id} API
subnet	body	object
subnet.name	body	string	Human-readable name of the resource.
subnet.gateway_ip	body	string	Gateway IP of this subnet. If the value is `null` that implies no gateway is associated with the subnet. If the gateway_ip is not specified, OpenStack Networking allocates an address from the CIDR for the gateway for the subnet by default.
subnet.enable_dhcp	body	[‘string’, ‘boolean’]	Indicates whether dhcp is enabled or disabled for the subnet. Default is `true`.
subnet.dns_publish_fixed_ip	body	[‘string’, ‘boolean’]	Whether to publish DNS records for IPs from this subnet. Default is `false`.
subnet.description	body	string	A human-readable description for the resource. Default is an empty string.
subnet.segment_id	body	[‘string’, ‘null’]	The ID of a network segment the subnet is associated with. It is available when `segment` extension is enabled.

Schema

{
  "type": "object",
  "description": "Request of the subnets/subnet_id:put operation",
  "properties": {
    "subnet": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource."
        },
        "gateway_ip": {
          "type": "string",
          "description": "Gateway IP of this subnet. If the value is `null` that implies no\ngateway is associated with the subnet. If the gateway_ip is not\nspecified, OpenStack Networking allocates an address from the CIDR\nfor the gateway for the subnet by default."
        },
        "allocation_pools": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "start": {
                "type": "string"
              },
              "end": {
                "type": "string"
              }
            }
          },
          "description": "Allocation pools with `start` and `end` IP addresses\nfor this subnet. If allocation_pools are not specified, OpenStack\nNetworking automatically allocates pools for covering all IP addresses\nin the CIDR, excluding the address reserved for the subnet gateway by\ndefault."
        },
        "dns_nameservers": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of dns name servers associated with the subnet. Default is an\nempty list."
        },
        "host_routes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "destination": {
                "type": "string"
              },
              "nexthop": {
                "type": "string"
              }
            }
          },
          "description": "Additional routes for the subnet. A list of dictionaries with\n`destination` and `nexthop` parameters. Default value is\nan empty list."
        },
        "enable_dhcp": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Indicates whether dhcp is enabled or disabled\nfor the subnet. Default is `true`."
        },
        "service_types": {
          "type": "array",
          "description": "The service types associated with the subnet.",
          "items": {
            "type": "string"
          }
        },
        "dns_publish_fixed_ip": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "Whether to publish DNS records for IPs from this subnet. Default\nis `false`."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "segment_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of a network segment the subnet is associated with.\nIt is available when `segment` extension is enabled."
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
subnet	body	object	A `subnet` object.
subnet.id	body	string	The ID of the subnet.
subnet.name	body	string	Human-readable name of the resource.
subnet.ip_version	body	integer	The IP protocol version. Value is `4` or `6`.
subnet.network_id	body	string	The ID of the network to which the subnet belongs.
subnet.subnetpool_id	body	[‘string’, ‘null’]	The ID of the subnet pool associated with the subnet.
subnet.cidr	body	[‘string’, ‘null’]	The CIDR of the subnet.
subnet.gateway_ip	body	string	Gateway IP of this subnet. If the value is `null` that implies no gateway is associated with the subnet.
subnet.tenant_id	body	string	The ID of the project.
subnet.enable_dhcp	body	[‘string’, ‘boolean’]	Indicates whether dhcp is enabled or disabled for the subnet.
subnet.ipv6_ra_mode	body	string	The IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless` or `null`.
subnet.ipv6_address_mode	body	string	The IPv6 address modes specifies mechanisms for assigning IP addresses. Value is `slaac`, `dhcpv6-stateful`, `dhcpv6-stateless` or `null`.
subnet.revision_number	body	integer	The revision number of the resource.
subnet.created_at	body	string	Time at which the resource has been created (in UTC ISO8601 format).
subnet.updated_at	body	string	Time at which the resource has been updated (in UTC ISO8601 format).
subnet.dns_publish_fixed_ip	body	[‘string’, ‘boolean’]	Whether to publish DNS records for IPs from this subnet.
subnet.description	body	string	A human-readable description for the resource.
subnet.segment_id	body	[‘string’, ‘null’]	The ID of a network segment the subnet is associated with. It is available when `segment` extension is enabled.

DELETE

/v2.0/subnets/{subnet_id}

Delete subnet

Deletes a subnet.

The operation fails if subnet IP addresses are still allocated.

Normal response codes: 204

Error response codes: 401, 404, 412

Responses¶

204¶

trunks¶

GET

/v2.0/trunks/{trunk_id}/tags

Responses¶

200¶

PUT

/v2.0/trunks/{trunk_id}/tags

Request of the trunks/trunk_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

trunk_id

path

string

trunk_id parameter for /v2.0/trunks/{trunk_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the trunks/trunk_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/trunks/{trunk_id}/tags

Responses¶

204¶

GET

/v2.0/trunks/{trunk_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/trunks/{trunk_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/trunks/{trunk_id}/tags/{id}

Responses¶

204¶

network_segment_ranges¶

GET

/v2.0/network_segment_ranges/{network_segment_range_id}/tags

Responses¶

200¶

PUT

/v2.0/network_segment_ranges/{network_segment_range_id}/tags

Request of the network_segment_ranges/network_segment_range_id/tags:put operation

Request¶

Description

Name

Location

Type

Description

network_segment_range_id

path

string

network_segment_range_id parameter for /v2.0/network_segment_ranges/{network_segment_range_id}/tags/{id} API

Schema

{
  "type": "object",
  "description": "Request of the network_segment_ranges/network_segment_range_id/tags:put operation",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      }
    }
  }
}

Responses¶

200¶

DELETE

/v2.0/network_segment_ranges/{network_segment_range_id}/tags

Responses¶

204¶

GET

/v2.0/network_segment_ranges/{network_segment_range_id}/tags/{id}

Responses¶

204¶

PUT

/v2.0/network_segment_ranges/{network_segment_range_id}/tags/{id}

Responses¶

201¶

DELETE

/v2.0/network_segment_ranges/{network_segment_range_id}/tags/{id}

Responses¶

204¶

vpn¶

GET

/v2.0/vpn/endpoint-groups

List VPN endpoint groups

Lists VPN endpoint groups.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

POST

/v2.0/vpn/endpoint-groups

Create VPN endpoint group

Creates a VPN endpoint group.

The endpoint group contains one or more endpoints of a specific type that you can use to create a VPN connections.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
endpoint_group	body	object
endpoint_group.tenant_id	body	string	The ID of the project.
endpoint_group.name	body	string	Human-readable name of the resource. Default is an empty string.
endpoint_group.description	body	string	A human-readable description for the resource. Default is an empty string.
endpoint_group.type	body	string	The type of the endpoints in the group. A valid value is `subnet`, `cidr`, `network`, `router`, or `vlan`. Only `subnet` and `cidr` are supported at this moment.

Schema

{
  "type": "object",
  "description": "Request of the vpn/endpoint-groups:post operation",
  "properties": {
    "endpoint_group": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "type": {
          "type": "string",
          "enum": [
            "cidr",
            "network",
            "router",
            "subnet",
            "vlan"
          ],
          "description": "The type of the endpoints in the group. A valid\nvalue is `subnet`, `cidr`, `network`, `router`, or\n`vlan`. Only `subnet` and `cidr` are supported\nat this moment."
        },
        "endpoints": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of endpoints of the same type, for the\nendpoint group. The values will depend on type."
        }
      }
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
endpoint_group	body	object
endpoint_group.id	body	string	The ID of the VPN endpoint group.
endpoint_group.tenant_id	body	string	The ID of the project.
endpoint_group.name	body	string	Human-readable name of the resource. Default is an empty string.
endpoint_group.description	body	string	A human-readable description for the resource. Default is an empty string.
endpoint_group.type	body	string	The type of the endpoints in the group. A valid value is `subnet`, `cidr`, `network`, `router`, or `vlan`. Only `subnet` and `cidr` are supported at this moment.

GET

/v2.0/vpn/endpoint-groups/{id}

Show VPN endpoint group

Shows details for a VPN endpoint group.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
endpoint_group	body	object
endpoint_group.id	body	string	The ID of the VPN endpoint group.
endpoint_group.tenant_id	body	string	The ID of the project.
endpoint_group.name	body	string	Human-readable name of the resource. Default is an empty string.
endpoint_group.description	body	string	A human-readable description for the resource. Default is an empty string.
endpoint_group.type	body	string	The type of the endpoints in the group. A valid value is `subnet`, `cidr`, `network`, `router`, or `vlan`. Only `subnet` and `cidr` are supported at this moment.

PUT

/v2.0/vpn/endpoint-groups/{id}

Update VPN endpoint group

Updates settings for a VPN endpoint group.

Normal response codes: 200

Error response codes: 400, 401, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/vpn/endpoint-groups/{id} API
endpoint_group	body	object
endpoint_group.name	body	string	Human-readable name of the resource. Default is an empty string.
endpoint_group.description	body	string	A human-readable description for the resource. Default is an empty string.

Schema

{
  "type": "object",
  "description": "Request of the vpn/endpoint-groups/id:put operation",
  "properties": {
    "endpoint_group": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        }
      }
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
endpoint_group	body	object
endpoint_group.id	body	string	The ID of the VPN endpoint group.
endpoint_group.tenant_id	body	string	The ID of the project.
endpoint_group.name	body	string	Human-readable name of the resource. Default is an empty string.
endpoint_group.description	body	string	A human-readable description for the resource. Default is an empty string.
endpoint_group.type	body	string	The type of the endpoints in the group. A valid value is `subnet`, `cidr`, `network`, `router`, or `vlan`. Only `subnet` and `cidr` are supported at this moment.

DELETE

/v2.0/vpn/endpoint-groups/{id}

Remove VPN endpoint group

Removes a VPN endpoint group.

Normal response codes: 204

Error response codes: 401, 404, 409

Responses¶

204¶

GET

/v2.0/vpn/vpnservices

List VPN services

Lists all VPN services.

The list might be empty.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

POST

/v2.0/vpn/vpnservices

Create VPN service

Creates a VPN service.

The service is associated with a router. After you create the service, it can contain multiple VPN connections.

An optional flavor_id attribute can be passed to enable dynamic selection of an appropriate provider if configured by the operator. It is only available when vpn-flavors extension is enabled. The basic selection algorithm chooses the provider in the first service profile currently associated with flavor. This option can only be set in POST operation.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
vpnservice	body	object	A `vpnservice` object.
vpnservice.tenant_id	body	string	The ID of the project.
vpnservice.name	body	string	Human-readable name of the resource. Default is an empty string.
vpnservice.description	body	string	A human-readable description for the resource. Default is an empty string.
vpnservice.subnet_id	body	[‘string’, ‘null’]	If you specify only a subnet UUID, OpenStack Networking allocates an available IP from that subnet to the port. If you specify both a subnet UUID and an IP address, OpenStack Networking tries to allocate the address to the port.
vpnservice.router_id	body	string
vpnservice.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
vpnservice.flavor_id	body	[‘string’, ‘null’]	The ID of the flavor.

Schema

{
  "type": "object",
  "description": "Request of the vpn/vpnservices:post operation",
  "properties": {
    "vpnservice": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "subnet_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "If you specify only a subnet UUID, OpenStack\nNetworking allocates an available IP from that subnet to the port.\nIf you specify both a subnet UUID and an IP address, OpenStack\nNetworking tries to allocate the address to the port."
        },
        "router_id": {
          "type": "string",
          "format": "uuid"
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`)."
        },
        "flavor_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID of the flavor."
        }
      },
      "description": "A `vpnservice` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
vpnservice	body	object	A `vpnservice` object.
vpnservice.id	body	string	The ID of the VPN service.
vpnservice.tenant_id	body	string	The ID of the project.
vpnservice.name	body	string	Human-readable name of the resource. Default is an empty string.
vpnservice.description	body	string	A human-readable description for the resource. Default is an empty string.
vpnservice.subnet_id	body	[‘string’, ‘null’]	If you specify only a subnet UUID, OpenStack Networking allocates an available IP from that subnet to the port. If you specify both a subnet UUID and an IP address, OpenStack Networking tries to allocate the address to the port.
vpnservice.router_id	body	string
vpnservice.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
vpnservice.external_v4_ip	body	string	Read-only external (public) IPv4 address that is used for the VPN service. The VPN plugin sets this address if an IPv4 interface is available.
vpnservice.external_v6_ip	body	string	Read-only external (public) IPv6 address that is used for the VPN service. The VPN plugin sets this address if an IPv6 interface is available.
vpnservice.status	body	string	Indicates whether IPsec VPN service is currently operational. Values are `ACTIVE`, `DOWN`, `BUILD`, `ERROR`, `PENDING_CREATE`, `PENDING_UPDATE`, or `PENDING_DELETE`.
vpnservice.flavor_id	body	[‘string’, ‘null’]	The ID of the flavor.

GET

/v2.0/vpn/vpnservices/{id}

Show VPN service details

Shows details for a VPN service.

If the user is not an administrative user and the VPN service object does not belong to the tenant account for the user, the operation returns the Forbidden (403) response code.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
vpnservice	body	object	A `vpnservice` object.
vpnservice.id	body	string	The ID of the VPN service.
vpnservice.tenant_id	body	string	The ID of the project.
vpnservice.name	body	string	Human-readable name of the resource. Default is an empty string.
vpnservice.description	body	string	A human-readable description for the resource. Default is an empty string.
vpnservice.subnet_id	body	[‘string’, ‘null’]	If you specify only a subnet UUID, OpenStack Networking allocates an available IP from that subnet to the port. If you specify both a subnet UUID and an IP address, OpenStack Networking tries to allocate the address to the port.
vpnservice.router_id	body	string
vpnservice.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
vpnservice.external_v4_ip	body	string	Read-only external (public) IPv4 address that is used for the VPN service. The VPN plugin sets this address if an IPv4 interface is available.
vpnservice.external_v6_ip	body	string	Read-only external (public) IPv6 address that is used for the VPN service. The VPN plugin sets this address if an IPv6 interface is available.
vpnservice.status	body	string	Indicates whether IPsec VPN service is currently operational. Values are `ACTIVE`, `DOWN`, `BUILD`, `ERROR`, `PENDING_CREATE`, `PENDING_UPDATE`, or `PENDING_DELETE`.
vpnservice.flavor_id	body	[‘string’, ‘null’]	The ID of the flavor.

PUT

/v2.0/vpn/vpnservices/{id}

Update VPN service

Updates a VPN service.

Updates the attributes of a VPN service. You cannot update a service with a PENDING_\* status.

Normal response codes: 200

Error response codes: 400, 401, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/vpn/vpnservices/{id} API
vpnservice	body	object	A `vpnservice` object.
vpnservice.name	body	string	Human-readable name of the resource. Default is an empty string.
vpnservice.description	body	string	A human-readable description for the resource. Default is an empty string.
vpnservice.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).

Schema

{
  "type": "object",
  "description": "Request of the vpn/vpnservices/id:put operation",
  "properties": {
    "vpnservice": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`)."
        }
      },
      "description": "A `vpnservice` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
vpnservice	body	object	A `vpnservice` object.
vpnservice.id	body	string	The ID of the VPN service.
vpnservice.tenant_id	body	string	The ID of the project.
vpnservice.name	body	string	Human-readable name of the resource. Default is an empty string.
vpnservice.description	body	string	A human-readable description for the resource. Default is an empty string.
vpnservice.subnet_id	body	[‘string’, ‘null’]	If you specify only a subnet UUID, OpenStack Networking allocates an available IP from that subnet to the port. If you specify both a subnet UUID and an IP address, OpenStack Networking tries to allocate the address to the port.
vpnservice.router_id	body	string
vpnservice.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
vpnservice.external_v4_ip	body	string	Read-only external (public) IPv4 address that is used for the VPN service. The VPN plugin sets this address if an IPv4 interface is available.
vpnservice.external_v6_ip	body	string	Read-only external (public) IPv6 address that is used for the VPN service. The VPN plugin sets this address if an IPv6 interface is available.
vpnservice.status	body	string	Indicates whether IPsec VPN service is currently operational. Values are `ACTIVE`, `DOWN`, `BUILD`, `ERROR`, `PENDING_CREATE`, `PENDING_UPDATE`, or `PENDING_DELETE`.
vpnservice.flavor_id	body	[‘string’, ‘null’]	The ID of the flavor.

DELETE

/v2.0/vpn/vpnservices/{id}

Remove VPN service

Removes a VPN service.

If the service has connections, the request is rejected.

Normal response codes: 204

Error response codes: 401, 404, 409

Responses¶

204¶

GET

/v2.0/vpn/ipsec-site-connections

List IPsec connections

Lists all IPsec connections.

Use the fields query parameter to control which fields are returned in the response body. For information, see Filtering and Column Selection.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

POST

/v2.0/vpn/ipsec-site-connections

Create IPsec connection

Creates a site-to-site IPsec connection for a service.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
ipsec_site_connection	body	object	An `ipsec_site_connection` object.
ipsec_site_connection.tenant_id	body	string	The ID of the project.
ipsec_site_connection.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsec_site_connection.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsec_site_connection.local_id	body	string	An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
ipsec_site_connection.peer_address	body	string	The peer gateway public IPv4 or IPv6 address or FQDN.
ipsec_site_connection.peer_id	body	string	The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the `peer_address` value.
ipsec_site_connection.local_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private subnets for the local side of the connection. Yo must specify this parameter with the `peer_ep_group_id` parameter unless in backward- compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.peer_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the `local_ep_group_id` parameter unless in backward-compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
ipsec_site_connection.initiator	body	string	Indicates whether this VPN can only respond to connections or both respond to and initiate connections. A valid value is `response- only` or `bi-directional`. Default is `bi-directional`.
ipsec_site_connection.psk	body	string	The pre-shared key. A valid value is any string.
ipsec_site_connection.dpd	body	string	A dictionary with dead peer detection (DPD) protocol controls.
ipsec_site_connection.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
ipsec_site_connection.vpnservice_id	body	string	The ID of the VPN service.
ipsec_site_connection.ikepolicy_id	body	string	The ID of the IKE policy.
ipsec_site_connection.ipsecpolicy_id	body	string	The ID of the IPsec policy.

Schema

{
  "type": "object",
  "description": "Request of the vpn/ipsec-site-connections:post operation",
  "properties": {
    "ipsec_site_connection": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "local_id": {
          "type": "string",
          "description": "An ID to be used instead of the external IP address for a virtual\nrouter used in traffic between instances on different networks in\neast-west traffic. Most often, local ID would be domain name, email\naddress, etc. If this is not configured then the external IP address\nwill be used as the ID."
        },
        "peer_address": {
          "type": "string",
          "description": "The peer gateway public IPv4 or IPv6 address or\nFQDN."
        },
        "peer_id": {
          "type": "string",
          "description": "The peer router identity for authentication. A\nvalid value is an IPv4 address, IPv6 address, e-mail address, key\nID, or FQDN. Typically, this value matches the `peer_address`\nvalue."
        },
        "peer_cidrs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "(Deprecated) Unique list of valid peer private\nCIDRs in the form < net_address > / < prefix > ."
        },
        "local_ep_group_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID for the endpoint group that contains\nprivate subnets for the local side of the connection. Yo must\nspecify this parameter with the `peer_ep_group_id` parameter\nunless in backward- compatible mode where `peer_cidrs` is\nprovided with a `subnet_id` for the VPN service."
        },
        "peer_ep_group_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID for the endpoint group that contains\nprivate CIDRs in the form < net_address > / < prefix > for the\npeer side of the connection. You must specify this parameter with\nthe `local_ep_group_id` parameter unless in backward-compatible\nmode where `peer_cidrs` is provided with a `subnet_id` for the\nVPN service."
        },
        "mtu": {
          "type": "integer",
          "minimum": 0,
          "description": "The maximum transmission unit (MTU) value to\naddress fragmentation. Minimum value is 68 for IPv4, and 1280 for\nIPv6."
        },
        "initiator": {
          "type": "string",
          "enum": [
            "bi-directional",
            "response-only"
          ],
          "description": "Indicates whether this VPN can only respond to\nconnections or both respond to and initiate connections. A valid\nvalue is `response- only` or `bi-directional`. Default is\n`bi-directional`."
        },
        "psk": {
          "type": "string",
          "description": "The pre-shared key. A valid value is any string."
        },
        "dpd": {
          "type": "string",
          "description": "A dictionary with dead peer detection (DPD)\nprotocol controls."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`)."
        },
        "vpnservice_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the VPN service."
        },
        "ikepolicy_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the IKE policy."
        },
        "ipsecpolicy_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the IPsec policy."
        }
      },
      "description": "An `ipsec_site_connection` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
ipsec_site_connection	body	object	An `ipsec_site_connection` object.
ipsec_site_connection.id	body	string	The ID of the IPsec site-to-site connection.
ipsec_site_connection.tenant_id	body	string	The ID of the project.
ipsec_site_connection.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsec_site_connection.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsec_site_connection.local_id	body	string	An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
ipsec_site_connection.peer_address	body	string	The peer gateway public IPv4 or IPv6 address or FQDN.
ipsec_site_connection.peer_id	body	string	The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the `peer_address` value.
ipsec_site_connection.local_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private subnets for the local side of the connection. Yo must specify this parameter with the `peer_ep_group_id` parameter unless in backward- compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.peer_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the `local_ep_group_id` parameter unless in backward-compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.route_mode	body	string	The route mode. A valid value is `static`, which is the default.
ipsec_site_connection.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
ipsec_site_connection.initiator	body	string	Indicates whether this VPN can only respond to connections or both respond to and initiate connections. A valid value is `response- only` or `bi-directional`. Default is `bi-directional`.
ipsec_site_connection.auth_mode	body	string	The authentication mode. A valid value is `psk`, which is the default.
ipsec_site_connection.psk	body	string	The pre-shared key. A valid value is any string.
ipsec_site_connection.dpd	body	string	A dictionary with dead peer detection (DPD) protocol controls.
ipsec_site_connection.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
ipsec_site_connection.status	body	string	Indicates whether the IPsec connection is currently operational. Values are `ACTIVE`, `DOWN`, `BUILD`, `ERROR`, `PENDING_CREATE`, `PENDING_UPDATE`, or `PENDING_DELETE`.
ipsec_site_connection.vpnservice_id	body	string	The ID of the VPN service.
ipsec_site_connection.ikepolicy_id	body	string	The ID of the IKE policy.
ipsec_site_connection.ipsecpolicy_id	body	string	The ID of the IPsec policy.

GET

/v2.0/vpn/ipsec-site-connections/{id}

Show IPsec connection

Shows details for an IPsec connection.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
ipsec_site_connection	body	object	An `ipsec_site_connection` object.
ipsec_site_connection.id	body	string	The ID of the IPsec site-to-site connection.
ipsec_site_connection.tenant_id	body	string	The ID of the project.
ipsec_site_connection.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsec_site_connection.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsec_site_connection.local_id	body	string	An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
ipsec_site_connection.peer_address	body	string	The peer gateway public IPv4 or IPv6 address or FQDN.
ipsec_site_connection.peer_id	body	string	The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the `peer_address` value.
ipsec_site_connection.local_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private subnets for the local side of the connection. Yo must specify this parameter with the `peer_ep_group_id` parameter unless in backward- compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.peer_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the `local_ep_group_id` parameter unless in backward-compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.route_mode	body	string	The route mode. A valid value is `static`, which is the default.
ipsec_site_connection.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
ipsec_site_connection.initiator	body	string	Indicates whether this VPN can only respond to connections or both respond to and initiate connections. A valid value is `response- only` or `bi-directional`. Default is `bi-directional`.
ipsec_site_connection.auth_mode	body	string	The authentication mode. A valid value is `psk`, which is the default.
ipsec_site_connection.psk	body	string	The pre-shared key. A valid value is any string.
ipsec_site_connection.dpd	body	string	A dictionary with dead peer detection (DPD) protocol controls.
ipsec_site_connection.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
ipsec_site_connection.status	body	string	Indicates whether the IPsec connection is currently operational. Values are `ACTIVE`, `DOWN`, `BUILD`, `ERROR`, `PENDING_CREATE`, `PENDING_UPDATE`, or `PENDING_DELETE`.
ipsec_site_connection.vpnservice_id	body	string	The ID of the VPN service.
ipsec_site_connection.ikepolicy_id	body	string	The ID of the IKE policy.
ipsec_site_connection.ipsecpolicy_id	body	string	The ID of the IPsec policy.

PUT

/v2.0/vpn/ipsec-site-connections/{id}

Update IPsec connection

Updates connection settings for an IPsec connection.

Normal response codes: 200

Error response codes: 400, 401, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/vpn/ipsec-site-connections/{id} API
ipsec_site_connection	body	object	An `ipsec_site_connection` object.
ipsec_site_connection.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsec_site_connection.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsec_site_connection.local_id	body	string	An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
ipsec_site_connection.peer_address	body	string	The peer gateway public IPv4 or IPv6 address or FQDN.
ipsec_site_connection.peer_id	body	string	The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the `peer_address` value.
ipsec_site_connection.local_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private subnets for the local side of the connection. Yo must specify this parameter with the `peer_ep_group_id` parameter unless in backward- compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.peer_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the `local_ep_group_id` parameter unless in backward-compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
ipsec_site_connection.initiator	body	string	Indicates whether this VPN can only respond to connections or both respond to and initiate connections. A valid value is `response- only` or `bi-directional`. Default is `bi-directional`.
ipsec_site_connection.psk	body	string	The pre-shared key. A valid value is any string.
ipsec_site_connection.dpd	body	string	A dictionary with dead peer detection (DPD) protocol controls.
ipsec_site_connection.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).

Schema

{
  "type": "object",
  "description": "Request of the vpn/ipsec-site-connections/id:put operation",
  "properties": {
    "ipsec_site_connection": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "local_id": {
          "type": "string",
          "description": "An ID to be used instead of the external IP address for a virtual\nrouter used in traffic between instances on different networks in\neast-west traffic. Most often, local ID would be domain name, email\naddress, etc. If this is not configured then the external IP address\nwill be used as the ID."
        },
        "peer_address": {
          "type": "string",
          "description": "The peer gateway public IPv4 or IPv6 address or\nFQDN."
        },
        "peer_id": {
          "type": "string",
          "description": "The peer router identity for authentication. A\nvalid value is an IPv4 address, IPv6 address, e-mail address, key\nID, or FQDN. Typically, this value matches the `peer_address`\nvalue."
        },
        "peer_cidrs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "(Deprecated) Unique list of valid peer private\nCIDRs in the form < net_address > / < prefix > ."
        },
        "local_ep_group_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID for the endpoint group that contains\nprivate subnets for the local side of the connection. Yo must\nspecify this parameter with the `peer_ep_group_id` parameter\nunless in backward- compatible mode where `peer_cidrs` is\nprovided with a `subnet_id` for the VPN service."
        },
        "peer_ep_group_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "The ID for the endpoint group that contains\nprivate CIDRs in the form < net_address > / < prefix > for the\npeer side of the connection. You must specify this parameter with\nthe `local_ep_group_id` parameter unless in backward-compatible\nmode where `peer_cidrs` is provided with a `subnet_id` for the\nVPN service."
        },
        "mtu": {
          "type": "integer",
          "minimum": 0,
          "description": "The maximum transmission unit (MTU) value to\naddress fragmentation. Minimum value is 68 for IPv4, and 1280 for\nIPv6."
        },
        "initiator": {
          "type": "string",
          "enum": [
            "bi-directional",
            "response-only"
          ],
          "description": "Indicates whether this VPN can only respond to\nconnections or both respond to and initiate connections. A valid\nvalue is `response- only` or `bi-directional`. Default is\n`bi-directional`."
        },
        "psk": {
          "type": "string",
          "description": "The pre-shared key. A valid value is any string."
        },
        "dpd": {
          "type": "string",
          "description": "A dictionary with dead peer detection (DPD)\nprotocol controls."
        },
        "admin_state_up": {
          "type": [
            "string",
            "boolean"
          ],
          "description": "The administrative state of the resource, which is\nup (`true`) or down (`false`)."
        }
      },
      "description": "An `ipsec_site_connection` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
ipsec_site_connection	body	object	An `ipsec_site_connection` object.
ipsec_site_connection.id	body	string	The ID of the IPsec site-to-site connection.
ipsec_site_connection.tenant_id	body	string	The ID of the project.
ipsec_site_connection.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsec_site_connection.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsec_site_connection.local_id	body	string	An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
ipsec_site_connection.peer_address	body	string	The peer gateway public IPv4 or IPv6 address or FQDN.
ipsec_site_connection.peer_id	body	string	The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the `peer_address` value.
ipsec_site_connection.local_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private subnets for the local side of the connection. Yo must specify this parameter with the `peer_ep_group_id` parameter unless in backward- compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.peer_ep_group_id	body	[‘string’, ‘null’]	The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the `local_ep_group_id` parameter unless in backward-compatible mode where `peer_cidrs` is provided with a `subnet_id` for the VPN service.
ipsec_site_connection.route_mode	body	string	The route mode. A valid value is `static`, which is the default.
ipsec_site_connection.mtu	body	integer	The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
ipsec_site_connection.initiator	body	string	Indicates whether this VPN can only respond to connections or both respond to and initiate connections. A valid value is `response- only` or `bi-directional`. Default is `bi-directional`.
ipsec_site_connection.auth_mode	body	string	The authentication mode. A valid value is `psk`, which is the default.
ipsec_site_connection.psk	body	string	The pre-shared key. A valid value is any string.
ipsec_site_connection.dpd	body	string	A dictionary with dead peer detection (DPD) protocol controls.
ipsec_site_connection.admin_state_up	body	[‘string’, ‘boolean’]	The administrative state of the resource, which is up (`true`) or down (`false`).
ipsec_site_connection.status	body	string	Indicates whether the IPsec connection is currently operational. Values are `ACTIVE`, `DOWN`, `BUILD`, `ERROR`, `PENDING_CREATE`, `PENDING_UPDATE`, or `PENDING_DELETE`.
ipsec_site_connection.vpnservice_id	body	string	The ID of the VPN service.
ipsec_site_connection.ikepolicy_id	body	string	The ID of the IKE policy.
ipsec_site_connection.ipsecpolicy_id	body	string	The ID of the IPsec policy.

DELETE

/v2.0/vpn/ipsec-site-connections/{id}

Remove IPsec connection

Removes an IPsec connection.

Normal response codes: 204

Error response codes: 401, 404, 409

Responses¶

204¶

GET

/v2.0/vpn/ipsecpolicies

List IPsec policies

Lists all IPsec policies.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

POST

/v2.0/vpn/ipsecpolicies

Create IPsec policy

Creates an IP security (IPsec) policy.

The IPsec policy specifies the authentication and encryption algorithms and encapsulation mode to use for the established VPN connection.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
ipsecpolicy	body	object	An `ipsecpolicy` object.
ipsecpolicy.tenant_id	body	string	The ID of the project.
ipsecpolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsecpolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsecpolicy.transform_protocol	body	string	The transform protocol. A valid value is `ESP`, `AH`, or `AH- ESP`. Default is `ESP`.
ipsecpolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ipsecpolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ipsecpolicy.encapsulation_mode	body	string	The encapsulation mode. A valid value is `tunnel` or `transport`. Default is `tunnel`.
ipsecpolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ipsecpolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

Schema

{
  "type": "object",
  "description": "Request of the vpn/ipsecpolicies:post operation",
  "properties": {
    "ipsecpolicy": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "transform_protocol": {
          "type": "string",
          "enum": [
            "ah",
            "ah-esp",
            "esp"
          ],
          "description": "The transform protocol. A valid value is `ESP`,\n`AH`, or `AH- ESP`. Default is `ESP`."
        },
        "auth_algorithm": {
          "type": "string",
          "enum": [
            "sha1",
            "sha256",
            "sha384",
            "sha512",
            "aes-xcbc",
            "aes-cmac"
          ],
          "description": "The authentication hash algorithm. Valid values\nare `sha1`, `sha256`, `sha384`, `sha512`.\nThe default is `sha1`."
        },
        "encryption_algorithm": {
          "type": "string",
          "enum": [
            "3des",
            "aes-128",
            "aes-192",
            "aes-256",
            "aes-128-ccm-8",
            "aes-192-ccm-8",
            "aes-256-ccm-8",
            "aes-128-ccm-12",
            "aes-192-ccm-12",
            "aes-256-ccm-12",
            "aes-128-ccm-16",
            "aes-192-ccm-16",
            "aes-256-ccm-16",
            "aes-128-gcm-8",
            "aes-192-gcm-8",
            "aes-256-gcm-8",
            "aes-128-gcm-12",
            "aes-192-gcm-12",
            "aes-256-gcm-12",
            "aes-128-gcm-16",
            "aes-192-gcm-16",
            "aes-256-gcm-16"
          ],
          "description": "The encryption algorithm. A valid value is\n`3des`, `aes-128`, `aes-192`, `aes-256`, and so on.\nDefault is `aes-128`."
        },
        "encapsulation_mode": {
          "type": "string",
          "enum": [
            "transport",
            "tunnel"
          ],
          "description": "The encapsulation mode. A valid value is\n`tunnel` or `transport`. Default is `tunnel`."
        },
        "lifetime": {
          "type": "string",
          "description": "The lifetime of the security association. The\nlifetime consists of a unit and integer value. You can omit either\nthe unit or value portion of the lifetime. Default unit is seconds\nand default value is 3600."
        },
        "pfs": {
          "type": "string",
          "enum": [
            "group2",
            "group5",
            "group14",
            "group15",
            "group16",
            "group17",
            "group18",
            "group19",
            "group20",
            "group21",
            "group22",
            "group23",
            "group24",
            "group25",
            "group26",
            "group27",
            "group28",
            "group29",
            "group30",
            "group31"
          ],
          "description": "Perfect forward secrecy (PFS). A valid value is\n`Group2`, `Group5`, `Group14`, and so on. Default is\n`Group5`."
        }
      },
      "description": "An `ipsecpolicy` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
ipsecpolicy	body	object	An `ipsecpolicy` object.
ipsecpolicy.id	body	string	The ID of the IPsec policy.
ipsecpolicy.tenant_id	body	string	The ID of the project.
ipsecpolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsecpolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsecpolicy.transform_protocol	body	string	The transform protocol. A valid value is `ESP`, `AH`, or `AH- ESP`. Default is `ESP`.
ipsecpolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ipsecpolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ipsecpolicy.encapsulation_mode	body	string	The encapsulation mode. A valid value is `tunnel` or `transport`. Default is `tunnel`.
ipsecpolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ipsecpolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

GET

/v2.0/vpn/ipsecpolicies/{id}

Show IPsec policy

Shows details for an IPsec policy.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
ipsecpolicy	body	object	An `ipsecpolicy` object.
ipsecpolicy.id	body	string	The ID of the IPsec policy.
ipsecpolicy.tenant_id	body	string	The ID of the project.
ipsecpolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsecpolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsecpolicy.transform_protocol	body	string	The transform protocol. A valid value is `ESP`, `AH`, or `AH- ESP`. Default is `ESP`.
ipsecpolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ipsecpolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ipsecpolicy.encapsulation_mode	body	string	The encapsulation mode. A valid value is `tunnel` or `transport`. Default is `tunnel`.
ipsecpolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ipsecpolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

PUT

/v2.0/vpn/ipsecpolicies/{id}

Update IPsec policy

Updates policy settings in an IPsec policy.

Normal response codes: 200

Error response codes: 400, 401, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/vpn/ipsecpolicies/{id} API
ipsecpolicy	body	object	An `ipsecpolicy` object.
ipsecpolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsecpolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsecpolicy.transform_protocol	body	string	The transform protocol. A valid value is `ESP`, `AH`, or `AH- ESP`. Default is `ESP`.
ipsecpolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ipsecpolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ipsecpolicy.encapsulation_mode	body	string	The encapsulation mode. A valid value is `tunnel` or `transport`. Default is `tunnel`.
ipsecpolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ipsecpolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

Schema

{
  "type": "object",
  "description": "Request of the vpn/ipsecpolicies/id:put operation",
  "properties": {
    "ipsecpolicy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "transform_protocol": {
          "type": "string",
          "enum": [
            "ah",
            "ah-esp",
            "esp"
          ],
          "description": "The transform protocol. A valid value is `ESP`,\n`AH`, or `AH- ESP`. Default is `ESP`."
        },
        "auth_algorithm": {
          "type": "string",
          "enum": [
            "sha1",
            "sha256",
            "sha384",
            "sha512",
            "aes-xcbc",
            "aes-cmac"
          ],
          "description": "The authentication hash algorithm. Valid values\nare `sha1`, `sha256`, `sha384`, `sha512`.\nThe default is `sha1`."
        },
        "encryption_algorithm": {
          "type": "string",
          "enum": [
            "3des",
            "aes-128",
            "aes-192",
            "aes-256",
            "aes-128-ccm-8",
            "aes-192-ccm-8",
            "aes-256-ccm-8",
            "aes-128-ccm-12",
            "aes-192-ccm-12",
            "aes-256-ccm-12",
            "aes-128-ccm-16",
            "aes-192-ccm-16",
            "aes-256-ccm-16",
            "aes-128-gcm-8",
            "aes-192-gcm-8",
            "aes-256-gcm-8",
            "aes-128-gcm-12",
            "aes-192-gcm-12",
            "aes-256-gcm-12",
            "aes-128-gcm-16",
            "aes-192-gcm-16",
            "aes-256-gcm-16"
          ],
          "description": "The encryption algorithm. A valid value is\n`3des`, `aes-128`, `aes-192`, `aes-256`, and so on.\nDefault is `aes-128`."
        },
        "encapsulation_mode": {
          "type": "string",
          "enum": [
            "transport",
            "tunnel"
          ],
          "description": "The encapsulation mode. A valid value is\n`tunnel` or `transport`. Default is `tunnel`."
        },
        "lifetime": {
          "type": "string",
          "description": "The lifetime of the security association. The\nlifetime consists of a unit and integer value. You can omit either\nthe unit or value portion of the lifetime. Default unit is seconds\nand default value is 3600."
        },
        "pfs": {
          "type": "string",
          "enum": [
            "group2",
            "group5",
            "group14",
            "group15",
            "group16",
            "group17",
            "group18",
            "group19",
            "group20",
            "group21",
            "group22",
            "group23",
            "group24",
            "group25",
            "group26",
            "group27",
            "group28",
            "group29",
            "group30",
            "group31"
          ],
          "description": "Perfect forward secrecy (PFS). A valid value is\n`Group2`, `Group5`, `Group14`, and so on. Default is\n`Group5`."
        }
      },
      "description": "An `ipsecpolicy` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
ipsecpolicy	body	object	An `ipsecpolicy` object.
ipsecpolicy.id	body	string	The ID of the IPsec policy.
ipsecpolicy.tenant_id	body	string	The ID of the project.
ipsecpolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ipsecpolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ipsecpolicy.transform_protocol	body	string	The transform protocol. A valid value is `ESP`, `AH`, or `AH- ESP`. Default is `ESP`.
ipsecpolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ipsecpolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ipsecpolicy.encapsulation_mode	body	string	The encapsulation mode. A valid value is `tunnel` or `transport`. Default is `tunnel`.
ipsecpolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ipsecpolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

DELETE

/v2.0/vpn/ipsecpolicies/{id}

Remove IPsec policy

Removes an IPsec policy.

Normal response codes: 204

Error response codes: 401, 404, 409

Responses¶

204¶

GET

/v2.0/vpn/ikepolicies

List IKE policies

Lists IKE policies.

Normal response codes: 200

Error response codes: 401, 403

Responses¶

200¶

POST

/v2.0/vpn/ikepolicies

Create IKE policy

Creates an IKE policy.

The IKE policy is used for phases one and two negotiation of the VPN connection. You can specify both the authentication and encryption algorithms for connections.

Normal response codes: 201

Error response codes: 400, 401

Request¶

Description

Name	Location	Type	Description
ikepolicy	body	object	An `ikepolicy` object.
ikepolicy.tenant_id	body	string	The ID of the project.
ikepolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ikepolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ikepolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ikepolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ikepolicy.phase1_negotiation_mode	body	string	The IKE mode. A valid value is `main`, which is the default.
ikepolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ikepolicy.ike_version	body	string	The IKE version. A valid value is `v1` or `v2`. Default is `v1`.
ikepolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

Schema

{
  "type": "object",
  "description": "Request of the vpn/ikepolicies:post operation",
  "properties": {
    "ikepolicy": {
      "type": "object",
      "properties": {
        "tenant_id": {
          "type": "string",
          "maxLength": 255,
          "description": "The ID of the project."
        },
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "auth_algorithm": {
          "type": "string",
          "enum": [
            "sha1",
            "sha256",
            "sha384",
            "sha512",
            "aes-xcbc",
            "aes-cmac"
          ],
          "description": "The authentication hash algorithm. Valid values\nare `sha1`, `sha256`, `sha384`, `sha512`.\nThe default is `sha1`."
        },
        "encryption_algorithm": {
          "type": "string",
          "enum": [
            "3des",
            "aes-128",
            "aes-192",
            "aes-256",
            "aes-128-ccm-8",
            "aes-192-ccm-8",
            "aes-256-ccm-8",
            "aes-128-ccm-12",
            "aes-192-ccm-12",
            "aes-256-ccm-12",
            "aes-128-ccm-16",
            "aes-192-ccm-16",
            "aes-256-ccm-16",
            "aes-128-gcm-8",
            "aes-192-gcm-8",
            "aes-256-gcm-8",
            "aes-128-gcm-12",
            "aes-192-gcm-12",
            "aes-256-gcm-12",
            "aes-128-gcm-16",
            "aes-192-gcm-16",
            "aes-256-gcm-16"
          ],
          "description": "The encryption algorithm. A valid value is\n`3des`, `aes-128`, `aes-192`, `aes-256`, and so on.\nDefault is `aes-128`."
        },
        "phase1_negotiation_mode": {
          "type": "string",
          "enum": [
            "main",
            "aggressive"
          ],
          "description": "The IKE mode. A valid value is `main`, which is\nthe default."
        },
        "lifetime": {
          "type": "string",
          "description": "The lifetime of the security association. The\nlifetime consists of a unit and integer value. You can omit either\nthe unit or value portion of the lifetime. Default unit is seconds\nand default value is 3600."
        },
        "ike_version": {
          "type": "string",
          "enum": [
            "v1",
            "v2"
          ],
          "description": "The IKE version. A valid value is `v1` or\n`v2`. Default is `v1`."
        },
        "pfs": {
          "type": "string",
          "enum": [
            "group2",
            "group5",
            "group14",
            "group15",
            "group16",
            "group17",
            "group18",
            "group19",
            "group20",
            "group21",
            "group22",
            "group23",
            "group24",
            "group25",
            "group26",
            "group27",
            "group28",
            "group29",
            "group30",
            "group31"
          ],
          "description": "Perfect forward secrecy (PFS). A valid value is\n`Group2`, `Group5`, `Group14`, and so on. Default is\n`Group5`."
        }
      },
      "description": "An `ikepolicy` object."
    }
  }
}

Responses¶

201¶

Name	Location	Type	Description
ikepolicy	body	object	An `ikepolicy` object.
ikepolicy.id	body	string	The ID of the IKE policy.
ikepolicy.tenant_id	body	string	The ID of the project.
ikepolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ikepolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ikepolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ikepolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ikepolicy.phase1_negotiation_mode	body	string	The IKE mode. A valid value is `main`, which is the default.
ikepolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ikepolicy.ike_version	body	string	The IKE version. A valid value is `v1` or `v2`. Default is `v1`.
ikepolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

GET

/v2.0/vpn/ikepolicies/{id}

Show IKE policy details

Shows details for an IKE policy.

Normal response codes: 200

Error response codes: 401, 403, 404

Responses¶

200¶

Name	Location	Type	Description
ikepolicy	body	object	An `ikepolicy` object.
ikepolicy.id	body	string	The ID of the IKE policy.
ikepolicy.tenant_id	body	string	The ID of the project.
ikepolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ikepolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ikepolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ikepolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ikepolicy.phase1_negotiation_mode	body	string	The IKE mode. A valid value is `main`, which is the default.
ikepolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ikepolicy.ike_version	body	string	The IKE version. A valid value is `v1` or `v2`. Default is `v1`.
ikepolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

PUT

/v2.0/vpn/ikepolicies/{id}

Update IKE policy

Updates policy settings in an IKE policy.

Normal response codes: 200

Error response codes: 400, 401, 404

Request¶

Description

Name	Location	Type	Description
id	path	string	id parameter for /v2.0/vpn/ikepolicies/{id} API
ikepolicy	body	object	An `ikepolicy` object.
ikepolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ikepolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ikepolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ikepolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ikepolicy.phase1_negotiation_mode	body	string	The IKE mode. A valid value is `main`, which is the default.
ikepolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ikepolicy.ike_version	body	string	The IKE version. A valid value is `v1` or `v2`. Default is `v1`.
ikepolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

Schema

{
  "type": "object",
  "description": "Request of the vpn/ikepolicies/id:put operation",
  "properties": {
    "ikepolicy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Human-readable name of the resource.\nDefault is an empty string."
        },
        "description": {
          "type": "string",
          "maxLength": 255,
          "description": "A human-readable description for the resource.\nDefault is an empty string."
        },
        "auth_algorithm": {
          "type": "string",
          "enum": [
            "sha1",
            "sha256",
            "sha384",
            "sha512",
            "aes-xcbc",
            "aes-cmac"
          ],
          "description": "The authentication hash algorithm. Valid values\nare `sha1`, `sha256`, `sha384`, `sha512`.\nThe default is `sha1`."
        },
        "encryption_algorithm": {
          "type": "string",
          "enum": [
            "3des",
            "aes-128",
            "aes-192",
            "aes-256",
            "aes-128-ccm-8",
            "aes-192-ccm-8",
            "aes-256-ccm-8",
            "aes-128-ccm-12",
            "aes-192-ccm-12",
            "aes-256-ccm-12",
            "aes-128-ccm-16",
            "aes-192-ccm-16",
            "aes-256-ccm-16",
            "aes-128-gcm-8",
            "aes-192-gcm-8",
            "aes-256-gcm-8",
            "aes-128-gcm-12",
            "aes-192-gcm-12",
            "aes-256-gcm-12",
            "aes-128-gcm-16",
            "aes-192-gcm-16",
            "aes-256-gcm-16"
          ],
          "description": "The encryption algorithm. A valid value is\n`3des`, `aes-128`, `aes-192`, `aes-256`, and so on.\nDefault is `aes-128`."
        },
        "phase1_negotiation_mode": {
          "type": "string",
          "enum": [
            "main",
            "aggressive"
          ],
          "description": "The IKE mode. A valid value is `main`, which is\nthe default."
        },
        "lifetime": {
          "type": "string",
          "description": "The lifetime of the security association. The\nlifetime consists of a unit and integer value. You can omit either\nthe unit or value portion of the lifetime. Default unit is seconds\nand default value is 3600."
        },
        "ike_version": {
          "type": "string",
          "enum": [
            "v1",
            "v2"
          ],
          "description": "The IKE version. A valid value is `v1` or\n`v2`. Default is `v1`."
        },
        "pfs": {
          "type": "string",
          "enum": [
            "group2",
            "group5",
            "group14",
            "group15",
            "group16",
            "group17",
            "group18",
            "group19",
            "group20",
            "group21",
            "group22",
            "group23",
            "group24",
            "group25",
            "group26",
            "group27",
            "group28",
            "group29",
            "group30",
            "group31"
          ],
          "description": "Perfect forward secrecy (PFS). A valid value is\n`Group2`, `Group5`, `Group14`, and so on. Default is\n`Group5`."
        }
      },
      "description": "An `ikepolicy` object."
    }
  }
}

Responses¶

200¶

Name	Location	Type	Description
ikepolicy	body	object	An `ikepolicy` object.
ikepolicy.id	body	string	The ID of the IKE policy.
ikepolicy.tenant_id	body	string	The ID of the project.
ikepolicy.name	body	string	Human-readable name of the resource. Default is an empty string.
ikepolicy.description	body	string	A human-readable description for the resource. Default is an empty string.
ikepolicy.auth_algorithm	body	string	The authentication hash algorithm. Valid values are `sha1`, `sha256`, `sha384`, `sha512`. The default is `sha1`.
ikepolicy.encryption_algorithm	body	string	The encryption algorithm. A valid value is `3des`, `aes-128`, `aes-192`, `aes-256`, and so on. Default is `aes-128`.
ikepolicy.phase1_negotiation_mode	body	string	The IKE mode. A valid value is `main`, which is the default.
ikepolicy.lifetime	body	string	The lifetime of the security association. The lifetime consists of a unit and integer value. You can omit either the unit or value portion of the lifetime. Default unit is seconds and default value is 3600.
ikepolicy.ike_version	body	string	The IKE version. A valid value is `v1` or `v2`. Default is `v1`.
ikepolicy.pfs	body	string	Perfect forward secrecy (PFS). A valid value is `Group2`, `Group5`, `Group14`, and so on. Default is `Group5`.

DELETE

/v2.0/vpn/ikepolicies/{id}

Remove IKE policy

Removes an IKE policy.

Normal response codes: 204

Error response codes: 401, 404, 409