Skip to content
Olivares AI docs

Create or update a sealed secret

PUT
/v1/console/secrets
 
curl --request PUT \
  --url 'https://example.com/v1/console/secrets?scope=tenant' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "name": "example", "value": "example" }'

Creates or rotates a sealed secret using its name in the body. Omitted scope requires global superadmin; explicit scope=tenant admits any unconfined member of the tenant: its admins reach mcp/, env/ and credential/ names, and every member only their own vault// items, which are JSON item documents (login, note or totp) whose kind is the listed hint. Writes require AAL3.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
scope
string
Allowed values: tenant

Omit for superadmin global secrets; tenant selects the tenant’s own names: mcp/, env/ and credential/ for tenant admins, and every member’s personal vault// items for that member alone. Writes require the deployment’s step-up in either scope.

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant in explicit tenant mode.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
description
string
name
required
string
value
required
string format: password
Example generated 
{
  "description": "example",
  "name": "example",
  "value": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
action
string
name
string
Example generated 
{
  "action": "example",
  "name": "example"
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}