Skip to content

Add External Store Endpoint

POST
/user/secrets/add-external-store
 
curl --request POST \
  --url https://example.com/user/secrets/add-external-store \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-UserKey: <X-Tenzir-UserKey>' \
  --data '{ "tenant_id": "example", "type": "aws", "name": "example", "is_writable": false, "make_default": false, "options": { "additionalProperty": "example" } }'

Add a new secrets store

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
AddExternalStoreRequest
object
tenant_id
required
Tenant Id
string
type
required
StoreType
string
Allowed values: aws
name
Any of:
string
is_writable
Is Writable
boolean
make_default
Make Default
boolean
options
required
Options
object
key
additional properties
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
AddExternalStoreResponse
object
store_id
required
Store Id
string
Example generated
{
  "store_id": "example"
}

403

Section titled “403 ”

{"detail": "Invalid API Key"}

404

Section titled “404 ”

{"detail": "Tenant not found"}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}