Creating an API Key

For Cloudpath to honor inbound requests from external systems, the external system must authenticate using an API key. The API key is part of the REST API query used to retrieve information from the Cloudpath system. Authentication is a combination of this API key and an authentication with the Token API. To create an API Key, perform the following steps:

More info about the token is in Security section.
  1. Go to Configuration > API Keys.
  2. Click Add API Key.

Create API Key

Cloudpath provides a generated APIKey, or you can specify a custom key. An API key must be URL-safe.

The Allowed Path Regex is a regex specifying the paths allowed to be called with this API key. For example,/admin/api/.*/certificate/.* can query anything in the 'certificate' realm. If left blank, there is no restriction.

For the Expiration Date, the Cloudpath system defaults to a one-year expiration, but this value can be modified.

Parent topic: Cloudpath REST API Basics