Rust API client for gzctf-server-api

GZCTF Server API Document

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: v1
• Generator version: 7.23.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named gzctf-server-api and add the following to Cargo.toml under [dependencies]:

gzctf-server-api = { path = "./gzctf-server-api" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccountApi	account_avatar	PUT /api/account/avatar	Update user avatar
AccountApi	account_change_email	PUT /api/account/changeemail	User email change
AccountApi	account_change_password	PUT /api/account/changepassword	User password change
AccountApi	account_log_in	POST /api/account/login	User login
AccountApi	account_log_out	POST /api/account/logout	User logout
AccountApi	account_mail_change_confirm	POST /api/account/mailchangeconfirm	User email change confirmation
AccountApi	account_password_reset	POST /api/account/passwordreset	User password reset
AccountApi	account_profile	GET /api/account/profile	Get user information
AccountApi	account_recovery	POST /api/account/recovery	User password recovery request
AccountApi	account_register	POST /api/account/register	User registration
AccountApi	account_update	PUT /api/account/update	User data update
AccountApi	account_verify	POST /api/account/verify	User email confirmation
AdminApi	admin_add_users	POST /api/admin/users	Add users in batch
AdminApi	admin_delete_team	DELETE /api/admin/teams/{id}	Delete team
AdminApi	admin_delete_user	DELETE /api/admin/users/{userid}	Delete user
AdminApi	admin_destroy_instance	DELETE /api/admin/instances/{id}	Delete container instance
AdminApi	admin_download_all_writeups	GET /api/admin/writeups/{id}/all	Download all Writeups
AdminApi	admin_files	GET /api/admin/files	Get all files
AdminApi	admin_get_configs	GET /api/admin/config	Get configuration
AdminApi	admin_instances	GET /api/admin/instances	Get all container instances
AdminApi	admin_logs	GET /api/admin/logs	Get all logs
AdminApi	admin_participation	PUT /api/admin/participation/{id}	Update participation status
AdminApi	admin_reset_logo	DELETE /api/admin/config/logo	Reset platform Logo
AdminApi	admin_reset_password	DELETE /api/admin/users/{userid}/password	Reset user password
AdminApi	admin_search_teams	POST /api/admin/teams/search	Search teams
AdminApi	admin_search_users	POST /api/admin/users/search	Search users
AdminApi	admin_teams	GET /api/admin/teams	Get all team information
AdminApi	admin_update_configs	PUT /api/admin/config	Change configuration
AdminApi	admin_update_logo	POST /api/admin/config/logo	Change platform Logo
AdminApi	admin_update_team	PUT /api/admin/teams/{id}	Modify team information
AdminApi	admin_update_user_info	PUT /api/admin/users/{userid}	Modify user information
AdminApi	admin_user_info	GET /api/admin/users/{userid}	Get user information
AdminApi	admin_users	GET /api/admin/users	Get all users
AdminApi	admin_writeups	GET /api/admin/writeups/{id}	Get all Writeup basic information
ApiTokenApi	api_token_generate_token	POST /api/tokens	Generates a new API token.
ApiTokenApi	api_token_list_tokens	GET /api/tokens	Lists all API tokens.
ApiTokenApi	api_token_restore_token	POST /api/tokens/{id}/restore	Restores an API token.
ApiTokenApi	api_token_revoke_token	DELETE /api/tokens/{id}	Revokes an API token.
AssetsApi	assets_delete	DELETE /api/assets/{hash}	File deletion interface
AssetsApi	assets_get_file	GET /assets/{hash}/{filename}	File retrieval interface
AssetsApi	assets_upload	POST /api/assets	File upload interface
EditApi	edit_add_flags	POST /api/edit/games/{id}/challenges/{cId}/flags	Add Game Challenge Flag
EditApi	edit_add_game	POST /api/edit/games	Add Game
EditApi	edit_add_game_challenge	POST /api/edit/games/{id}/challenges	Add Game Challenge
EditApi	edit_add_game_notice	POST /api/edit/games/{id}/notices	Add Game Notice
EditApi	edit_add_post	POST /api/edit/posts	Add Post
EditApi	edit_create_division	POST /api/edit/games/{id}/divisions	Create Division
EditApi	edit_create_test_container	POST /api/edit/games/{id}/challenges/{cId}/container	Test Game Challenge Container
EditApi	edit_delete_division	DELETE /api/edit/games/{id}/divisions/{divisionId}	Delete Division
EditApi	edit_delete_game	DELETE /api/edit/games/{id}	Delete Game
EditApi	edit_delete_game_notice	DELETE /api/edit/games/{id}/notices/{noticeId}	Delete Game Notice
EditApi	edit_delete_game_write_ups	DELETE /api/edit/games/{id}/writeups	Delete All WriteUps
EditApi	edit_delete_post	DELETE /api/edit/posts/{id}	Delete Post
EditApi	edit_destroy_test_container	DELETE /api/edit/games/{id}/challenges/{cId}/container	Destroy Test Game Challenge Container
EditApi	edit_export_game	POST /api/edit/games/{id}/export	Export game package
EditApi	edit_flush_scoreboard_cache	POST /api/edit/games/{id}/scoreboard/flush	Flush Scoreboard Cache
EditApi	edit_get_divisions	GET /api/edit/games/{id}/divisions	Get Divisions
EditApi	edit_get_game	GET /api/edit/games/{id}	Get Game
EditApi	edit_get_game_challenge	GET /api/edit/games/{id}/challenges/{cId}	Get Game Challenge
EditApi	edit_get_game_challenges	GET /api/edit/games/{id}/challenges	Get All Game Challenges
EditApi	edit_get_game_notices	GET /api/edit/games/{id}/notices	Get Game Notices
EditApi	edit_get_games	GET /api/edit/games	Get Game List
EditApi	edit_import_game	POST /api/edit/games/import	Import game package
EditApi	edit_remove_flag	DELETE /api/edit/games/{id}/challenges/{cId}/flags/{fId}	Delete Game Challenge Flag
EditApi	edit_remove_game_challenge	DELETE /api/edit/games/{id}/challenges/{cId}	Delete Game Challenge
EditApi	edit_update_attachment	POST /api/edit/games/{id}/challenges/{cId}/attachment	Update Game Challenge Attachment
EditApi	edit_update_division	PUT /api/edit/games/{id}/divisions/{divisionId}	Update Division
EditApi	edit_update_game	PUT /api/edit/games/{id}	Update Game
EditApi	edit_update_game_challenge	PUT /api/edit/games/{id}/challenges/{cId}	Update Game Challenge Information
EditApi	edit_update_game_notice	PUT /api/edit/games/{id}/notices/{noticeId}	Update Game Notice
EditApi	edit_update_game_poster	PUT /api/edit/games/{id}/poster	Update Game Poster
EditApi	edit_update_post	PUT /api/edit/posts/{id}	Update Post
GameApi	game_challenges_with_team_info	GET /api/game/{id}/details	Get team details in a game
GameApi	game_cheat_info	GET /api/game/{id}/cheatinfo	Get game cheat information
GameApi	game_create_container	POST /api/game/{id}/container/{challengeId}	Creates a container
GameApi	game_delete_all_team_traffic	DELETE /api/game/captures/{challengeId}/{partId}/all	Deletes all traffic files
GameApi	game_delete_container	DELETE /api/game/{id}/container/{challengeId}	Deletes a container
GameApi	game_delete_team_traffic	DELETE /api/game/captures/{challengeId}/{partId}/{filename}	Deletes a traffic file
GameApi	game_events	GET /api/game/{id}/events	Get game events
GameApi	game_extend_container_lifetime	POST /api/game/{id}/container/{challengeId}/extend	Extends container lifetime
GameApi	game_game	GET /api/game/{id}	Get detailed game information
GameApi	game_games	GET /api/game	Get games
GameApi	game_get_all_team_traffic	GET /api/game/captures/{challengeId}/{partId}/all	Download all traffic files
GameApi	game_get_challenge	GET /api/game/{id}/challenges/{challengeId}	Get challenge information
GameApi	game_get_challenge_traffic	GET /api/game/captures/{challengeId}	Get team captures in a challenge
GameApi	game_get_challenges_with_traffic_capturing	GET /api/game/games/{id}/captures	Get challenges with traffic capturing enabled
GameApi	game_get_game_join_check_info	GET /api/game/{id}/check	Get check info for joining a game
GameApi	game_get_team_traffic	GET /api/game/captures/{challengeId}/{partId}/{filename}	Get a traffic file
GameApi	game_get_team_traffic_all	GET /api/game/captures/{challengeId}/{partId}	Get traffic files
GameApi	game_get_writeup	GET /api/game/{id}/writeup	Get writeup information
GameApi	game_join_game	POST /api/game/{id}	Join a game
GameApi	game_leave_game	DELETE /api/game/{id}	Leave a game
GameApi	game_notices	GET /api/game/{id}/notices	Get game notices
GameApi	game_participations	GET /api/game/{id}/participations	Get all game participations
GameApi	game_recent_games	GET /api/game/recent	Get the recent games
GameApi	game_scoreboard	GET /api/game/{id}/scoreboard	Get the scoreboard
GameApi	game_scoreboard_sheet	GET /api/game/{id}/scoreboardsheet	Downloads the scoreboard
GameApi	game_status	GET /api/game/{id}/challenges/{challengeId}/status/{submitId}	Queries flag status
GameApi	game_submission_sheet	GET /api/game/{id}/submissionsheet	Downloads all submissions
GameApi	game_submissions	GET /api/game/{id}/submissions	Get game submissions
GameApi	game_submit	POST /api/game/{id}/challenges/{challengeId}	Submits a flag
GameApi	game_submit_writeup	POST /api/game/{id}/writeup	Submits a writeup
InfoApi	info_get_client_captcha_info	GET /api/captcha	Get Captcha configuration
InfoApi	info_get_client_config	GET /api/config	Get client configuration
InfoApi	info_get_latest_posts	GET /api/posts/latest	Get the latest posts
InfoApi	info_get_post	GET /api/posts/{id}	Get post details
InfoApi	info_get_posts	GET /api/posts	Get all posts
InfoApi	info_pow_challenge	GET /api/captcha/powchallenge	Create Pow Captcha
ProxyApi	proxy_proxy_for_instance	GET /api/proxy/{id}	Proxy TCP over websocket
ProxyApi	proxy_proxy_for_no_instance	GET /api/proxy/noinst/{id}	Proxy TCP over websocket for admins
TeamApi	team_accept	POST /api/team/accept	Accept invitation
TeamApi	team_avatar	PUT /api/team/{id}/avatar	Update team avatar
TeamApi	team_create_team	POST /api/team	Create team
TeamApi	team_delete_team	DELETE /api/team/{id}	Delete team
TeamApi	team_get_basic_info	GET /api/team/{id}	Get team information
TeamApi	team_get_teams_info	GET /api/team	Get current team information
TeamApi	team_invite_code	GET /api/team/{id}/invite	Get invitation information
TeamApi	team_kick_user	POST /api/team/{id}/kick/{userId}	Kick user
TeamApi	team_leave	POST /api/team/{id}/leave	Leave team
TeamApi	team_transfer	PUT /api/team/{id}/transfer	Transfer team ownership
TeamApi	team_update_invite_token	PUT /api/team/{id}/invite	Update invitation token
TeamApi	team_update_team	PUT /api/team/{id}	Update team information
TeamApi	team_verify_signature	POST /api/team/verify	Verify signature

Documentation For Models

• AccountPolicy
• AccountVerifyModel
• AdminTeamModel
• AdminUserInfoModel
• AnswerResult
• ApiToken
• ApiTokenCreateModel
• ApiTokenResponse
• ArrayResponseOfBasicGameInfoModel
• ArrayResponseOfContainerInstanceModel
• ArrayResponseOfGameInfoModel
• ArrayResponseOfLocalFile
• ArrayResponseOfTeamInfoModel
• ArrayResponseOfUserInfoModel
• Attachment
• AttachmentCreateModel
• BasicGameInfoModel
• BasicWriteupInfoModel
• Blood
• CaptchaProvider
• ChallengeCategory
• ChallengeDetailModel
• ChallengeEditDetailModel
• ChallengeInfo
• ChallengeInfoModel
• ChallengeItem
• ChallengeModel
• ChallengeTrafficModel
• ChallengeType
• ChallengeUpdateModel
• CheatInfoModel
• ClientCaptchaInfoModel
• ClientConfig
• ClientFlagContext
• ConfigEditModel
• ContainerInfoModel
• ContainerInstanceModel
• ContainerPolicy
• ContainerPortMappingType
• ContainerStatus
• DetailedGameInfoModel
• Division
• DivisionChallengeConfig
• DivisionChallengeConfigModel
• DivisionChallengeItem
• DivisionCreateModel
• DivisionEditModel
• DivisionInfo
• DivisionItem
• EventType
• FileRecord
• FileType
• FlagCreateModel
• FlagInfoModel
• FlagSubmitModel
• FormattableDataOfEventType
• FormattableDataOfNoticeType
• GameDetailModel
• GameEvent
• GameInfoModel
• GameJoinCheckInfoModel
• GameJoinModel
• GameNotice
• GameNoticeModel
• GamePermission
• GameSubmissionsTypeParameter
• GlobalConfig
• HashPowChallenge
• JoinedTeam
• LocalFile
• LogMessageModel
• LoginModel
• MailChangeModel
• ModelWithCaptcha
• NetworkMode
• NoticeType
• ParticipationEditModel
• ParticipationInfoModel
• ParticipationModel
• ParticipationStatus
• PasswordChangeModel
• PasswordResetModel
• PostDetailModel
• PostEditModel
• PostInfoModel
• ProblemDetails
• ProfileUpdateModel
• ProfileUserInfoModel
• RecoveryModel
• RegisterModel
• RegisterStatus
• RequestResponse
• RequestResponseOfBoolean
• RequestResponseOfRegisterStatus
• Role
• ScoreboardItem
• ScoreboardModel
• SignatureVerifyModel
• Submission
• SubmissionType
• TaskStatus
• TeamInfoModel
• TeamModel
• TeamTrafficModel
• TeamTransferModel
• TeamUpdateModel
• TeamUserInfoModel
• TeamWithDetailedUserInfo
• TimeLine
• TimeLineItem
• TopTimeLine
• UserCreateModel
• UserInfoModel
• WriteupInfo
• WriteupInfoModel

To get access to the crate's generated documentation, use:

cargo doc --open

Author

SimonIT simonit.orig@gmail.com