How to use the Public API
- 30 Oct 2023
- 1 Minute to read
- Contributors
How to use the Public API
- Updated on 30 Oct 2023
- 1 Minute to read
- Contributors
Article Summary
Share feedback
Thanks for sharing your feedback!
This article describes how to access the complete documentation for the Perimeter 81 Public API (v2).
Authorize via Access Token
- Performing actions using the Perimeter81 API is only allowed after authorizing an Access Token via the Workspace API Key.
OpenAPI
- This API version fully aligns with OpenAPI standards.
This feature is being Beta tested.
- This version of the API (v2) is in beta, some features may be subject to change, and not all features may be available at this time.
- Approved beta testers may deliver feedback and suggestions on improving the API.
API Endpoints
The Perimeter 81 Public API allows you to programmatically create and manage the following classes within the Perimeter 81 platform:
- Networks
- Gateways
- Regions
- Users
- Groups
- Tunnels
SwaggerHub
Our documentation is hosted in SwaggerHub: Use this link to access it.
This documentation provides the following:
- A detailed description of the available endpoints and services.
- A schema containing available requests and responses.
Swaggerhub also allows you to:
- Try the API.
- Export configurations.
- Generate SDKs.
Was this article helpful?