Skip to main content
GET
List sync plans

Authorizations

klef.session
string
cookie
required

Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.

Query Parameters

status
enum<string>[]

Filter by any of these lifecycle statuses.

Available options:
generating,
ready,
approved,
applying,
done,
done_with_errors,
discarded
workerId
string<uuid>

Filter by an operation for this worker id.

origin
enum<string>[]

Filter by what started the plan: any of these origins.

What started a SyncPlan. For audit and filters only: nothing branches on it.

Available options:
manual,
scheduled,
event,
retry
q
string

The plan's number, or a case-insensitive match on the name of any policy the plan evaluated.

Required string length: 3 - 100
sort
enum<string>

Order the results by this column (default: newest requested).

Available options:
requested_at,
status,
generated_at,
approved_at,
completed_at,
approved_by
dir
enum<string>

Sort direction for sort (default: descending).

Available options:
asc,
desc
approvedBy
string<uuid>[]

Filter by any of these approvers.

requestedBy
string<uuid>[]

Filter by any of these requesters.

requestedBySystem
boolean

Include plans the schedule requested, alongside any requestedBy given.

completedFrom
string

Filter by completion at or after this timestamp.

completedTo
string

Filter by completion at or before this timestamp.

hasAny
enum<string>[]

Filter by holding any of these.

Available options:
operations,
findings,
error
cursor
integer<int32>
limit
integer<int32>

Response

OK

results
object[]
required
errors
object[]
required
pagination
null | object
required

Where one page sits in a paged read.