Read a Vault entry API Reference

GET

/tenants/{tenant}/vault/{path}

curl --request GET \
  --url https://api.kupe.cloud/api/v1/tenants/example/vault/example \
  --header 'Authorization: <Authorization>'

Read an entry’s version and the secrets that use it. Admins can add values=true to include its values.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

path

required

string

Path in the tenant’s vault

Query Parameters

values

boolean

Include values (admin only)

Responses

200

OK

Media type application/json

object

createdAt

string

deleted

boolean

path

string

references

Array<string>

updatedAt

string

values

object

key

additional properties

string

version

integer

Example ^generated

{
  "createdAt": "example",
  "deleted": true,
  "path": "example",
  "references": [
    "example"
  ],
  "updatedAt": "example",
  "values": {
    "additionalProperty": "example"
  },
  "version": 1
}

Headers

ETag

string

KV version

400

Bad Request

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Unauthorized

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Forbidden

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Not Found

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Too Many Requests

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

503

Service Unavailable

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}