Update Secret

PUT 
/vault/v1/secrets/:secret_id

Update Secret

Request

Path Parameters

secret_id Secret Idrequired

application/json

Body

required

headerobject

anyOf

HeaderDTO

nameobject

anyOf

MOD1

string

descriptionobject

anyOf

MOD1

string

secretobject
anyOf
SecretDTO
kind SecretKind (string)required
Possible values: [provider_key]
data
object
required
provider ProviderKind (string)required
Possible values: [openai, cohere, anyscale, deepinfra, alephalpha, groq, mistralai, anthropic, perplexityai, togetherai, openrouter, gemini]
key Key (string)required

Responses

200

Successful Response

application/json

Schema

Schema

header

object

required

nameobject

anyOf

MOD1

string

descriptionobject

anyOf

MOD1

string

secret

object

required

kind SecretKind (string)required

Possible values: [provider_key]

data

object

required

provider ProviderKind (string)required

Possible values: [openai, cohere, anyscale, deepinfra, alephalpha, groq, mistralai, anthropic, perplexityai, togetherai, openrouter, gemini]

key Key (string)required
id uuidrequired
lifecycleobject

anyOf

LifecycleDTO

created_at

object

anyOf

MOD1

string

updated_at

object

anyOf

MOD1

string

updated_by_id

object

anyOf

MOD1

string

Example (from schema)

{
  "header": {
    "name": "string",
    "description": "string"
  },
  "secret": {
    "kind": "provider_key",
    "data": {
      "provider": "openai",
      "key": "string"
    }
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "lifecycle": {}
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...