Skip to main content

ProjectConfigurationField

namestringrequired

Possible values: Value must match regular expression ^[A-Za-z_][A-Za-z0-9_.-]{0,199}$

typestringrequired

Possible values: [string, number, boolean, json, file]

labelstring
descriptionstring
defaultValue

Native JSON default. Never store real secrets in source declarations.

requiredboolean
secretboolean
multipleboolean

String arrays for string fields; up to 32 server file references for file fields.

controlstring

Possible values: [text, textarea, select, radio, checkboxes]

acceptstring[]

File fields only. Accepted MIME types or extensions. Files upload through POST /api/projects/{projectId}/configurations/files and values contain server metadata, never file bytes.

options object[]
  • Array [
  • valuestringrequired
    labelstring
  • ]
  • sharing object
    publishboolean
    Default value: true
    includeValueboolean
    Default value: false
    editableboolean
    Default value: true
    paths object

    JSON Pointer rules, inherited from the parent with more specific rules taking precedence. Excluding the whole field excludes every descendant.

    property name* ConfigurationSharingRule
    publishboolean
    Default value: true
    includeValueboolean
    Default value: false
    editableboolean
    Default value: true
    omittedPathsstring[]

    Generated opaque deny hashes for omitted JSON paths, without private path names.

    Possible values: Value must match regular expression ^[a-f0-9]{64}$

    ProjectConfigurationField
    {
    "name": "string",
    "type": "string",
    "label": "string",
    "description": "string",
    "required": true,
    "secret": true,
    "multiple": true,
    "control": "text",
    "accept": [
    "string"
    ],
    "options": [
    {
    "value": "string",
    "label": "string"
    }
    ],
    "sharing": {
    "publish": true,
    "includeValue": false,
    "editable": true
    },
    "paths": {},
    "omittedPaths": [
    "string"
    ]
    }