v3

latestOpenAPI 3.0.02026-07-31278263961.8 KB
Packages

Refresh package

post/packages/{selector}/refresh

Path parameters

selectorstring required

Query parameters

layer'universal' | 'integration' | 'connection'
integrationKeystring
integrationIdstring
connectionIdstring
connectionKeystring
instanceKeystring

Response

idstring required

Internal database ID of the element. Assigned by the API; unique per element.

namestring required
uuidstring

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

keystring required
descriptionstring

Optional human-readable description.

metaobject

Optional key-value metadata.

state'BUILDING' | 'CLIENT_ACTION_REQUIRED' | 'CONFIGURATION_ERROR' | 'SETUP_FAILED' | 'READY' | 'DISCONNECTING'

Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.

revisionstring

Opaque revision token; changes on each update. Used for optimistic concurrency.

createdAtstring

ISO date when the element was created.

updatedAtstring

ISO date when the element was last updated.

archivedAtstring

When set, the element is archived (soft-deleted). Archived elements cannot be patched.

isDeactivatedboolean

When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).

isReadOnlyboolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

integrationIdstring

Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.

integrationUuidstring

UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.

integrationKeystring

Key of the integration; alternative to integrationId. Resolved to integrationId by the API.

parentIdstring

Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.

parentUuidstring

UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.

parentKeystring

Key of the parent element; alternative to parentId. Resolved to parentId by the API.

connectionIdstring

Connection ID. Used when filtering by connection in list/selector queries, or when creating or identifying connection-level instances.

instanceKeystring

Key identifying a specific connection-level instance when multiple instances exist per (element, connection). Used in selector queries and when creating instances.

isUniversalboolean

When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.

externalAppIdstring

Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.

externalAppUuidstring

UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.

externalAppKeystring

Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.

scenarioTemplateIdstring
isCustomizedboolean
isPublicboolean
versionstring
changelogstring
parentPackageVersionstring