STsteep
code

POST /v1/code/syncs

Sync your semantic models (Steep YAML, dbt or Cube) into Steep. Enqueues the sync and returns immediately with a queued result; poll get sync by id until the outcome is terminal (completed or failed). With dryRun, previews the sync instead: returns what it would create, update and remove, without changing anything.

Request

  • Base URL
    https://help.steep.app (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Request body

datasourceIdstring required

Unique resource ID (opaque). The datasource whose semantic models to sync.

dryRunboolean

When true, previews the sync: returns what it would create, update and remove, without changing anything. Nothing is queued, so there is no sync to poll.

Response

Response for status 200

datasourceIdstring required

Unique resource ID (opaque).

methodstring required

How the sync was triggered.

outcome'completed' | 'failed' required

completed when the sync would succeed, failed when it would fail, with the reason in error.

createdstring[] required

identifiers of entities the sync would create. Null when the preview failed.

updatedstring[] required

identifiers of entities the sync would update. Null when the preview failed.

removedstring[] required

identifiers of entities the sync would remove. Null when the preview failed.

unchangedstring[] required

identifiers of entities the sync would leave unchanged. Null when the preview failed.

errorunknown required
typestring required

Source of the semantic models that were synced.

errorsstring[] required

Errors the sync reported. Null until terminal.

warningsstring[] required

Warnings the sync reported. Null until terminal.

dryRunboolean required

Always true: this is a preview, and nothing was changed.

Changes

No recorded changes to this operation across all 1 revision of this API.