SUsupercheck-io
Variables

Update a variable

Changed on

Update an existing text or secret variable's key, value, secret flag, or description. File-type variables must be managed through the project UI upload workflow.

put/api/variables/{id}

Request

  • Base URL
    https://demo.supercheck.dev
  • Auth
    HTTP bearer

Request body

keystring

Uppercase letters, digits, and underscores only; cannot use the SUPERCHECK_ prefix or reserved system names.

valuestring
isSecretboolean
descriptionstring

Response

Variable updated

idstring uuid
projectIdstring uuid
keystring

Variable key. Uppercase letters, digits, and underscores only; 4-20 characters; must not use the SUPERCHECK_ prefix or a reserved name (for example PATH, HOME).

type'variable' | 'secret' | 'file'

Variable type. File variables expose metadata in API responses; file contents are not returned.

valuestring

Plaintext for regular variables, redacted for secrets, and empty for file variables

isSecretboolean
descriptionstring nullable
createdByNamestring nullable
createdByImagestring nullable
fileNamestring nullable
fileSizeinteger nullable
mimeTypestring nullable
createdAtstring date-time
updatedAtstring date-time nullable

Changes

  • 4531981d91c6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • bfc5fb32bad1Revision changes
    • breaking

      the request property's minLength was increased from 0 to 4

    • breaking

      added the pattern ^[A-Z][A-Z0-9_]*$ to the request property

    • warning

      the request property's maxLength was set to 20

    • warning

      the request property's maxLength was set to 10000