Developer Documentation
[[start]]
 

CradlePoint Enterprise Cloud Manager REST API Version 1 (BETA)

CradlePoint Enterprise Cloud Manager is a SaaS-type server that enables the remote management of routers. This specification describes a RESTful API that can be used by web applications to access the service.

THIS API IS IN BETA: BOTH THE API AND THIS DOCUMENTATION ARE INCOMPLETE AND SUBJECT TO CHANGE.

What is a REST API?

An API, or application programming interface, is a protocol that enables communication between different software systems. It provides the building blocks programmers need to craft applications that access the data from a software platform – in this case the data from CradlePoint Enterprise Cloud Manager.

REST, or representational state transfer, is a particular architectural style, common for Web APIs, that leverages existing technologies of the Web (e.g. HTTP, XML) to enable information access on a large scale. The REST architecture was first described by Roy Fielding in his 2000 doctoral dissertation.

A REST API is a hypertext-driven API that uses HTTP methods and follows the REST principles. The CradlePoint Enterprise Cloud Manager REST API uses the following HTTP methods: POST, GET, PUT, and DELETE.

Basics

Base URL: https://cradlepointecm.com/api/v1/ (“v1” designates version 1)

Authentication: Authentication is the means by which a request proves who it is coming from. This API uses HTTP Basic Authentication. Alternatively, a sessionid cookie (obtained during normal login to ECM) can be used for authentication.

Authorization: Authorization is the means by which the system determines that the requestor has the right to do what it is trying to do. (It assumes that the requestor has already been authenticated, see above.)

Read results are always filtered by what the requestor has permission to read. Create, update, and delete operations fail unless the requestor has the right permissions. Permissions are specific to each account and resource type.

(There is a glossary in the appendix for help with additional unfamiliar terms.)

Table of Contents

start.txt · Last modified: 2014/12/18 19:10 by jpenick
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki