Skip to main content
GET
/
api
/
v1
/
apps
/
{id}
/
params
Get configurable parameters for an app.
curl --request GET \
  --url https://api.rigbox.dev/api/v1/apps/{id}/params \
  --header 'Authorization: Bearer <token>'
{
  "specs": [
    {
      "key": "<string>",
      "label": "<string>",
      "default": "<string>",
      "description": "<string>",
      "group": "<string>",
      "help_url": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "order": 123,
      "required": true,
      "sensitive": true,
      "validation_pattern": "<string>"
    }
  ],
  "values": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt

Use this file to discover all available pages before exploring further.

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

Response

200 - application/json

App params

​
specs
object[]
required

The parameter schema (snapshotted at creation time).

​
values
object
required

Current values (from metadata.config). Sensitive values are masked.