---
seo:
  description: >-
    Administrative API for the attack/defence event's services, settings, game
    state, scoreboard, host and diagnostics. Authenticate with an organizer API
    key as…
sidebar:
  label: Overview
title: Athena Attack/Defence Admin API
---
Administrative API for the attack/defence event's services, settings, game state, scoreboard, host and diagnostics. Authenticate with an organizer API key as a bearer token. A few operations belong to the organizer panel or to the platform itself and say so in their description; an organizer key is refused on them. Players' flag submission and the public attack-info document are not part of this API; see the player guide.

Version 1.0.0

## Services

- [`GET /api/admin/services`](/ad-api/services/get-api-admin-services) — List services.
- [`POST /api/admin/services`](/ad-api/services/post-api-admin-services) — Create a service; refused once the host is allocated or the network opens.
- [`GET /api/admin/services/{id}`](/ad-api/services/get-api-admin-services-by-id) — Get a service.
- [`PATCH /api/admin/services/{id}`](/ad-api/services/patch-api-admin-services-by-id) — Update a service; ports and checker timeout freeze with the host allocation.
- [`DELETE /api/admin/services/{id}`](/ad-api/services/delete-api-admin-services-by-id) — Delete a service; refused once the host is allocated or the network opens.
- [`POST /api/admin/services/{id}/image`](/ad-api/services/post-api-admin-services-by-id-image) — Record a service's verified image digests; refused once the host is allocated.
- [`POST /api/admin/services/{id}/image/resolve`](/ad-api/services/post-api-admin-services-by-id-image-resolve) — Resolve a service's image and checker image to digests with the registry credentials stored on the service; nothing is written.
- [`PATCH /api/admin/services/{id}/stores/{index}`](/ad-api/services/patch-api-admin-services-by-id-stores-by-index) — Relabel a flag store.
- [`POST /api/admin/services/{id}/enable`](/ad-api/services/post-api-admin-services-by-id-enable) — Enable a service; refused once the host is allocated or the network opens.
- [`POST /api/admin/services/{id}/disable`](/ad-api/services/post-api-admin-services-by-id-disable) — Disable a service; refused once the host is allocated or the network opens.
- [`POST /api/admin/services/{id}/source`](/ad-api/services/post-api-admin-services-by-id-source) — Attach an uploaded source archive to a service.
- [`DELETE /api/admin/services/{id}/source`](/ad-api/services/delete-api-admin-services-by-id-source) — Detach a service's source archive.

## Config

- [`GET /api/admin/config`](/ad-api/config/get-api-admin-config) — Get the current event settings.
- [`PATCH /api/admin/config`](/ad-api/config/patch-api-admin-config) — Apply an idempotent event settings operation.
- [`GET /api/admin/config/versions`](/ad-api/config/get-api-admin-config-versions) — List every version of the event settings.
- [`POST /api/admin/config/revert`](/ad-api/config/post-api-admin-config-revert) — Restore settings through a new versioned operation.
- [`GET /api/admin/config/sync`](/ad-api/config/get-api-admin-config-sync) — Read settings synchronization status.
- [`GET /api/admin/config/operations/{id}`](/ad-api/config/get-api-admin-config-operations-by-id) — Read a durable settings operation.
- [`POST /api/admin/config/operations/{id}/ack`](/ad-api/config/post-api-admin-config-operations-by-id-ack) — Acknowledge the control-plane settings commit.

## Game

- [`GET /api/admin/game`](/ad-api/game/get-api-admin-game) — Read the game state.
- [`POST /api/admin/game/pause`](/ad-api/game/post-api-admin-game-pause) — Pause the game; the engine withdraws running checks and retries them on resume.
- [`POST /api/admin/game/resume`](/ad-api/game/post-api-admin-game-resume) — Resume the game once both control streams are attached and the host has converged.
- [`POST /api/admin/game/open`](/ad-api/game/post-api-admin-game-open) — Request the network open; the engine opens it once prerequisites hold.
- [`GET /api/admin/game/open`](/ad-api/game/get-api-admin-game-open) — Read the current host's opening attempt: its snapshot and seal operations and whether one failed.
- [`POST /api/admin/game/open/retry`](/ad-api/game/post-api-admin-game-open-retry) — Retry a failed network opening with fresh snapshot and seal operations for the attempt that failed; a replay of the same attempt returns the retry already made.
- [`POST /api/admin/game/end`](/ad-api/game/post-api-admin-game-end) — Record the End operation; the engine drains, scores and acknowledges it.
- [`GET /api/admin/game/end`](/ad-api/game/get-api-admin-game-end) — Read the End operation and whether the engine acknowledged it.

## Roster

- [`GET /api/admin/roster`](/ad-api/roster/get-api-admin-roster) — Read the roster lock status.
- [`POST /api/admin/roster/lock`](/ad-api/roster/post-api-admin-roster-lock) — Lock the roster: admit every team, assign stable numbers, refuse later formation.

## Submission tokens

- [`GET /api/admin/teams/{teamId}/submission-token`](/ad-api/submission-tokens/get-api-admin-teams-by-team-id-submission-token) — Read a team's live submission token.
- [`GET /api/admin/teams/{teamId}/submission-tokens`](/ad-api/submission-tokens/get-api-admin-teams-by-team-id-submission-tokens) — List every live submission-token generation of a team, newest first.
- [`POST /api/admin/teams/{teamId}/submission-token/issue`](/ad-api/submission-tokens/post-api-admin-teams-by-team-id-submission-token-issue) — Issue a team's submission token.
- [`POST /api/admin/submission-token/revoke`](/ad-api/submission-tokens/post-api-admin-submission-token-revoke) — Revoke a submission token.

## Scoreboard

- [`GET /api/admin/scoreboard`](/ad-api/scoreboard/get-api-admin-scoreboard) — Read the teams x services scoreboard.
- [`GET /api/admin/scoreboard/history`](/ad-api/scoreboard/get-api-admin-scoreboard-history) — Read per-tick score events and service states for the matrix history.
- [`GET /api/admin/scoreboard/stores`](/ad-api/scoreboard/get-api-admin-scoreboard-stores) — Drill into one team's per-store states and score events for a service.

## Checker attempts

- [`GET /api/admin/checker-attempts`](/ad-api/checker-attempts/get-api-admin-checker-attempts) — List recent checker attempts.

## Diagnostics

- [`POST /api/admin/diagnostics`](/ad-api/diagnostics/post-api-admin-diagnostics) — Dispatch a diagnostic check against a team's box.
- [`GET /api/admin/diagnostics`](/ad-api/diagnostics/get-api-admin-diagnostics) — List recent diagnostic checks.
- [`GET /api/admin/diagnostics/{id}/bundle`](/ad-api/diagnostics/get-api-admin-diagnostics-by-id-bundle) — Read a diagnostic check's bounded, redacted output.

## Host

- [`GET /api/admin/host`](/ad-api/host/get-api-admin-host) — Read the event host's desired/observed state.
- [`GET /api/admin/host/inventory`](/ad-api/host/get-api-admin-host-inventory) — Read the enabled services a host is sized from, with the revision its allocation must match.
- [`PUT /api/admin/host/credential`](/ad-api/host/put-api-admin-host-credential) — Pin the event host's client certificate for a generation.
- [`POST /api/admin/host/credential/revoke`](/ad-api/host/post-api-admin-host-credential-revoke) — Revoke the event host's credential up to and including a generation.
- [`PUT /api/admin/host/allocation`](/ad-api/host/put-api-admin-host-allocation) — Deliver the admitted host shape the engine composes desired state from.
- [`POST /api/admin/host/incident`](/ad-api/host/post-api-admin-host-incident) — Record a host compromise: block both host sessions and pause play. Before the network opens the event may receive a replacement host; after, the loss is terminal.
- [`POST /api/admin/host/reallocation`](/ad-api/host/post-api-admin-host-reallocation) — Retire the current host allocation before the network opens, for an image change or a recorded compromise.
- [`GET /api/admin/host/history`](/ad-api/host/get-api-admin-host-history) — Read the current host allocation and list retired ones and recorded host incidents.

## Boxes

- [`GET /api/admin/boxes`](/ad-api/boxes/get-api-admin-boxes) — List every team's box.
- [`GET /api/admin/boxes/{teamId}`](/ad-api/boxes/get-api-admin-boxes-by-team-id) — Read a team's box.
- [`POST /api/admin/boxes/{teamId}/restore`](/ad-api/boxes/post-api-admin-boxes-by-team-id-restore) — Request a snapshot restore for a team's box.
- [`POST /api/admin/teams/{teamId}/ssh-keys/{keyId}/revoke`](/ad-api/boxes/post-api-admin-teams-by-team-id-ssh-keys-by-key-id-revoke) — Revoke a registered SSH key.

## Runner

- [`GET /api/admin/runner`](/ad-api/runner/get-api-admin-runner) — Read the runner's connectivity and backlog.
- [`POST /api/admin/runner/restart`](/ad-api/runner/post-api-admin-runner-restart) — Request a runner worker restart.

## Analytics

- [`GET /api/admin/stats`](/ad-api/analytics/get-api-admin-stats) — Get the event's headline counts.
- [`GET /api/admin/analytics/overview`](/ad-api/analytics/get-api-admin-analytics-overview) — Get the analytics overview.
- [`GET /api/admin/analytics/captures`](/ad-api/analytics/get-api-admin-analytics-captures) — Break submissions and captures down per tick.
- [`GET /api/admin/analytics/services`](/ad-api/analytics/get-api-admin-analytics-services) — Break checks, captures and points down per service.
- [`GET /api/admin/analytics/export`](/ad-api/analytics/get-api-admin-analytics-export) — Download the analytics report.

## Players

- [`GET /api/admin/players`](/ad-api/players/get-api-admin-players) — List players with their team and score.
- [`GET /api/admin/players/{id}`](/ad-api/players/get-api-admin-players-by-id) — Get a player's profile, keys and VPN assignment.
- [`DELETE /api/admin/players/{id}`](/ad-api/players/delete-api-admin-players-by-id) — Delete a player account.
- [`POST /api/admin/players/{id}/ban`](/ad-api/players/post-api-admin-players-by-id-ban) — Suspend a player and end their sessions.
- [`POST /api/admin/players/{id}/unban`](/ad-api/players/post-api-admin-players-by-id-unban) — Lift a player's suspension.
- [`POST /api/admin/players/{id}/vpn-peer/revoke`](/ad-api/players/post-api-admin-players-by-id-vpn-peer-revoke) — Revoke a player's WireGuard peer; the host drops it on its next desired generation.

## Teams

- [`GET /api/admin/teams`](/ad-api/teams/get-api-admin-teams) — List teams by score.
- [`POST /api/admin/teams`](/ad-api/teams/post-api-admin-teams) — Create a team before the roster locks; a hidden reference team may be memberless and is admitted but never scored.
- [`GET /api/admin/teams/{teamId}`](/ad-api/teams/get-api-admin-teams-by-team-id) — Get a team's profile, members, scores and keys.
- [`PATCH /api/admin/teams/{teamId}`](/ad-api/teams/patch-api-admin-teams-by-team-id) — Rename a team.
- [`DELETE /api/admin/teams/{teamId}`](/ad-api/teams/delete-api-admin-teams-by-team-id) — Delete an empty team, before the roster locks.
- [`PATCH /api/admin/teams/{teamId}/visibility`](/ad-api/teams/patch-api-admin-teams-by-team-id-visibility) — Make a team a hidden reference team or a scored one, before the roster locks.
- [`POST /api/admin/teams/{teamId}/members`](/ad-api/teams/post-api-admin-teams-by-team-id-members) — Move a player onto a team; their SSH keys and VPN peer on the old team are revoked.
- [`DELETE /api/admin/teams/{teamId}/members/{userId}`](/ad-api/teams/delete-api-admin-teams-by-team-id-members-by-user-id) — Remove a player from a team; an admitted team keeps its box when it empties.

## Submissions

- [`GET /api/admin/submissions`](/ad-api/submissions/get-api-admin-submissions) — List every line the submission endpoint answered.

## Announcements

- [`GET /api/admin/announcements`](/ad-api/announcements/get-api-admin-announcements) — List the announcements.
- [`POST /api/admin/announcements`](/ad-api/announcements/post-api-admin-announcements) — Post an announcement.
- [`PATCH /api/admin/announcements/{id}`](/ad-api/announcements/patch-api-admin-announcements-by-id) — Edit an announcement.
- [`DELETE /api/admin/announcements/{id}`](/ad-api/announcements/delete-api-admin-announcements-by-id) — Delete an announcement.

## Storage

- [`GET /api/admin/files`](/ad-api/storage/get-api-admin-files) — List every stored object with the service it sources.
- [`GET /api/admin/storage/usage`](/ad-api/storage/get-api-admin-storage-usage) — Get the event's storage usage against its quota.
- [`POST /api/admin/storage/upload-url`](/ad-api/storage/post-api-admin-storage-upload-url) — Reserve quota and presign a create-only upload.
- [`DELETE /api/admin/storage/files/{fileId}`](/ad-api/storage/delete-api-admin-storage-files-by-file-id) — Delete an uploaded file from the event's storage.

## Reports

- [`GET /api/admin/reports`](/ad-api/reports/get-api-admin-reports) — List the player reports.
- [`GET /api/admin/reports/{id}`](/ad-api/reports/get-api-admin-reports-by-id) — Get a report with its full thread.
- [`PATCH /api/admin/reports/{id}`](/ad-api/reports/patch-api-admin-reports-by-id) — Close a report.
- [`POST /api/admin/reports/{id}/admin-messages`](/ad-api/reports/post-api-admin-reports-by-id-admin-messages) — Reply to a report as an organizer.

## Feedback

- [`GET /api/admin/feedback`](/ad-api/feedback/get-api-admin-feedback) — Read the player feedback with its rating summary.

## Audit

- [`GET /api/admin/audit`](/ad-api/audit/get-api-admin-audit) — Read the event's audit trail.

## API keys

- [`GET /api/admin/api-keys`](/ad-api/api-keys/get-api-admin-api-keys) — List the organizer API keys.
- [`POST /api/admin/api-keys`](/ad-api/api-keys/post-api-admin-api-keys) — Mint an organizer API key.
- [`DELETE /api/admin/api-keys/{id}`](/ad-api/api-keys/delete-api-admin-api-keys-by-id) — Revoke an organizer API key.
- [`POST /api/admin/api-keys/system`](/ad-api/api-keys/post-api-admin-api-keys-system) — Mint an additional system API key.
- [`GET /api/admin/api-keys/system`](/ad-api/api-keys/get-api-admin-api-keys-system) — List the system API keys.
- [`DELETE /api/admin/api-keys/system/{id}`](/ad-api/api-keys/delete-api-admin-api-keys-system-by-id) — Revoke one system API key.
- [`PUT /api/admin/api-keys/provisioner`](/ad-api/api-keys/put-api-admin-api-keys-provisioner) — Install the provisioner's system key by hash.
- [`POST /api/admin/api-keys/system/extend`](/ad-api/api-keys/post-api-admin-api-keys-system-extend) — Keep every live system key valid until at least an instant; a revoked or expired key is never revived.
- [`POST /api/admin/api-keys/revoke-all`](/ad-api/api-keys/post-api-admin-api-keys-revoke-all) — Revoke every organizer API key.

## Certificates

- [`GET /api/admin/certificates/templates`](/ad-api/certificates/get-api-admin-certificates-templates) — List the certificate templates.
- [`POST /api/admin/certificates/templates`](/ad-api/certificates/post-api-admin-certificates-templates) — Create a certificate template.
- [`GET /api/admin/certificates/templates/{id}`](/ad-api/certificates/get-api-admin-certificates-templates-by-id) — Get a certificate template with its background URL.
- [`DELETE /api/admin/certificates/templates/{id}`](/ad-api/certificates/delete-api-admin-certificates-templates-by-id) — Delete a certificate template.
- [`PUT /api/admin/certificates/templates/{id}/draft`](/ad-api/certificates/put-api-admin-certificates-templates-by-id-draft) — Save a certificate template's draft layout.
- [`POST /api/admin/certificates/templates/{id}/background`](/ad-api/certificates/post-api-admin-certificates-templates-by-id-background) — Attach an uploaded background to a certificate draft.
- [`POST /api/admin/certificates/templates/{id}/publish`](/ad-api/certificates/post-api-admin-certificates-templates-by-id-publish) — Publish a certificate template's draft as a version.
- [`GET /api/admin/certificates/templates/{id}/versions/{version}`](/ad-api/certificates/get-api-admin-certificates-templates-by-id-versions-by-version) — Get a published version of a certificate template.
- [`GET /api/admin/certificates/tiers`](/ad-api/certificates/get-api-admin-certificates-tiers) — Get the certificate tiers.
- [`PUT /api/admin/certificates/tiers`](/ad-api/certificates/put-api-admin-certificates-tiers) — Replace the certificate tiers.
- [`GET /api/admin/certificates/samples`](/ad-api/certificates/get-api-admin-certificates-samples) — Preview a sample credential per tier.
- [`GET /api/admin/certificates`](/ad-api/certificates/get-api-admin-certificates) — List the issued certificates.
- [`POST /api/admin/certificates/issue`](/ad-api/certificates/post-api-admin-certificates-issue) — Issue certificates to the qualifying players.
- [`POST /api/admin/certificates/{id}/revoke`](/ad-api/certificates/post-api-admin-certificates-by-id-revoke) — Revoke an issued certificate.
- [`POST /api/admin/certificates/artifacts`](/ad-api/certificates/post-api-admin-certificates-artifacts) — Store the signed verification token and Open Badge.
- [`POST /api/admin/certificates/mark-emailed`](/ad-api/certificates/post-api-admin-certificates-mark-emailed) — Mark certificates as emailed to their holders.

## Discord

- [`GET /api/admin/discord`](/ad-api/discord/get-api-admin-discord) — Get the event's Discord integration state.
- [`PATCH /api/admin/discord`](/ad-api/discord/patch-api-admin-discord) — Turn the Discord integration on or off.
- [`PUT /api/admin/discord/staff-role`](/ad-api/discord/put-api-admin-discord-staff-role) — Set the Discord role that may run the bot's staff commands.
- [`DELETE /api/admin/discord/link/{id}`](/ad-api/discord/delete-api-admin-discord-link-by-id) — Detach a player's Discord account.

## Integrity

- [`GET /api/admin/integrity/filtering`](/ad-api/integrity/get-api-admin-integrity-filtering) — List source-filtering penalties with the evidence behind each, and inconclusive findings that were not penalized.

## Notifications

- [`GET /api/admin/notifications`](/ad-api/notifications/get-api-admin-notifications) — List event email deliveries and their outcomes, including terminal failures.
