> ## 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.

# Get App Parameters

> Get the configurable parameters for an app.



## OpenAPI

````yaml GET /api/v1/apps/{id}/params
openapi: 3.1.0
info:
  title: Rigbox Public API
  description: >-
    Gateway-owned public API for Rigbox. The gateway composes its local
    lifecycle API with service-owned exported specs.
  contact:
    name: Rigbox
    url: https://rigbox.dev
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.rigbox.dev
    description: Production gateway
security: []
tags:
  - name: Workspaces
  - name: CLI
  - name: Observability
  - name: Auth
  - name: API Keys
  - name: Access Control
  - name: Apps
  - name: App Catalog
  - name: Logs
  - name: AI
  - name: Tools
  - name: Snapshots
  - name: SSH Keys
  - name: Templates
  - name: Setup Scripts
  - name: Service Specs
  - name: Deploy
  - name: Community
  - name: User Settings
  - name: Roadmap
  - name: System
paths:
  /api/v1/apps/{id}/params:
    get:
      tags:
        - Apps
      summary: Get configurable parameters for an app.
      description: Get the configurable parameter specs and current values for an app.
      operationId: get_app_params
      parameters:
        - name: id
          in: path
          description: App ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: App params
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppParamsResponse'
      security:
        - bearer: []
components:
  schemas:
    AppParamsResponse:
      type: object
      required:
        - specs
        - values
      properties:
        specs:
          type: array
          items:
            $ref: '#/components/schemas/ParamSpec'
          description: The parameter schema (snapshotted at creation time).
        values:
          type: object
          description: Current values (from metadata.config). Sensitive values are masked.
          additionalProperties:
            type: string
          propertyNames:
            type: string
    ParamSpec:
      type: object
      description: >-
        One configurable parameter declared by a template expected app or
        catalog item.


        The `key` is used as the `{PARAM_<KEY>}` placeholder (upper-cased) in

        install scripts, exec_start, and config_file JSON values.
      required:
        - key
        - label
        - param_type
      properties:
        default:
          type: string
          description: Pre-filled value (empty string = no default).
        description:
          type: string
          description: Longer description / hint text shown below the field.
        group:
          type:
            - string
            - 'null'
          description: Visual group header for related params.
        help_url:
          type:
            - string
            - 'null'
          description: Help URL (e.g. docs for getting an API key).
        key:
          type: string
          description: Machine key, e.g. `"telegram_bot_token"`.
        label:
          type: string
          description: Human-readable label for the UI.
        options:
          type: array
          items:
            $ref: '#/components/schemas/ParamOption'
          description: Selectable options for `ParamType::Select`.
        order:
          type: integer
          format: int32
          description: Display order within the group (lower = higher).
        param_type:
          $ref: '#/components/schemas/ParamType'
          description: Determines the UI element and basic validation.
        required:
          type: boolean
          description: If true, deploy is blocked when the value is empty.
        sensitive:
          type: boolean
          description: If true, render as password field and mask in API responses.
        validation_pattern:
          type:
            - string
            - 'null'
          description: Optional regex the submitted value must match.
    ParamOption:
      type: object
      description: A selectable option for `ParamType::Select` fields.
      required:
        - value
        - label
      properties:
        label:
          type: string
        value:
          type: string
    ParamType:
      type: string
      description: Data type for validation + UI element selection.
      enum:
        - string
        - secret
        - email
        - url
        - number
        - boolean
        - select
        - textarea
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````