Skip to content

Sign in with a read key (view-only session)

POST
/auth/read-key
curl --request POST \
--url https://stats.example.com/auth/read-key \
--header 'Content-Type: application/json' \
--data '{ "key": "example" }'
Media typeapplication/json
object
key
required
string

Example generated

{
"key": "example"
}

Signed in

Key not accepted

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}

CSRF header missing

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}