AMamika
Hosts

Register an organization host

Changed on

Idempotent by hostname: registering a hostname the organization already has returns that host with 200 and leaves its stored secret and sizes unchanged. Use PUT to rotate the secret or replace the sizes.

post/api/v0beta1/hosts

Request

  • Base URL
    https://app.amika.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://app.amika.dev/api/v0beta1/hosts
  • Auth
    • HTTP bearer
    • or API key in cookie wos-session

Request body

hostnamestring required
urlstring uri nullable
secretstring required
sizesobject
transport_mode'listen' | 'tunnel'

Response

Host already registered. The secret value is never returned.

idstring required
hostnamestring required
urlstring nullable required
org_idstring required
sizesobject required
transport_mode'listen' | 'tunnel' required

Changes

  • c46868fd7b41Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • a122301d00e0Revision changes
    • breaking

      added the pattern ^[\x21-\x7e]{32,}$ to the request property

    • info

      the request property's minLength was decreased from 1 to 0