checkSecretProvider

POST

/api/v1/secret-providers/{name}/check

curl --request POST \
  --url https://example.com/api/v1/secret-providers/example/check \
  --header 'Content-Type: application/json' \
  --data '{ "ref": "example" }'

Parameters

Path Parameters

name

required

string

/^[a-z0-9][a-z0-9_-]{0,62}$/

Request Body^required

Media typeapplication/json

object

ref

required

string

>= 1 characters <= 512 characters

key

additional properties

any

Example^generated

{
  "ref": "example"
}

Responses

200

OK

Media typeapplication/json

object

message

string

status

required

string

Allowed values: ok not_found access_denied provider_error

key

additional properties

any

Example

{
  "status": "ok"
}

default

Error

Media typeapplication/json

object

error

required

object

code

required

string

details

message

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}