# OpenFaaS API

**Canonical:** https://apis.io/apis/openfaas/openfaas-api/  
**Provider:** OpenFaaS — https://apis.io/providers/openfaas/  
**Base URL:** https://github.com  
**Documentation:** https://docs.openfaas.com/reference/async

OpenFaaS API is one of 2 APIs that [OpenFaaS](https://apis.io/providers/openfaas/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

OpenFaaS API as documented publicly: 12 operations. Contract generated from the documentation by API Evangelist (2026-10-14); not the provider's own document.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| POST | `/` | POST / |
| PUT | `/` | PUT / |
| GET | `/alexellis/openfaas-cloud-test` | GET /alexellis/openfaas-cloud-test |
| DELETE | `/async-function/ee7fcaeb-82b7-4834-b677-45005c5f0b1b` | DELETE /async-function/ee7fcaeb-82b7-4834-b677-45005c5f0b1b |
| GET | `/async-function/figlet` | GET /async-function/figlet |
| GET | `/auth/{authid}` | OAuth login for functions |
| POST | `/auth/{authid}` | OAuth login for functions |
| GET | `/function/{functionid}` | GET /function/env.openfaas.fn |
| GET | `/system/function/env` | GET /system/function/env |
| GET | `/system/functions` | GET /system/functions |
| PUT | `/system/functions` | PUT /system/functions |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openfaas/refs/heads/main/openapi/_ae-authored/openfaas-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/openfaas/refs/heads/main/json-schema/openfaas-get-function-functionid-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/openfaas/refs/heads/main/json-schema/openfaas-get-system-function-env-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/openfaas/refs/heads/main/json-schema/openfaas-put-system-functions-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/openfaas/refs/heads/main/json-schema/openfaas-put-system-functions-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/openfaas/refs/heads/main/json-schema/openfaas-put-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/openfaas/refs/heads/main/json-schema/openfaas-post-request-schema.json

## Other OpenFaaS APIs (1)

- [OpenFaaS API](https://apis.io/apis/openfaas/openfaas-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openfaas/openfaas-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openfaas/.