Advertise the currently selected offline-sync contract version

GET/api/v1/sync/contract-version

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Responses

200

Contract-version negotiation metadata

contractVersionstringrequired

Allowed:v1

supportedContractVersionsstring[]

min items 1 · default: ["v1"]

deprecationstring | nullrequired

migrationstringrequired

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X GET '/api/v1/sync/contract-version' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("/api/v1/sync/contract-version", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/sync/contract-version",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "contractVersion": "v1",
  "supportedContractVersions": [
    "v1"
  ],
  "deprecation": "string",
  "migration": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}