Skip to main content
PATCH
/
api
/
apps
/
{id}
Update an app.
curl --request PATCH \
  --url https://api.rigbox.dev/api/apps/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowed_emails": [
    "<string>"
  ],
  "description": "<string>",
  "metadata": "<unknown>",
  "name": "<string>",
  "port": 1,
  "status": "<string>",
  "visibility": "private"
}
'
{
  "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.

Path Parameters

id
string
required

App ID

Body

application/json
allowed_emails
string[] | null
description
string | null
metadata
any
name
string | null
port
integer<int32> | null
Required range: x >= 0
status
string | null

Toggle status: "active" or "inactive"

visibility
null | enum<string>
Available options:
private,
public,
privileged

Response

App updated

app
object
required