# Change a queued session's priority

`PATCH /v1/admin/runtime/sessions/{id}/priority`

URL: https://docs.spacerun.co/docs/platform/reference/runtime-sessions/setRuntimeSessionPriority

- **Operation ID:** `setRuntimeSessionPriority`
- **Tags:** Runtime sessions
- **Base URL:** `http://localhost:8787`

Only queued sessions can be reprioritised; otherwise the runtime answers `conflict`. Audited as `runtime.session_priority`. Authenticates with a Platform staff JWT and permission, like every admin route; the backend calls the separate Runtime service on the caller's behalf (no Runtime API key is ever exposed or accepted).

**Workflow:** [Integration guide](https://docs.spacerun.co/docs/platform/guides/runtime-management).

**Authentication:** staff Bearer JWT with permission `runtime.write`.

## Authentication

- **Auth:** staff Bearer JWT (`Authorization: Bearer <access_token>`) with the permissions below.
- **Required permissions:** `runtime.write`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | `string` | yes | Min length: 1. Max length: 200 |

## Request body

Required: yes.

Content type: `application/json`

Schema: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `priority` | `integer` | yes | Min: -1000. Max: 1000 |

## Responses

### 200

Updated session.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (RuntimeSession)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | yes | - |
| `poolId` | `string` | yes | - |
| `appId` | `string` | yes | - |
| `appVersion` | `integer` | yes | - |
| `nodeId` | `string \| null` | yes | - |
| `state` | `string` | yes | One of: `"pending"`, `"queued"`, `"assigned"`, `"starting"`, `"ready"`, `"active"`, `"paused"`, `"ending"`, `"ended"` |
| `endReason` | `string \| null` | yes | - |
| `priority` | `integer` | yes | - |
| `externalRef` | `string \| null` | yes | Platform user id that owns the session. |
| `metadata` | `any` | no | - |
| `options` | `object` | yes | - |
| `deadlineAt` | `integer \| null` | yes | Hard deadline (Unix epoch milliseconds). |
| `createdAt` | `integer` | yes | Created (Unix epoch milliseconds). |
| `queuedAt` | `integer \| null` | yes | Queued (Unix epoch milliseconds). |
| `startedAt` | `integer \| null` | yes | Started (Unix epoch milliseconds). |
| `endedAt` | `integer \| null` | yes | Ended (Unix epoch milliseconds). |

## Errors

### 400

Request validation failed.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ValidationErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | `boolean` | yes | One of: `false` |
| `error` | `object` | yes | - |
| `error.name` | `string` | yes | One of: `"ZodError"` |
| `error.issues` | `object[]` | yes | - |
| `error.issues[].code` | `string` | yes | - |
| `error.issues[].path` | `(string \| number)[]` | yes | - |
| `error.issues[].message` | `string` | yes | - |

**Request validation**

```json
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}
```

### 401

Missing, malformed, expired or wrong-audience Bearer token (`missing_token`, `invalid_token`, `invalid_audience`).

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | `string` | yes | Stable machine-readable error code, e.g. `forbidden`, `not_found`. |
| `details` | `any` | no | Optional structured context. For 403 it is `{ perm }`. |

**Error response**

```json
{
  "error": "missing_token"
}
```

### 403

Authenticated but lacking the required permission. `details.perm` lists the accepted permission keys.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "forbidden",
  "details": {
    "perm": "runtime.write"
  }
}
```

### 404

`not_found`: the runtime does not know this resource.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "not_found"
}
```

### 409

`conflict`: the runtime rejected the change (details carry its message).

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "conflict"
}
```

### 422

`invalid_request`: the runtime rejected the payload (details carry its message).

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "invalid_request"
}
```

### 500

Unexpected server error (`internal`). No details are returned.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "internal"
}
```

### 503

`unavailable`: the runtime could not be reached; retry.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "unavailable"
}
```

## Examples

### curl

```bash
curl -X PATCH 'http://localhost:8787/v1/admin/runtime/sessions/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90/priority' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"priority":1}'
```

### TypeScript

```ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/runtime/sessions/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90/priority", {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "priority": 1
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();
```