Explore all defined operations, data models and types for this version. For live editing and client SDK generators, inspect on TypeHub.
Returns user data of the current authenticated user
Revoke the access token of the current authenticated user
Changes the password of the authenticated user
Returns user data of the authenticated user
Updates user data of the authenticated user
Creates a new action
Deletes an existing action
Executes a specific action. This method should be used to test an action configuration
Returns a specific action
Returns a paginated list of actions
Returns all available action classes
Returns a paginated list of action commits
Returns the action config form
Updates an existing action
Creates a new agent
Deletes an existing agent
Returns a specific agent
Returns a paginated list of agents
Returns available tools for an agent
Returns a paginated list of agent messages
Submits a new agent message
Updates an existing agent
Creates a new app
Deletes an existing app
Deletes an existing token from an app
Returns a specific app
Returns a paginated list of apps
Updates an existing app
Returns a specific audit
Returns a paginated list of audits
Generates an backup of the current system
Imports an backup to the current system
Creates a new bundle
Deletes an existing bundle
Returns a specific bundle
Returns a paginated list of bundles
Publish an existing bundle to the marketplace
Updates an existing bundle
Creates a new category
Deletes an existing category
Returns a specific category
Returns a paginated list of categories
Updates an existing category
Returns a specific config
Returns a paginated list of configuration values
Updates an existing config value
Sends a message to an agent
Creates a new connection
Creates a new row at a table on a database
Creates a new table on a database
Deletes an existing row at a table on a database
Deletes an existing table on a database
Returns a specific row at a table on a database
Returns paginated rows at a table on a database
Returns the schema of a specific table on a database
Returns all available tables on a database
Updates an existing row at a table on a database
Updates an existing table on a database
Deletes an existing connection
Uploads one or more files on the filesystem connection
Deletes an existing file on the filesystem connection
Returns the content of the provided file id on the filesystem connection
Returns all available files on the filesystem connection
Updates an existing file on the filesystem connection
Returns a specific connection
Returns a paginated list of connections
Returns all available connection classes
Returns the connection config form
Returns a redirect url to start the OAuth2 authorization flow for the given connection
Sends an arbitrary HTTP request to the connection
Returns the SDK specification
Updates an existing connection
Creates a new cronjob
Deletes an existing cronjob
Returns a specific cronjob
Returns a paginated list of cronjobs
Updates an existing cronjob
Returns all available dashboard widgets
Creates a new event
Deletes an existing event
Returns a specific event
Returns a paginated list of events
Updates an existing event
Creates a new firewall rule
Deletes an existing firewall rule
Returns a specific firewall rule
Returns a paginated list of firewall rules
Updates an existing firewall rule
Creates a new form
Deletes an existing form
Returns a specific form
Returns a paginated list of forms
Updates an existing form
Executes a generator with the provided config
Generates a changelog of all potential changes if you execute this generator with the provided config
Returns all available generator classes
Returns the generator config form
Creates a new identity
Deletes an existing identity
Returns a specific identity
Returns a paginated list of identities
Returns all available identity classes
Returns the identity config form
Updates an existing identity
Returns a specific log
Returns a paginated list of logs
Returns a paginated list of log errors
Returns a specific error
Returns a specific marketplace action
Returns a paginated list of marketplace actions
Installs an action from the marketplace
Upgrades an action from the marketplace
Returns a specific marketplace app
Returns a paginated list of marketplace apps
Installs an app from the marketplace
Upgrades an app from the marketplace
Returns a specific marketplace bundle
Returns a paginated list of marketplace bundles
Installs an bundle from the marketplace
Upgrades an bundle from the marketplace
Creates a new operation
Deletes an existing operation
Returns a specific operation
Returns a paginated list of operations
Updates an existing operation
Creates a new page
Deletes an existing page
Returns a specific page
Returns a paginated list of pages
Updates an existing page
Creates a new plan
Deletes an existing plan
Returns a specific plan
Returns a paginated list of plans
Updates an existing plan
Creates a new rate limitation
Deletes an existing rate
Returns a specific rate
Returns a paginated list of rate limitations
Updates an existing rate
Creates a new role
Deletes an existing role
Returns a specific role
Returns a paginated list of roles
Updates an existing role
Creates a new schema
Deletes an existing schema
Returns a specific schema
Returns a paginated list of schemas
Returns a paginated list of schema commits
Returns a HTML preview of the provided schema
Updates an existing schema
Creates a new scope
Deletes an existing scope
Returns a specific scope
Returns a paginated list of scopes
Returns all available scopes grouped by category
Updates an existing scope
Generates a specific SDK
Returns a paginated list of SDKs
Returns the TypeHub specification
Returns the changelog between your current specification and the last tag
Publish the specification
Creates a new tag of your specification
Returns a statistic containing the activities per user
Returns a statistic containing the request count
Returns a statistic containing the errors per operation
Returns a statistic containing the incoming requests
Returns a statistic containing the incoming transactions
Returns a statistic containing the issues tokens
Returns a statistic containing the most used activities
Returns a statistic containing the most used apps
Returns a statistic containing the most used operations
Returns a statistic containing the requests per ip
Returns a statistic containing the requests per operation
Returns a statistic containing the requests per user
Returns a statistic containing the test coverage
Returns a statistic containing the time average
Returns a statistic containing the time per operation
Returns a statistic containing the used points
Returns a statistic containing the user registrations
Creates a new taxonomy
Deletes an existing taxonomy
Returns a specific taxonomy
Returns a paginated list of taxonomies
Moves the provided ids to the taxonomy
Updates an existing taxonomy
Removes an existing tenant
Setup a new tenant
Returns a specific test
Returns a paginated list of tests
Refresh all tests
Run all tests
Updates an existing test
Returns a specific token
Returns a paginated list of tokens
Returns a specific transaction
Returns a paginated list of transactions
Returns all deleted records by trash type
Returns all trash types
Restores a previously deleted record
Creates a new trigger
Deletes an existing trigger
Returns a specific trigger
Returns a paginated list of triggers
Updates an existing trigger
Creates a new user
Deletes an existing user
Returns a specific user
Returns a paginated list of users
Resend the activation mail to the provided user
Updates an existing user
Creates a new webhook
Deletes an existing webhook
Returns a specific webhook
Returns a paginated list of webhooks
Updates an existing webhook
Activates an previously registered account through a token which was provided to the user via email
Authorizes the access of a specific app for the authenticated user
Change the password for the authenticated user
Change the password after the password reset flow was started
Returns a user data for the authenticated user
Returns information about a specific app to start the OAuth2 authorization code flow
User login by providing a username and password
Refresh a previously obtained access token
Register a new user account
Start the password reset flow
Updates user data for the authenticated user
Returns a specific agent
Returns a paginated list of agents
Returns a paginated list of agent messages
Submits a new agent message
Creates a new app for the authenticated user
Deletes an existing app for the authenticated user
Returns a specific app for the authenticated user
Returns a paginated list of apps which are assigned to the authenticated user
Updates an existing app for the authenticated user
Returns a specific event for the authenticated user
Returns a paginated list of apps which are assigned to the authenticated user
Returns a specific form for the authenticated user
Returns a paginated list of forms which are relevant to the authenticated user
Deletes an existing grant for an app which was created by the authenticated user
Returns a paginated list of grants which are assigned to the authenticated user
Identity callback endpoint to exchange an access token
Returns a paginated list of identities which are relevant to the authenticated user
Redirect the user to the configured identity provider
Returns a specific log for the authenticated user
Returns a paginated list of logs which are assigned to the authenticated user
Returns a specific page for the authenticated user
Returns a paginated list of pages which are relevant to the authenticated user
Start the checkout process for a specific plan
Generates a payment portal link for the authenticated user
Returns a specific plan for the authenticated user
Returns a paginated list of plans which are relevant to the authenticated user
Returns a paginated list of scopes which are assigned to the authenticated user
Returns all scopes by category
Creates a new token for the authenticated user
Deletes an existing token for the authenticated user
Returns a specific token for the authenticated user
Returns a paginated list of tokens which are assigned to the authenticated user
Updates an existing token for the authenticated user
Returns a specific transaction for the authenticated user
Returns a paginated list of transactions which are assigned to the authenticated user
Creates a new webhook for the authenticated user
Deletes an existing webhook for the authenticated user
Returns a specific webhook for the authenticated user
Returns a paginated list of webhooks which are assigned to the authenticated user
Updates an existing webhook for the authenticated user
Endpoint to generate a captcha challenge
Connection OAuth2 callback to authorize a connection
Returns meta information and links about the current installed Fusio version
Debug endpoint which returns the provided data
Health check endpoint which returns information about the health status of the system
Returns all available routes
Returns details of a specific schema
Payment webhook endpoint after successful purchase of a plan
This object represents an agent input
Agent item
Binary agent message
Choice agent message
Structured agent message
Text agent message
Tool call agent message
Concrete values for a function tool call
This object represents an agent output
Payload required to update the current user's password
This object represents the business logic which can be executed either through an operation or cronjob
A paginated collection of action objects
An action commit which represents a change in the action configuration
A paginated collection of action commit objects
The action configuration which contains arbitrary key-value entries
Payload for creating a new action entity
Represents a request to execute an action
Represents a request body
Represents an action execution response
Represents a response body
Represents a map of headers
Contains all possible classes which can be used at an action as class
Represents a concrete action class
Payload for updating an existing action entity
This object represents an agent
Represents a collection of agent messages
Payload for creating a new AI agent
This object represents an agent message
Represents a collection of agent messages
Represents a concrete tool
Represents a collection of available tools
Payload for updating an existing AI agent
This object represents an app to access the API on-behalf of a user
A paginated collection of app objects
Payload for creating a new consumer application
Payload for updating an existing consumer application
This object represents an audit which is created every time something was changed at the system
A paginated collection of audit objects
A key value object containing the changes
Export of the complete system configuration
Import a previously exported system configuration
Result of a backup import operation
This object represents a bundle which contains action, schema, event, cronjob and trigger configurations from you local instance
A paginated collection of bundle objects
Configuration settings and resource specs exported within the bundle
Payload for creating a new configuration bundle
Payload for updating an existing configuration bundle
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 is possible to build separate areas for external developers
A paginated collection of category objects
Payload for creating a new category
Payload for updating an existing category
This object represents a system configuration
A paginated collection of config objects
Payload for updating a system configuration entry
This object represents a connection to an external system like i.e. a database, message-queue or client-sdk
A paginated collection of connection objects
The connection configuration which contains arbitrary key-value entries
Payload for creating a new connection
Contains all possible classes which can be used at an connection as class
Represents a concrete connection class
Redirect response to initiate an OAuth2 flow
Payload for updating an existing connection
This object represents a cronjob which can invoke an action at a specific interval
A paginated collection of cronjob objects
Payload for creating a new cronjob
Represents an error which occurred on cronjob execution
Payload for updating an existing cronjob
Represents an object containing all widget data for the dashboard
This object represents a row on a relational table
A paginated collection of database rows
This object represents a relational table on a database connection
A paginated collection of database table objects
This object represents a column at a relation table
This object represents a foreign key constraint on a relational database
This object represents a table index on a relational database
This object represents an event which can be triggered by an action
A paginated collection of event objects
Payload for creating a new event entity
Payload for updating an existing event entity
This object represents a file on the filesystem
A paginated collection of file objects
This object represents a firewall rule which blocks specific IP addresses
A paginated collection of firewall objects
Payload for creating a new firewall rule
Payload for updating an existing firewall rule
This object represents a form which helps to dynamically generate a form at a frontend app
A paginated collection of form objects
Payload for creating a new form definition
Payload for updating an existing form definition
Represents a concrete generator class
Contains all possible classes which can be used at an generator as class
Configuration object used to invoke a schema/operation generator
Represents a preview changelog of entities created or updated by a generator run
Arbitrary configuration map for the generator provider
This object represents a HTTP request
This object represents a HTTP response
This object represents an identity which allows to authenticate with a remote identity provider
A paginated collection of identity objects
Identity provider configuration containing key-value parameters
Payload for creating a new identity provider entity
Contains all possible classes which can be used at an identity as class
Represents a concrete identity class
Payload for updating an existing identity provider entity
This object represents a log entry. Every HTTP requests to the system generates such a log entry.
A paginated collection of log objects
Represents an error logged during a specific HTTP request
A paginated collection of log error objects
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 about the request and response payload
A paginated collection of operation objects
Payload for creating a new operation entity
Map of path or query parameters accepted by the operation
Defines primitive type constraints for parameter schema definitions
Map of HTTP error status codes to target schema names
Payload for updating an existing operation entity
This object represents a page at the developer portal
A paginated collection of page objects
Payload for creating a new portal page
Payload for updating an existing portal page
This object represents a plan, a plan allows users to obtain points or in general subscribe to your app
A paginated collection of plan objects
Payload for creating a new subscription or point plan
Payload for updating an existing plan definition
This object represents a rate limitation, which allows to limit the requests which a user can send
This object represents a rate allocation, in case a request matches it gets assigned to the attached rate
A paginated collection of rate objects
Payload for creating a new rate limit policy
Payload for updating an existing rate limit policy
This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user
A paginated collection of role objects
Payload for creating a new user role entity
Payload for updating an existing user role entity
This object represents a schema to describe a JSON payload
A paginated collection of schema objects
A schema commit which represents a change in the schema source
A paginated collection of schema commit objects
Payload for creating a new schema definition
Response container for a generated schema code preview
Contains the TypeSchema specification
Payload for updating an existing schema definition
This object represents a scope. A scope is assigned to a user and is required to access operations
Container for grouping available scopes into logical categories
Represents a functional grouping of scopes
Simplified scope representation within a category view
A paginated collection of scope objects
Payload for creating a new scope entity
Mapping defining access permissions for a specific operation within a scope
Payload for updating an existing scope entity
Payload defining target format and configuration for triggering an SDK generation run
Response structure detailing the outcome of an SDK generation job
Container listing target SDK languages or formats available for generator execution
Represents available SDK type which can be generated
Represents structural changelog differences between specification versions
Container delivering the compiled API specification schema object
Payload defining configuration parameters for publishing an API specification export
Represents dataset structures formatted for rendering statistic charts
A single data line or bar series for a statistic chart
Represents an aggregated count metric over a specific timeframe
This object represents a taxonomy. A taxonomy helps to internally organize operations, actions and other entities
A paginated collection of taxonomy objects
Payload for creating a new taxonomy organization node
Moves the provided objects to a taxonomy
Payload for updating an existing taxonomy node
This object represents a test. A test helps to verify that all operations work as expected
A paginated collection of test objects
Configuration parameters for executing a test run
This object represents a token, this an access token which was requested by a user
A paginated collection of token objects
This object represents a transaction. The system generates a transaction in case a payment was successfully executed
A paginated collection of transaction objects
This object represents a deleted item stored in the trash bin
A paginated collection of deleted objects
Request payload to restore an item from the trash bin
List of available entity types that can be restored from the trash
This object represents a trigger which can invoke an action on a custom event
A paginated collection of trigger objects
Request payload to create a new trigger
Request payload to update an existing trigger
This object represents a user
A paginated collection of user objects
Request payload to register or create a new user account
Request payload to update existing user account information
This object represents a webhook, a webhook is called in case a specific event was triggered
A paginated collection of webhook objects
Request payload to create a new webhook subscription
Log record representing an execution attempt and delivery response for a webhook target
Request payload to update an existing webhook subscription
Base collection
Represents a config form with a list of elements
Form base element
Form element to select an action
Form element to select an agent
Form element which represents a checkbox element
Form element which represents a collection element
Form element to select a connection
Form element which represents an input element
Form element which represents a map element
Form element which represents a select element
Represents a concrete option entry
Form element which represents a textarea
Form element which represents a TypeAPI editor
Form element which represents a TypeSchema editor
Common error message
This object represents an agent
Represents a collection of agent messages
This object represents an agent message
Represents a collection of agent messages
Represents a consumer application registered by a user
Collection of consumer applications
Payload for creating a new consumer application
Payload for updating an existing consumer application
Metadata for an OAuth authorization request screen
Parameters sent to initiate an OAuth authorization decision
Result of an OAuth authorization decision
Represents an event trigger definition within the platform
Collection of event definitions
Dynamic form configuration entity
Collection of dynamic form definitions
Represents user authorization granted to a consumer application
Collection of user authorization grant records
Identity provider configuration for single sign-on
Collection of third-party identity providers
Access log entry recording an incoming HTTP request
Collection of access log records
Content page definition for developer portal documentation
Collection of content page entries
Request payload to initiate a checkout flow for a plan
Response payload containing the payment provider checkout URI
Request payload to launch the billing management portal
Response payload containing the customer portal portal link
Subscription or monetization plan for API consumers
Collection of subscription plans
Permission scope defining access rights to API endpoints
Grouped list of scope categories for user authorization forms
Category grouping related API scopes together
Scope entry within a specific category group
Collection of API permission scopes
Personal access token entity generated for consumer access
OAuth 2.0 access token response object
Collection of personal access tokens
Payload for issuing a new personal access token
Payload for updating an existing personal access token
Billing transaction record for quota or subscription purchases
Collection of transaction records
User profile and subscription status details
Payload used to activate a user account via token
Payload used to initiate account recovery or email requests
JWT authentication response containing access credentials
Credentials payload for user login
Payload for completing a password reset
Active plan summary associated with a user
Payload to request a refreshed authentication token
Payload for registering a new user account
Webhook endpoint subscription definition
Collection of webhook subscriptions
Payload for registering a new webhook subscription
Recorded delivery log response for a webhook dispatch
Payload for updating an existing webhook subscription
Installs an object from the marketplace
Base class of all objects on the marketplace
No schema information available