Docs

Create a secret

POST/v1/secrets

Request

Body

application/json

max_ttl_sinteger<int64>
namestring
project_idstring
rotationobject
- reminder_daysinteger<int64>
tiersarray[integer<int64>] or null
valuestring

Responses

Created

Body

application/json

created_atobjectrequired
idstringrequired
last_injected_atobjectrequired
max_ttl_sinteger<int64>required
namestringrequired
objectstringrequired
project_idstringrequired
rotationdictionary[string, any]required
tiersarray[integer<int64>] or nullrequired
updated_atobjectrequired
versioninteger<int64>required

Body

{
  "max_ttl_s": 0,
  "name": "string",
  "project_id": "string",
  "rotation": {
    "reminder_days": 0
  },
  "tiers": [
    0
  ],
  "value": "string"
}

Request Sample: Shell / cURL

curl --request POST \
  --url https://api.workspaces.build/v1/secrets \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json' \
  --data '{
  "max_ttl_s": 0,
  "name": "string",
  "project_id": "string",
  "rotation": {
    "reminder_days": 0
  },
  "tiers": [
    0
  ],
  "value": "string"
}'

Response Example · 201

{
  "created_at": {},
  "id": "string",
  "last_injected_at": {},
  "max_ttl_s": 0,
  "name": "string",
  "object": "string",
  "project_id": "string",
  "rotation": {
    "property1": null,
    "property2": null
  },
  "tiers": [
    0
  ],
  "updated_at": {},
  "version": 0
}