Documentation

Overview

Use the service

Billing

Reference

Reference

DELETE /sessions/{sessionId}

Release a browser session: stop its meter and remove the browser.

Syntax

DELETE https://grid-lab.zyxio.xyz/sessions/<sessionId>
x-api-key: <key>

Request

NameWhereRequiredMeaning
x-api-keyheaderyes, or AuthorizationYour API key, or Authorization: Bearer <token> from Zyxio sign-in.
sessionIdpathyesThe id from POST /sessions.

No body.

Response

204 No Content. The session is gone; its cdpUrl stops working.

Errors

StatusBodyWhenWhat to do
401{"error": "unauthorized"}No credential, or a key that is revoked, expired, wrong, or of a suspended account.Send a valid key.
503{"error": "accounting_unavailable"}Your key or Zyxio sign-in could not be checked because the account database did not answer in time. Nothing was done.Retry shortly; the same request is safe to resend.
403{"error": "forbidden"}A valid Zyxio sign-in token whose identity has no account here, or whose account is suspended.Accept your invitation first, or use a key.
404{"error": "unknown session"}No such session, it has already ended, or it belongs to another identity.Nothing to release.
503{"error": "sessions disabled"}Sessions are switched off on the grid.Try again later.

Example

curl -s -o /dev/null -w '%{http_code}\n' -X DELETE \
  https://grid-lab.zyxio.xyz/sessions/a1b2c3d4e5f6 -H "x-api-key: $BROWSERGRID_API_KEY"
204

Billing

The call is free, and it is what stops the meter. The session is charged €0.07 per hour for the time between its first ready moment and this release, rounded once to the micro-euro; the rest of its reservation returns to your available credit. Released before it became ready, it costs nothing.

See also

Browser sessions, POST /sessions.