Documentation for FastAPI¶
Documentation for API Endpoints¶
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountApi | createApiTokenApiCreateKeyPost | POST /api/create-key | Create Api Token |
| AccountApi | createMfaMfaCreatePost | POST /mfa/create | Create Mfa |
| AccountApi | createReferralReferralPost | POST /referral | Create Referral |
| AccountApi | deleteApiKeyApiDeleteKeyDelete | DELETE /api/delete-key | Delete Api Key |
| AccountApi | deleteMfaMfaDeleteDelete | DELETE /mfa/delete | Delete Mfa |
| AccountApi | deleteMfaWithUsernamePassMfaRecoveryDelete | DELETE /mfa/recovery | Delete Mfa With Username Pass |
| AccountApi | getApiKeysApiGetKeysGet | GET /api/get-keys | Get Api Keys |
| AccountApi | getGdprGdprGet | GET /gdpr | Get Gdpr |
| AccountApi | getKeyApiGetKeyGet | GET /api/get-key | Get Key |
| AccountApi | getSettingsSettingsGet | GET /settings | Get Settings |
| AccountApi | loginLoginPost | POST /login | Login |
| AccountApi | logoutLogoutPatch | PATCH /logout | Logout |
| AccountApi | redeemCodeRedeemPost | POST /redeem | Redeem Code |
| AccountApi | refreshRefreshPost | POST /refresh | Refresh |
| AccountApi | resendVerificationEmailSendPost | POST /email/send | Resend Verification |
| AccountApi | resetPasswordRecoveryVerifyPost | POST /recovery/verify | Reset Password |
| AccountApi | sendAccountDeletionDeletionSendDelete | DELETE /deletion/send | Send Account Deletion |
| AccountApi | sendRecoveryLinkRecoverySendPost | POST /recovery/send | Send Recovery Link |
| AccountApi | signUpSignUpPost | POST /sign-up | Sign Up |
| AccountApi | verifyAccountEmailVerifyPost | POST /email/verify | Verify Account |
| AccountApi | verifyDeletionDeletionVerifyDelete | DELETE /deletion/verify | Verify Deletion |
| AccountApi | verifyMfaSetupMfaVerifyPost | POST /mfa/verify | Verify Mfa Setup |
| AccountApi | yearWrappedProfileWrappedGet | GET /profile/wrapped | Year Wrapped |
| AdminApi | addTldAdminUserTldAddPost | POST /admin/user/tld/add | Add Tld |
| AdminApi | canAccessAdminUserCanAccessGet | GET /admin/user/can-access | Can Access |
| AdminApi | changePermissionAdminUserPermissionPatch | PATCH /admin/user/permission | Change Permission |
| AdminApi | clearStatusAdminStatusClearPost | POST /admin/status/clear | Clear Status |
| AdminApi | deleteDnsRecordAdminUserDeleteRecordDelete | DELETE /admin/user/delete/record | Delete Dns Record |
| AdminApi | deleteDomainAdminDomainDeleteDelete | DELETE /admin/domain/delete | Delete Domain |
| AdminApi | deleteUserAdminUserDeleteDelete | DELETE /admin/user/delete | Delete User |
| AdminApi | domainDetailAdminDomainDetailGet | GET /admin/domain/detail | Domain Detail |
| AdminApi | editDomainAdminDomainEditPatch | PATCH /admin/domain/edit | Edit Domain |
| AdminApi | findDesyncAdminDnsDesyncGet | GET /admin/dns/desync | Find Desync |
| AdminApi | findUserByDomainAdminUserGetDomainGet | GET /admin/user/get/domain | Find User By Domain |
| AdminApi | findUserByEmailAdminUserGetEmailGet | GET /admin/user/get/email | Find User By Email |
| AdminApi | findUserByIdAdminUserGetIdGet | GET /admin/user/get/id | Find User By Id |
| AdminApi | findUserByIpsAdminUserGetIpsPost | POST /admin/user/get/ips | Find User By Ips |
| AdminApi | findUserByReferralAdminUserGetReferralGet | GET /admin/user/get/referral | Find User By Referral |
| AdminApi | findUserByUsernameAdminUserGetUsernameGet | GET /admin/user/get/username | Find User By Username |
| AdminApi | fullAdminAdminUserFullAdminPost | POST /admin/user/full-admin | Full Admin |
| AdminApi | getFlaggedUsersAdminUsersFlaggedGet | GET /admin/users/flagged | Get Flagged Users |
| AdminApi | manualLoginAdminUserManualLoginPost | POST /admin/user/manual-login | Manual Login |
| AdminApi | reinstateUserAdminUserReinstatePost | POST /admin/user/reinstate | Reinstate User |
| AdminApi | removeTldAdminUserTldRemovePost | POST /admin/user/tld/remove | Remove Tld |
| AdminApi | setStatusAdminStatusPost | POST /admin/status | Set Status |
| AdminApi | terminateManualLoginAdminUserManualLoginTerminatePost | POST /admin/user/manual-login/terminate | Terminate Manual Login |
| AdminApi | toggleUserDisabledAdminUserDisabledPost | POST /admin/user/disabled | Toggle User Disabled |
| AdminApi | updateUserRiskAdminUserRiskUpdatePost | POST /admin/user/risk/update | Update User Risk |
| AdminApi | verifyAdminUserVerifyPost | POST /admin/user/verify | Verify |
| ApiApi | createApiTokenApiCreateKeyPost | POST /api/create-key | Create Api Token |
| ApiApi | deleteApiDomainDelete | DELETE /api/domain | Delete |
| ApiApi | deleteApiKeyApiDeleteKeyDelete | DELETE /api/delete-key | Delete Api Key |
| ApiApi | getApiKeysApiGetKeysGet | GET /api/get-keys | Get Api Keys |
| ApiApi | getDomainsApiDomainsGet | GET /api/domains | Get Domains |
| ApiApi | getKeyApiGetKeyGet | GET /api/get-key | Get Key |
| ApiApi | getUserProfileApiUserGet | GET /api/user | Get User Profile |
| ApiApi | isAvailableApiDomainAvailableGet | GET /api/domain/available | Is Available |
| ApiApi | modifyApiDomainPatch | PATCH /api/domain | Modify |
| ApiApi | registerApiDomainPost | POST /api/domain | Register |
| Class2faApi | createMfaMfaCreatePost | POST /mfa/create | Create Mfa |
| Class2faApi | deleteMfaMfaDeleteDelete | DELETE /mfa/delete | Delete Mfa |
| Class2faApi | deleteMfaWithUsernamePassMfaRecoveryDelete | DELETE /mfa/recovery | Delete Mfa With Username Pass |
| Class2faApi | verifyMfaSetupMfaVerifyPost | POST /mfa/verify | Verify Mfa Setup |
| DefaultApi | createTunnelServeoTunnelsPost | POST /serveo/tunnels | Create Tunnel |
| DefaultApi | deleteTunnelServeoTunnelsTunnelIdDelete | DELETE /serveo/tunnels/{tunnel_id} | Delete Tunnel |
| DefaultApi | getKeyIntentsApiIntentsGet | GET /api/intents | Get Key Intents |
| DefaultApi | listTunnelsServeoTunnelsGet | GET /serveo/tunnels | List Tunnels |
| DefaultApi | statusStatusGet | GET /status | Status |
| DefaultApi | updateTunnelServeoTunnelsTunnelIdPut | PUT /serveo/tunnels/{tunnel_id} | Update Tunnel |
| DomainApi | deleteApiDomainDelete | DELETE /api/domain | Delete |
| DomainApi | deleteDomainDeleteDelete | DELETE /domain/delete | Delete |
| DomainApi | getDomainsApiDomainsGet | GET /api/domains | Get Domains |
| DomainApi | getDomainsDomainGetGet | GET /domain/get | Get Domains |
| DomainApi | isAvailableApiDomainAvailableGet | GET /api/domain/available | Is Available |
| DomainApi | isAvailableDomainAvailableGet | GET /domain/available | Is Available |
| DomainApi | modifyApiDomainPatch | PATCH /api/domain | Modify |
| DomainApi | modifyDomainModifyPatch | PATCH /domain/modify | Modify |
| DomainApi | registerApiDomainPost | POST /api/domain | Register |
| DomainApi | registerDomainRegisterPost | POST /domain/register | Register |
| FunApi | yearWrappedProfileWrappedGet | GET /profile/wrapped | Year Wrapped |
| InviteApi | createInviteCreatePost | POST /invite/create | Create |
| KofiApi | redeemCodeRedeemPost | POST /redeem | Redeem Code |
| KofiApi | webhookKofiWebhookPost | POST /kofi/webhook | Webhook |
| PrivacyApi | getGdprGdprGet | GET /gdpr | Get Gdpr |
| ReferralApi | createReferralReferralPost | POST /referral | Create Referral |
| SessionApi | loginLoginPost | POST /login | Login |
| SessionApi | logoutLogoutPatch | PATCH /logout | Logout |
| SessionApi | refreshRefreshPost | POST /refresh | Refresh |
| UserApi | getUserProfileApiUserGet | GET /api/user | Get User Profile |
Documentation for Models¶
- AccountData
- AdminDomainEdit
- AdminStatusMessage
- ApiCreationBody
- ApiDeletion
- ApiPermission
- ApiType
- BanUser
- Ban_Reasons
- Country
- CountryType
- DomainRecord
- DomainRetrieve
- DomainType
- HTTPValidationError
- InviteCreate
- InviteType
- Ip
- IpFind
- Location_inner
- LoginRequest
- MFACreation
- ManualLoginTermination
- MfaRecovery
- NewSessionType
- PasswordReset
- Registered
- Response_Find_User_By_Email_Admin_User_Get_Email_Get
- Response_Find_User_By_Username_Admin_User_Get_Username_Get
- Risk
- RiskFlag
- RiskUpdateBody
- SignUp
- TunnelCreate
- TunnelUpdate
- UserAction
- UserDisabledBody
- UserPageType
- UserRisk
- ValidationError
- Value
- YearWrapped
- login_login_post_200_response
- login_login_post_422_response
- sign_up_sign_up_post_422_response
Documentation for Authorization¶
All endpoints do not require authorization.