Skip to content

Share the test documentation by a public link (the token is shown once)

PUT
/v1/projects/{id}/test-docs/public-link
curl --request PUT \
--url https://beta-api.plune.ai/v1/projects/example/test-docs/public-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "password": "correct horse battery staple" }'

Freezes the pack as it is now and makes GET /public/test-docs/<token> answer it to anyone who holds the address, with no account (#2750, ADR 0082 §6, D7). The link of a run’s public report in every respect: a 256-bit token in the 201 ONCE (only its SHA-256 is kept), { expiresAt?, password? } (an hour to 30 days, 7 by default; 8-128 printable ASCII, kept as a salted scrypt hash). A live link: 200 with the state, no token; with a date or a password, 409 link_exists. An expired one is replaced. A new snapshot is a new link: revoke and make it again. The project’s owner or a manager; a paid plan (Є1): on Free with the limits enforced, 403 with feature: public_docs_link. Written to the project’s feed as the field testDocsLink, never the token. Sixty a minute.

id
required
string

The project’s id

Media type application/json
object
expiresAt

ISO 8601 with an offset; 1 hour to 30 days from now. Default: 7 days from now.

string format: date-time
password

Printable ASCII only. Optional; never returned.

string
>= 8 characters <= 128 characters
Example
{
"password": "correct horse battery staple"
}

A live link already exists: the state only, no token

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 generated
{
"enabled": true,
"paidOnly": true,
"createdAt": "2026-04-15T12:00:00Z",
"createdBy": "example",
"expiresAt": "2026-04-15T12:00:00Z",
"expired": true,
"passwordProtected": true,
"lockedUntil": "2026-04-15T12:00:00Z",
"token": "example",
"path": "example",
"url": "example"
}

Shared: the new link, with its token - this once

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": true,
"paidOnly": false,
"token": "…",
"path": "/public/test-docs/…",
"url": null,
"passwordProtected": true,
"expired": false
}

A date that is not ISO 8601 with an offset, under an hour or over 30 days away, or a password outside 8-128 printable ASCII characters

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

No / invalid token or session

A member or a reader (only the owner or a manager shares it), or a plan without the public link (feature: public_docs_link)

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

No such project, or you are not in it

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

A live link exists and the body asks for a date or a password: code: link_exists

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

The body is over 4096 bytes, or the pack is over 8 MiB as one snapshot (code: pack_too_large; export it as a file instead)

Media type application/json
object
error
required
string
Example
{
"error": "the test documentation is too large to share as one snapshot: export it as a file instead",
"code": "pack_too_large"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

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

Seconds until the window rolls over