How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Fusio Backend API

The Fusio Backend API provides a REST interface to configure and manage all aspects of a Fusio API management instance. It covers operations, routes, schemas, actions, connections, apps, users, and marketplace resources used by the Fusio backend application.

Fusio Backend API is one of 5 APIs that Fusio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Backend, Configuration, Management, and REST API. The published artifact set on APIs.io includes API documentation, an API reference, an OpenAPI specification, and a GitHub repository.

This API exposes 215 operations across 121 paths, organized into 38 resource areas, and defines 219 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against a single base URL, https://demo.fusio-project.org.

215 operations 121 paths 219 schemas 27 DELETE109 GET44 POST35 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Base URL
https://demo.fusio-project.org
Authentication
OAuth 2.0
Resource Areas
38

Authentication & Security 1

Fusio Backend API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (app) using the clientCredentials and authorizationCode flows, exposing 39 scopes.

Paths & Operations 215

Across 121 paths, the API surfaces 215 operations — 27 DELETE, 109 GET, 44 POST, 35 PUT. They span 38 resource areas, including account, action, agent, app, audit, backup, bundle, category, and 30 more. Each is listed below with its method, path, parameters, and response codes.

account 3
PUT
/backend/account/change_password
Changes the password of the authenticated user
backend.account.changePassword body → 2004XX5XX
GET
/backend/account
Returns user data of the authenticated user
backend.account.get → 2004XX5XX
PUT
/backend/account
Updates user data of the authenticated user
backend.account.update body → 2004XX5XX
action 9
GET
/backend/action
Returns a paginated list of actions
backend.action.getAll 3 params → 2004XX5XX
POST
/backend/action
Creates a new action
backend.action.create body → 2014XX5XX
GET
/backend/action/{action_id}
Returns a specific action
backend.action.get 1 param → 2004XX5XX
PUT
/backend/action/{action_id}
Updates an existing action
backend.action.update 1 param body → 2004XX5XX
DELETE
/backend/action/{action_id}
Deletes an existing action
backend.action.delete 1 param → 2004XX5XX
POST
/backend/action/execute/{action_id}
Executes a specific action. This method should be used to test an action configuration
backend.action.execute 1 param body → 2004XX5XX
GET
/backend/action/list
Returns all available action classes
backend.action.getClasses → 2004XX5XX
GET
/backend/action/{action_id}/commit
Returns a paginated list of action commits
backend.action.getCommits 4 params → 2004XX5XX
GET
/backend/action/form
Returns the action config form
backend.action.getForm 1 param → 2004XX5XX
agent 8
GET
/backend/agent
Returns a paginated list of agents
backend.agent.getAll 3 params → 2004XX5XX
POST
/backend/agent
Creates a new agent
backend.agent.create body → 2014XX5XX
GET
/backend/agent/{agent_id}
Returns a specific agent
backend.agent.get 1 param → 2004XX5XX
PUT
/backend/agent/{agent_id}
Updates an existing agent
backend.agent.update 1 param body → 2004XX5XX
DELETE
/backend/agent/{agent_id}
Deletes an existing agent
backend.agent.delete 1 param → 2004XX5XX
GET
/backend/agent/tools
Returns available tools for an agent
backend.agent.getTools → 2004XX5XX
GET
/backend/agent/{agent_id}/message
Returns a paginated list of agent messages
backend.agent.message.getAll 2 params → 2004XX5XX
POST
/backend/agent/{agent_id}/message
Submits a new agent message
backend.agent.message.submit 1 param body → 2014XX5XX
app 6
GET
/backend/app
Returns a paginated list of apps
backend.app.getAll 3 params → 2004XX5XX
POST
/backend/app
Creates a new app
backend.app.create body → 2014XX5XX
GET
/backend/app/{app_id}
Returns a specific app
backend.app.get 1 param → 2004XX5XX
PUT
/backend/app/{app_id}
Updates an existing app
backend.app.update 1 param body → 2004XX5XX
DELETE
/backend/app/{app_id}
Deletes an existing app
backend.app.delete 1 param → 2004XX5XX
DELETE
/backend/app/{app_id}/token/{token_id}
Deletes an existing token from an app
backend.app.deleteToken 2 params → 2004XX5XX
audit 2
GET
/backend/audit/{audit_id}
Returns a specific audit
backend.audit.get 1 param → 2004XX5XX
GET
/backend/audit
Returns a paginated list of audits
backend.audit.getAll 10 params → 2004XX5XX
backup 2
POST
/backend/backup/export
Generates an backup of the current system
backend.backup.export → 2004XX5XX
POST
/backend/backup/import
Imports an backup to the current system
backend.backup.import body → 2004XX5XX
bundle 6
GET
/backend/bundle
Returns a paginated list of bundles
backend.bundle.getAll 3 params → 2004XX5XX
POST
/backend/bundle
Creates a new bundle
backend.bundle.create body → 2014XX5XX
GET
/backend/bundle/{bundle_id}
Returns a specific bundle
backend.bundle.get 1 param → 2004XX5XX
PUT
/backend/bundle/{bundle_id}
Updates an existing bundle
backend.bundle.update 1 param body → 2004XX5XX
DELETE
/backend/bundle/{bundle_id}
Deletes an existing bundle
backend.bundle.delete 1 param → 2004XX5XX
POST
/backend/bundle/{bundle_id}/publish
Publish an existing bundle to the marketplace
backend.bundle.publish 1 param → 2004XX5XX
category 5
GET
/backend/category
Returns a paginated list of categories
backend.category.getAll 3 params → 2004XX5XX
POST
/backend/category
Creates a new category
backend.category.create body → 2014XX5XX
GET
/backend/category/{category_id}
Returns a specific category
backend.category.get 1 param → 2004XX5XX
PUT
/backend/category/{category_id}
Updates an existing category
backend.category.update 1 param body → 2004XX5XX
DELETE
/backend/category/{category_id}
Deletes an existing category
backend.category.delete 1 param → 2004XX5XX
config 3
GET
/backend/config/{config_id}
Returns a specific config
backend.config.get 1 param → 2004XX5XX
PUT
/backend/config/{config_id}
Updates an existing config value
backend.config.update 1 param body → 2004XX5XX
GET
/backend/config
Returns a paginated list of configuration values
backend.config.getAll 3 params → 2004XX5XX
connection 26
POST
/backend/connection/{connection_id}/agent
Sends a message to an agent
backend.connection.agent.send 1 param body → 2004XX5XX
GET
/backend/connection
Returns a paginated list of connections
backend.connection.getAll 4 params → 2004XX5XX
POST
/backend/connection
Creates a new connection
backend.connection.create body → 2014XX5XX
GET
/backend/connection/{connection_id}/database/{table_name}/rows
Returns paginated rows at a table on a database
backend.connection.database.getRows 10 params → 2004XX5XX
POST
/backend/connection/{connection_id}/database/{table_name}/rows
Creates a new row at a table on a database
backend.connection.database.createRow 2 params body → 2014XX5XX
GET
/backend/connection/{connection_id}/database
Returns all available tables on a database
backend.connection.database.getTables 3 params → 2004XX5XX
POST
/backend/connection/{connection_id}/database
Creates a new table on a database
backend.connection.database.createTable 1 param body → 2014XX5XX
GET
/backend/connection/{connection_id}/database/{table_name}/rows/{id}
Returns a specific row at a table on a database
backend.connection.database.getRow 3 params → 2004XX5XX
PUT
/backend/connection/{connection_id}/database/{table_name}/rows/{id}
Updates an existing row at a table on a database
backend.connection.database.updateRow 3 params body → 2004XX5XX
DELETE
/backend/connection/{connection_id}/database/{table_name}/rows/{id}
Deletes an existing row at a table on a database
backend.connection.database.deleteRow 3 params → 2004XX5XX
GET
/backend/connection/{connection_id}/database/{table_name}
Returns the schema of a specific table on a database
backend.connection.database.getTable 2 params → 2004XX5XX
PUT
/backend/connection/{connection_id}/database/{table_name}
Updates an existing table on a database
backend.connection.database.updateTable 2 params body → 2004XX5XX
DELETE
/backend/connection/{connection_id}/database/{table_name}
Deletes an existing table on a database
backend.connection.database.deleteTable 2 params → 2004XX5XX
GET
/backend/connection/{connection_id}
Returns a specific connection
backend.connection.get 1 param → 2004XX5XX
PUT
/backend/connection/{connection_id}
Updates an existing connection
backend.connection.update 1 param body → 2004XX5XX
DELETE
/backend/connection/{connection_id}
Deletes an existing connection
backend.connection.delete 1 param → 2004XX5XX
GET
/backend/connection/{connection_id}/filesystem
Returns all available files on the filesystem connection
backend.connection.filesystem.getAll 3 params → 2004XX5XX
POST
/backend/connection/{connection_id}/filesystem
Uploads one or more files on the filesystem connection
backend.connection.filesystem.create 1 param body → 2014XX5XX
GET
/backend/connection/{connection_id}/filesystem/{file_id}
Returns the content of the provided file id on the filesystem connection
backend.connection.filesystem.get 2 params → 2004XX5XX
PUT
/backend/connection/{connection_id}/filesystem/{file_id}
Updates an existing file on the filesystem connection
backend.connection.filesystem.update 2 params body → 2004XX5XX
DELETE
/backend/connection/{connection_id}/filesystem/{file_id}
Deletes an existing file on the filesystem connection
backend.connection.filesystem.delete 2 params → 2004XX5XX
GET
/backend/connection/list
Returns all available connection classes
backend.connection.getClasses → 2004XX5XX
GET
/backend/connection/form
Returns the connection config form
backend.connection.getForm 1 param → 2004XX5XX
GET
/backend/connection/{connection_id}/redirect
Returns a redirect url to start the OAuth2 authorization flow for the given connection
backend.connection.getRedirect 1 param → 2004XX5XX
POST
/backend/connection/{connection_id}/http
Sends an arbitrary HTTP request to the connection
backend.connection.http.execute 1 param body → 2004XX5XX
GET
/backend/connection/{connection_id}/sdk
Returns the SDK specification
backend.connection.sdk.get 1 param → 2004XX5XX
cronjob 5
GET
/backend/cronjob
Returns a paginated list of cronjobs
backend.cronjob.getAll 4 params → 2004XX5XX
POST
/backend/cronjob
Creates a new cronjob
backend.cronjob.create body → 2014XX5XX
GET
/backend/cronjob/{cronjob_id}
Returns a specific cronjob
backend.cronjob.get 1 param → 2004XX5XX
PUT
/backend/cronjob/{cronjob_id}
Updates an existing cronjob
backend.cronjob.update 1 param body → 2004XX5XX
DELETE
/backend/cronjob/{cronjob_id}
Deletes an existing cronjob
backend.cronjob.delete 1 param → 2004XX5XX
dashboard 1
GET
/backend/dashboard
Returns all available dashboard widgets
backend.dashboard.getAll → 2004XX5XX
event 5
GET
/backend/event
Returns a paginated list of events
backend.event.getAll 4 params → 2004XX5XX
POST
/backend/event
Creates a new event
backend.event.create body → 2014XX5XX
GET
/backend/event/{event_id}
Returns a specific event
backend.event.get 1 param → 2004XX5XX
PUT
/backend/event/{event_id}
Updates an existing event
backend.event.update 1 param body → 2004XX5XX
DELETE
/backend/event/{event_id}
Deletes an existing event
backend.event.delete 1 param → 2004XX5XX
firewall 5
GET
/backend/firewall
Returns a paginated list of firewall rules
backend.firewall.getAll 3 params → 2004XX5XX
POST
/backend/firewall
Creates a new firewall rule
backend.firewall.create body → 2014XX5XX
GET
/backend/firewall/{firewall_id}
Returns a specific firewall rule
backend.firewall.get 1 param → 2004XX5XX
PUT
/backend/firewall/{firewall_id}
Updates an existing firewall rule
backend.firewall.update 1 param body → 2004XX5XX
DELETE
/backend/firewall/{firewall_id}
Deletes an existing firewall rule
backend.firewall.delete 1 param → 2004XX5XX
form 5
GET
/backend/form
Returns a paginated list of forms
backend.form.getAll 3 params → 2004XX5XX
POST
/backend/form
Creates a new form
backend.form.create body → 2014XX5XX
GET
/backend/form/{form_id}
Returns a specific form
backend.form.get 1 param → 2004XX5XX
PUT
/backend/form/{form_id}
Updates an existing form
backend.form.update 1 param body → 2004XX5XX
DELETE
/backend/form/{form_id}
Deletes an existing form
backend.form.delete 1 param → 2004XX5XX
generator 4
GET
/backend/generator/{provider}
Returns the generator config form
backend.generator.getForm 1 param → 2004XX5XX
PUT
/backend/generator/{provider}
Generates a changelog of all potential changes if you execute this generator with the provided config
backend.generator.getChangelog 1 param body → 2004XX5XX
POST
/backend/generator/{provider}
Executes a generator with the provided config
backend.generator.executeProvider 1 param body → 2014XX5XX
GET
/backend/generator
Returns all available generator classes
backend.generator.getClasses → 2004XX5XX
identity 7
GET
/backend/identity
Returns a paginated list of identities
backend.identity.getAll 3 params → 2004XX5XX
POST
/backend/identity
Creates a new identity
backend.identity.create body → 2014XX5XX
GET
/backend/identity/{identity_id}
Returns a specific identity
backend.identity.get 1 param → 2004XX5XX
PUT
/backend/identity/{identity_id}
Updates an existing identity
backend.identity.update 1 param body → 2004XX5XX
DELETE
/backend/identity/{identity_id}
Deletes an existing identity
backend.identity.delete 1 param → 2004XX5XX
GET
/backend/identity/list
Returns all available identity classes
backend.identity.getClasses → 2004XX5XX
GET
/backend/identity/form
Returns the identity config form
backend.identity.getForm 1 param → 2004XX5XX
log 4
GET
/backend/log/{log_id}
Returns a specific log
backend.log.get 1 param → 2004XX5XX
GET
/backend/log
Returns a paginated list of logs
backend.log.getAll 14 params → 2004XX5XX
GET
/backend/log/error
Returns a paginated list of log errors
backend.log.getAllErrors 3 params → 2004XX5XX
GET
/backend/log/error/{error_id}
Returns a specific error
backend.log.getError 1 param → 2004XX5XX
marketplace 12
GET
/backend/marketplace/action/{user}/{name}
Returns a specific marketplace action
backend.marketplace.action.get 2 params → 2004XX5XX
PUT
/backend/marketplace/action/{user}/{name}
Upgrades an action from the marketplace
backend.marketplace.action.upgrade 2 params → 2004XX5XX
GET
/backend/marketplace/action
Returns a paginated list of marketplace actions
backend.marketplace.action.getAll 2 params → 2004XX5XX
POST
/backend/marketplace/action
Installs an action from the marketplace
backend.marketplace.action.install body → 2014XX5XX
GET
/backend/marketplace/app/{user}/{name}
Returns a specific marketplace app
backend.marketplace.app.get 2 params → 2004XX5XX
PUT
/backend/marketplace/app/{user}/{name}
Upgrades an app from the marketplace
backend.marketplace.app.upgrade 2 params → 2004XX5XX
GET
/backend/marketplace/app
Returns a paginated list of marketplace apps
backend.marketplace.app.getAll 2 params → 2004XX5XX
POST
/backend/marketplace/app
Installs an app from the marketplace
backend.marketplace.app.install body → 2014XX5XX
GET
/backend/marketplace/bundle/{user}/{name}
Returns a specific marketplace bundle
backend.marketplace.bundle.get 2 params → 2004XX5XX
PUT
/backend/marketplace/bundle/{user}/{name}
Upgrades an bundle from the marketplace
backend.marketplace.bundle.upgrade 2 params → 2004XX5XX
GET
/backend/marketplace/bundle
Returns a paginated list of marketplace bundles
backend.marketplace.bundle.getAll 2 params → 2004XX5XX
POST
/backend/marketplace/bundle
Installs an bundle from the marketplace
backend.marketplace.bundle.install body → 2014XX5XX
operation 5
GET
/backend/operation
Returns a paginated list of operations
backend.operation.getAll 4 params → 2004XX5XX
POST
/backend/operation
Creates a new operation
backend.operation.create body → 2014XX5XX
GET
/backend/operation/{operation_id}
Returns a specific operation
backend.operation.get 1 param → 2004XX5XX
PUT
/backend/operation/{operation_id}
Updates an existing operation
backend.operation.update 1 param body → 2004XX5XX
DELETE
/backend/operation/{operation_id}
Deletes an existing operation
backend.operation.delete 1 param → 2004XX5XX
page 5
GET
/backend/page
Returns a paginated list of pages
backend.page.getAll 3 params → 2004XX5XX
POST
/backend/page
Creates a new page
backend.page.create body → 2014XX5XX
GET
/backend/page/{page_id}
Returns a specific page
backend.page.get 1 param → 2004XX5XX
PUT
/backend/page/{page_id}
Updates an existing page
backend.page.update 1 param body → 2004XX5XX
DELETE
/backend/page/{page_id}
Deletes an existing page
backend.page.delete 1 param → 2004XX5XX
plan 5
GET
/backend/plan
Returns a paginated list of plans
backend.plan.getAll 3 params → 2004XX5XX
POST
/backend/plan
Creates a new plan
backend.plan.create body → 2014XX5XX
GET
/backend/plan/{plan_id}
Returns a specific plan
backend.plan.get 1 param → 2004XX5XX
PUT
/backend/plan/{plan_id}
Updates an existing plan
backend.plan.update 1 param body → 2004XX5XX
DELETE
/backend/plan/{plan_id}
Deletes an existing plan
backend.plan.delete 1 param → 2004XX5XX
rate 5
GET
/backend/rate
Returns a paginated list of rate limitations
backend.rate.getAll 3 params → 2004XX5XX
POST
/backend/rate
Creates a new rate limitation
backend.rate.create body → 2014XX5XX
GET
/backend/rate/{rate_id}
Returns a specific rate
backend.rate.get 1 param → 2004XX5XX
PUT
/backend/rate/{rate_id}
Updates an existing rate
backend.rate.update 1 param body → 2004XX5XX
DELETE
/backend/rate/{rate_id}
Deletes an existing rate
backend.rate.delete 1 param → 2004XX5XX
role 5
GET
/backend/role
Returns a paginated list of roles
backend.role.getAll 3 params → 2004XX5XX
POST
/backend/role
Creates a new role
backend.role.create body → 2014XX5XX
GET
/backend/role/{role_id}
Returns a specific role
backend.role.get 1 param → 2004XX5XX
PUT
/backend/role/{role_id}
Updates an existing role
backend.role.update 1 param body → 2004XX5XX
DELETE
/backend/role/{role_id}
Deletes an existing role
backend.role.delete 1 param → 2004XX5XX
schema 7
GET
/backend/schema
Returns a paginated list of schemas
backend.schema.getAll 4 params → 2004XX5XX
POST
/backend/schema
Creates a new schema
backend.schema.create body → 2014XX5XX
GET
/backend/schema/{schema_id}
Returns a specific schema
backend.schema.get 1 param → 2004XX5XX
PUT
/backend/schema/{schema_id}
Updates an existing schema
backend.schema.update 1 param body → 2004XX5XX
DELETE
/backend/schema/{schema_id}
Deletes an existing schema
backend.schema.delete 1 param → 2004XX5XX
GET
/backend/schema/{schema_id}/commit
Returns a paginated list of schema commits
backend.schema.getCommits 4 params → 2004XX5XX
POST
/backend/schema/preview/{schema_id}
Returns a HTML preview of the provided schema
backend.schema.getPreview 1 param → 2004XX5XX
scope 6
GET
/backend/scope
Returns a paginated list of scopes
backend.scope.getAll 3 params → 2004XX5XX
POST
/backend/scope
Creates a new scope
backend.scope.create body → 2014XX5XX
GET
/backend/scope/{scope_id}
Returns a specific scope
backend.scope.get 1 param → 2004XX5XX
PUT
/backend/scope/{scope_id}
Updates an existing scope
backend.scope.update 1 param body → 2004XX5XX
DELETE
/backend/scope/{scope_id}
Deletes an existing scope
backend.scope.delete 1 param → 2004XX5XX
GET
/backend/scope/categories
Returns all available scopes grouped by category
backend.scope.getCategories → 2004XX5XX
sdk 2
GET
/backend/sdk
Returns a paginated list of SDKs
backend.sdk.getAll → 2004XX5XX
POST
/backend/sdk
Generates a specific SDK
backend.sdk.generate body → 2004XX5XX
specification 4
GET
/backend/specification
Returns the TypeHub specification
backend.specification.get → 2004XX5XX
POST
/backend/specification
Publish the specification
backend.specification.publish body → 2004XX5XX
GET
/backend/specification/changelog
Returns the changelog between your current specification and the last tag
backend.specification.getChangelog → 2004XX5XX
POST
/backend/specification/tag
Creates a new tag of your specification
backend.specification.tag body → 2004XX5XX
statistic 17
GET
/backend/statistic/activities_per_user
Returns a statistic containing the activities per user
backend.statistic.getActivitiesPerUser 14 params → 2004XX5XX
GET
/backend/statistic/count_requests
Returns a statistic containing the request count
backend.statistic.getCountRequests 14 params → 2004XX5XX
GET
/backend/statistic/errors_per_operation
Returns a statistic containing the errors per operation
backend.statistic.getErrorsPerOperation 14 params → 2004XX5XX
GET
/backend/statistic/incoming_requests
Returns a statistic containing the incoming requests
backend.statistic.getIncomingRequests 14 params → 2004XX5XX
GET
/backend/statistic/incoming_transactions
Returns a statistic containing the incoming transactions
backend.statistic.getIncomingTransactions 14 params → 2004XX5XX
GET
/backend/statistic/issued_tokens
Returns a statistic containing the issues tokens
backend.statistic.getIssuedTokens 14 params → 2004XX5XX
GET
/backend/statistic/most_used_activities
Returns a statistic containing the most used activities
backend.statistic.getMostUsedActivities 14 params → 2004XX5XX
GET
/backend/statistic/most_used_apps
Returns a statistic containing the most used apps
backend.statistic.getMostUsedApps 14 params → 2004XX5XX
GET
/backend/statistic/most_used_operations
Returns a statistic containing the most used operations
backend.statistic.getMostUsedOperations 14 params → 2004XX5XX
GET
/backend/statistic/requests_per_ip
Returns a statistic containing the requests per ip
backend.statistic.getRequestsPerIP 14 params → 2004XX5XX
GET
/backend/statistic/requests_per_operation
Returns a statistic containing the requests per operation
backend.statistic.getRequestsPerOperation 14 params → 2004XX5XX
GET
/backend/statistic/requests_per_user
Returns a statistic containing the requests per user
backend.statistic.getRequestsPerUser 14 params → 2004XX5XX
GET
/backend/statistic/test_coverage
Returns a statistic containing the test coverage
backend.statistic.getTestCoverage → 2004XX5XX
GET
/backend/statistic/time_average
Returns a statistic containing the time average
backend.statistic.getTimeAverage 14 params → 2004XX5XX
GET
/backend/statistic/time_per_operation
Returns a statistic containing the time per operation
backend.statistic.getTimePerOperation 14 params → 2004XX5XX
GET
/backend/statistic/used_points
Returns a statistic containing the used points
backend.statistic.getUsedPoints 14 params → 2004XX5XX
GET
/backend/statistic/user_registrations
Returns a statistic containing the user registrations
backend.statistic.getUserRegistrations 14 params → 2004XX5XX
taxonomy 6
GET
/backend/taxonomy
Returns a paginated list of taxonomies
backend.taxonomy.getAll 3 params → 2004XX5XX
POST
/backend/taxonomy
Creates a new taxonomy
backend.taxonomy.create body → 2014XX5XX
GET
/backend/taxonomy/{taxonomy_id}
Returns a specific taxonomy
backend.taxonomy.get 1 param → 2004XX5XX
PUT
/backend/taxonomy/{taxonomy_id}
Updates an existing taxonomy
backend.taxonomy.update 1 param body → 2004XX5XX
POST
/backend/taxonomy/{taxonomy_id}
Moves the provided ids to the taxonomy
backend.taxonomy.move 1 param body → 2004XX5XX
DELETE
/backend/taxonomy/{taxonomy_id}
Deletes an existing taxonomy
backend.taxonomy.delete 1 param → 2004XX5XX
tenant 2
PUT
/backend/tenant/{tenant_id}
Setup a new tenant
backend.tenant.setup 1 param → 2004XX5XX
DELETE
/backend/tenant/{tenant_id}
Removes an existing tenant
backend.tenant.remove 1 param → 2004XX5XX
test 5
GET
/backend/test/{test_id}
Returns a specific test
backend.test.get 1 param → 2004XX5XX
PUT
/backend/test/{test_id}
Updates an existing test
backend.test.update 1 param body → 2004XX5XX
GET
/backend/test
Returns a paginated list of tests
backend.test.getAll 3 params → 2004XX5XX
PUT
/backend/test
Refresh all tests
backend.test.refresh → 2004XX5XX
POST
/backend/test
Run all tests
backend.test.run → 2004XX5XX
token 2
GET
/backend/token/{token_id}
Returns a specific token
backend.token.get 1 param → 2004XX5XX
GET
/backend/token
Returns a paginated list of tokens
backend.token.getAll 10 params → 2004XX5XX
transaction 2
GET
/backend/transaction/{transaction_id}
Returns a specific transaction
backend.transaction.get 1 param → 2004XX5XX
GET
/backend/transaction
Returns a paginated list of transactions
backend.transaction.getAll 11 params → 2004XX5XX
trash 3
GET
/backend/trash/{type}
Returns all deleted records by trash type
backend.trash.getAllByType 4 params → 2004XX5XX
POST
/backend/trash/{type}
Restores a previously deleted record
backend.trash.restore 1 param body → 2004XX5XX
GET
/backend/trash
Returns all trash types
backend.trash.getTypes → 2004XX5XX
trigger 5
GET
/backend/trigger
Returns a paginated list of triggers
backend.trigger.getAll 4 params → 2004XX5XX
POST
/backend/trigger
Creates a new trigger
backend.trigger.create body → 2014XX5XX
GET
/backend/trigger/{trigger_id}
Returns a specific trigger
backend.trigger.get 1 param → 2004XX5XX
PUT
/backend/trigger/{trigger_id}
Updates an existing trigger
backend.trigger.update 1 param body → 2004XX5XX
DELETE
/backend/trigger/{trigger_id}
Deletes an existing trigger
backend.trigger.delete 1 param → 2004XX5XX
user 6
GET
/backend/user
Returns a paginated list of users
backend.user.getAll 3 params → 2004XX5XX
POST
/backend/user
Creates a new user
backend.user.create body → 2014XX5XX
GET
/backend/user/{user_id}
Returns a specific user
backend.user.get 1 param → 2004XX5XX
PUT
/backend/user/{user_id}
Updates an existing user
backend.user.update 1 param body → 2004XX5XX
DELETE
/backend/user/{user_id}
Deletes an existing user
backend.user.delete 1 param → 2004XX5XX
POST
/backend/user/{user_id}/resend
Resend the activation mail to the provided user
backend.user.resend 1 param body → 2004XX5XX
webhook 5
GET
/backend/webhook
Returns a paginated list of webhooks
backend.webhook.getAll 3 params → 2004XX5XX
POST
/backend/webhook
Creates a new webhook
backend.webhook.create body → 2014XX5XX
GET
/backend/webhook/{webhook_id}
Returns a specific webhook
backend.webhook.get 1 param → 2004XX5XX
PUT
/backend/webhook/{webhook_id}
Updates an existing webhook
backend.webhook.update 1 param body → 2004XX5XX
DELETE
/backend/webhook/{webhook_id}
Deletes an existing webhook
backend.webhook.delete 1 param → 2004XX5XX

Schemas 219

The contract defines 219 schemas that model the data the API accepts and returns. The most detailed are Backend_Operation (18 properties), Backend_Agent (14 properties), Backend_App (12 properties), Backend_DatabaseTableColumn (11 properties). Each schema is shown below with its type and property counts.

Agent_Input
object
This object represents an agent input
2 properties
Agent_Item
Agent_ItemBinary
Agent_ItemChoice
Agent_ItemObject
Agent_ItemText
Agent_ItemToolCall
Agent_ItemToolCallFunction
object
Concrete values for a function tool call
3 properties
Agent_Output
object
This object represents an agent output
2 properties
Backend_AccountChangePassword
object
3 properties
Backend_Action
object
This object represents the business logic which can be executed either through an operation or cronjob
7 properties
Backend_ActionCollection
object
Base collection
4 properties
Backend_ActionCommit
object
An action commit which represents a change in the action configuration
5 properties
Backend_ActionCommitCollection
object
Base collection
4 properties
Backend_ActionConfig
object
The action configuration which contains arbitrary key-value entries
Backend_ActionCreate
Backend_ActionExecuteRequest
object
Represents a request to execute an action
5 properties
Backend_ActionExecuteRequestBody
object
Represents a request body
Backend_ActionExecuteResponse
object
Represents an action execution response
3 properties
Backend_ActionExecuteResponseBody
object
Represents a response body
Backend_ActionExecuteResponseHeaders
object
Represents a map of headers
Backend_ActionIndex
object
Contains all possible classes which can be used at an action as class
1 property
Backend_ActionIndexEntry
object
Represents a concrete action class
2 properties
Backend_ActionUpdate
Backend_Agent
object
This object represents an agent
14 properties
Backend_AgentCollection
object
Base collection
4 properties
Backend_AgentCreate
Backend_AgentMessage
object
This object represents an agent message
5 properties
Backend_AgentMessageCollection
object
Base collection
4 properties
Backend_AgentTool
object
Represents a concrete tool
2 properties
Backend_AgentTools
object
Represents a collection of available tools
1 property
Backend_AgentUpdate
Backend_App
object
This object represents an app to access the API on-behalf of a user
12 properties
Backend_AppCollection
object
Base collection
4 properties
Backend_AppCreate
Backend_AppUpdate
Backend_Audit
object
This object represents an audit which is created every time something was changed at the system
8 properties
Backend_AuditCollection
object
Base collection
4 properties
Backend_AuditObject
object
A key value object containing the changes
Backend_BackupExport
object
Export of the complete system configuration
1 property
Backend_BackupImport
object
Import a previously exported system configuration
1 property
Backend_BackupImportResult
object
Result of a backup import operation
3 properties
Backend_Bundle
object
This object represents a bundle which contains action, schema, event, cronjob and trigger configurations from you local instance
8 properties
Backend_BundleCollection
object
Base collection
4 properties
Backend_BundleConfig
object
Backend_BundleCreate
Backend_BundleUpdate
Backend_Category
object
This object represents a category. Every user is assigned to a category and can only view objects which are also assigned to the same category, through this it…
2 properties
Backend_CategoryCollection
object
Base collection
4 properties
Backend_CategoryCreate
Backend_CategoryUpdate
Backend_Config
object
This object represents a system configuration
5 properties
Backend_ConfigCollection
object
Base collection
4 properties
Backend_ConfigUpdate
Backend_Connection
object
This object represents a connection to an external system like i.e. a database, message-queue or client-sdk
6 properties
Backend_ConnectionCollection
object
Base collection
4 properties
Backend_ConnectionConfig
object
The connection configuration which contains arbitrary key-value entries
Backend_ConnectionCreate
Backend_ConnectionIndex
object
Contains all possible classes which can be used at an connection as class
1 property
Backend_ConnectionIndexEntry
object
Represents a concrete connection class
2 properties
Backend_ConnectionRedirectResponse
object
Redirect response to initiate an OAuth2 flow
1 property
Backend_ConnectionUpdate
Backend_Cronjob
object
This object represents a cronjob which can invoke an action at a specific interval
8 properties
Backend_CronjobCollection
object
Base collection
4 properties
Backend_CronjobCreate
Backend_CronjobError
object
Represents an error which occurred on cronjob execution
4 properties
Backend_CronjobUpdate
Backend_Dashboard
object
Represents an object containing all widget data for the dashboard
9 properties
Backend_DatabaseRow
object
This object represents a row on a relational table
Backend_DatabaseRowCollection
object
Base collection
4 properties
Backend_DatabaseTable
object
This object represents a relational table on a database connection
5 properties
Backend_DatabaseTableCollection
object
Base collection
4 properties
Backend_DatabaseTableColumn
object
This object represents a column at a relation table
11 properties
Backend_DatabaseTableForeignKeyConstraint
object
This object represents a foreign key constraint on a relational database
4 properties
Backend_DatabaseTableIndex
object
This object represents a table index on a relational database
3 properties
Backend_Event
object
This object represents an event which can be triggered by an action
5 properties
Backend_EventCollection
object
Base collection
4 properties
Backend_EventCreate
Backend_EventUpdate
Backend_File
object
This object represents a file on the filesystem
5 properties
Backend_FileCollection
object
Base collection
4 properties
Backend_Firewall
object
This object represents a firewall rule which blocks specific IP addresses
6 properties
Backend_FirewallCollection
object
Base collection
4 properties
Backend_FirewallCreate
Backend_FirewallUpdate
Backend_Form
object
This object represents a form which helps to dynamically generate a form at a frontend app
6 properties
Backend_FormCollection
object
Base collection
4 properties
Backend_FormCreate
Backend_FormUpdate
Backend_GeneratorIndexProvider
object
Represents a concrete generator class
2 properties
Backend_GeneratorIndexProviders
object
Contains all possible classes which can be used at an generator as class
1 property
Backend_GeneratorProvider
object
4 properties
Backend_GeneratorProviderChangelog
object
3 properties
Backend_GeneratorProviderConfig
object
Backend_HttpRequest
object
This object represents a HTTP request
4 properties
Backend_HttpResponse
object
This object represents a HTTP response
3 properties
Backend_Identity
object
This object represents an identity which allows to authenticate with a remote identity provider
8 properties
Backend_IdentityCollection
object
Base collection
4 properties
Backend_IdentityConfig
object
Backend_IdentityCreate
Backend_IdentityIndex
object
Contains all possible classes which can be used at an identity as class
1 property
Backend_IdentityIndexEntry
object
Represents a concrete identity class
2 properties
Backend_IdentityUpdate
Backend_Log
object
This object represents a log entry. Every HTTP requests to the system generates such a log entry.
9 properties
Backend_LogCollection
object
Base collection
4 properties
Backend_LogError
object
7 properties
Backend_LogErrorCollection
object
Base collection
4 properties
Backend_Operation
object
This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information a…
18 properties
Backend_OperationCollection
object
Base collection
4 properties
Backend_OperationCreate
Backend_OperationParameters
object
Backend_OperationSchema
object
4 properties
Backend_OperationThrows
object
Backend_OperationUpdate
Backend_Page
object
This object represents a page at the developer portal
6 properties
Backend_PageCollection
object
Base collection
4 properties
Backend_PageCreate
Backend_PageUpdate
Backend_Plan
object
This object represents a plan, a plan allows users to obtain points or in general subscribe to your app
9 properties
Backend_PlanCollection
object
Base collection
4 properties
Backend_PlanCreate
Backend_PlanUpdate
Backend_Rate
object
This object represents a rate limitation, which allows to limit the requests which a user can send
7 properties
Backend_RateAllocation
object
This object represents a rate allocation, in case a request matches it gets assigned to the attached rate
6 properties
Backend_RateCollection
object
Base collection
4 properties
Backend_RateCreate
Backend_RateUpdate
Backend_Role
object
This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user
4 properties
Backend_RoleCollection
object
Base collection
4 properties
Backend_RoleCreate
Backend_RoleUpdate
Backend_Schema
object
This object represents a schema to describe a JSON payload
5 properties
Backend_SchemaCollection
object
Base collection
4 properties
Backend_SchemaCommit
object
A schema commit which represents a change in the schema source
5 properties
Backend_SchemaCommitCollection
object
Base collection
4 properties
Backend_SchemaCreate
Backend_SchemaPreviewResponse
object
1 property
Backend_SchemaSource
object
Contains the TypeSchema specification
Backend_SchemaUpdate
Backend_Scope
object
This object represents a scope. A scope is assigned to a user and is required to access operations
5 properties
Backend_ScopeCategories
object
1 property
Backend_ScopeCategory
object
3 properties
Backend_ScopeCategoryScope
object
3 properties
Backend_ScopeCollection
object
Base collection
4 properties
Backend_ScopeCreate
Backend_ScopeOperation
object
2 properties
Backend_ScopeUpdate
Backend_SdkGenerate
object
2 properties
Backend_SdkMessage
object
3 properties
Backend_SdkResponse
object
1 property
Backend_SdkTypes
object
Represents available SDK type which can be generated
Backend_SpecificationChangelog
object
4 properties
Backend_SpecificationGet
object
1 property
Backend_SpecificationPublish
object
3 properties
Backend_StatisticChart
object
2 properties
Backend_StatisticChartSeries
object
2 properties
Backend_StatisticCount
object
3 properties
Backend_Taxonomy
object
This object represents a taxonomy. A taxonomy helps to internally organize operations, actions and other entities
3 properties
Backend_TaxonomyCollection
object
Base collection
4 properties
Backend_TaxonomyCreate
Backend_TaxonomyMove
object
Moves the provided objects to a taxonomy
6 properties
Backend_TaxonomyUpdate
Backend_Test
object
This object represents a test. A test helps to verify that all operations work as expected
6 properties
Backend_TestCollection
object
Base collection
4 properties
Backend_TestConfig
Backend_Token
object
This object represents a token, this an access token which was requested by a user
7 properties
Backend_TokenCollection
object
Base collection
4 properties
Backend_Transaction
object
This object represents a transaction. The system generates a transaction in case a payment was successfully executed
9 properties
Backend_TransactionCollection
object
Base collection
4 properties
Backend_TrashData
object
3 properties
Backend_TrashDataCollection
object
Base collection
4 properties
Backend_TrashRestore
object
1 property
Backend_TrashTypes
object
1 property
Backend_Trigger
object
This object represents a trigger which can invoke an action on a custom event
5 properties
Backend_TriggerCollection
object
Base collection
4 properties
Backend_TriggerCreate
Backend_TriggerUpdate
Backend_User
object
This object represents a user
11 properties
Backend_UserCollection
object
Base collection
4 properties
Backend_UserCreate
Backend_UserUpdate
Backend_Webhook
object
This object represents a webhook, a webhook is called in case a specific event was triggered
6 properties
Backend_WebhookCollection
object
Base collection
4 properties
Backend_WebhookCreate
Backend_WebhookResponse
object
6 properties
Backend_WebhookUpdate
Common_FormContainer
object
Represents a config form with a list of elements
1 property
Common_FormElement
Common_FormElementCheckbox
Common_FormElementCollection
Common_FormElementInput
Common_FormElementMap
Common_FormElementSelect
Common_FormElementSelectOption
object
Represents a concrete option entry
2 properties
Common_FormElementTextArea
Common_FormElementTypeAPI
Common_FormElementTypeSchema
Common_Message
object
Common error message
3 properties
Common_Metadata
object
MarketplaceAction
MarketplaceActionCollection
object
4 properties
MarketplaceActionConfig
object
MarketplaceApp
MarketplaceAppCollection
object
4 properties
MarketplaceBundle
MarketplaceBundleAction
object
3 properties
MarketplaceBundleActionConfig
object
MarketplaceBundleCollection
object
4 properties
MarketplaceBundleConfig
object
5 properties
MarketplaceBundleCronjob
object
3 properties
MarketplaceBundleEvent
object
3 properties
MarketplaceBundleSchema
object
2 properties
MarketplaceBundleSchemaSource
object
MarketplaceBundleTrigger
object
3 properties
MarketplaceInstall
object
Installs an object from the marketplace
1 property
MarketplaceMessage
object
3 properties
MarketplaceObject
object
Base class of all objects on the marketplace
10 properties
MarketplaceUser
object
3 properties
Passthru
object
No schema information available

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusio-backend.json Raw ↑

Other APIs Fusio publishes across the network.

Fusio Consumer API
Fusio Worker API
Fusio System API
Fusio Authorization API
Where this information came from

This is an independent, third-party profile of Fusio Backend API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.