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

Read a durable settings operation

GET/api/admin/config/operations/{id}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
idstringrequired
min length 1
Responses
200

Success

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
401

Unauthorized

errorstringrequired
404

Not found

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET '/api/admin/config/operations/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "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"
}