Open a dashboard sign in link

POST

/v1/dashboard/login/confirm

• Bookrail cloud.
• A local `pnpm dev`, on the default `PORT`.

Turns the token of the link into a session of twelve hours, absolute, with no renewal. The session token is in this answer and nowhere else. A link works once. No API key.

Request Body ^required

object

token

required

The token from the dashboard link, taken out of its #token= fragment.

string

>= 16 characters <= 200 characters

Responses

200

Success.

object

object

required

string

Allowed values: dashboard_session

session_token

required

The session, bds_..., in clear text and only here. Send it as Authorization: Bearer bds_... to the other dashboard operations. Stored as a SHA-256 hash.

string

Example

bds_...

expires_at

required

Twelve hours after the link was opened. Nothing renews it.

string format: date-time

Example

2026-09-08T07:00:00Z

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

400

Error codes: invalid_body, parameter_invalid, parameter_missing, unsupported_api_version.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

404

Error codes: dashboard_login_not_found.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

409

Error codes: dashboard_login_used.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

410

Error codes: dashboard_login_expired.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

500

Error codes: internal_error.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.