@itentialopensource/adapter-openstack_neutron

{ "openapi": "3.0.0", "info": { "version": "1.0", "title": "Openstack Neutron API" }, "servers": [ { "url": "http://{host}:{port}", "description": "Networking service (neutron) administrative endpoint", "variables": { "host": { "default": "localhost" }, "port": { "default": "9696" } } } ], "paths": { "/": { "get": { "operationId": "listAPIVersions", "summary": "List API versions", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#list-api-versions" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "API versions" ] } }, "/v2.0/": { "get": { "operationId": "showAPIV2Details", "summary": "Show API v2 details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#show-api-v2-details" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "API versions" ] } }, "/v2.0/extensions": { "get": { "operationId": "listExtensions", "summary": "List extensions", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#list-extensions" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Extensions" ] } }, "/v2.0/extensions/{alias}": { "get": { "operationId": "showExtensionDetails", "summary": "Show extension details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#show-extension-details" }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "description": "The alias of an extension." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Extensions" ] } }, "/v2.0/networks/{network_id}": { "get": { "operationId": "showNetworkDetails", "summary": "Show network details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#show-network-details" }, "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "description": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy using fields parameter, the API returns only the requested set of\nattributes. fields parameter can be specified multiple times.\nFor example, if you specify fields=id&fields=name in the request URL,\nonly id and name attributes will be returned." } }, { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the network." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Networks" ] }, "put": { "operationId": "updateNetwork", "summary": "Update network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#update-network" }, "parameters": [ { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the network." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "network": { "type": "object", "properties": { "dns_domain": { "type": "string" }, "name": { "type": "string" }, "qos_policy_id": { "type": "string" }, "mtu": { "type": "integer" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Networks" ] }, "delete": { "operationId": "deleteNetwork", "summary": "Delete network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#delete-network" }, "parameters": [ { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the network." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Networks" ] } }, "/v2.0/networks": { "get": { "operationId": "listNetworks", "summary": "List networks", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#list-networks" }, "parameters": [ { "name": "admin_state_up", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false)." } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the resource." } }, { "name": "mtu", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the network list result by the maximum transmission unit (MTU)\nvalue to address fragmentation. Minimum value is 68 for IPv4,\nand 1280 for IPv6." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the human-readable name of the resource." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the project that owns the resource." } }, { "name": "provider:network_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the type of physical network that this\nnetwork/segment is mapped to. For example, flat, vlan, vxlan,\nor gre. Valid values depend on a networking back-end." } }, { "name": "provider:physical_network", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the physical network where\nthis network/segment is implemented." } }, { "name": "provider:segmentation_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the list result by the ID of the isolated segment\non the physical network." } }, { "name": "revision_number", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the list result by the revision number of the resource." } }, { "name": "router:external", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the network list result based on whether the network has an\nexternal routing facility that’s not managed by the networking service." } }, { "name": "shared", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the network list result based on if the network is shared across\nall tenants." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the network list result by network status. Values are ACTIVE,\nDOWN, BUILD or ERROR." } }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the project that owns the resource." } }, { "name": "vlan_transparent", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the network list by the VLAN transparency mode of the network,\nwhich is VLAN transparent (true) or not VLAN transparent (false)." } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the human-readable description of the resource." } }, { "name": "is_default", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the network list result based on if the network is default pool\nor not." } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "not-tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "not-tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a network attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:" } }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "description": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy using fields parameter, the API returns only the requested set of\nattributes. fields parameter can be specified multiple times.\nFor example, if you specify fields=id&fields=name in the request URL,\nonly id and name attributes will be returned." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Networks" ] }, "post": { "operationId": "createNetwork", "summary": "Create network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#create-network" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "network": { "type": "object", "properties": { "admin_state_up": { "type": "boolean" }, "name": { "type": "string" }, "provider:network_type": { "type": "string" }, "provider:physical_network": { "type": "string" }, "provider:segmentation_id": { "type": "integer" }, "qos_policy_id": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Networks" ] } }, "/v2.0/network_segment_ranges/{network_segment_range_id}": { "get": { "operationId": "showNetworkSegmentRangeDetails", "summary": "Show network segment range details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#show-network-segment-range-details" }, "parameters": [ { "name": "network_segment_range_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the network segment range." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Network Segment Ranges" ] }, "put": { "operationId": "updateNetworkSegmentRange", "summary": "Update network segment range", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#update-network-segment-range" }, "parameters": [ { "name": "tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "not-tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "not-tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "network_segment_range_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the network segment range." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "network_segment_range": { "type": "object", "properties": { "name": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" }, "description": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Network Segment Ranges" ] }, "delete": { "operationId": "deleteNetworkSegmentRange", "summary": "Delete network segment range", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#delete-network-segment-range" }, "parameters": [ { "name": "network_segment_range_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the network segment range." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Network Segment Ranges" ] } }, "/v2.0/network_segment_ranges": { "get": { "operationId": "listNetworkSegmentRanges", "summary": "List network segment ranges", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#list-network-segment-ranges" }, "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the network segment range list result based on the range ID." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the network segment range list result based on the name of the\nrange." } }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the project that owns the resource." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the project that owns the resource." } }, { "name": "network_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the type of physical network that this\nnetwork segment range is mapped to. For example, vlan, vxlan, or\ngre. Valid values depend on a networking back-end." } }, { "name": "physical_network", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the physical network where this\nnetwork segment range is implemented." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a network segment range attribute. You can specify multiple pairs\nof sort key and sort direction query parameters. The sort keys are limited\nto:" } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "not-tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "not-tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "description": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy using fields parameter, the API returns only the requested set of\nattributes. fields parameter can be specified multiple times.\nFor example, if you specify fields=id&fields=name in the request URL,\nonly id and name attributes will be returned." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Network Segment Ranges" ] }, "post": { "operationId": "createNetworkSegmentRange", "summary": "Create network segment range", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#create-network-segment-range" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "network_segment_range": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "shared": { "type": "boolean" }, "project_id": { "type": "string" }, "network_type": { "type": "string" }, "physical_network": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Network Segment Ranges" ] } }, "/v2.0/ports/{port_id}": { "get": { "operationId": "showPortDetails", "summary": "Show port details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#show-port-details" }, "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "description": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy using fields parameter, the API returns only the requested set of\nattributes. fields parameter can be specified multiple times.\nFor example, if you specify fields=id&fields=name in the request URL,\nonly id and name attributes will be returned." } }, { "name": "port_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the port." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Ports" ] }, "put": { "operationId": "updatePort", "summary": "Update port", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#update-port" }, "parameters": [ { "name": "port_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the port." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "port": { "type": "object", "properties": { "binding:host_id": { "type": "string" }, "binding:profile": { "type": "object" }, "device_id": { "type": "string" }, "data_plane_status": { "type": "string" }, "device_owner": { "type": "string" }, "qos_policy_id": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Ports" ] }, "delete": { "operationId": "deletePort", "summary": "Delete port", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#delete-port" }, "parameters": [ { "name": "port_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the port." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Ports" ] } }, "/v2.0/ports": { "get": { "operationId": "listPorts", "summary": "List ports", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#list-ports" }, "parameters": [ { "name": "admin_state_up", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false)." } }, { "name": "binding:host_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the port list result by the ID of the host where the port resides." } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the human-readable description of the resource." } }, { "name": "device_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the port list result by the ID of the device that uses this port.\nFor example, a server instance or a logical router." } }, { "name": "device_owner", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the port result list by the entity type that uses this port.\nFor example, compute:nova (server instance), network:dhcp\n(DHCP agent) or network:router_interface (router interface)." } }, { "name": "fixed_ips", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the port list result by the IP addresses for the port.\nThis field has one or multiple entries.\nEach entry consists of IP address (ip_address), IP address substring\n(ip_address_substr) and/or the subnet ID from which\nthe IP address is assigned (subnet_id)." } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the resource." } }, { "name": "ip_allocation", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the port list result based on if the ports use deferred,\nimmediate or no IP allocation (none)." } }, { "name": "mac_address", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the port list result by the MAC address of the port." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the human-readable name of the resource." } }, { "name": "network_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the attached network." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the project that owns the resource." } }, { "name": "revision_number", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the list result by the revision number of the resource." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a port attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the port list result by the port status.\nValues are ACTIVE, DOWN, BUILD and ERROR." } }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the project that owns the resource." } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma." } }, { "name": "not-tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "not-tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma." } }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "description": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy using fields parameter, the API returns only the requested set of\nattributes. fields parameter can be specified multiple times.\nFor example, if you specify fields=id&fields=name in the request URL,\nonly id and name attributes will be returned." } }, { "name": "mac_learning_enabled", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the list result by the mac_learning_enabled state of the resource,\nwhich is enabled (true) or disabled (false)." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Ports" ] }, "post": { "operationId": "createPort", "summary": "Create port", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#create-port" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "port": { "type": "object", "properties": { "binding:host_id": { "type": "string" }, "binding:profile": { "type": "object", "properties": { "local_link_information": { "type": "array", "items": { "type": "object", "properties": { "port_id": { "type": "string" }, "switch_id": { "type": "string" }, "switch_info": { "type": "string" } } } } } }, "binding:vnic_type": { "type": "string" }, "device_id": { "type": "string" }, "device_owner": { "type": "string" }, "dns_domain": { "type": "string" }, "dns_name": { "type": "string" }, "qos_policy_id": { "type": "string" }, "propagate_uplink_status": { "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Ports" ] } }, "/v2.0/segments/{segment_id}": { "get": { "operationId": "showSegmentDetails", "summary": "Show segment details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#show-segment-details" }, "parameters": [ { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the segment." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Segments" ] }, "put": { "operationId": "updateSegment", "summary": "Update segment", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#update-segment" }, "parameters": [ { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the segment." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "segment": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Segments" ] }, "delete": { "operationId": "deleteSegment", "summary": "Delete segment", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#delete-segment" }, "parameters": [ { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the segment." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Segments" ] } }, "/v2.0/segments": { "get": { "operationId": "listSegments", "summary": "List segments", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#list-segments" }, "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the resource." } }, { "name": "network_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the ID of the attached network." } }, { "name": "physical_network", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the physical network where\nthis network/segment is implemented." } }, { "name": "network_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the type of physical network that this\nnetwork/segment is mapped to. For example, flat, vlan, vxlan,\nor gre. Valid values depend on a networking back-end." } }, { "name": "revision_number", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the list result by the revision number of the resource." } }, { "name": "segmentation_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the list result by the ID of the isolated segment\non the physical network." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the human-readable name of the resource." } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list result by the human-readable description of the resource." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a segment attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:" } }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "description": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy using fields parameter, the API returns only the requested set of\nattributes. fields parameter can be specified multiple times.\nFor example, if you specify fields=id&fields=name in the request URL,\nonly id and name attributes will be returned." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Segments" ] }, "post": { "operationId": "createSegment", "summary": "Create segment", "externalDocs": { "url": "https://docs.openstack.org/api-ref/network/v2/index.html?expanded=#create-segment" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "segment": { "type": "object", "properties": { "network_id": { "type": "string" }, "segmentation_id": { "type": "integer" }, "network_type": { "type": "string" }, "physical_network": { "type": "string" } } } } } } } }