Skip to main content
Platform API is used mainly for our Platform App, but it is open to be used by our users to fulfill their custom needs. Here are some references:
This documentation in only used for purpose of Platform API, Run API has different section.

Starters

Authentication

Get understanding of how we handle authentication.

HTTP Codes

Read all possible HTTP codes and what they mean.

API Sections

General & Security

AI Assistant

Open threads and get designed solution for your needs or support instantly.

Search

Find anything in your instance, use our powerful search.

Components

Manage components and libraries.

Secrets

Keep your secrets directly in our secure secret store, that can be used for your components (e.g. external API Keys, Private Keys and more).

Audit & Logs

Keep hand on audit, logs and setup monitoring of your instance.

Settings

Instance settings (e.g. authentication providers, default groups and more) as well as monitor your quota and usage.

IAM

Accounts

Manage user and service accounts as well as service account API Keys.

Permissions

Manage groups of permissions and assign roles and accounts.

Groups

Structure your accounts into groups that can be widely used.

Me

Manage your account.

Roles

Get all defined permissions and their meaning.

Resources

Databases

Manage various logical databases designed for specific needs.

Structure

Design and manage reusable database structure for your databases.

Files

Manage files with our blob storage.

Templates

Design and ship HTML templates quickly.

Endpoints

Endpoints (Run API)

Manage your customized Endpoints also known as Run API.

Jobs 🚀

Jobs

Configure templates of Jobs that can be used as destination for your triggers.

History

Monitor detailed executions of Jobs.

Triggers

Monitor events triggered by the instance or other components.

Schedule

Schedule

Configure a trigger to execute Job using cron-like schedule.

Events

Events

Configure a trigger to lecture your Job using realtime events.

Webhooks

Webhooks

Trigger and manage webhooks triggered by you or your Components.