Skip to content

The public link of the test documentation

GET
/v1/projects/{id}/test-docs/public-link
curl --request GET \
--url https://beta-api.plune.ai/v1/projects/example/test-docs/public-link \
--header 'Authorization: Bearer <token>'

Whether the pack is shared by a public link (#2750, ADR 0082 §6; D7), when it ends, whether it has a password, and paidOnly for a plan without it. Never the token. Anyone in the project, a reader too.

id
required
string

The project’s id

The state

Media type application/json

The public link of the test documentation (#2750), never its token. paidOnly: the project’s plan has no public link (ADR 0082 Є1) and the limits are enforced - the panel shows the switch off with Upgrade

object
enabled
required
boolean
paidOnly
required
boolean
createdAt

Only when enabled

string format: date-time
createdBy

The id of the person who made it. Only when enabled

string
expiresAt

When the link stops answering. Only when enabled

string format: date-time
expired

The address answers 410, and PUT makes a new link. Only when enabled

boolean
passwordProtected

Only when enabled

boolean
lockedUntil

Set while wrong passwords lock the address (10 in 15 minutes). Only when enabled

string format: date-time
nullable
token

In the 201 of PUT only, ONCE: the server keeps only its hash

string
path

In the 201 only: /public/test-docs/<token>

string
url

In the 201 only: the whole link when the server knows the dashboard’s address

string
nullable
Example
{
"enabled": false,
"paidOnly": false
}

No / invalid token or session

No such project, or you are not in it

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