Base

get

List the resources that can be accessed from the base URL

Network Devices

get

List Network Devices. NB: Query parameters should be implemented for all permitted resource attributes.

get

Get a single Network Device

Endpoints

get

List Endpoints. NB: Query parameters should be implemented for all permitted resource attributes.

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

get

Get a single Endpoint

put

Register a new Endpoint. The PUT is invoked to inform the network controller about the presence of an Endpoint. The Endpoint should include details of the Network Device the Endpoint is attached to. The attached network device details can be fetched by the endpoint through LLDP (if the endpoint is LLDP capable) or manual entry in the caller of this API (e.g., a broadcast controller). The network controller may verify these details. If the details are invalid, the network controller may reject the request. When the attached network device details are not included in the request, the network controller may attempt to determine them and include them in the registered Endpoint. However, if the network controller cannot determine them, it may reject the the request. Subsequent PUT requests should receive an error response. Updates should be done using PATCH.

patch

Update an existing Endpoint's attributes.

delete

Delete an existing Endpoint.

Network Flows

get

List Network Flows. NB: Query parameters should be implemented for all permitted resource attributes.

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

get

Get a single Network Flow

put

Create a Network Flow with the specified ID. Subsequent PUT requests should receive an error response. Updates should be done using PATCH.

patch

Update an existing Network Flow with the specified ID. A Network Flow is equivalent to and also uniquely identified by the Sender Endpoint ID and the multicast address, or the <S,G> pair. So, neither the Sender Endpoint ID nor the multicast address can be updated of an existing Network Flow. A new Network Flow should be created for a different pair of <S,G>. Moreover, for simplicity, receiver Endpoint IDs can only be updated using a /receivers POST or DELETE request.

delete

Delete the Network Flow with the specified ID.

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

post

Add one or more receivers to this Network Flow. Receivers included in the body should be appended to the existing receivers, if any. If the forward flow flag is set for this Network Flow, both bandwidth reservation and flow switching must occur for all new receivers. If the forward flow flag is not set, only resource reservation should take place. Failure to satisfy for any one receiver should fail for all and fail the complete request. Proper error message should be provided in this scenario. No task should be completed partially, that is, server should employ all-or-nothing strategy.

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

delete

Delete the receiver with the specified ID from this Network Flow.

Network Address Translation policies

get

List Network Address Translation policies. NB: Query parameters should be implemented for all permitted resource attributes.

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

get

Get a single Network Address Translation policy

put

Create a Network Address Translation policy with the specified ID. Subsequent PUT requests should receive an error response.

patch

Update an existing Network Address Translation policy's attributes.

delete

Delete the Network Address Translation policy with the specified ID.

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

post

Add one or more receivers to this Network Address Translation policy. Receivers included in the body should be appended to the existing receivers, if any.

options

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes

delete

Delete the receiver with the specified ID from this Network Address Translation policy.