OpenFaaS System API

openapi: 3.2.0
info:
  title: OpenFaaS System 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: System
paths:
  /system/function/env:
    get:
      operationId: get_system_function_env
      tags:
      - System
      summary: GET /system/function/env
      x-source: https://docs.openfaas.com/reference/rest-api
      parameters:
      - name: usage
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSystemFunctionEnvResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s  -X GET  http://admin:$PASSWORD@127.0.0.1:8080/system/function/env?usage=1  -H 'Content-Type: application/json'\n Adding ?usage=1 includes the RAM and CPU usage of the function for commercial editions of OpenFaaS. \n Example output: \n { \n \"name\" : \"env\" , \n \"image\" : \"ghcr.io/openfaas/alpine:latest\" , \n \"namespace\" : \"openfaas-fn\" , \n \"envProcess\" : \"env\" , \n \"labels\" : { \n \"com.openfaas.sca"
  /system/functions:
    get:
      operationId: get_system_functions
      tags:
      - System
      summary: GET /system/functions
      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 \" \n http:// $HOST /system/functions\n Function authentication ¶ \n For authentication for functions, see Function Authentication \n A note on namespaces ¶ \n In OpenFaaS For Enterprises, all endpoints other than \"list namespaces\" support a namespace parameter. \n Depending on the endpoint, and operation this is passed either through the body or as a query-strin"
    put:
      operationId: put_system_functions
      tags:
      - System
      summary: PUT /system/functions
      x-source: https://docs.openfaas.com/reference/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutSystemFunctionsRequest'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutSystemFunctionsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i  -X PUT  http://admin:$PASSWORD@127.0.0.1:8080/system/functions  -H 'Content-Type: application/json'  -d '{\"service\":\"env\",\"image\":\"ghcr.io/openfaas/alpine:latest\",\"envProcess\":\"env\",\"labels\":{\"com.openfaas.scale.zero\":\"true\",\"com.openfaas.scale.zero-duration\":\"2m\"},\"annotations\":{}}'\n Here we've added the label com.openfaas.scale.zero which will instruct the OpenFaaS auto-scaler to scale "
components:
  schemas:
    PutSystemFunctionsResponse:
      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
    GetSystemFunctionEnvResponse:
      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
    PutSystemFunctionsRequest:
      type: object
      properties:
        service:
          type: string
        image:
          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
  securitySchemes:
    bearer:
      type: http
      scheme: bearer