---
title: "Get system requirements"
method: GET
path: "/requirements"
tags: ["Product"]
---

# Get system requirements

`GET /requirements`

## Request

- Base URL: `https://yappy.biz/api/v1`
- URL: `https://yappy.biz/api/v1/requirements`
- Auth: one of:
  - none
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://yappy.biz/oauth/authorize`, token URL `https://yappy.biz/oauth/token`; client credentials, token URL `https://yappy.biz/oauth/token`)

The minimum macOS version, the required CPU architecture, disk needs, and every macOS permission Yappy asks for with what each one unlocks and what breaks if it is denied.

## Response `200`

System requirements

- Requirements: What a Mac needs before Yappy will run on it.
  - `object` 'requirements', required: Type discriminator.
  - `os` string, required: Operating system name.
  - `minimum_os_version` string, required: Lowest supported version.
  - `architectures` string[], required: Supported CPU architectures.
  - `disk_space_mb` integer: Approximate install size in megabytes.
  - `app_store` boolean: Whether it is distributed via the Mac App Store.
  - `permissions` object[], required: Each macOS permission, what it unlocks, and what breaks without it.
    - `name` string, required: The permission as macOS names it.
    - `required` boolean, required: Whether Yappy is unusable without it.
    - `purpose` string, required: What it is used for.
    - `if_denied` string: What stops working.

## Other responses

- `400`: The request was malformed
- `401`: The supplied credential is missing, expired, or invalid
- `403`: The credential is valid but lacks the required scope
- `429`: Too many requests
- `500`: Unexpected server error
- `503`: A dependency was unavailable

---

[API](https://skmtc.dev/yappy/apis/yappy-web-api.md) · [All operations](https://skmtc.dev/yappy/apis/yappy-web-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yappy/apis/yappy-web-api/revisions/02b27cd526a7?raw)