Skip to content

Models

CTFdModel

Bases: BaseModel

Base model for every CTFd resource.

The CTFd API regularly adds fields between releases, so unknown keys are tolerated rather than rejected.

Award

Bases: CTFdModel

Bracket

Bases: CTFdModel

A scoring bracket grouping users or teams (e.g. students vs staff).

Not formally defined in the public swagger; fields are inferred from the CTFd source and kept fully optional.

Challenge

Bases: CTFdModel

Comment

Bases: CTFdModel

Config

Bases: CTFdModel

Export

Bases: CTFdModel

Metadata about a CTFd export archive.

The /exports/raw endpoint streams a ZIP file rather than returning JSON, so this model only carries optional metadata that may accompany an export request (filename, size, content type).

File

Bases: CTFdModel

Flag

Bases: CTFdModel

Hint

Bases: CTFdModel

Notification

Bases: CTFdModel

Page

Bases: CTFdModel

ScoreboardEntry

Bases: CTFdModel

A single row of the scoreboard.

Not formally defined in the public swagger; fields are inferred from the CTFd source and kept fully optional.

Share

Bases: CTFdModel

A shareable link to a CTFd resource (e.g. a solve, a profile).

Not formally defined in the public swagger; fields are inferred from the CTFd source and kept fully optional.

Solution

Bases: CTFdModel

Statistic

Bases: CTFdModel

Generic container for the /statistics/* endpoints.

The CTFd statistics endpoints return heterogeneous aggregates (counts per category, percentages, time-series matrices, ...). Rather than locking a single shape, the payload is exposed as a free-form mapping under data.

Submission

Bases: CTFdModel

Tag

Bases: CTFdModel

Team

Bases: CTFdModel

Token

Bases: CTFdModel

Topic

Bases: CTFdModel

Unlock

Bases: CTFdModel

User

Bases: CTFdModel