Skip to content
Sluice

putGlobalSecret

PUT
/api/v1/secrets/{key}
curl --request PUT \
  --url https://example.com/api/v1/secrets/example \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "provider": "example", "ref": "example", "value": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
key
required
string
/^[A-Za-z_][A-Za-z0-9_]{0,127}$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
description
string
<= 500 characters
provider

Provider name. Default builtin, or the provider of the existing secret.

string
<= 63 characters
ref

Reference of an external secret, for example path#field for vault.

string
<= 512 characters
value

Value of a builtin secret. Write-only.

string
>= 1 characters <= 65536 characters
key
additional properties
any
Examplegenerated
{
  "description": "example",
  "provider": "example",
  "ref": "example",
  "value": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
description
required
string
inherited
required

True when a parent namespace or the global scope defines the secret.

boolean
key
required
string
last_resolved_at
string | null format: date-time
provider
required
string
provider_type
required
string
Allowed values: builtin env kubernetes azure_key_vault vault
ref

Reference of an external secret. Builtin secrets have none.

string
scope
required

Global or the namespace name that defines the secret.

string
updated_at
required
string format: date-time
updated_by
required
string
key
additional properties
any
Example
{
  "provider_type": "builtin"
}

default

Section titled “default”

Error

Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}