Download OpenAPI specification:Download
The MPP Client API provides REST access to a limited set of dedicated actions.
Requests are logged in a separate log file (/var/log/mpp/api.log).
The API uses only the following status codes:
The 200 (OK) status code indicates that the request has succeeded.
The 201 (Created) status code indicates that the request has been fulfilled and has resulted in one or more
new resources being created.
The 204 (No Content) status code indicates that the server has successfully fulfilled the request and that
there is no additional content to send in the response payload body.
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 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 409 (Conflict) status code indicates that the request could not be completed due to a conflict with the
current state of the target resource. This code is used in situations where the user might be able to resolve
the conflict and resubmit the request.
The 429 (Too Many Requests) status code indicates that the user has sent too many requests in a given amount
of time ("rate limiting").
The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition
that prevented it from fulfilling the request.
The 503 (Service Unavailable) status code indicates that the server is not responsible for client processing.
(e.g. maintenance or backup mode)
| customer-key required | string Key of the customer |
| mac required | string Client MAC address with or without any delimiter |
| site-id | string Site id to limit the request to a single site. If not provided, the result will include information from all sites. |
curl -v "https://mpp01.example.org/device/information?customer-key=MPP&mac=320013edc120"
{- "groupKey": "SRU",
- "marks": [
- {
- "createdAt": "2011-12-03T10:15:30Z",
- "mark": "First class",
- "siteId": "eaed12a4-c34f-4473-a9af-74fca9b9642f",
- "siteName": "Zurich"
}
]
}Route MPP session object
| mac | string Client MAC address with optional delimiter. Either Mac or Ip must be present. |
| ip | string Client service IP address. Either Ip or Mac is must be present. |
| key required | string Route key |
{- "mac": "11:22:33:44:55:66",
- "ip": "192.168.1.100",
- "key": "quarantine"
}Start MPP session object
| mac required | string Client MAC address without or with any delimiter |
| ip required | string Dotted-decimal formatted client IP address |
| hostname | string Client hostname |
{- "mac": "112233445566 or 11:22:33:44:55:66",
- "ip": "203.0.113.123",
- "hostname": "My iPhone"
}