Fusio System API

The Fusio System API is the meta surface every Fusio instance exposes without configuration. It carries the discovery document at the root, the health check, the route table, and the specification generator that emits the instance's own OpenAPI, OpenRPC, TypeAPI and client SDK archives on demand. It is what makes a Fusio deployment self-describing: the contract is generated from the running instance rather than maintained beside it.

Operations 7

GET /system/connection/{name}/callback #
GET /system/about #
POST /system/debug #
GET /system/health #
GET /system/route #
GET /system/schema/{name} #
POST /system/payment/{provider}/webhook #

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/fusio-system-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

fusio-system.json Raw ↑
{
    "openapi": "3.0.3",
    "info": {
        "title": "Fusio",
        "description": "Self-Hosted API Management for Builders.",
        "version": "1"
    },
    "servers": [
        {
            "url": "https://demo.fusio-project.org"
        }
    ],
    "paths": {
        "/system/connection/{name}/callback": {
            "get": {
                "description": "Connection OAuth2 callback to authorize a connection",
                "operationId": "system.connection.callback",
                "responses": {
                    "200": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "4XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "5XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    }
                }
            },
            "parameters": [
                {
                    "name": "name",
                    "in": "path",
                    "required": true,
                    "schema": {
                        "type": "string"
                    }
                }
            ]
        },
        "/system/about": {
            "get": {
                "description": "Returns meta information and links about the current installed Fusio version",
                "operationId": "system.meta.getAbout",
                "responses": {
                    "200": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/System_About"
                                }
                            }
                        }
                    },
                    "4XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "5XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/system/debug": {
            "post": {
                "description": "Debug endpoint which returns the provided data",
                "operationId": "system.meta.getDebug",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Passthru"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Passthru"
                                }
                            }
                        }
                    },
                    "4XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "5XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/system/health": {
            "get": {
                "description": "Health check endpoint which returns information about the health status of the system",
                "operationId": "system.meta.getHealth",
                "responses": {
                    "200": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/System_HealthCheck"
                                }
                            }
                        }
                    },
                    "4XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "5XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/system/route": {
            "get": {
                "description": "Returns all available routes",
                "operationId": "system.meta.getRoutes",
                "responses": {
                    "200": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/System_Route"
                                }
                            }
                        }
                    },
                    "4XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "5XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/system/schema/{name}": {
            "get": {
                "description": "Returns details of a specific schema",
                "operationId": "system.meta.getSchema",
                "responses": {
                    "200": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/System_Schema"
                                }
                            }
                        }
                    },
                    "4XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "5XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    }
                }
            },
            "parameters": [
                {
                    "name": "name",
                    "in": "path",
                    "required": true,
                    "schema": {
                        "type": "string"
                    }
                }
            ]
        },
        "/system/payment/{provider}/webhook": {
            "post": {
                "description": "Payment webhook endpoint after successful purchase of a plan",
                "operationId": "system.payment.webhook",
                "responses": {
                    "200": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "4XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    },
                    "5XX": {
                        "description": "",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Common_Message"
                                }
                            }
                        }
                    }
                }
            },
            "parameters": [
                {
                    "name": "provider",
                    "in": "path",
                    "required": true,
                    "schema": {
                        "type": "string"
                    }
                }
            ]
        }
    },
    "components": {
        "schemas": {
            "Common_Message": {
                "description": "Common error message",
                "type": "object",
                "properties": {
                    "success": {
                        "type": "boolean"
                    },
                    "message": {
                        "type": "string"
                    },
                    "id": {
                        "type": "string"
                    }
                }
            },
            "Passthru": {
                "description": "No schema information available",
                "type": "object",
                "additionalProperties": {}
            },
            "System_About": {
                "type": "object",
                "properties": {
                    "apiVersion": {
                        "type": "string"
                    },
                    "title": {
                        "type": "string"
                    },
                    "description": {
                        "type": "string"
                    },
                    "termsOfService": {
                        "type": "string"
                    },
                    "contactName": {
                        "type": "string"
                    },
                    "contactUrl": {
                        "type": "string"
                    },
                    "contactEmail": {
                        "type": "string"
                    },
                    "licenseName": {
                        "type": "string"
                    },
                    "licenseUrl": {
                        "type": "string"
                    },
                    "paymentCurrency": {
                        "type": "string"
                    },
                    "categories": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "scopes": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "apps": {
                        "$ref": "#/components/schemas/System_AboutApps"
                    },
                    "links": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/System_AboutLink"
                        }
                    }
                }
            },
            "System_AboutApps": {
                "type": "object",
                "additionalProperties": {
                    "type": "string"
                }
            },
            "System_AboutLink": {
                "type": "object",
                "properties": {
                    "rel": {
                        "type": "string"
                    },
                    "href": {
                        "type": "string"
                    }
                }
            },
            "System_HealthCheck": {
                "type": "object",
                "properties": {
                    "healthy": {
                        "type": "boolean"
                    },
                    "error": {
                        "type": "string"
                    }
                }
            },
            "System_Route": {
                "type": "object",
                "properties": {
                    "routes": {
                        "$ref": "#/components/schemas/System_RoutePath"
                    }
                }
            },
            "System_RouteMethod": {
                "type": "object",
                "additionalProperties": {
                    "type": "string"
                }
            },
            "System_RoutePath": {
                "type": "object",
                "additionalProperties": {
                    "$ref": "#/components/schemas/System_RouteMethod"
                }
            },
            "System_Schema": {
                "type": "object",
                "properties": {
                    "schema": {
                        "$ref": "#/components/schemas/System_SchemaTypeSchema"
                    },
                    "form": {
                        "$ref": "#/components/schemas/System_SchemaForm"
                    }
                }
            },
            "System_SchemaForm": {
                "type": "object",
                "additionalProperties": {}
            },
            "System_SchemaTypeSchema": {
                "type": "object",
                "additionalProperties": {}
            }
        },
        "securitySchemes": {
            "app": {
                "type": "oauth2",
                "flows": {
                    "clientCredentials": {
                        "tokenUrl": "https://demo.fusio-project.org/authorization/token",
                        "refreshUrl": "https://demo.fusio-project.org/authorization/token",
                        "scopes": {
                            "system": ""
                        }
                    },
                    "authorizationCode": {
                        "authorizationUrl": "https://demo.fusio-project.org/authorization/authorize",
                        "tokenUrl": "https://demo.fusio-project.org/authorization/token",
                        "refreshUrl": "https://demo.fusio-project.org/authorization/token",
                        "scopes": {
                            "system": ""
                        }
                    }
                }
            }
        }
    }
}