Skip to content
Relay Port

API reference

Feedback

Votes for planned platforms and modules.

GET/interest

List the planned platforms and modules you voted for

  • Session only

Your votes in this workspace, as interest keys (platform:<type> or module:<id>).

Needs a signed-in Dashboard session; API keys are refused.

Parameters

  • X-Api-Versionstringheader

    The API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.

    One of 2026-12-01

  • X-Workspace-Idstring (uuid)header

    The workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.

Responses

200OK
  • dataInterestKeysrequired

  • keysstring[]required

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable

POST/interest

Vote for a planned platform or module

  • Session only
  • Idempotency-Key

key is the interestKey of a planned platform from GET /platforms, or module:<id> of a planned module. A repeat vote answers 200 with recorded false. A key that is not planned is 422 with details.reason.

Needs a signed-in Dashboard session; API keys are refused.

Parameters

  • X-Api-Versionstringheader

    The API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.

    One of 2026-12-01

  • X-Workspace-Idstring (uuid)header

    The workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.

  • Idempotency-Keystringheader

    Repeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.

  • X-Requested-Withstringheader

    Required on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.

    One of XMLHttpRequest

Request body

  • keystringrequired

Responses

200OK. A repeat vote: nothing changed
  • dataInterestRecordrequired

  • keystringrequired

  • recordedbooleanrequired

201Created. A new vote
  • dataInterestRecordrequired

  • keystringrequired

  • recordedbooleanrequired

400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409IdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable