List secret types

GET

/secret-types

const url = 'https://example.com/api/v1/secret-types';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/secret-types

Lists the secret_type shapes a secret can take, for the create form. Gated by secret:read.

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

secret_types

required

Array<object> | null

object

default_admin_sensitive

required

The admin_sensitive value the create form seeds for this type

boolean

display_name

required

string

fields

required

Array<object> | null

object

name

required

string

origin

required

Operator (set at creation) or lifecycle (filled by the secret’s own machinery)

string

secret

required

boolean

type

required

string

required

The secret type’s uuid, the stable handle that survives a rename

string

name

required

The kebab handle an operator reads and types; renameable

string

official

required

boolean

Example

{
  "$schema": "/api/v1/schemas/ListSecretTypesOutputBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}