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
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" |
OK
Authorization information is missing or invalid.
A Network with the specified name already exists.
Unexpected error.
Unexpected error
{- "name": "GREEN_NETWORK",
- "net_id": "123e4567-e89b-12d3-a456-426655440012",
- "description": "Bengaluru DC IP Network",
- "tenant_name": "Customer-A",
- "segments": [
- {
- "segment_id": "1",
- "network_type": "vlan"
}
], - "admin_state_up": true,
- "mtu": 1400
}
Delete Network
net_id | string Network ID to be deleted |
OK
Authorization information is missing or invalid.
A Network with the specified name was not found.
Unexpected error.
Unexpected error
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. |
OK
Authorization information is missing or invalid.
A Subnet with the specified name already exists.
Unexpected error.
Unexpected error
{- "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"
}
Delete Subnet by subnet UUID
subnet_id | string subnet UUID |
OK
Authorization information is missing or invalid.
A Subnet with the specified name was not found.
Unexpected error.
Unexpected error
Update Subnet Settings
name required | string |
subnet_id | string |
net_id required | string |
gateway_ip required | string |
OK
Incorrect values specified for Subnet setting
Authorization information is missing or invalid.
A subnet with the specified name was not found.
A subnet settings already exist and cannot be updated.
Unexpected error
Unexpected error
{- "name": "MY_SUBNET",
- "net_id": "123e4567-e89b-12d3-a456-426655440012",
- "gateway_ip": "10.56.4.1"
}
Get specified or all Port-channel details.
name | string Unique name of the Port-channel to be fetched. |
tenant_name required | string tenant to which this port channel belongs. |
OK
Authorization information is missing or invalid.
Port-channel with the specified ID or number is not found.
Unexpected error
Unexpected error
This api will fetch the configured details like l2VNI, l3VNI and its assets.
name | string Name of the tenant to retrieve |
OK
Authorization information is missing or invalid.
A tenant with the specified name is not found.
Unexpected error.
Unexpected error
This API will cleanup all openstack assets associated to a tenant
name | string Name of the tenant to cleanup |
OK
Authorization information is missing or invalid.
A tenant with the specified name is not found.
Unexpected error.
Unexpected error
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) |
OK
Authorization information is missing or invalid.
A Port with the specified name already exists.
Unexpected error
Unexpected error
{- "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": [
- {
- "intf_type": "ethernet",
- "intf_name": "0/2",
- "mgmt_ip": "10.10.10.1"
}
]
}
Delete Ports by neutron port id
port_id required | string Port ID to be deleted |
OK
Authorization information is missing or invalid.
A Portt with the specified name was not found.
Unexpected error.
Unexpected error
Update Port Setting.
name required | string |
device_owner required | string |
OK
Incorrect values specified for Port setting
Authorization information is missing or invalid.
A port with the specified name was not found.
A port settings already exist and cannot be updated.
Unexpected error
Unexpected error
{- "name": "Private-port",
- "device_owner": "baremetal:none"
}
Create Router with a specified Neutron UUID
name required | string |
router_id required | string |
tenant_name | string Unique Name of the tenant |
OK
Authorization information is missing or invalid.
A Router with the specified name already exists.
Unexpected error
Unexpected error
{- "name": "ROUTER-1",
- "router_id": "f8a44de0-fc8e-45df-93c7-f79bf3b01c95",
- "tenant_name": "Customer-A"
}
Delete specified router on router-id
router_id | string The ID of the router to be deleted |
OK
Authorization information is missing or invalid.
A Router with the specified name was not found.
Unexpected error.
Unexpected error
Add a Router Interface to a Router
router_id required | string |
subnet_id | string |
OK
Authorization information is missing or invalid.
A Router with the specified name already exists.
Unexpected error
Unexpected error
{- "router_id": "f8a44de0-fc8e-45df-93c7-f79bf3b01c95",
- "subnet_id": "45a44de0-fc8e-45df-93c7-f79bf3b01c95"
}
Delete Router Interface from Router
router_id required | string |
subnet_id | string |
OK
Authorization information is missing or invalid.
A Router with the specified name was not found.
Unexpected error.
Unexpected error
{- "router_id": "f8a44de0-fc8e-45df-93c7-f79bf3b01c95",
- "subnet_id": "45a44de0-fc8e-45df-93c7-f79bf3b01c95"
}
This API will delete openstack asset
Ids of the Oss sset to delete
operation | string Enum: "network-delete" "network-interface-delete" "router-delete" "router-interface-delete" |
net_id | string |
port_id | string |
router_id | string |
subnet_id | string |
OK
Authorization information is missing or invalid.
A tenant with the specified name is not found.
Unexpected error.
Unexpected error
{- "operation": "network-delete",
- "net_id": "123e4567-e89b-12d3-a456-426655440012",
- "port_id": "123e4567-e89b-12d3-a456-426655440010",
- "router_id": "f8a44de0-fc8e-45df-93c7-f79bf3b01c95",
- "subnet_id": "45a44de0-fc8e-45df-93c7-f79bf3b01c95"
}
Get the detailed output of the given execution ID
id required | string Execution ID |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
Get the list of all the previous executions
limit required | integer Default: 10 Limit the number of executions that will be sent in the response. Default is 10 |
status | string Default: "all" Filter the executions based on the status(failed/succeeded/all) |
OK
Authorization information is missing or invalid.
Unexpected error.
Unexpected error
This API will delete the execution entries older than specific number of days
days_older_by required | integer Default: 30 Deletes execution entries older than specified number of days |
OK
ACCEPTED
Authorization information is missing or invalid.
Unexpected error.
Unexpected error