Sessions
Rename a session or replace its storage state
PATCH /v1/sessions/{id}: Rename a session or replace its storage state
PATCH /v1/sessions/{id}
| Operation id | updateSession |
| Key scope | run: keys that run jobs (and admin keys) |
| Section | Sessions |
#Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | min length 1 |
#Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | pattern ^[a-z0-9][a-z0-9-]{1,62}$ | |
concurrency | "exclusive", "shared" | ||
refresh | object or null | ||
refresh.program | string | yes | min length 1 |
refresh.inputs | map of string or number or boolean | ||
storage_state | object | ||
storage_state.cookies | object | yes | |
storage_state.cookies[].name | string | yes | |
storage_state.cookies[].value | string | yes | |
storage_state.cookies[].domain | string | yes | |
storage_state.cookies[].path | string | yes | |
storage_state.cookies[].expires | number | yes | |
storage_state.cookies[].httpOnly | boolean | yes | |
storage_state.cookies[].secure | boolean | yes | |
storage_state.cookies[].sameSite | "Strict", "Lax", "None" | yes | |
storage_state.origins | object | yes | |
storage_state.origins[].origin | string | yes | |
storage_state.origins[].localStorage | object | yes | |
storage_state.origins[].localStorage[].name | string | yes | |
storage_state.origins[].localStorage[].value | string | yes |
#Example request
curl -X PATCH "https://api.kaab.ist/v1/sessions/{id}" \
-H "Authorization: Bearer $KAAB_API_KEY" \
-H "Content-Type: application/json" \
-d '{"concurrency":"shared","refresh":null}'
#Responses
#200
Session
{
"id": "ses_01j9zqk3q7m4n5p6r7s8t9v0wx",
"object": "session",
"name": "acme",
"origins": [
"https://portal.acme.test"
],
"status": "valid",
"concurrency": "exclusive",
"refresh": {
"program": "acme-login",
"has_inputs": true
},
"last_verified_at": "2026-09-18T10:00:00Z",
"last_used_at": "2026-09-18T10:00:00Z",
"locked_by": null,
"created_at": "2026-09-18T10:00:00Z",
"updated_at": "2026-09-18T10:00:00Z"
}
#Errors
Every error answers with the error envelope; its code is one of the error codes.
| Status | When |
|---|---|
| 400 | request_invalid: request validation failed |
| 401 | Missing or invalid API key |
| 402 | insufficient_credits: top up to continue |
| 403 | The key's scope does not cover this operation |
| 404 | Resource not found |
| 409 | Conflicting state (see error.code) |
| 422 | Semantically invalid request (see error.code) |
| 429 | Rate limited; see Retry-After |
| 500 | internal: unexpected server error |