Describes how structured secrets are structured
GET/api/v2/secrets/meta
Describes how structured secrets are structured
Request
Responses
- 200
- 500
Contains the definition for the resource
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
]
]
supportedPurposes
undefined[]
required
descriptionstringrequired
purposestringrequired
requiresScopeboolean
scopeDescriptionstring
supportsScopeboolean
supportedTypes
undefined[]
required
adminbooleanrequired
Admin will be true if this secret type supports platform-wide admin workspace usage
exampleDescriptionstring
fields
undefined[]
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
{
"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
}
]
}
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
codeint32required
detailstringrequired
messagestringrequired
uristringrequired
verbstringrequired
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}