Adafruit IO Groups API
The Groups API from Adafruit IO — 5 operation(s) for groups.
Adafruit IO Groups API is one of 12 APIs that Adafruit IO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.
This API exposes 9 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
Requests are made against 2 base URLs: https://io.adafruit.com/api/v2, http://io.adafruit.com/api/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Adafruit IO Groups API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as X-AIO-Key (HeaderKey).
An API key is passed in the query as X-AIO-Key (QueryKey).
An API key is passed in the header as X-AIO-Signature (HeaderSignature).
By default, every request must be authenticated.
HeaderKey— The AIO Key is used to restrict or grant access to your data. The key is unique, and you can generate a key per feed, and control it in many different ways. Th…QueryKey— The AIO Key is used to restrict or grant access to your data. The key is unique, and you can generate a key per feed, and control it in many different ways. Th…HeaderSignature— The AIO Signature is an AWS inspired request signature.
Paths & Operations 9
Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Feed (19 properties), Data (12 properties), Group (6 properties), ShallowGroup (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Adafruit IO 11
Other APIs Adafruit IO publishes across the network.