AMamika
Sandboxes

Create a live service on a sandbox

Changed on
post/api/v0beta1/rigs/{id}/services

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/rigs/{id}/services
  • Auth
    • HTTP bearer
    • or API key in cookie wos-session

Path parameters

idstring required

Query parameters

sandbox_by'name' | 'id' | 'ref' | 'name_or_id'

How to interpret the sandbox {id} path param: ref/name_or_id (default; matches an id or a name and rejects an ambiguous match with 409 resource_ref_ambiguous), name, or id.

Request body

namestring required

Service name: a single DNS label, unique per sandbox.

portinteger required

Container port the service listens on.

url_scheme'http' | 'https' required

URL scheme the gateway serves the service over.

Response

Service created.

idstring nullable required
sandbox_idstring required
namestring required
portinteger required
url_scheme'http' | 'https' | 'null' nullable required
protocolstring required
urlstring nullable required
host_portinteger nullable required
source'table' | 'legacy' required
kind'system' | 'user' required

Changes