Getting started
Introduction to the Partner API — authentication, capabilities, conventions, and data type formats.
The Partner API lets you integrate your own systems with Peplink. It is organized around REST, uses Bearer authentication, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.
Authentication
Peplink Portal API uses Bearer authentication. Create an API key to represent your partner account, then submit it as an HTTP header on every request:
Authorization: Bearer <api-key-token>
See the Partner API guide for how to create, view, and revoke API keys from the API Keys page.
Capabilities
Some endpoints require your API key to have a specific capability assigned. Where that applies, the endpoint's Required Capabilities section lists exactly what's needed — make sure your API key has it assigned before calling that endpoint.
Request path
Every API request starts with the same URL prefix:
https://portal.peplink.com/api/e/v1/cpEach endpoint's own documentation shows the path to append to it, right below its title — for example, Retrieve account information shows:
GET /partnerAppend that path to the URL prefix to get the full request URL:
GET https://portal.peplink.com/api/e/v1/cp/partnerQuery parameter conventions
These conventions apply to query parameters across all endpoints.
Pagination
Search and list endpoints accept pageNum and pageSize query parameters. Unless an endpoint's documentation says otherwise, pageNum defaults to 1 and pageSize defaults to 10 with an allowed range of 1–100.
Array values
A query parameter marked array accepts multiple values as a single comma-separated string:
https://portal.peplink.com/api/e/v1/cp/sims/search?tagIds=101,102,103Nullable values
A query parameter marked nullable can be explicitly set to null by passing it with an empty value. Omitting the parameter entirely leaves it unfiltered, which is not the same as explicitly setting it to null:
https://portal.peplink.com/api/e/v1/cp/sims/search?fieldName=Data Type Formats
Here describes the formats of common data types used in API.
| Type | Format | Example |
|---|---|---|
| Date String | yyyy-MM-dd | 2024-09-23 |
| Datetime String | yyyy-MM-dd'T'HH:mm:ss.SSSZ | 2024-09-19T08:02.000Z |
Response format and errors
- Successful requests return
200with a JSON body, or204with no body. - Failed requests return a
4xxor5xxstatus code with a JSON error body. See Errors for the format and all error types. - Each endpoint's Response section lists the status codes it can return.