What's on this page

Resource Packages

The following section details the APIs used to manage Resource packages intended for the Brent (carrier-grade Resource Manager included with TNC-O).

Associated with each definition are details of the request parameters and responses. These include the name of each field plus a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied.

For a 40x, 50x or any other error response please see error response codes

Onboard Resource Package

Adds a new Resource package to Brent

Request

AspectValue
Endpoint URL/api/resource-manager/resource-packages
Content-Type:multipart/form-data
HTTP MethodPOST

Form Data

FieldDescriptionMandatory
fileThe Resource package fileYes

Response

AspectValue
Content-Typeapplication/json
Success Status Code201

Headers

FieldDescription
locationEndpoint to Resource package

Update Resource Package

Update an existing Resource package with new content

Request

AspectValue
Endpoint URL/api/resource-manager/resource-packages/{name}
Content-Type:multipart/form-data
HTTP MethodPUT

Query Parameters

FieldDescriptionMandatory
nameName of the existing Resource packageYes

Form Data

FieldDescriptionMandatory
fileThe Resource package fileYes

Response

AspectValue
Content-Typeapplication/json
Success Status Code200

Remove Resource Package

Remove an existing Resource package

Request

AspectValue
Endpoint URL/api/resource-manager/resource-packages/{name}
HTTP MethodDELETE

Path Parameters:

FieldDescriptionMandatory
nameName of the existing Resource packageYes

Response

AspectValue
Content-Typeapplication/json
Success Status Code204