---
title: "general"
description: "REST API endpoints for general."
canonical_url: "https://www.zeyos.com/api/general"
markdown_url: "https://www.zeyos.com/ai/guide/api/general.md"
section: "api-reference"
authority: "reference"
language: "en"
source_repository: "https://cloud.zeyos.com/__doc/openapi/api.json"
source_sha256: "f5850c6fa6f99a1b518fc8ddc4e566070b53b5506cde57a3299948d38fc6363c"
---

# ZeyOS Standard REST API (v1)

## Tag: general
General

## Spec
- /__doc/openapi/api.json

## Servers
- https://cloud.zeyos.com/{INSTANCE}/api/v1 — ZeyOS Cloud

## Authentication
- oauth (oauth2) — OAuth 2.0 Authorization ([RFC 6749](https://tools.ietf.org/html/rfc6749)); use the **[ZeyOS OAuth 2.0 API](https://developers.zeyos.com/oauth2) `POST /oauth2/v1/token`** to obtain a valid bearer token
- token (http) — HTTP Bearer Authentication ([RFC 6750](https://tools.ietf.org/html/rfc6750))
- session (apiKey) — Session Cookie Authentication ([RFC 6265](https://tools.ietf.org/html/rfc6265))

## Endpoints
| Method | Path | Summary |
| ------ | ---- | ------- |
| GET | /config | Get system configuration |
| GET | /settings | Get application settings |

### GET /config
- Summary: Get system configuration
- OperationId: getConfig
- Description: Return the user-visible system configuration.

Parameters:
- (none)

Request body:
- (none)

Responses:
- 200 — OK
  - application/json — object
- 401: #/components/responses/401
- 500: #/components/responses/500

### GET /settings
- Summary: Get application settings
- OperationId: getSettings
- Description: Return the settings of the application that was used for authentication.

Parameters:
- (none)

Request body:
- (none)

Responses:
- 200 — OK
  - application/json — object
- 401: #/components/responses/401
- 403 — Forbidden
  - text/plain — string
- 500: #/components/responses/500