Class AppBuilderApi

Create a new app, returning the app ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Create a publish request to ask for approval to publish an app whose protection level is approval_required. Publishing happens automatically once the request is approved by a user with the appropriate permissions.

Delete a single app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Delete multiple apps in a single request from a list of app IDs. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Get the full definition of an app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Retrieve an app blueprint by its ID.

List app blueprints associated with a specific integration ID.

Retrieve app blueprints by their slugs.

List the versions of an app. This endpoint is paginated.

List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

List available app blueprints.

List all tags associated with the authenticated user's apps.

Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Revert an app to a previous version. The version to revert to is selected through the version query parameter. The reverted version becomes the new latest version of the app.

Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a deployment object on the app, with a nil app_version_id (00000000-0000-0000-0000-000000000000). The app can still be updated and published again in the future. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Update an existing app. This creates a new version of the app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Add or remove an app from the current user's favorites. Favorited apps can be filtered for using the filter[favorite] query parameter on the List Apps endpoint.

Enable or disable self-service for an app. Self-service apps can be discovered and run by users in your organization without explicit access being granted.

Replace the tags on an app. The provided list overwrites the existing tags entirely; tags not present in the request body are removed.

Assign a human-readable name to a specific version of an app. The version is selected through the version query parameter.

Update the publication protection level of an app. When set to approval_required, future publishes must go through an approval workflow before going live.