Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Secret Manager Secrets API
description: 'This API can be used to resolve secrets from references and returns its actual confidential value.
'
version: 0.0.1
contact:
name: TARDIS
email: tadis@nop.telekom.de
url: https://developer.telekom.de/
license:
name: Apache 2.0
x-api-category: TARDIS
servers:
- url: https://locahost:8080
description: For local development
tags:
- name: secrets
description: Everything regarding storing and resolving secrets
paths:
/v1/secrets:
get:
operationId: listSecrets
summary: Get one or multiple secrets
description: Get a list of secrets that are identified by the provided references in the request body
tags:
- secrets
parameters:
- $ref: '#/components/parameters/QuerySecretId'
responses:
'200':
$ref: '#/components/responses/SecretListReponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
/v1/secrets/{secretId}:
get:
operationId: getSecret
summary: Get a specific secret
description: Get a specific secret identified by its reference or ID
tags:
- secrets
parameters:
- $ref: '#/components/parameters/SecretId'
responses:
'200':
$ref: '#/components/responses/SecretResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
put:
operationId: putSecret
summary: Create or update a secret
description: Create or update a secret that is identified by its reference in the request body
tags:
- secrets
parameters:
- $ref: '#/components/parameters/SecretId'
requestBody:
$ref: '#/components/requestBodies/SecretWriteRequest'
responses:
'200':
$ref: '#/components/responses/SecretWriteResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
components:
responses:
ErrorResponse:
description: In case of any error, this object is returned
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ApiProblem'
SecretWriteResponse:
description: Successful creation or update of a secret
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/SecretRef'
SecretListReponse:
description: Successful retrieval of secrets
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
description: A list of secrets
minItems: 1
maxItems: 10
items:
$ref: '#/components/schemas/Secret'
SecretResponse:
description: Successful retrieval of secrets
content:
application/json:
schema:
$ref: '#/components/schemas/Secret'
parameters:
SecretId:
name: secretId
in: path
description: The id or reference to a secret
allowEmptyValue: false
required: true
schema:
$ref: '#/components/schemas/SecretRef'
QuerySecretId:
name: secretId
in: query
description: The id or reference to a secret
schema:
type: array
items:
$ref: '#/components/schemas/SecretRef'
schemas:
Secret:
type: object
required:
- id
- value
properties:
id:
$ref: '#/components/schemas/SecretRef'
value:
type: string
description: If empty, a random secret will be generated
SecretRef:
description: A reference to a secret
type: string
ApiProblem:
description: Based on https://www.rfc-editor.org/rfc/rfc9457.html
type: object
required:
- type
- status
- title
- detail
properties:
type:
type: string
status:
type: integer
title:
type: string
detail:
type: string
instance:
type: string
requestBodies:
SecretWriteRequest:
content:
application/json:
schema:
type: object
required:
- value
properties:
value:
description: "This is the value of the secret.\nIf set to `{{rotate}}`, the secret will be randomly generated\nand rotated. \nOtherwise, you can set any string value.\n"
example: '{{rotate}}'
type: string