---
title: Platform Settings API
path: reference/api/platform-settings
status: published
---

# Platform Settings API

Reference for the `Platform Settings` endpoint group — 4 endpoints.

Generated from the live OpenAPI spec. Re-run `_generate_api_reference.py` after backend changes.

## Authentication

All endpoints require a Bearer JWT in the `Authorization` header unless noted otherwise. See [Concepts → Tokens and scopes](/docs/scaikey/concepts/tokens-and-scopes) and [Reference → OAuth endpoints](/docs/scaikey/reference/oauth-endpoints) for how to obtain one.

## Endpoints

### **GET** `/api/v1/admin/platform-settings`

_Get platform settings_

Get current platform-wide settings. Requires Super Admin role.

**Parameters:**

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `authorization` | header | no | `string` \| `null` |  |

**Responses:**

| Status | Body |
|---|---|
| `200` | `application/json` → object |
| `422` | `application/json` → [`HTTPValidationError`](#schema-httpvalidationerror) |

---

### **GET** `/api/v1/admin/platform-settings`

_Get platform settings_

Get current platform-wide settings. Requires Super Admin role.

**Parameters:**

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `authorization` | header | no | `string` \| `null` |  |

**Responses:**

| Status | Body |
|---|---|
| `200` | `application/json` → object |
| `422` | `application/json` → [`HTTPValidationError`](#schema-httpvalidationerror) |

---

### **PATCH** `/api/v1/admin/platform-settings`

_Update platform settings_

Update platform-wide settings. Requires Super Admin role.

**Parameters:**

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `authorization` | header | no | `string` \| `null` |  |

**Request body:**

Required.

- `application/json` → [`PlatformSettingsUpdate`](#schema-platformsettingsupdate)

**Responses:**

| Status | Body |
|---|---|
| `200` | `application/json` → object |
| `422` | `application/json` → [`HTTPValidationError`](#schema-httpvalidationerror) |

---

### **PATCH** `/api/v1/admin/platform-settings`

_Update platform settings_

Update platform-wide settings. Requires Super Admin role.

**Parameters:**

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `authorization` | header | no | `string` \| `null` |  |

**Request body:**

Required.

- `application/json` → [`PlatformSettingsUpdate`](#schema-platformsettingsupdate)

**Responses:**

| Status | Body |
|---|---|
| `200` | `application/json` → object |
| `422` | `application/json` → [`HTTPValidationError`](#schema-httpvalidationerror) |

---

## Schemas

Definitions for every type referenced by the endpoints above. Schema-to-schema references on this page link within the page; cross-page references would require visiting the linked page.

### `HTTPValidationError`

| Field | Type | Required | Description |
|---|---|---|---|
| `detail` | array of [`ValidationError`](#schema-validationerror) | no |  |

### `PlatformSettingsUpdate`

Platform settings update request.

| Field | Type | Required | Description |
|---|---|---|---|
| `self_registration` | [`SelfRegistrationSettings`](#schema-selfregistrationsettings) \| `null` | no |  |

### `SelfRegistrationSettings`

Self-registration settings.

| Field | Type | Required | Description |
|---|---|---|---|
| `global_self_registration_enabled` | `boolean` | no | Enable self-registration for global (platform-wide) applications |
| `self_registration_ip_whitelist` | array of `string` | no | IP CIDR whitelist for global self-registration (empty = allow all) |
| `registration_request_ttl_days` | `integer` | no | Days until pending registration requests expire (1-365) |

### `ValidationError`

| Field | Type | Required | Description |
|---|---|---|---|
| `loc` | array of `string` \| `integer` | yes |  |
| `msg` | `string` | yes |  |
| `type` | `string` | yes |  |