How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adafruit IO Dashboards API

The Dashboards API from Adafruit IO — 2 operation(s) for dashboards.

Adafruit IO Dashboards 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 Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 6 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.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.

6 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://io.adafruit.com/api/v2
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Adafruit IO Dashboards 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 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Dashboards 6
GET
/{username}/dashboards
All dashboards for current user
allDashboards 1 param → 200401403404500
POST
/{username}/dashboards
Create a new Dashboard
createDashboard 1 param body → 200401403404500
GET
/{username}/dashboards/{id}
Returns Dashboard based on ID
getDashboard 2 params → 200401403404500
PUT
/{username}/dashboards/{id}
Replace an existing Dashboard
replaceDashboard 2 params body → 200401403404500
PATCH
/{username}/dashboards/{id}
Update properties of an existing Dashboard
updateDashboard 2 params body → 200401403404500
DELETE
/{username}/dashboards/{id}
Delete an existing Dashboard
destroyDashboard 2 params → 200401403404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Feed (19 properties), Data (12 properties), Block (9 properties), Group (6 properties). Each schema is shown below with its type and property counts.

BlockFeed
object
3 properties
Block
object
9 properties
ShallowGroup
object
5 properties
Dashboard
object
4 properties
Group
object
6 properties
Feed
object
19 properties
Data
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adafruit-io-dashboards-api-openapi.yml Raw ↑

Other APIs Adafruit IO publishes across the network.

Adafruit IO MQTT API
Adafruit IO Activities API
Adafruit IO Blocks API
Adafruit IO Data API
Adafruit IO Feeds API
Adafruit IO Groups API
Adafruit IO Permissions API
Adafruit IO Tokens API
Adafruit IO Triggers API
Adafruit IO Users API
Adafruit IO Webhooks API
Where this information came from

This is an independent, third-party profile of Adafruit IO Dashboards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.