Skip to main content
POST
Trigger a topology sync for a site

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string<uuid>
required

A UUID string identifying this site.

Body

Request to sync a site's topology-service Region, declaring an intent first.

intent
object
required

What the first topology-service sync starting after this request should show.

Response

topology-service's answer to the sync trigger.

region
string
required
status
enum<string>
required
  • started - STARTED
  • already_running - ALREADY_RUNNING
Available options:
started,
already_running
intent
object
required

The stored intent as topology-service reports it.

request_id
string
required