Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titleUnstable Endpoints!

While the APIs documented here are mostly stable in their parameters (where they are not is indicated in each description as needed), their endpoints are very likely to change in future releases. Developers are advised to write code that is flexible in the face of URL changes.

APIs which related to FlowVisor or GENI are very likely to move, as they are not part of the "core" of FOAM, while APIs relating to core configuration and administration are more likely to stay where they are.

PathInputOutput
Description
[POST]
/core/admin/get-fv-slice-name
Code Block
{ 
  slice_urn":<urn>
}
Code Block
{
  "name":<string>
}

Returns the FlowVisor slice name for the given slice_urn.

Note
This API is subject to change to support multiple slivers per slice, accepting a sliver_urn (as "sliver_urn" : <urn> instead of (or in addition to) a slice_urn). Developers wanting to write forward-compatible code should include a valid sliver_urn as well as slice_urn, which will likely work as expected in future versions (the sliver_urn must belong to the given slice_urn).
[GET,POST]
/core/admin/list-slivers
Code Block
{
 "deleted":<bool>,
 "status":<approved|rejected|pending>
}

 


Code Block
[
 {  
  "id":<opaque>,
  "slice_urn":<urn>,
  "sliver_urn":<urn>,
  "flowvisor_slice":<string>,
  "enabled":<bool>,
  "expiration":<isotime>,
  "creation":<isotime>,
  "status":<sliver_status>,
  "deleted":<bool>
 },
 ...
]

Returns the list of slivers matching the given criteria.

GET behaves as if deleted is False, and status is any (not currently supported via POST).

[POST]
/core/admin/approve-sliver