Create or replace a secret.

PUT

/api/v1/projects/{project}/environments/{environment}/secrets/{secret}

curl --request PUT \
  --url https://example.com/api/v1/projects/example/environments/example/secrets/example \
  --header 'Content-Type: application/json' \
  --data '{ "data": { "additionalProperty": "example" } }'

Parameters

Path Parameters

project

required

string

Project name

environment

required

string

Environment short name

secret

required

string

Secret name

Request Body^required

Media typeapplication/json

object

data

required

Key → UTF-8 value. Replaces the whole secret.

object

key

additional properties

string

Example^generated

{
  "data": {
    "additionalProperty": "example"
  }
}

Responses

200

Media typeapplication/json

object

name

required

string

keys

required

Key names only; values are never returned.

Array<string>

created_at

string | null

Example^generated

{
  "name": "example",
  "keys": [
    "example"
  ],
  "created_at": "example"
}

409

A secret with this name exists and is not managed by Kuben

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

422

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}