Overview

Resources

Keepalive: Keep session alive

Keep session alive.

GET https://{device}/api/cascade.aaa/1.0/keepalive

Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Npm_Token: Get NPM token

Get NPM token.

GET https://{device}/api/cascade.aaa/1.0/npm_token

Authorization

This request requires authorization.

Response Body

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

JSON

{
  "expires_at": number,
  "token_type": string,
  "access_token": string
}

{
  "expires_at": number,
  "token_type": string,
  "access_token": string
}

Property Name	Type	Description
NpmToken	<object>	NPM token object.
NpmToken.expires_at	<number>	[Missing resource 'NpmToken.expires_at' in bundle 'rest_schemas']
NpmToken.token_type	<string>	[Missing resource 'NpmToken.token_type' in bundle 'rest_schemas']
NpmToken.access_token	<string>	[Missing resource 'NpmToken.access_token' in bundle 'rest_schemas']

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
INTERNAL_ERROR	500	Internal server error.
AUTH_REQUIRED	401	The requested resource requires authentication.
AUTH_INVALID_CREDENTIALS	401	Invalid username and/or password.
AUTH_INVALID_SESSION	401	Session ID is invalid.
AUTH_EXPIRED_PASSWORD	403	The password must be changed. Access only to password change resources.
AUTH_DISABLED_ACCOUNT	403	Account is either temporarily or permanently disabled.
AUTH_FORBIDDEN	403	User is not authorized to access the requested resource.
AUTH_INVALID_TOKEN	401	OAuth access token is invalid.
AUTH_EXPIRED_TOKEN	401	OAuth access token is expired.
AUTH_INVALID_CODE	401	OAuth access code is invalid.
AUTH_EXPIRED_CODE	401	OAuth access code is expired.
RESOURCE_NOT_FOUND	404	Requested resource was not found.
HTTP_INVALID_METHOD	405	Requested method is not available for this resource.
HTTP_INVALID_HEADER	400	An HTTP header was malformed.
REQUEST_INVALID_INPUT	400	Malformed input structure.
URI_INVALID_PARAMETER	400	URI parameter is not supported or malformed.
URI_MISSING_PARAMETER	400	Missing required parameter.