Skip to content

Apps, Actions, Blueprints and Types API

These endpoints describe the builder/registry layer: apps, actions, blueprints, and shared types. They are used for service integrations and reusable resource/action definitions.

Apps

GET /api/v2/apps

Returns apps.

Arguments:

ArgumentLocationDescription
projectQueryOptional project fullname filter.
workspaceQueryOptional workspace fullname filter.

Payload: none.

Response: AppView[].

GET /api/v2/apps/:fullname

Returns an app.

Arguments: fullname path argument.

Payload: none.

Response: AppView.

PUT /api/v2/apps/:fullname

Creates or updates an app.

Payload:

FieldRequiredDescription
nameYesApp name.
fullnameYesApp fullname.
projectYesProject fullname.
workspaceYesWorkspace fullname.
urlYesApp URL.
tagsNoTags.
labelsNoLabels.

Response: AppView.

DELETE /api/v2/apps/:fullname

Deletes an app.

Arguments: fullname path argument.

Payload: none.

Response: OperationResult.

Actions

GET /api/v2/actions

Returns actions.

Arguments:

ArgumentLocationDescription
projectQueryOptional project filter.
workspaceQueryOptional workspace filter.

Payload: none.

Response: ActionView[].

GET /api/v2/actions/:fullname

Returns an action.

Arguments: fullname path argument.

Payload: none.

Response: ActionView.

PUT /api/v2/actions/:fullname

Creates or updates an action.

Payload:

FieldRequiredDescription
nameYesAction name.
fullnameYesAction fullname.
projectYesProject fullname.
workspaceYesWorkspace fullname.
backendYesAction backend definition.
valuesYesAction values schema.
overridesYesFields that action can override.
tagsNoTags.
labelsNoLabels.
metaYesAction metadata.

Response: ActionView.

DELETE /api/v2/actions/:fullname

Deletes an action.

Arguments: fullname path argument.

Payload: none.

Response: OperationResult.

Blueprints

GET /api/v2/blueprints

Returns blueprints.

Arguments:

ArgumentLocationDescription
appQueryOptional app fullname filter.
projectQueryOptional project fullname filter.
workspaceQueryOptional workspace fullname filter.

Payload: none.

Response: BlueprintView[].

GET /api/v2/blueprints/:fullname

Returns a blueprint.

Arguments: fullname path argument.

Payload: none.

Response: BlueprintView.

PUT /api/v2/blueprints/:fullname

Creates or updates a blueprint.

Payload:

FieldRequiredDescription
nameYesBlueprint name.
fullnameYesBlueprint fullname.
appYesApp fullname.
projectYesProject fullname.
workspaceYesWorkspace fullname.
typeYesplain or external.
dataNoObject spec.
tagsNoTags.
labelsNoLabels.
meta.titleNoVisible title.
meta.descriptionNoDescription.

Response: BlueprintView.

DELETE /api/v2/blueprints/:fullname

Deletes a blueprint.

Arguments: fullname path argument.

Payload: none.

Response: OperationResult.

Types

GET /api/v2/types

Returns shared types.

Arguments:

ArgumentLocationDescription
projectQueryOptional project filter.
workspaceQueryOptional workspace filter.
statusQuerynot_tested, ready, or broken.
palletQueryOptional pallet filter.
kindQueryevent, call, transaction, or timer.
dataSourceQueryOptional data source filter.

Payload: none.

Response: SharedTypeView[].

GET /api/v2/types/:fullname

Returns a shared type.

Arguments: fullname path argument.

Payload: none.

Response: SharedTypeView.

PUT /api/v2/types/:fullname

Creates or updates a shared type.

Payload:

FieldRequiredDescription
nameYesShared type collection name.
fullnameYesShared type fullname.
projectYesProject fullname.
workspaceYesWorkspace fullname.
schemasYesObject with named type schemas.
tagsNoTags.
labelsNoLabels.
metaNoMetadata object.

Response: SharedTypeView.

DELETE /api/v2/types/:fullname

Deletes a shared type.

Arguments: fullname path argument.

Payload: none.

Response: OperationResult.