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

Create a challenge

POST/api/admin/challenges
Request body
requiredapplication/json
titlestringrequired
categoryIdstringrequired
difficultyIdstringrequired
descriptionstringrequired
pointsnumberrequired
maxAttemptsnumber | nullrequired
Show properties
Any of:
number
number
null
null
userSolvesVisibleboolean
scoringTypestring
Allowed:statictime_basedsolve_rate
initialPointsnumber | null
Show properties
Any of:
number
number
null
null
minimumPointsnumber
decayFactornumber
dynamicFlagboolean
containerSpecobject | null
Show properties
Any of:
object
sizestring
Allowed:smlxl
servicesobject[]required
min items 1 · max items 5
Show properties
Array of object
namestringrequired
matches ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
imagestringrequired
min length 1
commandstring[]
max items 64
environmentobject
portsobject[]
max items 2
Show properties
Array of object
portintegerrequired
min 1 · max 65535
kindstringrequired
Allowed:webtcp
null
null
hintsobject[]required
Show properties
Array of object
contentstringrequired
penaltyPointsnumber
filesobject[]required
Show properties
Array of object
idstringrequired
filenamestringrequired
sizenumberrequired
flagobject
Show properties
flagTypestringrequired
Allowed:staticdynamic
flagContentstringrequired
caseSensitiveboolean
prerequisitesstring[]required
Responses
200

Success

idstringrequired
pointsnumberrequired
titlestringrequired
descriptionstringrequired
containerSpecobject | nullrequired
Show properties
Any of:
object
servicesobject[]required
Show properties
Array of object
namestringrequired
imagestringrequired
commandstring[]
environmentobject
portsobject[]
Show properties
Array of object
portnumberrequired
kindstringrequired
Show properties
Any of:
string
string
string
string
sizestring
Show properties
Any of:
string
string
string
string
string
string
string
string
null
null
categoryIdstringrequired
difficultyIdstringrequired
maxAttemptsnumber | nullrequired
Show properties
Any of:
number
number
null
null
userSolvesVisiblebooleanrequired
scoringTypestringrequired
Show properties
Any of:
string
string
string
string
string
string
initialPointsnumber | nullrequired
Show properties
Any of:
number
number
null
null
minimumPointsnumber | nullrequired
Show properties
Any of:
number
number
null
null
decayFactornumber | nullrequired
Show properties
Any of:
number
number
null
null
dynamicFlagbooleanrequired
releaseAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
createdAtstring<date-time>required
updatedAtstring<date-time>required
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
createdBystringrequired
400

Bad request

errorstringrequired
401

Unauthorized

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
429

Too many requests

errorstringrequired
500

Unhandled server error

errorstringrequired
Try it
Server
Bodyapplication/json
Request
curl -X POST '/api/admin/challenges' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "categoryId": "string",
  "difficultyId": "string",
  "description": "string",
  "points": 0,
  "maxAttempts": 0,
  "userSolvesVisible": true,
  "scoringType": "static",
  "initialPoints": 0,
  "minimumPoints": 0,
  "decayFactor": 0,
  "dynamicFlag": true,
  "containerSpec": {
    "size": "s",
    "services": [
      {
        "name": "string",
        "image": "string",
        "command": [
          "string"
        ],
        "environment": {
          "property1": "string",
          "property2": "string"
        },
        "ports": [
          {
            "port": 1,
            "kind": "web"
          }
        ]
      }
    ]
  },
  "hints": [
    {
      "content": "string",
      "penaltyPoints": 0
    }
  ],
  "files": [
    {
      "id": "string",
      "filename": "string",
      "size": 0
    }
  ],
  "flag": {
    "flagType": "static",
    "flagContent": "string",
    "caseSensitive": true
  },
  "prerequisites": [
    "string"
  ]
}'
Response
{
  "id": "string",
  "points": 0,
  "title": "string",
  "description": "string",
  "containerSpec": {
    "services": [
      {
        "name": "string",
        "image": "string",
        "command": [
          "string"
        ],
        "environment": {
          "property1": "string",
          "property2": "string"
        },
        "ports": [
          {
            "port": 0,
            "kind": "tcp"
          }
        ]
      }
    ],
    "size": "xl"
  },
  "categoryId": "string",
  "difficultyId": "string",
  "maxAttempts": 0,
  "userSolvesVisible": true,
  "scoringType": "static",
  "initialPoints": 0,
  "minimumPoints": 0,
  "decayFactor": 0,
  "dynamicFlag": true,
  "releaseAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "status": "hidden",
  "createdBy": "string"
}