Skip to main content
POST
/
api
/
apps
Create a new app.
curl --request POST \
  --url https://api.rigbox.dev/api/apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "workspace_id": "<string>",
  "description": "<string>",
  "metadata": "<unknown>",
  "port": 1,
  "protocol": "<string>"
}
'
{
  "app": {
    "allowed_emails": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "node_id": "<string>",
    "port": 1,
    "status": "active",
    "subdomain": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "visibility": "private",
    "workspace_id": "<string>",
    "description": "<string>",
    "managed": true,
    "metadata": "<unknown>",
    "protocol": "<string>",
    "system_tags": [
      "<string>"
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
workspace_id
string
required
description
string | null
metadata
any
port
integer<int32>
Required range: x >= 0
protocol
string | null

Response

App created

app
object
required