Overview

The Microboard.Developers API uses HTTP REST APIs. It is based on the OpenAPI 3.1.0 specification.

https://api.microboard.com/api/{version}/{endpoint}

For example GET https://api.microboard.com/v1/developers/api-keys to list all keys for an API.

HTTP Methods

GET

GET methods are used for reading data. Filtering, sorting, or pagination is done via query parameters.

curl "https://api.microboard.dev/v1/developers/api-keys?keyId=key_123" \
  -H "Authorization: Bearer <ROOT_KEY>"

POST

POST methods are used for creating data. Data is passed as application/json in the request body.

curl -X POST "https://api.microboard.com/v1/developers/api-key" \
  -H "Authorization: Bearer <ROOT_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"apiId": "api_123", "name": "My Key"}'

PATCH

PATCH methods are used for updating data. Data is passed as application/json in the request body.

DELETE

DELETE methods are used for deleting data.