Skip to content
spirby spirby docs

Overview

Spirby API 1.0.0

Section titled “Spirby API 1.0.0”

Hand-designed REST surface for Spirby. See docs/api-surface.md for the canonical endpoint inventory.

Informations

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/v1/boards
POST
/v1/boards
GET
/v1/boards/{boardId}
DELETE
/v1/boards/{boardId}
PATCH
/v1/boards/{boardId}
GET
/v1/boards/{boardId}/changelog
POST
/v1/boards/{boardId}/changelog
GET
/v1/changelog/{entryId}
DELETE
/v1/changelog/{entryId}
PATCH
/v1/changelog/{entryId}
PUT
/v1/changelog/{entryId}/linked-posts
POST
/v1/changelog/{entryId}/publish
POST
/v1/changelog/{entryId}/unpublish
GET
/v1/boards/{boardId}/posts
POST
/v1/boards/{boardId}/posts
GET
/v1/posts/{postId}
DELETE
/v1/posts/{postId}
PATCH
/v1/posts/{postId}
POST
/v1/posts/{postId}/merge
GET
/v1/boards/{boardId}/tags
POST
/v1/boards/{boardId}/tags
DELETE
/v1/tags/{tagId}
PATCH
/v1/tags/{tagId}
DELETE
/v1/comments/{commentId}
PATCH
/v1/comments/{commentId}
GET
/v1/posts/{postId}/comments
POST
/v1/posts/{postId}/comments
GET
/v1/health
GET
/v1/members
POST
/v1/posts/{postId}/votes
DELETE
/v1/posts/{postId}/votes
GET
/v1/webhooks
POST
/v1/webhooks
GET
/v1/webhooks/{webhookId}
DELETE
/v1/webhooks/{webhookId}
PATCH
/v1/webhooks/{webhookId}
GET
/v1/webhooks/{webhookId}/deliveries
POST
/v1/webhooks/{webhookId}/deliveries/{deliveryId}/replay

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

API key in the form Bearer spk_<random>. Mint a key at /app/settings/api-keys; the secret is shown once and never again.

Security scheme type: http

Bearer format: spk_...