Introduction to the API

The VMware Pulse IoT Center API offers a way for third-party systems to interact with VMware Pulse IoT Center.

VMware Pulse IoT Center provides programmable REST APIs to integrate with your existing enterprise solution. With the VMware Pulse IoT Center APIs, you can create, view, edit, and delete various VMware Pulse IoT Center entities such as Devices, Campaigns, Alerts, Notifications, Groups, and Users, programmatically. All the core features of the VMware Pulse IoT Center provide REST APIs.

Terminology

This document uses the following terms.

API

API is an acronym for Application Programming Interface. It is a name used to refer to a special framework some web applications or services provide which allows a user to connect to the system and perform some number of discrete actions such as running functions, requesting data, or updating information.

Call

A call is another name for a request or a communication sent by a user to the API, in the form of a URL string, which invokes a specific action on one particular endpoint, and can also include additional parameters or values.

HTTP

HTTP is an acronym for Hyper-Text Transport Protocol. It is one of the key architectural components behind how web-based content on the Internet is accessed through web browsers.

JSON

JSON is an acronym for JavaScript Object Notation. It is a format for information, based on the JavaScript language, that is intended for consumption by a programmed function.

Method

HTTP provides support for four methods which each describe a type of result a user might want to achieve through a given communication with a web server or API. The four methods are: GET (for retrieving data), PUT (for inserting data), POST (for updating data), and DELETE (for removing data).

GET

GET is one of the four HTTP methods used for retrieving or querying records from a system.

PUT

PUT is one of the four HTTP methods used for inserting or creating records into a system.

POST

POST is one of the four HTTP methods used for updating existing records in a system.

DELETE

DELETE is one of the four HTTP methods used for removing records from a system.

REST

REST is an acronym for Representational State Transfer. It is a form of software architecture that is primarily used for designing a web service.

Note: The required permissions that are listed for each API are for invoking the API operation. Some APIs require additional permissions to complete the operation.