Update Secret

PUT 
/vault/v1/secrets/:secret_id

Update Secret

Request

Path Parameters

secret_id Secret Idrequired

application/json

Body

required

headerobject

anyOf

Header

nameobject

anyOf

MOD1

string

descriptionobject

anyOf

MOD1

string

secretobject

anyOf

SecretDTO

kind SecretKind (string)required

Possible values: [provider_key, custom_provider]

dataobject

required

anyOf

StandardProviderDTO

kind StandardProviderKind (string)required

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

providerobjectrequired

key Key (string)required

CustomProviderDTO

kind CustomProviderKind (string)required

Possible values: [custom, azure, bedrock, sagemaker, vertex, openai, cohere, anyscale, deepinfra, alephalpha, groq, mistralai, anthropic, perplexityai, togetherai, openrouter, gemini]

providerobjectrequired

urlobject

anyOf

MOD1

string

versionobject

anyOf

MOD1

string

keyobject

anyOf

MOD1

string

extrasobject

anyOf

modelsobject[]required

Array [

slug Slug (string)required

extrasobject

anyOf

]

provider_slugobject

anyOf

MOD1

string

model_keysobject

anyOf

MOD1

Array [

string

]

Responses

200

Successful Response

application/json

Schema

Schema

kind SecretKind (string)required

Possible values: [provider_key, custom_provider]

dataobject

required

anyOf

StandardProviderDTO

kind StandardProviderKind (string)required

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

providerobjectrequired

key Key (string)required

CustomProviderDTO

kind CustomProviderKind (string)required

Possible values: [custom, azure, bedrock, sagemaker, vertex, openai, cohere, anyscale, deepinfra, alephalpha, groq, mistralai, anthropic, perplexityai, togetherai, openrouter, gemini]

providerobjectrequired

urlobject

anyOf

MOD1

string

versionobject

anyOf

MOD1

string

keyobject

anyOf

MOD1

string

extrasobject

anyOf

modelsobject[]required

Array [

slug Slug (string)required

extrasobject

anyOf

]

provider_slugobject

anyOf

MOD1

string

model_keysobject

anyOf

MOD1

Array [

string

]

idobject

anyOf

MOD1

string

headerobjectrequired

nameobject

anyOf

MOD1

string

descriptionobject

anyOf

MOD1

string

lifecycleobject

anyOf

LifecycleDTO

created_atobject

anyOf

MOD1

string

updated_atobject

anyOf

MOD1

string

updated_by_idobject

anyOf

MOD1

string

Example (from schema)

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

422

Validation Error

application/json

Schema

Schema

detailobject[]

Array [

locobject[]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...