Skip to content

Get documentation auth settings

GET
/databases/{id}/doc-settings
curl --request GET \
--url https://api.reflexdb.cloud/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/doc-settings \
--header 'Authorization: Bearer <token>'

Returns whether API documentation access requires authentication with an API key.

id
required
string format: uuid

Database ID

Default Response

Media type application/json
object
protected
required
boolean
Example generated
{
"protected": true
}

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
"error": "example",
"message": "example"
}

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
"error": "example",
"message": "example"
}