Package: kraken_sdk
kraken-sdkThe core component of kraken-projectThis Python package is automatically generated by theOpenAPI Generatorproject:API version: 0.1.0Package version: 0.1.0Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirements.Python 3.7+Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/myOmikron/kraken-project.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/myOmikron/kraken-project.git)Then import the package:importkraken_sdkSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importkraken_sdkTestsExecutepytestto run the tests.Getting StartedPlease follow theinstallation procedureand then run the following:importtimeimportkraken_sdkfromkraken_sdk.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://localhost# See configuration.py for a list of all supported configuration parameters.configuration=kraken_sdk.Configuration(host="http://localhost")# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure API key authorization: api_keyconfiguration.api_key['api_key']=os.environ["API_KEY"]# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['api_key'] = 'Bearer'# Enter a context with an instance of the API clientasyncwithkraken_sdk.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=kraken_sdk.AdminWorkspacesApi(api_client)try:# Retrieve all workspacesapi_response=awaitapi_instance.get_all_workspaces_admin()print("The response of AdminWorkspacesApi->get_all_workspaces_admin:\n")pprint(api_response)exceptApiExceptionase:print("Exception when calling AdminWorkspacesApi->get_all_workspaces_admin:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhostClassMethodHTTP requestDescriptionAdminWorkspacesApiget_all_workspaces_adminGET/api/v1/admin/workspacesRetrieve all workspacesAdminWorkspacesApiget_workspace_adminGET/api/v1/admin/workspaces/{uuid}Retrieve a workspace by idApiKeysApicreate_api_keyPOST/api/v1/apiKeysCreate new api keyApiKeysApidelete_api_keyDELETE/api/v1/apiKeys/{uuid}Delete an existing api keyApiKeysApiget_api_keysGET/api/v1/apiKeysRetrieve all api keysApiKeysApiupdate_api_keyPUT/api/v1/apiKeys/{uuid}Update an api key by its idAttacksApibruteforce_subdomainsPOST/api/v1/attacks/bruteforceSubdomainsBruteforce subdomains through a DNS wordlist attackAttacksApidelete_attackDELETE/api/v1/attacks/{uuid}Delete an attack and its resultsAttacksApidns_resolutionPOST/api/v1/attacks/dnsResolutionPerform domain name resolutionAttacksApiget_all_attacksGET/api/v1/attacksRetrieve all attacks the user has access toAttacksApiget_attackGET/api/v1/attacks/{uuid}Retrieve an attack by idAttacksApiget_bruteforce_subdomains_resultsGET/api/v1/attacks/{uuid}/bruteforceSubdomainsResultsRetrieve a bruteforce subdomains' results by the attack's idAttacksApiget_dns_resolution_resultsGET/api/v1/attacks/{uuid}/dnsResolutionResultsRetrieve a dns resolution's results by the attack's idAttacksApiget_host_alive_resultsGET/api/v1/attacks/{uuid}/hostAliveResultsRetrieve a host alive's results by the attack's idAttacksApiget_query_certificate_transparency_resultsGET/api/v1/attacks/{uuid}/queryCertificateTransparencyResultsRetrieve a query certificate transparency's results by the attack's idAttacksApiget_query_unhashed_resultsGET/api/v1/attacks/{uuid}/queryUnhashedResultsRetrieve a query dehashed's results by the attack's idAttacksApiget_service_detection_resultsGET/api/v1/attacks/{uuid}/serviceDetectionResultsRetrieve a detect service's results by the attack's idAttacksApiget_tcp_port_scan_resultsGET/api/v1/attacks/{uuid}/tcpPortScanResultsRetrieve a tcp port scan's results by the attack's idAttacksApiget_workspace_attacksGET/api/v1/workspaces/{uuid}/attacksQuery all attacks of a workspaceAttacksApihosts_alive_checkPOST/api/v1/attacks/hostsAliveCheck if hosts are reachableAttacksApiquery_certificate_transparencyPOST/api/v1/attacks/queryCertificateTransparencyQuery a certificate transparency log collector.AttacksApiquery_dehashedPOST/api/v1/attacks/queryDehashedQuery thedehashedAPI.AttacksApiscan_tcp_portsPOST/api/v1/attacks/scanTcpPortsStart a tcp port scanAttacksApiservice_detectionPOST/api/v1/attacks/serviceDetectionPerform service detection on a ip and port combinationAuthenticationApifinish_authPOST/api/v1/auth/finishAuthFinishes the authentication with a security keyAuthenticationApifinish_registerPOST/api/v1/auth/finishRegisterFinish the registration of a security keyAuthenticationApiloginPOST/api/v1/auth/loginLogin to krakenAuthenticationApilogoutGET/api/v1/auth/logoutLog out of this sessionAuthenticationApistart_authPOST/api/v1/auth/startAuthStarts the authentication with a security keyAuthenticationApistart_registerPOST/api/v1/auth/startRegisterStart the registration of a security keyAuthenticationApitestGET/api/v1/auth/testTest the current login stateDomainsApicreate_domainPOST/api/v1/workspaces/{uuid}/domainsManually add a domainDomainsApiget_all_domainsPOST/api/v1/workspaces/{uuid}/domains/allRetrieve all domains of a specific workspaceDomainsApiget_domainGET/api/v1/workspaces/{w_uuid}/domains/{d_uuid}Retrieve all information about a single domainDomainsApiupdate_domainPUT/api/v1/workspaces/{w_uuid}/domains/{d_uuid}Update a domainGlobalTagsApicreate_global_tagPOST/api/v1/admin/globalTagsCreate a global tag.GlobalTagsApidelete_global_tagDELETE/api/v1/admin/globalTags/{uuid}Delete a global tagGlobalTagsApiget_all_global_tagsGET/api/v1/globalTagsRetrieve all global tagsGlobalTagsApiupdate_global_tagPUT/api/v1/admin/globalTags/{uuid}Update a global tagHostsApicreate_hostPOST/api/v1/workspaces/{uuid}/hostsManually add a hostHostsApiget_all_hostsPOST/api/v1/workspaces/{uuid}/hosts/allRetrieve all hosts.HostsApiget_hostGET/api/v1/workspaces/{w_uuid}/hosts/{h_uuid}Retrieve all information about a single hostHostsApiupdate_hostPUT/api/v1/workspaces/{w_uuid}/hosts/{h_uuid}Update a hostLeechManagementApicreate_leechPOST/api/v1/admin/leechesCreate a leechLeechManagementApidelete_leechDELETE/api/v1/admin/leeches/{uuid}Delete a leech by its uuidLeechManagementApigen_leech_configGET/api/v1/admin/leeches/{uuid}/certGenerate a new config for the leechLeechManagementApiget_all_leechesGET/api/v1/admin/leechesRetrieve all leechesLeechManagementApiget_leechGET/api/v1/admin/leeches/{uuid}Retrieve a leech by its idLeechManagementApiupdate_leechPUT/api/v1/admin/leeches/{uuid}Update a leech by its idOAuthApiacceptGET/api/v1/oauth/accept/{uuid}Endpoint visited by user to grant a requesting application accessOAuthApidenyGET/api/v1/oauth/deny/{uuid}Endpoint visited by user to deny a requesting application accessOAuthApiinfoGET/api/v1/oauth/info/{uuid}Queried by the frontend to display information about the oauth request to the userOAuthApplicationApicreate_oauth_appPOST/api/v1/admin/applicationsCreate a new applicationOAuthApplicationApidelete_oauth_appDELETE/api/v1/admin/applications/{uuid}Delete an applicationOAuthApplicationApiget_all_oauth_appsGET/api/v1/admin/applicationsOAuthApplicationApiget_oauth_appGET/api/v1/admin/applications/{uuid}OAuthApplicationApiupdate_oauth_appPUT/api/v1/admin/applications/{uuid}Update an applicationOAuthDecisionsApiget_decisionsGET/api/v1/oauthDecisionsRetrieve a user's remembered oauth decisionsOAuthDecisionsApirevoke_decisionDELETE/api/v1/oauthDecisions/{uuid}Revoke a user's remembered oauth decisionPortsApicreate_portPOST/api/v1/workspaces/{uuid}/portsManually add a portPortsApiget_all_portsPOST/api/v1/workspaces/{uuid}/ports/allList the ports of a workspacePortsApiget_portGET/api/v1/workspaces/{w_uuid}/ports/{p_uuid}Retrieve all information about a single portPortsApiupdate_portPUT/api/v1/workspaces/{w_uuid}/ports/{p_uuid}Update a portServicesApicreate_servicePOST/api/v1/workspaces/{uuid}/servicesManually add a serviceServicesApiget_all_servicesPOST/api/v1/workspaces/{uuid}/services/allList the services of a workspaceServicesApiget_serviceGET/api/v1/workspaces/{w_uuid}/services/{s_uuid}Retrieve all information about a single serviceServicesApiupdate_servicePUT/api/v1/workspaces/{w_uuid}/services/{s_uuid}Update a serviceSettingsManagementApiget_settingsGET/api/v1/admin/settingsRetrieve the currently active settingsSettingsManagementApiupdate_settingsPUT/api/v1/admin/settingsUpdate the settingsUserAdminManagementApicreate_userPOST/api/v1/admin/usersCreate a userUserAdminManagementApidelete_userDELETE/api/v1/admin/users/{uuid}Delete a user by its uuidUserAdminManagementApiget_all_users_adminGET/api/v1/admin/usersRetrieve all usersUserAdminManagementApiget_userGET/api/v1/admin/users/{uuid}Retrieve a user by its uuidUserManagementApiget_all_usersGET/api/v1/usersRequest all usersUserManagementApiget_meGET/api/v1/users/meRetrieve the own userUserManagementApiset_passwordPOST/api/v1/users/setPasswordSet a new passwordUserManagementApiupdate_mePUT/api/v1/users/meUpdates the own userWebsocketApiwebsocketGET/api/v1/wsStart a websocket connectionWordlistApiget_all_wordlistsGET/api/v1/wordlistsGet a list of all wordlist for the user to select from when starting an bruteforce subdomains attackWordlistManagementApicreate_wordlist_adminPOST/api/v1/admin/wordlistsCreate a new wordlistWordlistManagementApidelete_wordlist_adminDELETE/api/v1/admin/wordlists/{uuid}Delete an existing wordlistWordlistManagementApiget_all_wordlists_adminGET/api/v1/admin/wordlistsGet a list of all wordlists including their pathsWordlistManagementApiupdate_wordlist_adminPUT/api/v1/admin/wordlists/{uuid}Update an existing wordlistWorkspaceInvitationsApiaccept_invitationPOST/api/v1/invitations/{uuid}/acceptAccept an invitation to a workspaceWorkspaceInvitationsApidecline_invitationPOST/api/v1/invitations/{uuid}/declineDecline an invitation to a workspaceWorkspaceInvitationsApiget_all_invitationsGET/api/v1/invitationsRetrieve all open invitations to workspaces the currently logged-in userWorkspaceTagsApicreate_workspace_tagPOST/api/v1/workspaces/{uuid}/tagsCreate a workspace tag.WorkspaceTagsApidelete_workspace_tagDELETE/api/v1/workspaces/{w_uuid}/tags/{t_uuid}Delete a workspace tagWorkspaceTagsApiget_all_workspace_tagsGET/api/v1/workspaces/{uuid}/tagsRetrieve all workspace tagsWorkspaceTagsApiupdate_workspace_tagPUT/api/v1/workspaces/{w_uuid}/tags/{t_uuid}Update a workspace tagWorkspacesApicreate_invitationPOST/api/v1/workspaces/{uuid}/invitationsInvite a user to the workspaceWorkspacesApicreate_workspacePOST/api/v1/workspacesCreate a new workspaceWorkspacesApidelete_workspaceDELETE/api/v1/workspaces/{uuid}Delete a workspace by its idWorkspacesApiget_all_workspace_invitationsGET/api/v1/workspaces/{uuid}/invitationsQuery all open invitations to a workspaceWorkspacesApiget_all_workspacesGET/api/v1/workspacesRetrieve all workspaces that the executing user has access toWorkspacesApiget_search_resultsGET/api/v1/workspaces/{w_uuid}/search/{s_uuid}Retrieve results for a search by it's uuidWorkspacesApiget_searchesGET/api/v1/workspaces/{uuid}/searchQuery all searchesWorkspacesApiget_workspaceGET/api/v1/workspaces/{uuid}Retrieve a workspace by idWorkspacesApiretract_invitationDELETE/api/v1/workspaces/{w_uuid}/invitations/{i_uuid}Retract an invitation to the workspaceWorkspacesApisearchPOST/api/v1/workspaces/{uuid}/searchSearch through a workspaces' dataWorkspacesApitransfer_ownershipPOST/api/v1/workspaces/{uuid}/transferTransfer ownership to another accountWorkspacesApiupdate_workspacePUT/api/v1/workspaces/{uuid}Updates a workspace by its idDocumentation For ModelsApiErrorResponseApiStatusCodeAttackTypeBruteforceSubdomainsRequestBruteforceSubdomainsResultsPageCertificateTransparencyEntryColorCreateApiKeyRequestCreateAppRequestCreateDomainRequestCreateGlobalTagRequestCreateHostRequestCreateLeechRequestCreatePortRequestCreateServiceRequestCreateUserRequestCreateWordlistRequestCreateWorkspaceRequestCreateWorkspaceTagRequestDnsResolutionRequestDnsResolutionResultsPageDomainCertaintyDomainOrNetworkDomainResultsPageFinishRegisterRequestFullApiKeyFullDecisionFullDomainFullGlobalTagFullHostFullOauthClientFullPortFullQueryCertificateTransparencyResultFullServiceFullServiceDetectionResultFullWordlistFullWorkspaceFullWorkspaceInvitationFullWorkspaceTagGetAllDomainsQueryGetAllHostsQueryGetAllLeechesResponseGetAllPortsQueryGetAllServicesQueryGetAllUsersResponseGetAllWordlistsAdminResponseGetAllWordlistsResponseGetAllWorkspacesResponseGetApiKeysResponseGetAppsResponseGetGlobalTagsResponseGetMyDecisionsResponseGetUserGetUserResponseGetWorkspaceTagsResponseHostAliveResultsPageHostCertaintyHostResultsPageHostsAliveRequestInviteToWorkspaceLeechConfigLeechTlsConfigListAttacksLoginRequestManualHostCertaintyManualPortCertaintyManualServiceCertaintyOpenRequestInfoOsTypePageParamsPortCertaintyPortOrRangePortProtocolPortResultsPageQueryQueryCertificateTransparencyRequestQueryCertificateTransparencyResultsPageQueryDehashedRequestQueryOneOfQueryOneOf1QueryOneOf2QueryOneOf3QueryOneOf4QueryOneOf5QueryOneOf6QueryOneOf7QueryOneOf8QueryOneOf9QueryUnhashedResultsPageScanTcpPortsRequestSearchEntrySearchResultEntrySearchResultEntryOneOfSearchResultEntryOneOf1SearchResultEntryOneOf2SearchResultEntryOneOf3SearchResultEntryOneOf4SearchResultEntryOneOf5SearchResultEntryOneOf6SearchResultEntryOneOf7SearchResultEntryOneOf8SearchResultEntryOneOf9SearchResultPageSearchTypeSearchTypeOneOfSearchTypeOneOf1SearchTypeOneOf2SearchTypeOneOf3SearchTypeOneOf4SearchWorkspaceRequestSearchesResultPageServiceCertaintyServiceDetectionRequestServiceDetectionResultsPageServiceResultsPageSetPasswordRequestSettingsFullSimpleAggregationSourceSimpleAttackSimpleBruteforceSubdomainsResultSimpleDnsResolutionResultSimpleDomainSimpleHostSimpleHostAliveResultSimpleLeechSimpleOauthClientSimplePortSimpleQueryUnhashedResultSimpleServiceSimpleTagSimpleTcpPortScanResultSimpleUserSimpleWordlistSimpleWorkspaceTagTypeTcpPortScanResultsPageTransferWorkspaceRequestUpdateApiKeyRequestUpdateAppRequestUpdateDomainRequestUpdateGlobalTagUpdateHostRequestUpdateLeechRequestUpdateMeRequestUpdatePortRequestUpdateServiceRequestUpdateSettingsRequestUpdateWordlistRequestUpdateWorkspaceRequestUpdateWorkspaceTagUserPermissionUuidResponseWorkspaceInvitationListWsMessageWsMessageOneOfWsMessageOneOf1WsMessageOneOf10WsMessageOneOf11WsMessageOneOf2WsMessageOneOf3WsMessageOneOf4WsMessageOneOf5WsMessageOneOf6WsMessageOneOf7WsMessageOneOf8WsMessageOneOf9Documentation For AuthorizationAuthentication schemes defined for the API:api_keyType: API keyAPI key parameter name: idLocation:Authorgit@omikron.dev