Overview

The documentation pages in this section describe the RESTful APIs included with NetProfiler products. It is assumed that the reader has practical knowledge of RESTful APIs, so the documentation does not go into detail about what REST is and how to use it. Instead the documentation focuses on what operations can be performed.

The following operations can be performed via the API:

Get Status of device
Start Reinstall process

Details about REST resources can be found in the Resources section. This overview continues with how to run these API's.

Authentication

All REST requests must be authenticated. The Authentication section of the Common API describes which authentication methods are presently supported.

Resources

Reinstall: Reinstall Status

Get the status of Device.

GET https://{device}/api/mgmt.reinstall/1.0/reinstall

Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

JSON

{
}

Example:
{}

{
}

Example:
{}

Property Name	Type	Description	Notes
status	<object>	A response means device is up and running.

Reinstall: Start Reinstall

Start the reinstall on the system.

POST https://{device}/api/mgmt.reinstall/1.0/reinstall

Authorization

This request requires authorization.

Request Body

Do not provide a request body.

Response Body

On success, the server returns a response body with the following structure:

JSON

{
}

Example:
{}

{
}

Example:
{}

Property Name	Type	Description	Notes
status	<object>	A successfull operation return empty JSON response.

Error Codes

In the event that an error occurs while processing a request, the server will respond with appropriate HTTP status code and additional information in the response body:

{
     "error_id":   "{error identifier}",
     "error_text": "{error description}",
     "error_info": {error specific data structure, optional}
}

The table below lists the possible errors and the associated HTTP status codes that may returned.

Error ID	HTTP Status	Comments
BAD_REQUEST	400	Invalid argument.
AUTH_REQUIRED	401	Authentication required.
AUTH_INVALID_CREDENTIALS	401	Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.
HTTP_INVALID_METHOD	405	Requested method is not available for this resource.
INTERNAL_ERROR	500	Internal error.