Peplink Portal Docs

Overview

Starlink APIs are exclusive for the Authorized Peplink & Starlink Solution Providers (ASPs).

To access Starlink APIs, you need to create API keys and define the appropriate capabilities for the API keys.

Note

Only Starlink Admin is allowed to create API keys with Starlink capabilities.

Create API key with capabilities

Capabilities

Capabilities determine the level of access and permissions for the API keys:

CapabilityDescription
Starlink AdminIncludes all Manager and Viewer permissions. Grants full control to configure system-level settings, manage workflows, and assign Starlink capabilities to other members.
Starlink ManagerIncludes all Viewer permissions. Grants operational access to create, edit, and process all Starlink records. Cannot modify system configurations or assign member capabilities.
Starlink ViewerBase level access. Grants read-only access to view and search Starlink records and configurations. Cannot make any changes.

Different Starlink API requires different capabilities

Each Starlink API specifies the required capability in the documentation. Make sure to assign the appropriate capability to your API key to access the API successfully.

On this page