API docs by Redocly

MPP Admin API (9.0.0)

Download OpenAPI specification:Download

Support: support@onway.ch URL: https://www.onway.ch

Introduction

The MPP Admin API provides REST access to a limited set of dedicated actions. The MPP Admin API is running on port 1443.

Response codes

The API uses the following status codes:

  • The 200 (OK) status code indicates that the request has succeeded. The payload sent in a 200 response depends on the request method.

  • The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

  • The 401 (Unauthorized) status code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

  • The 403 (Forbidden) status code indicates that the server understood the request but refuses to authorize it.

  • The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists. A 404 status code does not indicate whether this lack of representation is temporary or permanent.

  • The 405 (Method Not Allowed) status indicates that the server does not support the request method for the target resource.

  • The 409 (Conflict) status indicates that a resource with the same ID or name already exists.

  • The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Authentication

To use the admin API, a security token must always be sent in the header. This token can be obtained via the authentication API.

api_header_token

Authentication token UUID

Security Scheme Type: API Key
Header parameter name: X-AUTH-TOKEN

Login and Logout

Authentication API to login and logout

Login to MPP

Request Body schema: application/json

MPP login object

username
required
string

MPP user

password
required
string

Cleartext password

Responses

Request samples

Content type
application/json
{
  • "username": "user1",
  • "password": "top-secret"
}

Response samples

Content type
application/json
{
  • "token": "112f14f5-f260-4afd-a26b-0ca8ed1885d6",
  • "username": "user1",
  • "userId": "ebb1afd2-bf30-436b-adae-59dcb67a6116",
  • "accessType": "SSH_ROOT_ACCESS",
  • "roles": [
    ],
  • "systemId": "0f0c5df2-df89-45c1-a88c-a8cab1b655d1",
  • "currentCustomerKey": "ONWAY",
  • "currentCustomerName": "onway ag"
}

Logout from MPP

Authorizations:
api_header_token

Responses

Request samples 

curl -v -H "X-AUTH-TOKEN:112f14f5-f260-4afd-a26b-0ca8ed1885d6" -H "Accept:application/json" -X GET https://mpp01.example.org:1443/api/logout

Response samples

Content type
application/json
{
  • "globalErrorsCount": 0,
  • "globalErrors": [ ],
  • "fieldErrorsCount": 1,
  • "fieldErrors": [
    ]
}

Version

MPP version information

Get current version information

Authorizations:
api_header_token

Responses

Request samples 

curl -v -i -H "X-AUTH-TOKEN:b5b3aeca-1e9d-414a-8d9d-c973424ab4eb" -H "Accept:application/json" https://mpp01.example.org:1443/api/version

Response samples

Content type
application/json
{
  • "buildDate": "2021-10-06T03:46:05Z",
  • "idAbbreviation": "4248ae8",
  • "version": "8.2.1"
}

Remote Session

Route remote session

Route remote session to another profile.

Note: This request starts an asynchronous task. A success status response code does not mean that the remote session has been found or routed, only that the request has started.

Authorizations:
api_header_token
Request Body schema: application/json

Route Session Request

macAddress
required
string

Client MAC address.

routeKey
required
string

Route key of the route authenticator.

Responses

Request samples

Content type
application/json
{
  • "macAddress": "afbecddcebfa",
  • "routeKey": "to-blocked"
}

Response samples

Content type
application/json
{
  • "globalErrorsCount": 0,
  • "globalErrors": [ ],
  • "fieldErrorsCount": 1,
  • "fieldErrors": [
    ]
}

Edit Config

Get whole MPP configuration for all customers

Authorizations:
api_header_token

Responses

Request samples 

curl -v -i -H "X-AUTH-TOKEN:112f14f5-f260-4afd-a26b-0ca8ed1885d6" -H "Accept: application/json" https://mpp01.example.org:1443/api/edit-config

Response samples

Content type
application/json
{ }

Replace whole MPP configuration for all customers

Note: This operation takes place in memory only. The configuration is neither saved nor activated. Use Save and activate current config to do that.

Authorizations:
api_header_token
Request Body schema: application/json
object (Config)

Whole MPP configuration object for all customers

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "globalErrorsCount": 0,
  • "globalErrors": [ ],
  • "fieldErrorsCount": 1,
  • "fieldErrors": [
    ]
}

Manage Config

Save and activate current config

Note: This request starts an asynchronous task. A success status response code does not mean that the configuration has been applied, only that the task has started. The task status can be polled via Get manage config task status.

Authorizations:
api_header_token
Request Body schema: application/json

Config description

description
required
string

description of the config revision

Responses

Request samples

Content type
application/json
{
  • "description": "Test config save"
}

Response samples

Content type
application/json
{
  • "globalErrorsCount": 0,
  • "globalErrors": [ ],
  • "fieldErrorsCount": 1,
  • "fieldErrors": [
    ]
}

Get manage config task status

Authorizations:
api_header_token

Responses

Request samples 

curl -v -i -H "X-AUTH-TOKEN:112f14f5-f260-4afd-a26b-0ca8ed1885d6" -H "Accept:application/json" https://mpp01.example.org:1443/api/admin/manage-config

Response samples

Content type
application/json
{
  • "taskId": "0d54e145-d2a4-45bc-8b7d-c69f09293010",
  • "comment": "No changes",
  • "commitId": "HEAD",
  • "peerId": "HEAD",
  • "state": "EMPTY_COMMIT"
}