Open a password-protected project

post/public/site/gate

Open a password-protected project: the password in the body; right answers return the project's markup. Rate limited; the same answer for a wrong password and an unknown project.

Before you call

Credential: Authorization: Bearer $KEY
Scope: hosting:read
Sdk: hosting.siteGate.open
Cli: hosting site gate open
Publishable: yes

Request bodyapplication/json, required

sitestring (uuid)required
pathstringrequired
At most 120 characters.
passwordstringrequired
At most 128 characters.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/public/site/gate' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "site": "string",
  "path": "string",
  "password": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown