Application

Media Type
[application/vnd.org.midonet.Application-v5+json]
GET     /

This is the root object in MidoNet REST API. From this object, clients can traverse the URIs to discover all the available services. The Neutron endpoint was added in version 5.

Field NameTypePOST/PUTRequiredDescription

uri

URI

  

A GET against this URI refreshes the representation of this resource.

version

String

  

The version of MidoNet REST API.

bridges

URI

  

A GET against this URI returns the list of bridges.

chains

URI

  

A GET against this URI returns the list of chains.

healthMonitors

URI

  

A GET against this URI returns the list of health monitors.

hosts

URI

  

A GET against this URI returns the list of hosts.

ipAddrGroups

URI

  

A GET against this URI returns the list of IP address groups.

loadBalancers

URI

  

A GET against this URI returns the list of load balancers.

mirrors

URI

  

A GET against this URI returns the list of port mirrors.

neutron

URI

  

A GET against this URI returns the available Neutron resources.

poolMembers

URI

  

A GET against this URI returns the list of pool members.

pools

URI

  

A GET against this URI returns the list of pools.

portGroups

URI

  

A GET against this URI returns the list of port groups.

ports

URI

  

A GET against this URI returns the list of ports.

qosPolicies

URI

  

A GET against this URI returns the list of QoS policies.

routers

URI

  

A GET against this URI returns the list of routers.

systemState

URI

  

A GET against this URI returns the system state.

tenants

URI

  

A GET against this URI returns the list of tenants.

traceRequests

URI

  

A GET against this URI returns the list of trace requests.

tunnelZones

URI

  

A GET against this URI return the list of tunnel zones.

vips

URI

  

A GET against this URI returns the list of VIPs.

vteps

URI

  

A GET against this URI returns the list of VTEPs.

bgpNetworkTemplate

String

  

Template of the URI that represents the location of the BGP network with the provided identifier.

bgpPeerTemplate

String

  

Template of the URI that represents the location of the BGP peer with the provided identifier.

bridgeTemplate

String

  

Template of the URI that represents the location of the bridge with the provided identifier.

chainTemplate

String

  

Template of the URI that represents the location of the chain with the provided identifier.

healthMonitorTemplate

String

  

Template of the URI that represents the location of the health monitor with the provided identifier.

hostTemplate

String

  

Template of the URI that represents the location of the host with the provided identifier.

ipAddrGroupTemplate

String

  

Template of the URI that represents the location of the IP address group with the provided identifier.

loadBalancerTemplate

String

  

Template of the URI that represents the location of the load balancer with the provided identifier.

mirrorTemplate

String

  

Template of the URI that represents the location of the port mirror with the provided identifier.

poolMemberTemplate

String

  

Template of the URI that represents the location of the pool member with the provided identifier.

poolTemplate

String

  

Template of the URI that represents the location of the pool with the provided identifier.

portGroupTemplate

String

  

Template of the URI that represents the location of the port group with the provided identifier.

portTemplate

String

  

Template of the URI that represents the location of the port with the provided identifier.

qosPolicyTemplate

String

  

Template of the URI that represents the location of the QoS policy with the provided identifier.

routerTemplate

String

  

Template of the URI that represents the location of the router with the provided identifier.

routeTemplate

String

  

Template of the URI that represents the location of the route with the provided identifier.

ruleTemplate

String

  

Template of the URI that represents the location of the rule with the provided identifier.

tenantTemplate

String

  

Template of the URI that represents the location of the tenant with the provided identifier.

traceRequestTemplate

String

  

Template of the URI that represents the location of the trace request with the provided identifier.

tunnelZoneTemplate

String

  

Template of the URI that represents the location of the tunnel zone with the provided identifier.

vipTemplate

String

  

Template of the URI that represents the location of the VIP with the provided identifier.

vtepTemplate

String

  

Template of the URI that represents the location of the VTEP with the provided identifier.

The following media types have been removed from the API: [application/vnd.org.midonet.Application-v1+json] [application/vnd.org.midonet.Application-v2+json] [application/vnd.org.midonet.Application-v3+json] [application/vnd.org.midonet.Application-v4+json]

Questions? Discuss on Mailing Lists or Chat.
Found an error? Report a bug.