Skip to main content

Describes how structured secrets are structured

GET 

/api/v2/secrets/meta

Describes how structured secrets are structured

Request

Responses

Contains the definition for the resource

Schema

    supportedPurposes

    undefined[]

    required

  • Array [

  • descriptionstringrequired
    purposestringrequired
    requiresScopeboolean
    scopeDescriptionstring
    supportsScopeboolean
  • ]

  • supportedTypes

    undefined[]

    required

  • Array [

  • adminbooleanrequired

    Admin will be true if this secret type supports platform-wide admin workspace usage

    exampleDescriptionstring

    fields

    undefined[]

  • Array [

  • descriptionstringrequired
    fromFileboolean
    multilineboolean

    Multiline is true when this field typically contains a multi-line string (such as a GCP JSON Service Account key)

    namestringrequired
    nonSensitiveboolean
    optionalboolean
  • ]

  • genericboolean

    Generic indicates that this secret type allows any generic key=value fields to be supplied.

    supportedPurposesstring[]required
    titlestringrequired
    typestringrequired
    workspacedbooleanrequired

    Workspaced will be true if this secret type supports workspaced usage

  • ]