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

Get the current event settings

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

Success

versionnumberrequired
activatedAtstring<date-time>required
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
401

Unauthorized

errorstringrequired
404

Response for status 404

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Request
curl -X GET '/api/admin/config' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "version": 0,
  "activatedAt": "2019-08-24T14:15:22Z",
  "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"
    }
  }
}