Openstack Service (2.2.0)

Download OpenAPI specification:Download

This is the spec that defines the API provided by the application to provide APIs that act as proxy for openstack neutron APIS

Network

getNetwork

Get one or All Networks

query Parameters
net_id
string

Network-id of the Neutron Network to retrieve

Responses

200

OK

404

No Networks found in the system

500

Unexpected error

default

Unexpected error

get/network
http://goopenstack-service:80/v1/openstack/network

createNetwork

Request Body schema: application/json

Create Network

name
required
string
net_id
string
description
string
segments
Array of objects (Segment)
tenant_name
string

Unique Name of the tenant

admin_state_up
boolean
mtu
integer
enable_bd
boolean
Default: "false"

Responses

200

OK

401

Authorization information is missing or invalid.

409

A Network with the specified name already exists.

500

Unexpected error.

default

Unexpected error

post/network
http://goopenstack-service:80/v1/openstack/network

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "GREEN_NETWORK",
  • "net_id": "123e4567-e89b-12d3-a456-426655440012",
  • "description": "Bengaluru DC IP Network",
  • "tenant_name": "Customer-A",
  • "segments":
    [
    ],
  • "admin_state_up": true,
  • "mtu": 1400
}

deleteNetwork

Delete Network

query Parameters
net_id
string

Network ID to be deleted

Responses

200

OK

401

Authorization information is missing or invalid.

404

A Network with the specified name was not found.

500

Unexpected error.

default

Unexpected error

delete/network
http://goopenstack-service:80/v1/openstack/network

Subnet

getSubnet

Get All Subnets

query Parameters
subnet_id
string

ID of the Subnet to retrieve

Responses

200

OK

404

Subnet not found in the system

500

Unexpected error

default

Unexpected error

get/subnet
http://goopenstack-service:80/v1/openstack/subnet

createSubnet

Request Body schema: application/json

Create Subnet

name
required
string
description
string

Description of the Subnet

net_id
required
string
subnet_id
string
segment_id
string
ip_version
integer <uint8>
cidr
string
gateway_ip
string
ipv6_address_mode
string

The IPv6 address modes specifies mechanisms for assigning IP addresses

ipv6_ra_mode
string

The IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet.

Responses

200

OK

401

Authorization information is missing or invalid.

409

A Subnet with the specified name already exists.

500

Unexpected error.

default

Unexpected error

post/subnet
http://goopenstack-service:80/v1/openstack/subnet

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "MY_SUBNET",
  • "description": "MY_GREEN_SUBNET",
  • "net_id": "123e4567-e89b-12d3-a456-426655440012",
  • "subnet_id": "b0e7435c-1512-45fb-aa9e-9a7c5932fb30",
  • "segment_id": "1",
  • "ip_version": "4",
  • "cidr": "10.56.4.0/22",
  • "gateway_ip": "10.56.4.1",
  • "ipv6_address_mode": "slaac",
  • "ipv6_ra_mode": "slaac"
}

deleteSubnet

Delete Subnet by subnet UUID

query Parameters
subnet_id
string

subnet UUID

Responses

200

OK

401

Authorization information is missing or invalid.

404

A Subnet with the specified name was not found.

500

Unexpected error.

default

Unexpected error

delete/subnet
http://goopenstack-service:80/v1/openstack/subnet

Subnet Setting

updateSubnetSetting

Request Body schema: application/json

Update Subnet Settings

name
required
string
subnet_id
string
net_id
required
string
gateway_ip
required
string

Responses

200

OK

400

Incorrect values specified for Subnet setting

401

Authorization information is missing or invalid.

404

A subnet with the specified name was not found.

409

A subnet settings already exist and cannot be updated.

500

Unexpected error

default

Unexpected error

put/subnet
http://goopenstack-service:80/v1/openstack/subnet

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "MY_SUBNET",
  • "net_id": "123e4567-e89b-12d3-a456-426655440012",
  • "gateway_ip": "10.56.4.1"
}

Port Channel

getPortchannel

Get specified or all Port-channel details.

query Parameters
name
string

Unique name of the Port-channel to be fetched.

tenant_name
required
string

tenant to which this port channel belongs.

Responses

200

OK

401

Authorization information is missing or invalid.

404

Port-channel with the specified ID or number is not found.

500

Unexpected error

default

Unexpected error

get/portchannel
http://goopenstack-service:80/v1/openstack/portchannel

Tenant

getTenant

This api will fetch the configured details like l2VNI, l3VNI and its assets.

query Parameters
name
string

Name of the tenant to retrieve

Responses

200

OK

401

Authorization information is missing or invalid.

404

A tenant with the specified name is not found.

500

Unexpected error.

default

Unexpected error

get/tenant
http://goopenstack-service:80/v1/openstack/tenant

cleanupTenant

This API will cleanup all openstack assets associated to a tenant

query Parameters
name
string

Name of the tenant to cleanup

Responses

200

OK

401

Authorization information is missing or invalid.

404

A tenant with the specified name is not found.

500

Unexpected error.

default

Unexpected error

delete/tenant
http://goopenstack-service:80/v1/openstack/tenant

Port

getPort

Get specified or all Ports

query Parameters
port_id
string

Neutron port-id of the Port to retrieve

Responses

200

OK

404

Port not found in the system

500

Unexpected error

default

Unexpected error

get/port
http://goopenstack-service:80/v1/openstack/port

createPort

Request Body schema: application/json

Create a new Port

name
required
string
port_id
required
string
net_id
string
dns_domain
string
dns_name
string
device_owner
string
switch_information
Array of objects (SwitchInformation)

Responses

200

OK

401

Authorization information is missing or invalid.

409

A Port with the specified name already exists.

500

Unexpected error

default

Unexpected error

post/port
http://goopenstack-service:80/v1/openstack/port

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "Private-Port",
  • "port_id": "Ethernet 0/1",
  • "net_id": "123e4567-e89b-12d3-a456-426655440012",
  • "dns_domain": "my-domain.org",
  • "dns_name": "myport",
  • "device_owner": "baremetal:none",
  • "switch_information":
    [
    ]
}

deletePort

Delete Ports by neutron port id

query Parameters
port_id
required
string

Port ID to be deleted

Responses

200

OK

401

Authorization information is missing or invalid.

404

A Portt with the specified name was not found.

500

Unexpected error.

default

Unexpected error

delete/port
http://goopenstack-service:80/v1/openstack/port

Port Setting

updatePortSetting

Request Body schema: application/json

Update Port Setting.

name
required
string
device_owner
required
string

Responses

200

OK

400

Incorrect values specified for Port setting

401

Authorization information is missing or invalid.

404

A port with the specified name was not found.

409

A port settings already exist and cannot be updated.

500

Unexpected error

default

Unexpected error

put/port
http://goopenstack-service:80/v1/openstack/port

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "Private-port",
  • "device_owner": "baremetal:none"
}

Router

getRouter

Get specified or all Routers

query Parameters
router_id
string

router-id of the Router

Responses

200

OK

404

Port not found in the system

500

Unexpected error

default

Unexpected error

get/router
http://goopenstack-service:80/v1/openstack/router

createRouter

Request Body schema: application/json

Create Router with a specified Neutron UUID

name
required
string
router_id
required
string
tenant_name
<