Skip to main content
POST
/
secrets
Create a new secret entry in the DB. These are typically used/needed to access datasets in protected cloud storage.
curl --request POST \
  --url https://api.example.com/secrets/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "data": "<string>",
  "secret_type": "plain-text",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organisation_id": "<string>",
  "secret_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Api-key
string | null

Body

application/json
​
name
string
required
​
data
string
required
​
secret_type
enum<string>
required
Available options:
plain-text,
plain-json,
client-id-secret,
token,
username-password,
google-cloud:service-account-key,
aws:access-keys,
azure:storage-account,
salesforce:client-credential,
sharepoint:client-secret
​
description
string | null

Response

The new secret entry just created

​
id
string<uuid>
required
​
name
string
required
​
organisation_id
string
required
​
secret_type
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null