Skip to main content
PATCH
/
v1
/
orgs
/
{orgId}
/
secrets
/
{secretName}
Update organization secret
curl --request PATCH \
  --url https://api.ryvn.app/v1/orgs/{orgId}/secrets/{secretName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add": {
    "clientSecret": "rotated-secret"
  },
  "remove": [
    "<string>"
  ]
}
'
{
  "name": "<string>",
  "version": 123,
  "keys": [
    "<string>"
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
orgId
string
required

The unique identifier of the organization

​
secretName
string
required

The name of the secret to operate on

Maximum string length: 63
Example:

"database-config"

Body

application/json
​
add
object
required

Map of key-value pairs to add or update. A key cannot appear here if it is also being removed with remove

Example:
{ "clientSecret": "rotated-secret" }
​
remove
string[]
required

Keys to remove. A key cannot appear here if it also appears in add.

Response

Secret updated successfully

​
name
string
required
​
version
integer
required
​
keys
string[]
required

List of keys for the secret.

​
updatedAt
string<date-time>
required
​
createdAt
string<date-time>
required