OpenFaaS OpenFaaS API

The OpenFaaS API API from OpenFaaS — 1 operation(s) for openfaas api.

Operations 3

GET / GET / #
POST / POST / #
PUT / PUT / #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/openfaas:openfaas-openfaas-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openfaas-openfaas-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OpenFaaS API
  version: '2026-10-14'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14: 12 operation(s) read from 7 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; OpenFaaS has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 12
    documentation: 0
    pages-with-code: 6
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-14'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.openfaas.com/reference/async
  - https://docs.openfaas.com/reference/secrets
  - https://docs.openfaas.com/reference/rest-api
  - https://docs.openfaas.com/reference/cicd/jenkins
  - https://docs.openfaas.com/reference/authentication
  - https://docs.openfaas.com/reference/cicd/bitbucket
  - https://docs.openfaas.com/reference/function-oauth
servers:
- url: https://github.com
security:
- bearer: []
tags:
- name: OpenFaaS API
paths:
  /:
    get:
      operationId: get
      tags:
      - OpenFaaS API
      summary: GET /
      x-source: https://docs.openfaas.com/reference/rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s  -H \"Authorization: Bearer $TOKEN \"  $OPENFAAS_URL /system/namespaces\n Create a namespace ¶ \n Note that for initial creation, the namespace n1 isn't included in the URL. \n export OPENFAAS_URL = \"http://127.0.0.1:8080\" \n export TOKEN = \"\" "
    post:
      operationId: post
      tags:
      - OpenFaaS API
      summary: POST /
      x-source: https://docs.openfaas.com/reference/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s  -X POST  --data-binary '{\"name\": \"n1\", \"annotations\": {\"openfaas\":\"1\"}}'  -H \"Authorization: Bearer $TOKEN \"  $OPENFAAS_URL /system/namespace/\n Note that the trailing / slash in /system/namespace/ is required for this endpoint, and that the name of the namespace must be passed within the body. \n Update a namespace ¶ \n This endpoint can be used to update the annotations for an existing nam"
    put:
      operationId: put
      tags:
      - OpenFaaS API
      summary: PUT /
      x-source: https://docs.openfaas.com/reference/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s  -X PUT  --data-binary '{\"name\": \"n1\", \"annotations\": {\"openfaas\":\"1\", \"customer\": \"openfaasltd\"}}'  -H \"Authorization: Bearer $TOKEN \"  $OPENFAAS_URL /system/namespaces/n1\n Delete a namespace ¶ \n export OPENFAAS_URL = \"http://127.0.0.1:8080\" \n export TOKEN = \"\" "
components:
  schemas:
    PutRequest:
      type: object
      properties:
        name:
          type: string
        annotations:
          type: object
          properties:
            openfaas:
              type: string
            customer:
              type: string
    PostRequest:
      type: object
      properties:
        name:
          type: string
        annotations:
          type: object
          properties:
            openfaas:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer