OpenFaaS Function API

The Function API from OpenFaaS — 1 operation(s) for function.

Operations 1

GET /function/{functionid} GET /function/env.openfaas.fn #

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-function-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-function-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OpenFaaS Function 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: Function
paths:
  /function/{functionid}:
    get:
      operationId: get_function_functionid
      tags:
      - Function
      summary: GET /function/env.openfaas.fn
      x-source: https://docs.openfaas.com/reference/rest-api
      parameters:
      - name: functionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFunctionFunctionidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s -i http://127.0.0.1:8080/function/env.openfaas.fn\n If no namespace is specified, then the default namespace is used for the installation, this is usually going to be openfaas-fn . \n Functions can also be invoked asynchronously by adding the /async-function/NAME.NAMESPACE path to the gateway URL. In this case, a HTTP POST is required with the payload in the body. \n If a function is being in"
        collapsed_from: 3 example path(s) differing only at functionId
components:
  schemas:
    GetFunctionFunctionidResponse:
      type: object
      properties:
        name:
          type: string
        image:
          type: string
        namespace:
          type: string
        envProcess:
          type: string
        labels:
          type: object
          properties:
            com.openfaas.scale.zero:
              type: string
            com.openfaas.scale.zero-duration:
              type: string
        annotations:
          type: object
        replicas:
          type: integer
        availableReplicas:
          type: integer
        createdAt:
          type: string
          format: date-time
        usage:
          type: object
          properties:
            cpu:
              type: number
            totalMemoryBytes:
              type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer