Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Read settings synchronization status

GET/api/admin/config/sync
Authorization
AuthorizationBearer token · headerrequired
Responses
200

Success

synchronizedbooleanrequired
pendingobject | nullrequired
Show properties
Any of:
object
idstringrequired
expectedVersionnumberrequired
targetVersionnumber | nullrequired
Show properties
Any of:
number
number
null
null
settingsobjectrequired
Show properties
ctfThemestringrequired
ctfNamestringrequired
ctfDescriptionstringrequired
startDatestringrequired
freezeDatestringrequired
endDatestringrequired
registrationOpenbooleanrequired
reportNotificationEmailsstring[]required
exportIncludeEmailsbooleanrequired
rulesstringrequired
faqobject[]required
Show properties
Array of object
questionstringrequired
answerstringrequired
rosterDeadlinestringrequired
tickSecondsnumberrequired
flagValidityTicksnumberrequired
checkerTimeoutSecondsnumberrequired
scoringWeightsobjectrequired
Show properties
slaUpnumberrequired
slaRecoveringnumberrequired
defenceBasenumberrequired
defenceWeightnumberrequired
attackBasenumberrequired
attackWeightnumberrequired
rankWeightnumberrequired
rankReductionbooleanrequired
reductionMinnumberrequired
reductionMaxnumberrequired
heroTitlestring | null
Show properties
Any of:
string
string
null
null
ctfLogoUrlstring | null
Show properties
Any of:
string
string
null
null
maxTeamSizenumber | null
Show properties
Any of:
number
number
null
null
marketingobject
Show properties
categoriesstring[]required
hostedBystring
prizePoolstring
discordUrlstring
writeupsUrlstring
contactUrlstring
versionnumberrequired
changedKeysstring[]required
requiresSyncbooleanrequired
acknowledgedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
createdAtstring<date-time>required
null
null
401

Unauthorized

errorstringrequired
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Request
curl -X GET '/api/admin/config/sync' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "synchronized": true,
  "pending": {
    "id": "string",
    "expectedVersion": 0,
    "targetVersion": 0,
    "settings": {
      "ctfTheme": "string",
      "ctfName": "string",
      "ctfDescription": "string",
      "startDate": "string",
      "freezeDate": "string",
      "endDate": "string",
      "registrationOpen": true,
      "reportNotificationEmails": [
        "string"
      ],
      "exportIncludeEmails": true,
      "rules": "string",
      "faq": [
        {
          "question": "string",
          "answer": "string"
        }
      ],
      "rosterDeadline": "string",
      "tickSeconds": 0,
      "flagValidityTicks": 0,
      "checkerTimeoutSeconds": 0,
      "scoringWeights": {
        "slaUp": 0,
        "slaRecovering": 0,
        "defenceBase": 0,
        "defenceWeight": 0,
        "attackBase": 0,
        "attackWeight": 0,
        "rankWeight": 0,
        "rankReduction": true,
        "reductionMin": 0,
        "reductionMax": 0
      },
      "heroTitle": "string",
      "ctfLogoUrl": "string",
      "maxTeamSize": 0,
      "marketing": {
        "categories": [
          "string"
        ],
        "hostedBy": "string",
        "prizePool": "string",
        "discordUrl": "string",
        "writeupsUrl": "string",
        "contactUrl": "string"
      }
    },
    "version": 0,
    "changedKeys": [
      "string"
    ],
    "requiresSync": true,
    "acknowledgedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}