Skip to content
English
Sign in
  • There are no suggestions because the search field is empty.

Getting Started with the Lifecycle API

In this article, learn how to use the Lifecycle API

The Lifecycle API is a great way to integrate with Orchestry via other system. 

What Can It Do?

Force Single Workspace

POST lifecycle/archivals/[siteId]/force

Used to force archival on a single workspace. For more information see: https://app.orchestry.com/client-api/documentation

Force Multiple Workspaces

POST lifecycle/archivals/forcebulk

Used to force an archival on multiple workspaces. For more information see https://app.orchestry.com/client-api/documentation

Get Workspace Archival Status

GET lifecycle/archivals/[siteId]/status

Used to retrieve the archival status of a single workspace. For more information see https://app.orchestry.com/client-api/documentation

Get Multiple Workspace Archival Statuses

GET lifecycle/archivals/getworkspacestatuses?siteIds=guid1,guid2,guid3

Used to retrieve the archival status of multiple workspaces. If any of the workspaces can't be found, will only return statuses of workspaces that were located. For more information see https://app.orchestry.com/client-api/documentation

Assign Lifecycle Policy to Single Workspace

POST lifecycle/archivals/[siteId]/assignpolicy

Used to assign a lifecycle policy to a single workspace. For more information see https://app.orchestry.com/client-api/documentation

Assign Lifecycle Policy to Multiple Workspaces

POST lifecycle/archivals/assignpolicies

For more information see https://app.orchestry.com/client-api/documentation

How Can it be Used?

Currently the Orchestry API can be used in three primary ways:

  1. Via the Test Bench
  2. Via PowerShell (see Using PowerShell to Call the Orchestry API : Orchestry Software )
  3. Via Power Automate custom actions (see Using Power Automate (or Azure Logic Apps) to Call the API : Orchestry Software)