solarOS Organization API

Organization API

Sync Contract provider status

Refreshes provider status. The body is optional. Any body fields are ignored but still participate in idempotency matching; prefer an empty object.

/api/v1/contracts/{id}/sync

Refreshes provider status. The body is optional. Any body fields are ignored but still participate in idempotency matching; prefer an empty object.

Sync Contract provider status. Use an organization API key with contracts:sync. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

contracts:syncIdempotency-Key required

Parameters

NameInTypeDescription
idrequiredpathstringContract identifier returned by the Organization API.

Request body

object
synccontractproviderstatusRequest
{}

Responses

200

Contract sync action envelope

#/components/schemas/OrgApiActionEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing required scope: contracts:sync

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: contracts:sync429 Rate limit exceeded

Static examples

curl -X POST "$SOLAROS_BASE_URL/api/v1/contracts/$SOLAROS_CONTRACT/sync" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SOLAROS_IDEMPOTENCY_KEY" \
  --data '{}'