Challenges

LockedChallengeHint

Bases: ResponseModel

Represents a locked challenge hint in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the hint	required
cost	int	The cost of the hint	required

Attributes:

Name	Type	Description
id	int	The ID of the hint, read-only
cost	int	The cost of the hint

Source code in ctfdpy\models\challenges.py

class LockedChallengeHint(ResponseModel):
    """
    Represents a locked challenge hint in CTFd.

    Parameters
    ----------
    id : int
        The ID of the hint
    cost : int
        The cost of the hint

    Attributes
    ----------
    id : int
        The ID of the hint, read-only
    cost : int
        The cost of the hint
    """

    id: int = Field(frozen=True, exclude=True)
    cost: int

UnlockedChallengeHint

Bases: ResponseModel

Represents an unlocked challenge hint in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the hint	required
cost	int	The cost of the hint	required
content	str	The content of the hint	required

Attributes:

Name	Type	Description
id	int	The ID of the hint, read-only
cost	int	The cost of the hint
content	str	The content of the hint

Source code in ctfdpy\models\challenges.py

class UnlockedChallengeHint(ResponseModel):
    """
    Represents an unlocked challenge hint in CTFd.

    Parameters
    ----------
    id : int
        The ID of the hint
    cost : int
        The cost of the hint
    content : str
        The content of the hint

    Attributes
    ----------
    id : int
        The ID of the hint, read-only
    cost : int
        The cost of the hint
    content : str
        The content of the hint
    """

    id: int = Field(frozen=True, exclude=True)
    cost: int
    content: str

ChallengeListing

Bases: ResponseModel

Represents a challenge listing in CTFd.

This is returned by the GET /challenges endpoint.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
type	ChallengeType	The type of the challenge	required
name	str	The name of the challenge	required
value	int	The value of the challenge	required
solves	int	The number of solves of the challenge	required
solved_by_me	bool	Whether the challenge is solved by the current user	required
category	str	The category of the challenge	required
tags	list[str]	The tags of the challenge	required
template	str	The HTML template of the modal for the challenge. Used internally by the CTFd frontend.	required
script	str	The Javascript code for the modal for the challenge. Used internally by the CTFd frontend	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
type	ChallengeType	The type of the challenge
name	str	The name of the challenge
value	int	The value of the challenge
solves	int	The number of solves of the challenge
solved_by_me	bool	Whether the challenge is solved by the current user
category	str	The category of the challenge
tags	list[str]	The tags of the challenge
template	str	The HTML template of the modal for the challenge. Used internally by the CTFd frontend.
script	str	The Javascript code for the modal for the challenge. Used internally by the CTFd frontend

Source code in ctfdpy\models\challenges.py

class ChallengeListing(ResponseModel):
    """
    Represents a challenge listing in CTFd.

    This is returned by the `GET /challenges` endpoint.

    Parameters
    ----------
    id : int
        The ID of the challenge
    type : ChallengeType
        The type of the challenge
    name : str
        The name of the challenge
    value : int
        The value of the challenge
    solves : int
        The number of solves of the challenge
    solved_by_me : bool
        Whether the challenge is solved by the current user
    category : str
        The category of the challenge
    tags : list[str]
        The tags of the challenge
    template : str
        The HTML template of the modal for the challenge. Used internally by the CTFd frontend.
    script : str
        The Javascript code for the modal for the challenge. Used internally by the CTFd frontend

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    type : ChallengeType
        The type of the challenge
    name : str
        The name of the challenge
    value : int
        The value of the challenge
    solves : int
        The number of solves of the challenge
    solved_by_me : bool
        Whether the challenge is solved by the current user
    category : str
        The category of the challenge
    tags : list[str]
        The tags of the challenge
    template : str
        The HTML template of the modal for the challenge. Used internally by the CTFd frontend.
    script : str
        The Javascript code for the modal for the challenge. Used internally by the CTFd frontend
    """

    id: int = Field(frozen=True, exclude=True)
    type: ChallengeType
    name: str
    value: int
    solves: int
    solved_by_me: bool
    category: str
    tags: list[str]
    template: str = Field(frozen=True, exclude=True)
    script: str = Field(frozen=True, exclude=True)

AnonymousChallenge

Bases: ResponseModel

Represents an anonymized challenge in CTFd.

All fields in this model will always be the same, except for id.

This can be returned by the GET /challenges and GET /challenges/<int:challenge_id> endpoints.

This occurs when the challenge has a prerequisite that has not been solved and is set to be anonymized instead of hidden.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
type	Literal['hidden']	The type of the challenge	required
name	Literal['???']	The name of the challenge	required
value	Literal[0]	The value of the challenge	required
solves	None	The number of solves of the challenge	required
solved_by_me	Literal[False]	Whether the challenge is solved by the current user	required
category	Literal['???']	The category of the challenge	required
tags	list[Never]	The tags of the challenge. Always an empty list.	required
template	Literal['']	The HTML template of the modal for the challenge. Used internally by the CTFd frontend.	required
script	Literal['']	The Javascript code for the modal for the challenge. Used internally by the CTFd frontend	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
type	Literal['hidden']	The type of the challenge
name	Literal['???']	The name of the challenge
value	Literal[0]	The value of the challenge
solves	None	The number of solves of the challenge
solved_by_me	Literal[False]	Whether the challenge is solved by the current user
category	Literal['???']	The category of the challenge
tags	list[Never]	The tags of the challenge. Always an empty list.
template	Literal['']	The HTML template of the modal for the challenge. Used internally by the CTFd frontend.
script	Literal['']	The Javascript code for the modal for the challenge. Used internally by the CTFd frontend

Source code in ctfdpy\models\challenges.py

class AnonymousChallenge(ResponseModel):
    """
    Represents an anonymized challenge in CTFd.

    All fields in this model will always be the same, except for `id`.

    This can be returned by the `GET /challenges` and `GET /challenges/<int:challenge_id>` endpoints.

    This occurs when the challenge has a prerequisite that has not been solved
    and is set to be anonymized instead of hidden.

    Parameters
    ----------
    id : int
        The ID of the challenge
    type : Literal["hidden"]
        The type of the challenge
    name : Literal["???"]
        The name of the challenge
    value : Literal[0]
        The value of the challenge
    solves : None
        The number of solves of the challenge
    solved_by_me : Literal[False]
        Whether the challenge is solved by the current user
    category : Literal["???"]
        The category of the challenge
    tags : list[Never]
        The tags of the challenge. Always an empty list.
    template : Literal[""]
        The HTML template of the modal for the challenge. Used internally by the CTFd frontend.
    script : Literal[""]
        The Javascript code for the modal for the challenge. Used internally by the CTFd frontend

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    type : Literal["hidden"]
        The type of the challenge
    name : Literal["???"]
        The name of the challenge
    value : Literal[0]
        The value of the challenge
    solves : None
        The number of solves of the challenge
    solved_by_me : Literal[False]
        Whether the challenge is solved by the current user
    category : Literal["???"]
        The category of the challenge
    tags : list[Never]
        The tags of the challenge. Always an empty list.
    template : Literal[""]
        The HTML template of the modal for the challenge. Used internally by the CTFd frontend.
    script : Literal[""]
        The Javascript code for the modal for the challenge. Used internally by the CTFd frontend
    """

    id: int = Field(frozen=True, exclude=True)
    type: Literal["hidden"] = "hidden"
    name: Literal["???"]
    value: Literal[0]
    solves: None
    solved_by_me: Literal[False]
    category: Literal["???"]
    tags: Annotated[list[Any], Len(0, 0)]
    template: Literal[""]
    script: Literal[""]

BaseChallenge

Bases: _BaseChallenge

The base class for challenge models in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
value	int	The value of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
type	ChallengeType	The type of the challenge	required
type_data	ChallengeTypeDataDict	The data of the challenge type	required
solves	int	The number of solves the challenge has	required
solved_by_me	bool	Whether the challenge is solved by the current user	required
attempts	int	The number of attempts the current user has made on the challenge	required
files	list[str]	The URL paths to the files of the challenge	required
tags	list[str]	The tags of the challenge	required
hints	list[LockedChallengeHint | UnlockedChallengeHint]	The hints of the challenge	required
view	str	The HTML template of the challenge. Used internally by the CTFd frontend	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
value	int	The value of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
type	ChallengeType	The type of the challenge
type_data	ChallengeTypeDataDict	The data of the challenge type
solves	int	The number of solves the challenge has
solved_by_me	bool	Whether the challenge is solved by the current user
attempts	int	The number of attempts the current user has made on the challenge
files	list[str]	The URL paths to the files of the challenge
tags	list[str]	The tags of the challenge
hints	list[LockedChallengeHint | UnlockedChallengeHint]	The hints of the challenge
view	str	The HTML template of the challenge. Used internally by the CTFd frontend

Source code in ctfdpy\models\challenges.py

class BaseChallenge(_BaseChallenge):
    """
    The base class for challenge models in CTFd.

    Parameters
    ----------
    id : int
        The ID of the challenge
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : ChallengeType
        The type of the challenge
    type_data : ChallengeTypeDataDict
        The data of the challenge type
    solves : int
        The number of solves the challenge has
    solved_by_me : bool
        Whether the challenge is solved by the current user
    attempts : int
        The number of attempts the current user has made on the challenge
    files : list[str]
        The URL paths to the files of the challenge
    tags : list[str]
        The tags of the challenge
    hints : list[LockedChallengeHint | UnlockedChallengeHint]
        The hints of the challenge
    view : str
        The HTML template of the challenge. Used internally by the CTFd frontend

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : ChallengeType
        The type of the challenge
    type_data : ChallengeTypeDataDict
        The data of the challenge type
    solves : int
        The number of solves the challenge has
    solved_by_me : bool
        Whether the challenge is solved by the current user
    attempts : int
        The number of attempts the current user has made on the challenge
    files : list[str]
        The URL paths to the files of the challenge
    tags : list[str]
        The tags of the challenge
    hints : list[LockedChallengeHint | UnlockedChallengeHint]
        The hints of the challenge
    view : str
        The HTML template of the challenge. Used internally by the CTFd frontend
    """

    solves: int
    solved_by_me: bool
    attempts: int

    files: list[str]
    tags: list[str]
    hints: list[
        Annotated[
            Annotated[LockedChallengeHint, Tag("locked")]
            | Annotated[UnlockedChallengeHint, Tag("unlocked")],
            Discriminator(_hint_model_discriminator),
        ]
    ]

    view: str

StandardChallenge

Bases: BaseChallenge

Represents a standard challenge in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
value	int	The value of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
type	Literal[STANDARD]	The type of the challenge	required
type_data	ChallengeTypeDataDict[Literal[STANDARD]]	The data of the challenge type	required
solves	int	The number of solves the challenge has	required
solved_by_me	bool	Whether the challenge is solved by the current user	required
attempts	int	The number of attempts the current user has made on the challenge	required
files	list[str]	The URL paths to the files of the challenge	required
tags	list[str]	The tags of the challenge	required
hints	list[LockedChallengeHint | UnlockedChallengeHint]	The hints of the challenge	required
view	str	The HTML template of the challenge. Used internally by the CTFd frontend	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
value	int	The value of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
type	Literal[STANDARD]	The type of the challenge
type_data	ChallengeTypeDataDict[Literal[STANDARD]]	The data of the challenge type
solves	int	The number of solves the challenge has
solved_by_me	bool	Whether the challenge is solved by the current user
attempts	int	The number of attempts the current user has made on the challenge
files	list[str]	The URL paths to the files of the challenge
tags	list[str]	The tags of the challenge
hints	list[LockedChallengeHint | UnlockedChallengeHint]	The hints of the challenge
view	str	The HTML template of the challenge. Used internally by the CTFd frontend

Source code in ctfdpy\models\challenges.py

class StandardChallenge(BaseChallenge):
    """
    Represents a standard challenge in CTFd.

    Parameters
    ----------
    id : int
        The ID of the challenge
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.STANDARD]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.STANDARD]]
        The data of the challenge type
    solves : int
        The number of solves the challenge has
    solved_by_me : bool
        Whether the challenge is solved by the current user
    attempts : int
        The number of attempts the current user has made on the challenge
    files : list[str]
        The URL paths to the files of the challenge
    tags : list[str]
        The tags of the challenge
    hints : list[LockedChallengeHint | UnlockedChallengeHint]
        The hints of the challenge
    view : str
        The HTML template of the challenge. Used internally by the CTFd frontend

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.STANDARD]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.STANDARD]]
        The data of the challenge type
    solves : int
        The number of solves the challenge has
    solved_by_me : bool
        Whether the challenge is solved by the current user
    attempts : int
        The number of attempts the current user has made on the challenge
    files : list[str]
        The URL paths to the files of the challenge
    tags : list[str]
        The tags of the challenge
    hints : list[LockedChallengeHint | UnlockedChallengeHint]
        The hints of the challenge
    view : str
        The HTML template of the challenge. Used internally by the CTFd frontend
    """

    type: Literal[ChallengeType.STANDARD] = ChallengeType.STANDARD
    type_data: ChallengeTypeDataDict[Literal[ChallengeType.STANDARD]]

DynamicChallenge

Bases: BaseChallenge

Represents a dynamic challenge in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
value	int	The value of the challenge	required
initial	int	The initial value of the challenge	required
decay	int	The decay value of the challenge	required
minimum	int	The minimum value of the challenge	required
function	DecayFunction	The decay function of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
type	Literal[DYNAMIC]	The type of the challenge	required
type_data	ChallengeTypeDataDict[Literal[DYNAMIC]]	The data of the challenge type	required
solves	int	The number of solves the challenge has	required
solved_by_me	bool	Whether the challenge is solved by the current user	required
attempts	int	The number of attempts the current user has made on the challenge	required
files	list[str]	The URL paths to the files of the challenge	required
tags	list[str]	The tags of the challenge	required
hints	list[LockedChallengeHint | UnlockedChallengeHint]	The hints of the challenge	required
view	str	The HTML template of the challenge. Used internally by the CTFd frontend	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
value	int	The value of the challenge
initial	int	The initial value of the challenge
decay	int	The decay value of the challenge
minimum	int	The minimum value of the challenge
function	DecayFunction	The decay function of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
type	Literal[DYNAMIC]	The type of the challenge
type_data	ChallengeTypeDataDict[Literal[DYNAMIC]]	The data of the challenge type
solves	int	The number of solves the challenge has
solved_by_me	bool	Whether the challenge is solved by the current user
attempts	int	The number of attempts the current user has made on the challenge
files	list[str]	The URL paths to the files of the challenge
tags	list[str]	The tags of the challenge
hints	list[LockedChallengeHint | UnlockedChallengeHint]	The hints of the challenge
view	str	The HTML template of the challenge. Used internally by the CTFd frontend

Source code in ctfdpy\models\challenges.py

class DynamicChallenge(BaseChallenge):
    """
    Represents a dynamic challenge in CTFd.

    Parameters
    ----------
    id : int
        The ID of the challenge
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.DYNAMIC]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.DYNAMIC]]
        The data of the challenge type
    solves : int
        The number of solves the challenge has
    solved_by_me : bool
        Whether the challenge is solved by the current user
    attempts : int
        The number of attempts the current user has made on the challenge
    files : list[str]
        The URL paths to the files of the challenge
    tags : list[str]
        The tags of the challenge
    hints : list[LockedChallengeHint | UnlockedChallengeHint]
        The hints of the challenge
    view : str
        The HTML template of the challenge. Used internally by the CTFd frontend

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.DYNAMIC]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.DYNAMIC]]
        The data of the challenge type
    solves : int
        The number of solves the challenge has
    solved_by_me : bool
        Whether the challenge is solved by the current user
    attempts : int
        The number of attempts the current user has made on the challenge
    files : list[str]
        The URL paths to the files of the challenge
    tags : list[str]
        The tags of the challenge
    hints : list[LockedChallengeHint | UnlockedChallengeHint]
        The hints of the challenge
    view : str
        The HTML template of the challenge. Used internally by the CTFd frontend
    """

    value: int = Field(frozen=True, exclude=True)
    initial: int
    decay: int
    minimum: int
    function: DecayFunction

    type: Literal[ChallengeType.DYNAMIC] = ChallengeType.DYNAMIC
    type_data: ChallengeTypeDataDict[Literal[ChallengeType.DYNAMIC]]

BaseChallengeWriteResult

Bases: _BaseChallenge

The base class for challenge write results in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
value	int	The value of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
type	ChallengeType	The type of the challenge	required
type_data	ChallengeTypeDataDict	The data of the challenge type	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
value	int	The value of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
type	ChallengeType	The type of the challenge
type_data	ChallengeTypeDataDict	The data of the challenge type

Source code in ctfdpy\models\challenges.py

class BaseChallengeWriteResult(_BaseChallenge):
    """
    The base class for challenge write results in CTFd.

    Parameters
    ----------
    id : int
        The ID of the challenge
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : ChallengeType
        The type of the challenge
    type_data : ChallengeTypeDataDict
        The data of the challenge type

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : ChallengeType
        The type of the challenge
    type_data : ChallengeTypeDataDict
        The data of the challenge type
    """

StandardChallengeWriteResult

Bases: BaseChallengeWriteResult

Represents a standard challenge write result in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
value	int	The value of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
type	Literal[STANDARD]	The type of the challenge	required
type_data	ChallengeTypeDataDict[Literal[STANDARD]]	The data of the challenge type	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
value	int	The value of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
type	Literal[STANDARD]	The type of the challenge
type_data	ChallengeTypeDataDict[Literal[STANDARD]]	The data of the challenge type

Source code in ctfdpy\models\challenges.py

class StandardChallengeWriteResult(BaseChallengeWriteResult):
    """
    Represents a standard challenge write result in CTFd.

    Parameters
    ----------
    id : int
        The ID of the challenge
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.STANDARD]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.STANDARD]]
        The data of the challenge type

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.STANDARD]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.STANDARD]]
        The data of the challenge type
    """

    type: Literal[ChallengeType.STANDARD] = ChallengeType.STANDARD
    type_data: ChallengeTypeDataDict[Literal[ChallengeType.STANDARD]]

DynamicChallengeWriteResult

Bases: BaseChallengeWriteResult

Represents a dynamic challenge write result in CTFd.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge	required
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
value	int	The value of the challenge	required
initial	int	The initial value of the challenge	required
decay	int	The decay value of the challenge	required
minimum	int	The minimum value of the challenge	required
function	DecayFunction	The decay function of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
type	Literal[DYNAMIC]	The type of the challenge	required
type_data	ChallengeTypeDataDict[Literal[DYNAMIC]]	The data of the challenge type	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge, read-only
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
value	int	The value of the challenge
initial	int	The initial value of the challenge
decay	int	The decay value of the challenge
minimum	int	The minimum value of the challenge
function	DecayFunction	The decay function of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
type	Literal[DYNAMIC]	The type of the challenge
type_data	ChallengeTypeDataDict[Literal[DYNAMIC]]	The data of the challenge type

Source code in ctfdpy\models\challenges.py

class DynamicChallengeWriteResult(BaseChallengeWriteResult):
    """
    Represents a dynamic challenge write result in CTFd.

    Parameters
    ----------
    id : int
        The ID of the challenge
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.DYNAMIC]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.DYNAMIC]]
        The data of the challenge type

    Attributes
    ----------
    id : int
        The ID of the challenge, read-only
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    value : int
        The value of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    type : Literal[ChallengeType.DYNAMIC]
        The type of the challenge
    type_data : ChallengeTypeDataDict[Literal[ChallengeType.DYNAMIC]]
        The data of the challenge type
    """

    value: int = Field(frozen=True, exclude=True)
    initial: int
    decay: int
    minimum: int
    function: DecayFunction

    type: Literal[ChallengeType.DYNAMIC] = ChallengeType.DYNAMIC
    type_data: ChallengeTypeDataDict[Literal[ChallengeType.DYNAMIC]]

CreateBaseChallengePayload

Bases: CreatePayloadModel

Represents the base payload for creating a challenge in CTFd.

Parameters:

Name	Type	Description	Default
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
requirements	ChallengeRequirementsDict | None	The requirements of the challenge	required
type	ChallengeType	The type of the challenge	required

Attributes:

Name	Type	Description
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
requirements	ChallengeRequirementsDict | None	The requirements of the challenge
type	ChallengeType	The type of the challenge

Source code in ctfdpy\models\challenges.py

class CreateBaseChallengePayload(CreatePayloadModel):
    """
    Represents the base payload for creating a challenge in CTFd.

    Parameters
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    type : ChallengeType
        The type of the challenge

    Attributes
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    type : ChallengeType
        The type of the challenge
    """

    name: str
    description: str
    category: str
    state: ChallengeState

    connection_info: str | None = None
    next_id: int | None = None
    max_attempts: int | None = None

    requirements: ChallengeRequirementsDict | None = None

    type: ChallengeType

CreateStandardChallengePayload

Bases: CreateBaseChallengePayload

Represents the payload for creating a standard challenge in CTFd.

Parameters:

Name	Type	Description	Default
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
requirements	ChallengeRequirementsDict | None	The requirements of the challenge	required
value	int	The value of the challenge	required
type	Literal[STANDARD]	The type of the challenge	required

Attributes:

Name	Type	Description
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
requirements	ChallengeRequirementsDict | None	The requirements of the challenge
value	int	The value of the challenge
type	Literal[STANDARD]	The type of the challenge

Source code in ctfdpy\models\challenges.py

class CreateStandardChallengePayload(CreateBaseChallengePayload):
    """
    Represents the payload for creating a standard challenge in CTFd.

    Parameters
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    value : int
        The value of the challenge
    type : Literal[ChallengeType.STANDARD]
        The type of the challenge

    Attributes
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    value : int
        The value of the challenge
    type : Literal[ChallengeType.STANDARD]
        The type of the challenge
    """

    value: int
    type: Literal[ChallengeType.STANDARD] = ChallengeType.STANDARD

CreateDynamicChallengePayload

Bases: CreateBaseChallengePayload

Represents the payload for creating a dynamic challenge in CTFd.

Parameters:

Name	Type	Description	Default
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
requirements	ChallengeRequirementsDict | None	The requirements of the challenge	required
initial	int	The initial value of the challenge	required
decay	int	The decay value of the challenge	required
minimum	int	The minimum value of the challenge	required
function	DecayFunction	The decay function of the challenge	required
type	Literal[DYNAMIC]	The type of the challenge	required

Attributes:

Name	Type	Description
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
requirements	ChallengeRequirementsDict | None	The requirements of the challenge
initial	int	The initial value of the challenge
decay	int	The decay value of the challenge
minimum	int	The minimum value of the challenge
function	DecayFunction	The decay function of the challenge
type	Literal[DYNAMIC]	The type of the challenge

Source code in ctfdpy\models\challenges.py

class CreateDynamicChallengePayload(CreateBaseChallengePayload):
    """
    Represents the payload for creating a dynamic challenge in CTFd.

    Parameters
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge
    type : Literal[ChallengeType.DYNAMIC]
        The type of the challenge

    Attributes
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge
    type : Literal[ChallengeType.DYNAMIC]
        The type of the challenge
    """

    initial: int
    decay: int
    minimum: int
    function: DecayFunction
    type: Literal[ChallengeType.DYNAMIC] = ChallengeType.DYNAMIC

UpdateBaseChallengePayload

Bases: UpdatePayloadModel

The base class for challenge update payloads in CTFd.

Parameters:

Name	Type	Description	Default
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
requirements	ChallengeRequirementsDict | None	The requirements of the challenge	required

Attributes:

Name	Type	Description
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
requirements	ChallengeRequirementsDict | None	The requirements of the challenge

Source code in ctfdpy\models\challenges.py

class UpdateBaseChallengePayload(UpdatePayloadModel):
    """
    The base class for challenge update payloads in CTFd.

    Parameters
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge

    Attributes
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    """

    name: str = MISSING
    description: str = MISSING
    category: str = MISSING
    state: ChallengeState = MISSING

    connection_info: str | None = MISSING
    next_id: int | None = MISSING
    max_attempts: int | None = MISSING

    requirements: ChallengeRequirementsDict | None = MISSING

UpdateStandardChallengePayload

Bases: UpdateBaseChallengePayload

Represents a standard challenge update payload in CTFd.

Parameters:

Name	Type	Description	Default
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
requirements	ChallengeRequirementsDict | None	The requirements of the challenge	required
value	int	The value of the challenge	required

Attributes:

Name	Type	Description
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
requirements	ChallengeRequirementsDict | None	The requirements of the challenge
value	int	The value of the challenge

Source code in ctfdpy\models\challenges.py

class UpdateStandardChallengePayload(UpdateBaseChallengePayload):
    """
    Represents a standard challenge update payload in CTFd.

    Parameters
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    value : int
        The value of the challenge

    Attributes
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    value : int
        The value of the challenge
    """

    value: int = MISSING

UpdateDynamicChallengePayload

Bases: UpdateBaseChallengePayload

Represents a dynamic challenge update payload in CTFd.

Parameters:

Name	Type	Description	Default
name	str	The name of the challenge	required
description	str	The description of the challenge	required
category	str	The category of the challenge	required
state	ChallengeState	The state of the challenge	required
connection_info	str | None	The connection information of the challenge	required
next_id	int | None	The ID of the next challenge	required
max_attempts	int | None	The maximum number of attempts for the challenge	required
requirements	ChallengeRequirementsDict | None	The requirements of the challenge	required
initial	int	The initial value of the challenge	required
decay	int	The decay value of the challenge	required
minimum	int	The minimum value of the challenge	required
function	DecayFunction	The decay function of the challenge	required

Attributes:

Name	Type	Description
name	str	The name of the challenge
description	str	The description of the challenge
category	str	The category of the challenge
state	ChallengeState	The state of the challenge
connection_info	str | None	The connection information of the challenge
next_id	int | None	The ID of the next challenge
max_attempts	int | None	The maximum number of attempts for the challenge
requirements	ChallengeRequirementsDict | None	The requirements of the challenge
initial	int	The initial value of the challenge
decay	int	The decay value of the challenge
minimum	int	The minimum value of the challenge
function	DecayFunction	The decay function of the challenge

Source code in ctfdpy\models\challenges.py

class UpdateDynamicChallengePayload(UpdateBaseChallengePayload):
    """
    Represents a dynamic challenge update payload in CTFd.

    Parameters
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge

    Attributes
    ----------
    name : str
        The name of the challenge
    description : str
        The description of the challenge
    category : str
        The category of the challenge
    state : ChallengeState
        The state of the challenge
    connection_info : str | None
        The connection information of the challenge
    next_id : int | None
        The ID of the next challenge
    max_attempts : int | None
        The maximum number of attempts for the challenge
    requirements : ChallengeRequirementsDict | None
        The requirements of the challenge
    initial : int
        The initial value of the challenge
    decay : int
        The decay value of the challenge
    minimum : int
        The minimum value of the challenge
    function : DecayFunction
        The decay function of the challenge
    """

    initial: int = MISSING
    decay: int = MISSING
    minimum: int = MISSING
    function: DecayFunction = MISSING

ChallengeAttemptResult

Bases: ResponseModel

Represents a challenge attempt result in CTFd.

This is returned by the POST /challenges/attempts endpoint.

Parameters:

Name	Type	Description	Default
status	Literal['correct', 'incorrect', 'authentication_required', 'paused', 'ratelimited', 'already_solved']	The status of the attempt	required
message	str	The message of the attempt	required

Attributes:

Name	Type	Description
status	Literal['correct', 'incorrect', 'authentication_required', 'paused', 'ratelimited', 'already_solved']	The status of the attempt
message	str	The message of the attempt

Properties

is_correct : bool Whether the attempt is correct

Source code in ctfdpy\models\challenges.py

class ChallengeAttemptResult(ResponseModel):
    """
    Represents a challenge attempt result in CTFd.

    This is returned by the `POST /challenges/attempts` endpoint.

    Parameters
    ----------
    status : Literal["correct", "incorrect", "authentication_required", "paused", "ratelimited", "already_solved"]
        The status of the attempt
    message : str
        The message of the attempt

    Attributes
    ----------
    status : Literal["correct", "incorrect", "authentication_required", "paused", "ratelimited", "already_solved"]
        The status of the attempt
    message : str
        The message of the attempt

    Properties
    ----------
    is_correct : bool
        Whether the attempt is correct
    """

    status: Literal[
        "correct",
        "incorrect",
        "authentication_required",
        "paused",
        "ratelimited",
        "already_solved",
    ]
    message: str

    @property
    def is_correct(self) -> bool:
        return self.status == "correct"

ChallengeTypeInfo

Bases: ResponseModel

Represents the information of a challenge type in CTFd.

This is returned by the GET /challenges/types endpoint.

Parameters:

Name	Type	Description	Default
id	ChallengeType	The ID of the challenge type	required
name	ChallengeType	The name of the challenge type	required
templates	ChallengeTypeTemplatesDict	The templates of the challenge type	required
scripts	ChallengeTypeScriptsDict	The scripts of the challenge type	required
create	str	The HTML template for the form to create a challenge of the type	required

Source code in ctfdpy\models\challenges.py

class ChallengeTypeInfo(ResponseModel):
    """
    Represents the information of a challenge type in CTFd.

    This is returned by the `GET /challenges/types` endpoint.

    Parameters
    ----------
    id : ChallengeType
        The ID of the challenge type
    name : ChallengeType
        The name of the challenge type
    templates : ChallengeTypeTemplatesDict
        The templates of the challenge type
    scripts : ChallengeTypeScriptsDict
        The scripts of the challenge type
    create : str
        The HTML template for the form to create a challenge of the type
    """

    id: ChallengeType
    name: ChallengeType
    templates: ChallengeTypeTemplatesDict
    scripts: ChallengeTypeScriptsDict
    create: str

ChallengeFileLocation

Bases: ResponseModel

Represents a location of a challenge file in CTFd.

This is returned by the GET /challenges/<int:challenge_id>/files endpoint.

Not to be confused with the ChallengeFile model.

Parameters:

Name	Type	Description	Default
id	int	The ID of the file location	required
type	Literal[CHALLENGE]	The type of the file location	required
location	str	The URL path to the file	required

Attributes:

Name	Type	Description
id	int	The ID of the file location, read-only
type	Literal[CHALLENGE]	The type of the file location
location	str	The URL path to the file

Source code in ctfdpy\models\challenges.py

class ChallengeFileLocation(ResponseModel):
    """
    Represents a location of a challenge file in CTFd.

    This is returned by the `GET /challenges/<int:challenge_id>/files` endpoint.

    Not to be confused with the `ChallengeFile` model.

    Parameters
    ----------
    id : int
        The ID of the file location
    type : Literal[FileType.CHALLENGE]
        The type of the file location
    location : str
        The URL path to the file

    Attributes
    ----------
    id : int
        The ID of the file location, read-only
    type : Literal[FileType.CHALLENGE]
        The type of the file location
    location : str
        The URL path to the file
    """

    id: int = Field(frozen=True, exclude=True)
    type: Literal[FileType.CHALLENGE]
    location: str

ChallengeRequirements

Bases: ResponseModel

Represents the requirements of a challenge in CTFd.

This is returned by the GET /challenges/<int:challenge_id>/requirements endpoint.

Parameters:

Name	Type	Description	Default
prerequisites	list[int]	The IDs of the prerequisites of the challenge	required
anonymize	bool	Whether the challenge is anonymized	required

Attributes:

Name	Type	Description
prerequisites	list[int]	The IDs of the prerequisites of the challenge
anonymize	bool	Whether the challenge is anonymized

Source code in ctfdpy\models\challenges.py

class ChallengeRequirements(ResponseModel):
    """
    Represents the requirements of a challenge in CTFd.

    This is returned by the `GET /challenges/<int:challenge_id>/requirements` endpoint.

    Parameters
    ----------
    prerequisites : list[int]
        The IDs of the prerequisites of the challenge
    anonymize : bool
        Whether the challenge is anonymized

    Attributes
    ----------
    prerequisites : list[int]
        The IDs of the prerequisites of the challenge
    anonymize : bool
        Whether the challenge is anonymized
    """

    prerequisites: list[int]
    anonymize: bool

ChallengeSolve

Bases: ResponseModel

Represents a challenge solve in CTFd.

This is returned by the GET /challenges/<int:challenge_id>/solves endpoint.

Parameters:

Name	Type	Description	Default
account_id	int	The ID of the account that solved the challenge	required
name	str	The name of the account that solved the challenge	required
date	datetime	The date the challenge was solved	required
account_url	str	The URL path to the account that solved the challenge	required

Attributes:

Name	Type	Description
account_id	int	The ID of the account that solved the challenge
name	str	The name of the account that solved the challenge
date	datetime	The date the challenge was solved
account_url	str	The URL path to the account that solved the challenge

Source code in ctfdpy\models\challenges.py

class ChallengeSolve(ResponseModel):
    """
    Represents a challenge solve in CTFd.

    This is returned by the `GET /challenges/<int:challenge_id>/solves` endpoint.

    Parameters
    ----------
    account_id : int
        The ID of the account that solved the challenge
    name : str
        The name of the account that solved the challenge
    date : datetime
        The date the challenge was solved
    account_url : str
        The URL path to the account that solved the challenge

    Attributes
    ----------
    account_id : int
        The ID of the account that solved the challenge
    name : str
        The name of the account that solved the challenge
    date : datetime
        The date the challenge was solved
    account_url : str
        The URL path to the account that solved the challenge
    """

    account_id: int
    name: str
    date: datetime
    account_url: str

ChallengeTopic

Bases: ResponseModel

Represents a challenge topic in CTFd.

This is returned by the GET /challenges/<int:challenge_id>/topics endpoint.

This model is similar to ChallengeTopicReference but includes the topic value.

Parameters:

Name	Type	Description	Default
id	int	The ID of the challenge topic	required
challenge_id	int	The ID of the challenge	required
topic_id	int	The ID of the topic	required
value	str	The value of the topic	required

Attributes:

Name	Type	Description
id	int	The ID of the challenge topic, read-only
challenge_id	int	The ID of the challenge
topic_id	int	The ID of the topic
value	str	The value of the topic

Source code in ctfdpy\models\challenges.py

class ChallengeTopic(ResponseModel):
    """
    Represents a challenge topic in CTFd.

    This is returned by the `GET /challenges/<int:challenge_id>/topics` endpoint.

    This model is similar to `ChallengeTopicReference` but includes the topic value.

    Parameters
    ----------
    id : int
        The ID of the challenge topic
    challenge_id : int
        The ID of the challenge
    topic_id : int
        The ID of the topic
    value : str
        The value of the topic

    Attributes
    ----------
    id : int
        The ID of the challenge topic, read-only
    challenge_id : int
        The ID of the challenge
    topic_id : int
        The ID of the topic
    value : str
        The value of the topic
    """

    id: int = Field(frozen=True, exclude=True)
    challenge_id: int = Field(
        validation_alias=AliasChoices("challenge_id", "challenge")
    )
    topic_id: int = Field(validation_alias=AliasChoices("topic_id", "topic"))
    value: str