dokploy-client
Endpoints for dokploy
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import dokploy_clientSetuptools
Install via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import dokploy_clientTests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import dokploy_client
from dokploy_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://dokploy.example.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = dokploy_client.Configuration(
host = "https://dokploy.example.com/api"
)
# 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: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with dokploy_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dokploy_client.AdminApi(api_client)
admin_setup_monitoring_request = dokploy_client.AdminSetupMonitoringRequest() # AdminSetupMonitoringRequest |
try:
api_instance.admin_setup_monitoring(admin_setup_monitoring_request)
except ApiException as e:
print("Exception when calling AdminApi->admin_setup_monitoring: %s\n" % e)Documentation for API Endpoints
All URIs are relative to https://dokploy.example.com/api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminApi | admin_setup_monitoring | POST /admin.setupMonitoring | |
| AiApi | ai_create | POST /ai.create | |
| AiApi | ai_delete | POST /ai.delete | |
| AiApi | ai_deploy | POST /ai.deploy | |
| AiApi | ai_get | GET /ai.get | |
| AiApi | ai_get_all | GET /ai.getAll | |
| AiApi | ai_get_models | GET /ai.getModels | |
| AiApi | ai_one | GET /ai.one | |
| AiApi | ai_suggest | POST /ai.suggest | |
| AiApi | ai_update | POST /ai.update | |
| ApplicationApi | application_cancel_deployment | POST /application.cancelDeployment | |
| ApplicationApi | application_clean_queues | POST /application.cleanQueues | |
| ApplicationApi | application_create | POST /application.create | |
| ApplicationApi | application_delete | POST /application.delete | |
| ApplicationApi | application_deploy | POST /application.deploy | |
| ApplicationApi | application_disconnect_git_provider | POST /application.disconnectGitProvider | |
| ApplicationApi | application_mark_running | POST /application.markRunning | |
| ApplicationApi | application_move | POST /application.move | |
| ApplicationApi | application_one | GET /application.one | |
| ApplicationApi | application_read_app_monitoring | GET /application.readAppMonitoring | |
| ApplicationApi | application_read_traefik_config | GET /application.readTraefikConfig | |
| ApplicationApi | application_redeploy | POST /application.redeploy | |
| ApplicationApi | application_refresh_token | POST /application.refreshToken | |
| ApplicationApi | application_reload | POST /application.reload | |
| ApplicationApi | application_save_bitbucket_provider | POST /application.saveBitbucketProvider | |
| ApplicationApi | application_save_build_type | POST /application.saveBuildType | |
| ApplicationApi | application_save_docker_provider | POST /application.saveDockerProvider | |
| ApplicationApi | application_save_environment | POST /application.saveEnvironment | |
| ApplicationApi | application_save_git_prodiver | POST /application.saveGitProdiver | |
| ApplicationApi | application_save_gitea_provider | POST /application.saveGiteaProvider | |
| ApplicationApi | application_save_github_provider | POST /application.saveGithubProvider | |
| ApplicationApi | application_save_gitlab_provider | POST /application.saveGitlabProvider | |
| ApplicationApi | application_start | POST /application.start | |
| ApplicationApi | application_stop | POST /application.stop | |
| ApplicationApi | application_update | POST /application.update | |
| ApplicationApi | application_update_traefik_config | POST /application.updateTraefikConfig | |
| BackupApi | backup_create | POST /backup.create | |
| BackupApi | backup_list_backup_files | GET /backup.listBackupFiles | |
| BackupApi | backup_manual_backup_compose | POST /backup.manualBackupCompose | |
| BackupApi | backup_manual_backup_mariadb | POST /backup.manualBackupMariadb | |
| BackupApi | backup_manual_backup_mongo | POST /backup.manualBackupMongo | |
| BackupApi | backup_manual_backup_my_sql | POST /backup.manualBackupMySql | |
| BackupApi | backup_manual_backup_postgres | POST /backup.manualBackupPostgres | |
| BackupApi | backup_manual_backup_web_server | POST /backup.manualBackupWebServer | |
| BackupApi | backup_one | GET /backup.one | |
| BackupApi | backup_remove | POST /backup.remove | |
| BackupApi | backup_update | POST /backup.update | |
| BitbucketApi | bitbucket_bitbucket_providers | GET /bitbucket.bitbucketProviders | |
| BitbucketApi | bitbucket_create | POST /bitbucket.create | |
| BitbucketApi | bitbucket_get_bitbucket_branches | GET /bitbucket.getBitbucketBranches | |
| BitbucketApi | bitbucket_get_bitbucket_repositories | GET /bitbucket.getBitbucketRepositories | |
| BitbucketApi | bitbucket_one | GET /bitbucket.one | |
| BitbucketApi | bitbucket_test_connection | POST /bitbucket.testConnection | |
| BitbucketApi | bitbucket_update | POST /bitbucket.update | |
| CertificatesApi | certificates_all | GET /certificates.all | |
| CertificatesApi | certificates_create | POST /certificates.create | |
| CertificatesApi | certificates_one | GET /certificates.one | |
| CertificatesApi | certificates_remove | POST /certificates.remove | |
| ClusterApi | cluster_add_manager | GET /cluster.addManager | |
| ClusterApi | cluster_add_worker | GET /cluster.addWorker | |
| ClusterApi | cluster_get_nodes | GET /cluster.getNodes | |
| ClusterApi | cluster_remove_worker | POST /cluster.removeWorker | |
| ComposeApi | compose_cancel_deployment | POST /compose.cancelDeployment | |
| ComposeApi | compose_clean_queues | POST /compose.cleanQueues | |
| ComposeApi | compose_create | POST /compose.create | |
| ComposeApi | compose_delete | POST /compose.delete | |
| ComposeApi | compose_deploy | POST /compose.deploy | |
| ComposeApi | compose_deploy_template | POST /compose.deployTemplate | |
| ComposeApi | compose_disconnect_git_provider | POST /compose.disconnectGitProvider | |
| ComposeApi | compose_fetch_source_type | POST /compose.fetchSourceType | |
| ComposeApi | compose_get_converted_compose | GET /compose.getConvertedCompose | |
| ComposeApi | compose_get_default_command | GET /compose.getDefaultCommand | |
| ComposeApi | compose_get_tags | GET /compose.getTags | |
| ComposeApi | compose_import | POST /compose.import | |
| ComposeApi | compose_isolated_deployment | POST /compose.isolatedDeployment | |
| ComposeApi | compose_load_mounts_by_service | GET /compose.loadMountsByService | |
| ComposeApi | compose_load_services | GET /compose.loadServices | |
| ComposeApi | compose_move | POST /compose.move | |
| ComposeApi | compose_one | GET /compose.one | |
| ComposeApi | compose_process_template | POST /compose.processTemplate | |
| ComposeApi | compose_randomize_compose | POST /compose.randomizeCompose | |
| ComposeApi | compose_redeploy | POST /compose.redeploy | |
| ComposeApi | compose_refresh_token | POST /compose.refreshToken | |
| ComposeApi | compose_start | POST /compose.start | |
| ComposeApi | compose_stop | POST /compose.stop | |
| ComposeApi | compose_templates | GET /compose.templates | |
| ComposeApi | compose_update | POST /compose.update | |
| DeploymentApi | deployment_all | GET /deployment.all | |
| DeploymentApi | deployment_all_by_compose | GET /deployment.allByCompose | |
| DeploymentApi | deployment_all_by_server | GET /deployment.allByServer | |
| DeploymentApi | deployment_all_by_type | GET /deployment.allByType | |
| DeploymentApi | deployment_kill_process | POST /deployment.killProcess | |
| DestinationApi | destination_all | GET /destination.all | |
| DestinationApi | destination_create | POST /destination.create | |
| DestinationApi | destination_one | GET /destination.one | |
| DestinationApi | destination_remove | POST /destination.remove | |
| DestinationApi | destination_test_connection | POST /destination.testConnection | |
| DestinationApi | destination_update | POST /destination.update | |
| DockerApi | docker_get_config | GET /docker.getConfig | |
| DockerApi | docker_get_containers | GET /docker.getContainers | |
| DockerApi | docker_get_containers_by_app_label | GET /docker.getContainersByAppLabel | |
| DockerApi | docker_get_containers_by_app_name_match | GET /docker.getContainersByAppNameMatch | |
| DockerApi | docker_get_service_containers_by_app_name | GET /docker.getServiceContainersByAppName | |
| DockerApi | docker_get_stack_containers_by_app_name | GET /docker.getStackContainersByAppName | |
| DockerApi | docker_restart_container | POST /docker.restartContainer | |
| DomainApi | domain_by_application_id | GET /domain.byApplicationId | |
| DomainApi | domain_by_compose_id | GET /domain.byComposeId | |
| DomainApi | domain_can_generate_traefik_me_domains | GET /domain.canGenerateTraefikMeDomains | |
| DomainApi | domain_create | POST /domain.create | |
| DomainApi | domain_delete | POST /domain.delete | |
| DomainApi | domain_generate_domain | POST /domain.generateDomain | |
| DomainApi | domain_one | GET /domain.one | |
| DomainApi | domain_update | POST /domain.update | |
| DomainApi | domain_validate_domain | POST /domain.validateDomain | |
| EnvironmentApi | environment_by_project_id | GET /environment.byProjectId | |
| EnvironmentApi | environment_create | POST /environment.create | |
| EnvironmentApi | environment_duplicate | POST /environment.duplicate | |
| EnvironmentApi | environment_one | GET /environment.one | |
| EnvironmentApi | environment_remove | POST /environment.remove | |
| EnvironmentApi | environment_update | POST /environment.update | |
| GitProviderApi | git_provider_get_all | GET /gitProvider.getAll | |
| GitProviderApi | git_provider_remove | POST /gitProvider.remove | |
| GiteaApi | gitea_create | POST /gitea.create | |
| GiteaApi | gitea_get_gitea_branches | GET /gitea.getGiteaBranches | |
| GiteaApi | gitea_get_gitea_repositories | GET /gitea.getGiteaRepositories | |
| GiteaApi | gitea_get_gitea_url | GET /gitea.getGiteaUrl | |
| GiteaApi | gitea_gitea_providers | GET /gitea.giteaProviders | |
| GiteaApi | gitea_one | GET /gitea.one | |
| GiteaApi | gitea_test_connection | POST /gitea.testConnection | |
| GiteaApi | gitea_update | POST /gitea.update | |
| GithubApi | github_get_github_branches | GET /github.getGithubBranches | |
| GithubApi | github_get_github_repositories | GET /github.getGithubRepositories | |
| GithubApi | github_github_providers | GET /github.githubProviders | |
| GithubApi | github_one | GET /github.one | |
| GithubApi | github_test_connection | POST /github.testConnection | |
| GithubApi | github_update | POST /github.update | |
| GitlabApi | gitlab_create | POST /gitlab.create | |
| GitlabApi | gitlab_get_gitlab_branches | GET /gitlab.getGitlabBranches | |
| GitlabApi | gitlab_get_gitlab_repositories | GET /gitlab.getGitlabRepositories | |
| GitlabApi | gitlab_gitlab_providers | GET /gitlab.gitlabProviders | |
| GitlabApi | gitlab_one | GET /gitlab.one | |
| GitlabApi | gitlab_test_connection | POST /gitlab.testConnection | |
| GitlabApi | gitlab_update | POST /gitlab.update | |
| MariadbApi | mariadb_change_status | POST /mariadb.changeStatus | |
| MariadbApi | mariadb_create | POST /mariadb.create | |
| MariadbApi | mariadb_deploy | POST /mariadb.deploy | |
| MariadbApi | mariadb_move | POST /mariadb.move | |
| MariadbApi | mariadb_one | GET /mariadb.one | |
| MariadbApi | mariadb_rebuild | POST /mariadb.rebuild | |
| MariadbApi | mariadb_reload | POST /mariadb.reload | |
| MariadbApi | mariadb_remove | POST /mariadb.remove | |
| MariadbApi | mariadb_save_environment | POST /mariadb.saveEnvironment | |
| MariadbApi | mariadb_save_external_port | POST /mariadb.saveExternalPort | |
| MariadbApi | mariadb_start | POST /mariadb.start | |
| MariadbApi | mariadb_stop | POST /mariadb.stop | |
| MariadbApi | mariadb_update | POST /mariadb.update | |
| MongoApi | mongo_change_status | POST /mongo.changeStatus | |
| MongoApi | mongo_create | POST /mongo.create | |
| MongoApi | mongo_deploy | POST /mongo.deploy | |
| MongoApi | mongo_move | POST /mongo.move | |
| MongoApi | mongo_one | GET /mongo.one | |
| MongoApi | mongo_rebuild | POST /mongo.rebuild | |
| MongoApi | mongo_reload | POST /mongo.reload | |
| MongoApi | mongo_remove | POST /mongo.remove | |
| MongoApi | mongo_save_environment | POST /mongo.saveEnvironment | |
| MongoApi | mongo_save_external_port | POST /mongo.saveExternalPort | |
| MongoApi | mongo_start | POST /mongo.start | |
| MongoApi | mongo_stop | POST /mongo.stop | |
| MongoApi | mongo_update | POST /mongo.update | |
| MountsApi | mounts_all_named_by_application_id | GET /mounts.allNamedByApplicationId | |
| MountsApi | mounts_create | POST /mounts.create | |
| MountsApi | mounts_one | GET /mounts.one | |
| MountsApi | mounts_remove | POST /mounts.remove | |
| MountsApi | mounts_update | POST /mounts.update | |
| MysqlApi | mysql_change_status | POST /mysql.changeStatus | |
| MysqlApi | mysql_create | POST /mysql.create | |
| MysqlApi | mysql_deploy | POST /mysql.deploy | |
| MysqlApi | mysql_move | POST /mysql.move | |
| MysqlApi | mysql_one | GET /mysql.one | |
| MysqlApi | mysql_rebuild | POST /mysql.rebuild | |
| MysqlApi | mysql_reload | POST /mysql.reload | |
| MysqlApi | mysql_remove | POST /mysql.remove | |
| MysqlApi | mysql_save_environment | POST /mysql.saveEnvironment | |
| MysqlApi | mysql_save_external_port | POST /mysql.saveExternalPort | |
| MysqlApi | mysql_start | POST /mysql.start | |
| MysqlApi | mysql_stop | POST /mysql.stop | |
| MysqlApi | mysql_update | POST /mysql.update | |
| NotificationApi | notification_all | GET /notification.all | |
| NotificationApi | notification_create_discord | POST /notification.createDiscord | |
| NotificationApi | notification_create_email | POST /notification.createEmail | |
| NotificationApi | notification_create_gotify | POST /notification.createGotify | |
| NotificationApi | notification_create_ntfy | POST /notification.createNtfy | |
| NotificationApi | notification_create_slack | POST /notification.createSlack | |
| NotificationApi | notification_create_telegram | POST /notification.createTelegram | |
| NotificationApi | notification_get_email_providers | GET /notification.getEmailProviders | |
| NotificationApi | notification_one | GET /notification.one | |
| NotificationApi | notification_receive_notification | POST /notification.receiveNotification | |
| NotificationApi | notification_remove | POST /notification.remove | |
| NotificationApi | notification_test_discord_connection | POST /notification.testDiscordConnection | |
| NotificationApi | notification_test_email_connection | POST /notification.testEmailConnection | |
| NotificationApi | notification_test_gotify_connection | POST /notification.testGotifyConnection | |
| NotificationApi | notification_test_ntfy_connection | POST /notification.testNtfyConnection | |
| NotificationApi | notification_test_slack_connection | POST /notification.testSlackConnection | |
| NotificationApi | notification_test_telegram_connection | POST /notification.testTelegramConnection | |
| NotificationApi | notification_update_discord | POST /notification.updateDiscord | |
| NotificationApi | notification_update_email | POST /notification.updateEmail | |
| NotificationApi | notification_update_gotify | POST /notification.updateGotify | |
| NotificationApi | notification_update_ntfy | POST /notification.updateNtfy | |
| NotificationApi | notification_update_slack | POST /notification.updateSlack | |
| NotificationApi | notification_update_telegram | POST /notification.updateTelegram | |
| OrganizationApi | organization_all | GET /organization.all | |
| OrganizationApi | organization_all_invitations | GET /organization.allInvitations | |
| OrganizationApi | organization_create | POST /organization.create | |
| OrganizationApi | organization_delete | POST /organization.delete | |
| OrganizationApi | organization_one | GET /organization.one | |
| OrganizationApi | organization_remove_invitation | POST /organization.removeInvitation | |
| OrganizationApi | organization_update | POST /organization.update | |
| PortApi | port_create | POST /port.create | |
| PortApi | port_delete | POST /port.delete | |
| PortApi | port_one | GET /port.one | |
| PortApi | port_update | POST /port.update | |
| PostgresApi | postgres_change_status | POST /postgres.changeStatus | |
| PostgresApi | postgres_create | POST /postgres.create | |
| PostgresApi | postgres_deploy | POST /postgres.deploy | |
| PostgresApi | postgres_move | POST /postgres.move | |
| PostgresApi | postgres_one | GET /postgres.one | |
| PostgresApi | postgres_rebuild | POST /postgres.rebuild | |
| PostgresApi | postgres_reload | POST /postgres.reload | |
| PostgresApi | postgres_remove | POST /postgres.remove | |
| PostgresApi | postgres_save_environment | POST /postgres.saveEnvironment | |
| PostgresApi | postgres_save_external_port | POST /postgres.saveExternalPort | |
| PostgresApi | postgres_start | POST /postgres.start | |
| PostgresApi | postgres_stop | POST /postgres.stop | |
| PostgresApi | postgres_update | POST /postgres.update | |
| PreviewDeploymentApi | preview_deployment_all | GET /previewDeployment.all | |
| PreviewDeploymentApi | preview_deployment_delete | POST /previewDeployment.delete | |
| PreviewDeploymentApi | preview_deployment_one | GET /previewDeployment.one | |
| ProjectApi | project_all | GET /project.all | |
| ProjectApi | project_create | POST /project.create | |
| ProjectApi | project_duplicate | POST /project.duplicate | |
| ProjectApi | project_one | GET /project.one | |
| ProjectApi | project_remove | POST /project.remove | |
| ProjectApi | project_update | POST /project.update | |
| RedirectsApi | redirects_create | POST /redirects.create | |
| RedirectsApi | redirects_delete | POST /redirects.delete | |
| RedirectsApi | redirects_one | GET /redirects.one | |
| RedirectsApi | redirects_update | POST /redirects.update | |
| RedisApi | redis_change_status | POST /redis.changeStatus | |
| RedisApi | redis_create | POST /redis.create | |
| RedisApi | redis_deploy | POST /redis.deploy | |
| RedisApi | redis_move | POST /redis.move | |
| RedisApi | redis_one | GET /redis.one | |
| RedisApi | redis_rebuild | POST /redis.rebuild | |
| RedisApi | redis_reload | POST /redis.reload | |
| RedisApi | redis_remove | POST /redis.remove | |
| RedisApi | redis_save_environment | POST /redis.saveEnvironment | |
| RedisApi | redis_save_external_port | POST /redis.saveExternalPort | |
| RedisApi | redis_start | POST /redis.start | |
| RedisApi | redis_stop | POST /redis.stop | |
| RedisApi | redis_update | POST /redis.update | |
| RegistryApi | registry_all | GET /registry.all | |
| RegistryApi | registry_create | POST /registry.create | |
| RegistryApi | registry_one | GET /registry.one | |
| RegistryApi | registry_remove | POST /registry.remove | |
| RegistryApi | registry_test_registry | POST /registry.testRegistry | |
| RegistryApi | registry_update | POST /registry.update | |
| RollbackApi | rollback_delete | POST /rollback.delete | |
| RollbackApi | rollback_rollback | POST /rollback.rollback | |
| ScheduleApi | schedule_create | POST /schedule.create | |
| ScheduleApi | schedule_delete | POST /schedule.delete | |
| ScheduleApi | schedule_list | GET /schedule.list | |
| ScheduleApi | schedule_one | GET /schedule.one | |
| ScheduleApi | schedule_run_manually | POST /schedule.runManually | |
| ScheduleApi | schedule_update | POST /schedule.update | |
| SecurityApi | security_create | POST /security.create | |
| SecurityApi | security_delete | POST /security.delete | |
| SecurityApi | security_one | GET /security.one | |
| SecurityApi | security_update | POST /security.update | |
| ServerApi | server_all | GET /server.all | |
| ServerApi | server_count | GET /server.count | |
| ServerApi | server_create | POST /server.create | |
| ServerApi | server_get_default_command | GET /server.getDefaultCommand | |
| ServerApi | server_get_server_metrics | GET /server.getServerMetrics | |
| ServerApi | server_one | GET /server.one | |
| ServerApi | server_public_ip | GET /server.publicIp | |
| ServerApi | server_remove | POST /server.remove | |
| ServerApi | server_security | GET /server.security | |
| ServerApi | server_setup | POST /server.setup | |
| ServerApi | server_setup_monitoring | POST /server.setupMonitoring | |
| ServerApi | server_update | POST /server.update | |
| ServerApi | server_validate | GET /server.validate | |
| ServerApi | server_with_ssh_key | GET /server.withSSHKey | |
| SettingsApi | settings_assign_domain_server | POST /settings.assignDomainServer | |
| SettingsApi | settings_check_gpu_status | GET /settings.checkGPUStatus | |
| SettingsApi | settings_clean_all | POST /settings.cleanAll | |
| SettingsApi | settings_clean_docker_builder | POST /settings.cleanDockerBuilder | |
| SettingsApi | settings_clean_docker_prune | POST /settings.cleanDockerPrune | |
| SettingsApi | settings_clean_monitoring | POST /settings.cleanMonitoring | |
| SettingsApi | settings_clean_redis | POST /settings.cleanRedis | |
| SettingsApi | settings_clean_ssh_private_key | POST /settings.cleanSSHPrivateKey | |
| SettingsApi | settings_clean_stopped_containers | POST /settings.cleanStoppedContainers | |
| SettingsApi | settings_clean_unused_images | POST /settings.cleanUnusedImages | |
| SettingsApi | settings_clean_unused_volumes | POST /settings.cleanUnusedVolumes | |
| SettingsApi | settings_get_dokploy_cloud_ips | GET /settings.getDokployCloudIps | |
| SettingsApi | settings_get_dokploy_version | GET /settings.getDokployVersion | |
| SettingsApi | settings_get_ip | GET /settings.getIp | |
| SettingsApi | settings_get_log_cleanup_status | GET /settings.getLogCleanupStatus | |
| SettingsApi | settings_get_open_api_document | GET /settings.getOpenApiDocument | |
| SettingsApi | settings_get_release_tag | GET /settings.getReleaseTag | |
| SettingsApi | settings_get_traefik_ports | GET /settings.getTraefikPorts | |
| SettingsApi | settings_get_update_data | POST /settings.getUpdateData | |
| SettingsApi | settings_have_activate_requests | GET /settings.haveActivateRequests | |
| SettingsApi | settings_have_traefik_dashboard_port_enabled | GET /settings.haveTraefikDashboardPortEnabled | |
| SettingsApi | settings_health | GET /settings.health | |
| SettingsApi | settings_is_cloud | GET /settings.isCloud | |
| SettingsApi | settings_is_user_subscribed | GET /settings.isUserSubscribed | |
| SettingsApi | settings_read_directories | GET /settings.readDirectories | |
| SettingsApi | settings_read_middleware_traefik_config | GET /settings.readMiddlewareTraefikConfig | |
| SettingsApi | settings_read_traefik_config | GET /settings.readTraefikConfig | |
| SettingsApi | settings_read_traefik_env | GET /settings.readTraefikEnv | |
| SettingsApi | settings_read_traefik_file | GET /settings.readTraefikFile | |
| SettingsApi | settings_read_web_server_traefik_config | GET /settings.readWebServerTraefikConfig | |
| SettingsApi | settings_reload_redis | POST /settings.reloadRedis | |
| SettingsApi | settings_reload_server | POST /settings.reloadServer | |
| SettingsApi | settings_reload_traefik | POST /settings.reloadTraefik | |
| SettingsApi | settings_save_ssh_private_key | POST /settings.saveSSHPrivateKey | |
| SettingsApi | settings_setup_gpu | POST /settings.setupGPU | |
| SettingsApi | settings_toggle_dashboard | POST /settings.toggleDashboard | |
| SettingsApi | settings_toggle_requests | POST /settings.toggleRequests | |
| SettingsApi | settings_update_docker_cleanup | POST /settings.updateDockerCleanup | |
| SettingsApi | settings_update_log_cleanup | POST /settings.updateLogCleanup | |
| SettingsApi | settings_update_middleware_traefik_config | POST /settings.updateMiddlewareTraefikConfig | |
| SettingsApi | settings_update_server | POST /settings.updateServer | |
| SettingsApi | settings_update_traefik_config | POST /settings.updateTraefikConfig | |
| SettingsApi | settings_update_traefik_file | POST /settings.updateTraefikFile | |
| SettingsApi | settings_update_traefik_ports | POST /settings.updateTraefikPorts | |
| SettingsApi | settings_update_web_server_traefik_config | POST /settings.updateWebServerTraefikConfig | |
| SettingsApi | settings_write_traefik_env | POST /settings.writeTraefikEnv | |
| SshKeyApi | ssh_key_all | GET /sshKey.all | |
| SshKeyApi | ssh_key_create | POST /sshKey.create | |
| SshKeyApi | ssh_key_generate | POST /sshKey.generate | |
| SshKeyApi | ssh_key_one | GET /sshKey.one | |
| SshKeyApi | ssh_key_remove | POST /sshKey.remove | |
| SshKeyApi | ssh_key_update | POST /sshKey.update | |
| StripeApi | stripe_can_create_more_servers | GET /stripe.canCreateMoreServers | |
| StripeApi | stripe_create_checkout_session | POST /stripe.createCheckoutSession | |
| StripeApi | stripe_create_customer_portal_session | POST /stripe.createCustomerPortalSession | |
| StripeApi | stripe_get_products | GET /stripe.getProducts | |
| SwarmApi | swarm_get_node_apps | GET /swarm.getNodeApps | |
| SwarmApi | swarm_get_node_info | GET /swarm.getNodeInfo | |
| SwarmApi | swarm_get_nodes | GET /swarm.getNodes | |
| UserApi | user_all | GET /user.all | |
| UserApi | user_assign_permissions | POST /user.assignPermissions | |
| UserApi | user_check_user_organizations | GET /user.checkUserOrganizations | |
| UserApi | user_create_api_key | POST /user.createApiKey | |
| UserApi | user_delete_api_key | POST /user.deleteApiKey | |
| UserApi | user_generate_token | POST /user.generateToken | |
| UserApi | user_get | GET /user.get | |
| UserApi | user_get_backups | GET /user.getBackups | |
| UserApi | user_get_container_metrics | GET /user.getContainerMetrics | |
| UserApi | user_get_invitations | GET /user.getInvitations | |
| UserApi | user_get_metrics_token | GET /user.getMetricsToken | |
| UserApi | user_get_server_metrics | GET /user.getServerMetrics | |
| UserApi | user_get_user_by_token | GET /user.getUserByToken | |
| UserApi | user_have_root_access | GET /user.haveRootAccess | |
| UserApi | user_one | GET /user.one | |
| UserApi | user_remove | POST /user.remove | |
| UserApi | user_send_invitation | POST /user.sendInvitation | |
| UserApi | user_update | POST /user.update | |
| VolumeBackupsApi | volume_backups_create | POST /volumeBackups.create | |
| VolumeBackupsApi | volume_backups_delete | POST /volumeBackups.delete | |
| VolumeBackupsApi | volume_backups_list | GET /volumeBackups.list | |
| VolumeBackupsApi | volume_backups_one | GET /volumeBackups.one | |
| VolumeBackupsApi | volume_backups_run_manually | POST /volumeBackups.runManually | |
| VolumeBackupsApi | volume_backups_update | POST /volumeBackups.update |
Documentation For Models
- AdminSetupMonitoringDefaultResponse
- AdminSetupMonitoringDefaultResponseIssuesInner
- AdminSetupMonitoringRequest
- AdminSetupMonitoringRequestMetricsConfig
- AdminSetupMonitoringRequestMetricsConfigContainers
- AdminSetupMonitoringRequestMetricsConfigContainersServices
- AdminSetupMonitoringRequestMetricsConfigServer
- AdminSetupMonitoringRequestMetricsConfigServerThresholds
- AiCreateRequest
- AiDeleteRequest
- AiDeployRequest
- AiDeployRequestConfigFilesInner
- AiDeployRequestDomainsInner
- AiSuggestRequest
- AiUpdateRequest
- ApplicationCreateRequest
- ApplicationDeleteRequest
- ApplicationMoveRequest
- ApplicationRedeployRequest
- ApplicationReloadRequest
- ApplicationSaveBitbucketProviderRequest
- ApplicationSaveBuildTypeRequest
- ApplicationSaveDockerProviderRequest
- ApplicationSaveEnvironmentRequest
- ApplicationSaveGitProdiverRequest
- ApplicationSaveGiteaProviderRequest
- ApplicationSaveGithubProviderRequest
- ApplicationSaveGitlabProviderRequest
- ApplicationUpdateRequest
- ApplicationUpdateRequestHealthCheckSwarm
- ApplicationUpdateRequestModeSwarm
- ApplicationUpdateRequestModeSwarmReplicated
- ApplicationUpdateRequestModeSwarmReplicatedJob
- ApplicationUpdateRequestNetworkSwarmInner
- ApplicationUpdateRequestPlacementSwarm
- ApplicationUpdateRequestPlacementSwarmPlatformsInner
- ApplicationUpdateRequestPlacementSwarmPreferencesInner
- ApplicationUpdateRequestPlacementSwarmPreferencesInnerSpread
- ApplicationUpdateRequestRestartPolicySwarm
- ApplicationUpdateRequestUpdateConfigSwarm
- ApplicationUpdateTraefikConfigRequest
- BackupCreateRequest
- BackupRemoveRequest
- BackupUpdateRequest
- BitbucketCreateRequest
- BitbucketTestConnectionRequest
- BitbucketUpdateRequest
- CertificatesCreateRequest
- CertificatesRemoveRequest
- ClusterRemoveWorkerRequest
- ComposeCleanQueuesRequest
- ComposeCreateRequest
- ComposeDeleteRequest
- ComposeDeployRequest
- ComposeDeployTemplateRequest
- ComposeMoveRequest
- ComposeProcessTemplateRequest
- ComposeRandomizeComposeRequest
- ComposeUpdateRequest
- DeploymentKillProcessRequest
- DestinationCreateRequest
- DestinationRemoveRequest
- DestinationUpdateRequest
- DockerGetContainersByAppNameMatchAppTypeParameter
- DockerRestartContainerRequest
- DomainCreateRequest
- DomainDeleteRequest
- DomainGenerateDomainRequest
- DomainUpdateRequest
- DomainValidateDomainRequest
- EnvironmentCreateRequest
- EnvironmentDuplicateRequest
- EnvironmentRemoveRequest
- EnvironmentUpdateRequest
- GitProviderRemoveRequest
- GiteaCreateRequest
- GiteaTestConnectionRequest
- GiteaUpdateRequest
- GithubTestConnectionRequest
- GithubUpdateRequest
- GitlabCreateRequest
- GitlabTestConnectionRequest
- GitlabUpdateRequest
- MariadbChangeStatusRequest
- MariadbCreateRequest
- MariadbMoveRequest
- MariadbReloadRequest
- MariadbSaveEnvironmentRequest
- MariadbSaveExternalPortRequest
- MariadbStartRequest
- MariadbUpdateRequest
- MongoChangeStatusRequest
- MongoCreateRequest
- MongoMoveRequest
- MongoReloadRequest
- MongoSaveEnvironmentRequest
- MongoSaveExternalPortRequest
- MongoStartRequest
- MongoUpdateRequest
- MountsCreateRequest
- MountsRemoveRequest
- MountsUpdateRequest
- MysqlChangeStatusRequest
- MysqlCreateRequest
- MysqlMoveRequest
- MysqlReloadRequest
- MysqlSaveEnvironmentRequest
- MysqlSaveExternalPortRequest
- MysqlStartRequest
- MysqlUpdateRequest
- NotificationCreateDiscordRequest
- NotificationCreateEmailRequest
- NotificationCreateGotifyRequest
- NotificationCreateNtfyRequest
- NotificationCreateSlackRequest
- NotificationCreateTelegramRequest
- NotificationReceiveNotificationRequest
- NotificationRemoveRequest
- NotificationTestDiscordConnectionRequest
- NotificationTestEmailConnectionRequest
- NotificationTestGotifyConnectionRequest
- NotificationTestNtfyConnectionRequest
- NotificationTestSlackConnectionRequest
- NotificationTestTelegramConnectionRequest
- NotificationUpdateDiscordRequest
- NotificationUpdateEmailRequest
- NotificationUpdateGotifyRequest
- NotificationUpdateNtfyRequest
- NotificationUpdateSlackRequest
- NotificationUpdateTelegramRequest
- OrganizationCreateRequest
- OrganizationRemoveInvitationRequest
- OrganizationUpdateRequest
- PortCreateRequest
- PortDeleteRequest
- PortUpdateRequest
- PostgresChangeStatusRequest
- PostgresCreateRequest
- PostgresMoveRequest
- PostgresReloadRequest
- PostgresSaveEnvironmentRequest
- PostgresSaveExternalPortRequest
- PostgresStartRequest
- PostgresUpdateRequest
- PreviewDeploymentDeleteRequest
- ProjectCreateRequest
- ProjectDuplicateRequest
- ProjectDuplicateRequestSelectedServicesInner
- ProjectRemoveRequest
- ProjectUpdateRequest
- RedirectsCreateRequest
- RedirectsDeleteRequest
- RedirectsUpdateRequest
- RedisChangeStatusRequest
- RedisCreateRequest
- RedisMoveRequest
- RedisReloadRequest
- RedisSaveEnvironmentRequest
- RedisSaveExternalPortRequest
- RedisStartRequest
- RedisUpdateRequest
- RegistryCreateRequest
- RegistryRemoveRequest
- RegistryTestRegistryRequest
- RegistryUpdateRequest
- RollbackDeleteRequest
- ScheduleCreateRequest
- ScheduleDeleteRequest
- ScheduleRunManuallyRequest
- ScheduleUpdateRequest
- SecurityCreateRequest
- SecurityDeleteRequest
- SecurityUpdateRequest
- ServerCreateRequest
- ServerSetupMonitoringRequest
- ServerSetupRequest
- ServerUpdateRequest
- SettingsAssignDomainServerRequest
- SettingsReloadTraefikRequest
- SettingsSaveSSHPrivateKeyRequest
- SettingsToggleDashboardRequest
- SettingsToggleRequestsRequest
- SettingsUpdateDockerCleanupRequest
- SettingsUpdateLogCleanupRequest
- SettingsUpdateTraefikConfigRequest
- SettingsUpdateTraefikFileRequest
- SettingsUpdateTraefikPortsRequest
- SettingsUpdateTraefikPortsRequestAdditionalPortsInner
- SettingsWriteTraefikEnvRequest
- SshKeyCreateRequest
- SshKeyGenerateRequest
- SshKeyRemoveRequest
- SshKeyUpdateRequest
- StripeCreateCheckoutSessionRequest
- UserAssignPermissionsRequest
- UserCreateApiKeyRequest
- UserCreateApiKeyRequestMetadata
- UserDeleteApiKeyRequest
- UserRemoveRequest
- UserSendInvitationRequest
- UserUpdateRequest
- UserUpdateRequestMetricsConfig
- UserUpdateRequestMetricsConfigContainers
- UserUpdateRequestMetricsConfigContainersServices
- UserUpdateRequestMetricsConfigServer
- UserUpdateRequestMetricsConfigServerThresholds
- VolumeBackupsCreateRequest
- VolumeBackupsDeleteRequest
- VolumeBackupsUpdateRequest
Documentation For Authorization
Authentication schemes defined for the API:
apiKey
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header