Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

The tenant API key that POST /bootstrap returned.

Body

application/json
snapshot
object
required

A tenant's configuration. The records use the fields of the create requests, except that a secret can be empty, which keeps the stored one. A null list leaves its records alone, even with prune. An empty list names the section with no records, so prune deletes every record of that kind. An export always sends apps, upstreams, and the users of each upstream whose users pgw stores.

prune
boolean
default:false

Delete the records that the snapshot leaves out, within the lists that it sends. A null or missing list deletes nothing.

dry_run
boolean
default:false

Return the plan and change nothing.

plan_digest
string

The plan_digest of the dry run. Required when the plan deletes.

Response

The plan, and whether pgw applied it.

changes
object[]
required
plan_digest
string
required

Identifies the plan. It doesn't depend on the order of the changes or on their devices.

applied
boolean
required

Whether pgw stored the changes.