Openstack Service (3.1.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

Authentication

efaAuthKey

Security Scheme Type API Key
Header parameter name: Authorization

openstackUser

This parameter is mandatory for client implementation where efa login is not possible. In this case, the client has to pass user name. Example - openstack plugin

Security Scheme Type API Key
Header parameter name: X-OpenStack-User

Network

getNetwork

Get one or All Networks

Authorizations:
query Parameters
net_id
string

Network-id of the Neutron Network to retrieve

tenant_name
string

tenant to which this network belongs

Responses

Response samples

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

createNetwork

Authorizations:
Request Body schema: application/json

Create Network

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

Unique Name of the tenant

admin_state_up
boolean
mtu
integer
enable_bd
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "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
}

Response samples

Content type
application/json
{
  • "name": "GREEN_NETWORK",
  • "net_id": "123e4567-e89b-12d3-a456-426655440012",
  • "efa_net_id": 1,
  • "description": "Green Network",
  • "segments": [
    ],
  • "tenant_name": "Customer-A",
  • "admin_state_up": true,
  • "mtu": 1400,
  • "enable_bd": true,
  • "error": [
    ]
}

deleteNetwork

Delete Network

Authorizations:
query Parameters
net_id
string

Network ID to be deleted

Responses

Response samples

Content type
application/json
{
  • "net_id": "123e4567-e89b-12d3-a456-42665544001",
  • "error": [
    ]
}

Subnet

getSubnet

Get All Subnets

Authorizations:
query Parameters
subnet_id
string

ID of the Subnet to retrieve

Responses

Response samples

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

createSubnet

Authorizations:
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