Describes how structured secrets are structured

GET 
/api/v2/secrets/meta

Describes how structured secrets are structured

Request

Responses

200

Contains the definition for the resource

application/json

Schema

Schema

supportedPurposes

undefined[]

required

Array [

description stringrequired

purpose stringrequired

requiresScope boolean

scopeDescription string

supportsScope boolean

]

supportedTypes

undefined[]

required

Array [

admin booleanrequired

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

exampleDescription string

fields

undefined[]

Array [

description stringrequired

fromFile boolean

multiline boolean

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

name stringrequired

nonSensitive boolean

optional boolean

]

generic boolean

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

supportedPurposes string[]required

title stringrequired

type stringrequired

workspaced booleanrequired

Workspaced will be true if this secret type supports workspaced usage

]

Example (from schema)

{
  "supportedPurposes": [
    {
      "description": "string",
      "purpose": "string",
      "requiresScope": true,
      "scopeDescription": "string",
      "supportsScope": true
    }
  ],
  "supportedTypes": [
    {
      "admin": true,
      "exampleDescription": "string",
      "fields": [
        {
          "description": "string",
          "fromFile": true,
          "multiline": true,
          "name": "string",
          "nonSensitive": true,
          "optional": true
        }
      ],
      "generic": true,
      "supportedPurposes": [
        "string"
      ],
      "title": "string",
      "type": "string",
      "workspaced": true
    }
  ]
}

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...