Variables

Retrieve a single variable. Secret values are redacted, and file-type variables return metadata rather than file contents.

get/api/variables/{id}

Request

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

Response

Variable details

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property pattern ^[A-Z][A-Z0-9_]*$ was added for the status