GEgetorchestra
Pipelines

Move a pipeline to a folder

Changed on

Move an Orchestra-backed pipeline to a folder by alias or pipeline ID, leaving its definition and versions as they are. A git-backed pipeline's folder comes from where its YAML file lives, so move the file instead.

put/pipelines/{pipeline_id_or_alias}/folder

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/pipelines/{pipeline_id_or_alias}/folder
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:write

Path parameters

string uuid4 required
OR
string required

Pipeline ID or alias.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

folderstring nullable required

Folder path to move an Orchestra-backed pipeline to, such as finance/daily. Send null or an empty string for no folder.

Response

Successful Response

idstring uuid4 required
namestring required
numTasksinteger nullable
yamlPathstring required
createdAtstring required
updatedAtstring required
pausedboolean required
triggerEventsstring nullable
webhookstring nullable
schedulestring nullable
sensorsstring nullable
inputsobject nullable
productIdstring uuid4 nullable
productNamestring nullable
latestVersionNumberinteger nullable
publishedVersionNumberinteger nullable
storageProviderstring nullable
repositorystring nullable
defaultBranchstring nullable
aliasstring nullable
folderstring nullable
latestRunIdstring uuid4 nullable
latestRunStatus'QUEUED' | 'CREATED' | 'RUNNING' | 'SUCCEEDED' | 'WARNING' | 'FAILED' | 'SKIPPED' | 'CANCELLING' | 'CANCELLED'
latestRunMessagestring nullable
latestRunCreatedAtstring nullable
latestRunCompletedAtstring nullable
latestRunStartedAtstring nullable

Changes