Overview

Cloudpath uses REST API v2, which is a RESTful API designed for external consumer use. It uses Json Web Tokens for authentication, and also requires an API Key. This authentication allows for auditing, and provides greater security than only requiring an API key.

Note: Basic knowledge of REST API v2 and Json format are necessary.

Cloudpath provides REST APIs to enable integration with existing processes or third-party applications. REST APIs allow the system to actively notify external systems (outbound calls) and to be queried and manipulated by external systems (inbound calls).

REST APIs are resource-based, and support the following HTTP verbs:

GET (to get information about a resource)

POST (to create a resource)

PUT (to change the state of a resource)

DELETE (to delete a resource)

REST APIs also return errors by using HTTP return codes. Refer to Return Codes and Error Response Format.

Root URI: The root URI is in the form of:

<Cloudpath FQDN>/admin/apiv2/{APIKey}

Map

Overview