<%= first_name %> <%= last_name %>
<%= email %>
Phone: <%= phone %>
User Plan: <%= developer_plan %>
User Support Plan: <%= support_plan %>
Communication Type: <%= communication_type %>
Support Topic: <%= ticket_topic %>
Support Sub Topic: <%= ticket_sub_topic %>
Tertiary Subtopic: <%= tertiary_sub_topic %>}
Support Subject: <%= subject %>
Support Description: <%= description %>
Agent code:<%= agent_code %>
User code: <%= user_code %>
Thank You for Submitting Your Support Ticket
Dear <%= first_name %> ,
Thank you for reaching out to <%= _conf_name %> support and submitting your ticket. We've successfully received your inquiry regarding <%= ticket_topic %>.
Our support team will review the details you've provided, and we aim to respond within <%= response_time %>.
Your ticket reference number is <%= user_code %>. In the meantime, you can view the status of your ticket or add any additional information at this link: \">Your Support Ticket.
We appreciate your trust in <%= _conf_name %> and thank you for giving us the opportunity to assist you. Best regards,<%= _conf_name %> support team ", "display_type": "info" } } }, "inquiries": { "icon_ph": "ph:ticket-duotone", "icon": "", "topics": { "inquiry_ticket_request": { "subject": "Support ticket #<%= id %>", "delivery_method": [ "email" ], "body": "
<%= first_name %> <%= last_name %>
<%= email %>
Phone: <%= phone %>
User Plan: <%= developer_plan %>
User Support Plan: <%= support_plan %>
Communication Type: <%= communication_type %>
Support Topic: <%= ticket_topic %>
Support Sub Topic: <%= ticket_sub_topic %>
Tertiary Subtopic: <%= tertiary_sub_topic %>}
Support Subject: <%= subject %>
Support Description: <%= description %>
Agent code:<%= agent_code %>
User code: <%= user_code %>
Inquiry Submission Acknowledged
Dear <%= first_name %>,
We are grateful to you for reaching out to the <%= _conf_name %> team with your inquiry. Rest assured, we have successfully received your request regarding <%= ticket_topic %>.
Our dedicated team is currently reviewing the information you provided, and we are committed to responding promptly.
Your unique inquiry reference number is <%= user_code %>. If you have an account with us, you can track the progress of your inquiry or add further details using the following link: \">Track Your Inquiry Ticket.
Thank you for placing your trust in <%= _conf_name %>. We are honored to serve you and look forward to assisting you. Warm regards, <%= _conf_name %> Team", "display_type": "info" } } }, "news": { "icon_ph": "ph:newspaper-duotone", "icon": "", "topics": {} } }, "cpi_methods": { "get_xuda_servers_info": { "category": "misc_module" }, "get_utc_ts": { "category": "misc_module" }, "test_jobs": { "category": "jobs_module" }, "get_app_info": { "description": "The get_app_info API method retrieves comprehensive information about a specific application based on the provided application ID. This API method is typically used for administrative and management purposes within a platform, providing a central view of application configuration, status, and operational metrics to support maintenance, updates, and compliance checks.", "fields": { "app_id": { "name": "App Id", "description": "This unique identifier specifies the application whose data will be retrieved.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_security_logs": { "description": "The get_security_logs API method is designed to retrieve security-related log entries for a specific application based on its unique identifier (app_id). This API is crucial for monitoring and auditing purposes, allowing administrators to track user activities, identify potential security incidents, and ensure compliance with security policies. It helps in understanding how users interact with the application and can aid in troubleshooting issues or assessing security measures.", "fields": { "app_id": { "name": "App Id", "description": "This unique identifier specifies the application whose data will be retrieved.", "type": "string", "mandatory": true } }, "category": "logs_module" }, "delete_user_logs": { "description": "The 'delete_user_logs' API method is designed to remove all logs associated with a user. This operation effectively clears the historical log data, potentially freeing up space and ensuring privacy or compliance with data retention policies. This method can be crucial for maintaining a clean and efficient logging system, especially in environments where log data accumulates quickly and needs regular purging to manage storage and maintain system performance.", "category": "logs_module" }, "delete_app_logs": { "description": "The 'delete_app_logs' API method is designed to remove all log data associated with a specific application. Upon invocation with the correct app_id, this method deletes the entire log history for that application, effectively clearing any recorded log data. This operation is useful for maintaining privacy, managing storage, or resetting log data to a clean state for troubleshooting purposes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "logs_module" }, "get_account_projects": { "description": "The 'get_account_projects' API method retrieves all projects associated with a specific account. This method outputs a list of project details, encapsulating each project's unique identifiers, names, types, status, creation dates, and other relevant metadata. This function is particularly useful for displaying a comprehensive overview of all projects tied to an account, aiding in account management and project oversight.", "category": "account_module" }, "get_account_datacenters": { "description": "The 'get_account_datacenters' API method is designed to retrieve a comprehensive list of all datacenters associated with a specific account. When invoked, it outputs a detailed JSON object containing information about each datacenter linked to the account. This information typically includes attributes such as the datacenter ID, name, location, configuration details, status, and any other relevant metadata that describes the datacenter's capabilities, resources, and operational state. This API method is useful for account management purposes, enabling administrators to overview and manage the datacenters that are provisioned under their account.", "category": "account_module" }, "get_account_deployments": { "description": "The 'get_account_deployments' API method retrieves a comprehensive list of all deployments associated with a specific account. This method does not require any parameters specific to individual deployments but operates at the account level to gather and return data on all deployment activities. The output includes details such as deployment identifiers, statuses, timestamps, configurations, and other relevant metadata that provide a full overview of the deployment history and current state within the account. This API is typically used for monitoring, managing, and auditing deployment activities across an account’s infrastructure.", "category": "account_module" }, "get_account_instances": { "category": "account_module" }, "create_project": { "description": "The 'create_project' API method on the Xuda platform is designed to initialize and register a new project within the system. When invoked, this method requires certain parameters in the 'data' object such as the project name, description, and possibly other settings like visibility (public or private) and initial configurations specific to the project's needs. Upon successful execution, the method creates a new project entry in the platform's database, allocates resources as specified, and returns details about the newly created project, such as the project ID, creation date, and initial settings. This API is crucial for users and developers who need to dynamically manage multiple projects, allowing them to automate project setup and configuration through programmable interfaces.", "fields": { "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_project_instances": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_backups": { "description": "The 'get_app_backups' API method is designed to retrieve a list of backups for a specific application. It requires an app_id as a parameter, which is the unique identifier for the application. Upon invocation, this method returns an array containing details of all the backups associated with the specified application. Each item in the array typically includes information such as the backup ID, creation date, size, and possibly other relevant metadata. This method is useful for managing and monitoring application backups, allowing users to view the history and status of their data backups directly through the API.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "get_table_counts": { "description": "The 'get_table_counts' API method is designed to retrieve the total number of records in a specific table within an application. It requires two parameters: app_id, which is the unique identifier for the application, and table_id, which identifies the specific table within that application. When called, this method returns the count of records present in the specified table, providing a quick overview of the data volume managed within that part of the application. This functionality is useful for monitoring and managing data storage, as well as for performing analytics or audits on the data usage within the application.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be query, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true } }, "category": "data_module" }, "dbs_create": { "description": "The 'dbs_create' API method is designed to create a new record in a specified table within a database. It requires an application identifier (app_id) and a table identifier (table_id) to locate the appropriate table. Additionally, it accepts table_data, which consists of key-value pairs representing the data fields and their values to be stored in the record. This method facilitates the insertion of data into the database dynamically, allowing for the expansion and management of database content programmatically.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be updated, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "table_data": { "name": "Table Data", "description": "Key-value pairs, such as {'user_name': 'John', 'last_name': 'Smith'}", "type": "object", "mandatory": true } }, "category": "data_module" }, "dbs_read": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be query, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true } }, "category": "data_module" }, "dbs_update": { "description": "The 'dbs_update' API method is used to modify an existing row in a specific table within a database. By specifying the application ID, table ID, and row ID, this method facilitates the update of row data with new key-value pairs. This functionality is essential for maintaining and adjusting database records dynamically, allowing applications to ensure their data remains accurate and up-to-date as operations evolve. This method effectively modifies only the specified row's data in the identified table, making it a targeted and efficient way to manage database contents.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be updated, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "row_id": { "name": "Row Id", "description": "The row ID uniquely identifies the document to be updated.", "type": "string", "mandatory": true }, "table_data": { "name": "Table Data", "description": "Key-value pairs, such as {'user_name': 'John', 'last_name': 'Smith'}, will replace the current data in the document.", "type": "object", "mandatory": true } }, "category": "data_module" }, "dbs_delete": { "description": "The 'dbs_delete' API method is designed for deleting specific documents from a database table within an application. This method processes a deletion request by targeting documents identified by their IDs within a specified table of a given application. It supports both soft and permanent deletions, the latter being irreversible. This functionality is crucial for managing data retention and compliance with data handling policies, allowing for precise control over the removal of records from the system's storage.", "fields": { "app_id": { "name": "App Id", "description": "", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be updated, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "ids": { "name": "Id's", "description": "Array of document IDs marked for deletion", "type": "array", "mandatory": true }, "permanent": { "name": "Permanent", "description": "Irreversible deletion of the documents (restoration not possible).", "type": "boolean", "mandatory": false } }, "category": "data_module" }, "dbs_restore": { "description": "Reinstate a previously removed row in the designated database table, except under the following conditions: 1. the table has undergone a repair operation, 2. the row was eliminated using a permanent delete option, 3. an automatic purge process has been executed.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be restored, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "ids": { "name": "Id's", "description": "Array of document ids to restore", "type": "array", "mandatory": true } }, "category": "data_module" }, "copy_table": { "category": "data_module" }, "get_plans": { "description": "The 'get_plans' API method retrieves detailed information about Xuda's various service plans, including tiers such as 'Free','Pro','Team', and 'Enterprise', among others. Each plan is presented with a comprehensive set of attributes such as ranking, ID, color code, name, price, and a detailed description of what the plan offers. Features of each plan cover aspects like the number of projects, team size, storage capabilities, and additional services such as studio access, support level, and deployment options. The output is structured to provide insights into what each plan includes, helping users to understand and select the most suitable subscription based on their needs. This method is useful for presenting users with options to upgrade or modify their current service packages based on detailed plan features and pricing.", "category": "misc_module" }, "get_app_config": { "description": "The 'get_app_config' API method retrieves specific configuration properties for a given application. It returns a JSON object containing the application's icon properties, name, and branding properties. These elements include the application's visual identifiers such as logos and branding colors, the application's official name, and any additional branding-related settings that have been configured for the application. This method is useful for obtaining a snapshot of critical visual and identity aspects of an application, which can be particularly helpful for UI rendering or in situations where application branding needs to be displayed or verified.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "set_runtime_user_monitor": { "description": "The 'set_runtime_user_monitor' API method enables or disables the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment. By toggling this functionality, administrators can observe user interactions, provide remote assistance, and manage support more effectively within the application. This method adjusts the monitoring settings based on the provided application identifier and a boolean value indicating whether to enable or disable these features. The primary function is to enhance administrative oversight and support responsiveness in the application's operational context.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "enable": { "name": "Enable", "description": "", "type": "boolean", "mandatory": true } }, "category": "app_module" }, "save_deploy_settings": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "compact_database": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "clear_session_logs": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "session_module" }, "get_db_activity": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "set_runtime_utility_screen": { "description": "The 'set_runtime_utility_screen' API method enables or disables a utility screen during the runtime of an application based on the user's input. When activated, this utility screen offers several options to enhance user support and application management. These options include requesting remote control assistance, accessing support services, performing a hard reload of the application, and clearing the application's cache. This functionality is particularly useful for troubleshooting and ensuring the smooth operation of the application while it is running. The method primarily hinges on the application's unique identifier and a boolean parameter that dictates whether the utility screen should be enabled or disabled.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "enable": { "name": "Enable", "description": "", "type": "boolean", "mandatory": true } }, "category": "app_module" }, "get_platform_servers_info": { "description": "The 'get_platform_servers_info' API method from the Xuda platform provides a comprehensive overview of server infrastructure associated with the platform. It retrieves essential data about the platform's servers, including their unique identifiers, the countries in which they are located (countries), the current operational status of each server (server_status), and detailed information about the digital ocean data centers (do_datacenters) utilized by these servers. This method is crucial for managing and monitoring the geographical distribution and operational health of the platform's server resources.", "category": "misc_module" }, "get_price_obj": { "category": "misc_module" }, "get_account_info": { "category": "account_module" }, "build_app": { "category": "build_module" }, "destroy_app": { "category": "app_module" }, "leave_team": { "category": "team_module" }, "turn_app_off": { "description": "The 'turn_app_off' API method is designed to deactivate a specific application on the platform. By invoking this method with the appropriate application identifier, it effectively disables the application, making it non-operational until further action is taken to reactivate it. This functionality is essential for managing the lifecycle of applications, allowing administrators or users to control the availability of the application as needed for maintenance, updates, or other administrative reasons.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "turn_app_on": { "description": "The 'turn_app_on' API method is designed to activate a specific application on the platform by setting its operational status to active. This method essentially switches the selected application from an inactive or dormant state to a running state, allowing it to serve requests and perform its designated functions.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "app_visibility_on": { "description": "The 'app_visibility_on' API method is designed to change the visibility settings of a specific application on the Xuda platform by making it publicly accessible. When activated, this function lists the application in the Xuda marketplace, allowing other users to view and clone the project and its associated programs. Furthermore, the API facilitates the integration of the application into the AI training process by automatically sending data every time a program associated with the project is saved. This feature enhances the collaborative and developmental capabilities of the platform, promoting shared resources and continuous learning through AI training contributions.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "app_visibility_off": { "description": "The 'app_visibility_off' API method is designed to alter the visibility settings of an application by turning off its public access. This action effectively makes the application private, removing it from the Xuda marketplace. When invoked, this method updates the application's visibility status based on its unique identifier, ensuring that it is no longer accessible to the broader user base or visible in any public listing within the marketplace. This functionality is crucial for controlling who can access the application and maintaining privacy and exclusivity as needed.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module", "min_plan": "pro" }, "enable_auto_backup": { "description": "The 'enable_auto_backup' API method is designed to activate automatic backup functionality for a specified application. Upon invocation, it sets the system to automatically perform backups on a daily basis, using predefined default settings. This ensures that the application's data is regularly saved, minimizing data loss risks and providing a reliable way to restore information to a recent state if needed. This feature is particularly valuable for maintaining data integrity and operational continuity.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "disable_auto_backup": { "description": "The 'disable_auto_backup' API method is used to deactivate the automatic backup feature for a specified application. This operation ceases the scheduled daily backups, effectively stopping the automatic preservation of data at regular intervals. This method is useful for scenarios where automatic backups are no longer necessary or when manual backup processes are preferred.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "update_auto_backup_preferences": { "description": "The 'update_auto_backup_preferences' API method allows for the configuration of backup settings for a specified application. This method adjusts the backup preferences, such as specifying on which days backups should occur and setting the retention period for how long these backups are kept. This functionality is essential for tailoring backup operations to meet specific data management requirements and compliance standards, ensuring that backups are both efficient and aligned with organizational policies.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "backup.schedule": { "name": "Backup Schedule", "description": "", "type": "object", "mandatory": true }, "backup.retention": { "name": "Backup Retention", "description": "", "type": "object", "mandatory": true } }, "category": "backup_module" }, "restore_backup": { "category": "backup_module" }, "get_contacts": { "category": "account_module" }, "get_app_releases": { "description": "The `get_app_releases` API method is designed to retrieve detailed information about the various release versions of a specific application. This method provides comprehensive data on each release, including version numbers, release notes, and the dates on which these versions were made available. It is particularly useful for tracking the evolution of an app and managing version control, ensuring that stakeholders are informed about new updates and historical changes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "build_module" }, "get_release_note_info": { "category": "build_module" }, "add_conversion": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "data_module" }, "get_pending_conversions": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "data_module" }, "update_conversion_completion_status": { "category": "data_module" }, "install_instance_build": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "build_module" }, "query_items": { "category": "marketplace_module" }, "convert_db": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "data_module" }, "update_app_property_object": { "category": "app_module" }, "update_app_single_property": { "category": "app_module" }, "get_new_notification_count": { "category": "notification_module" }, "submit_app_notification": { "category": "notification_module" }, "get_notifications": { "category": "notification_module" }, "get_system_notifications": { "category": "notification_module" }, "set_notification_read": { "category": "notification_module" }, "update_notification_status": { "category": "notification_module" }, "update_account_info": { "category": "account_module" }, "team_get_recipients": { "category": "team_module" }, "resend_access_invitation": { "category": "team_module" }, "repair_table": { "description": "This method conducts a comprehensive scan of the entire table, row by row, applying field definitions according to the table settings to correct the following issues: 1. transforming fields with incorrect types, 2. deleting data from obsolete fields, and 3. reconstructing indexes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be refreshed, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true } }, "category": "data_module" }, "get_devices_data": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "support_module" }, "reload_active_devices": {}, "get_client_error_data": { "category": "support_module" }, "get_user_emails": { "category": "email_module" }, "delete_release": { "category": "build_module" }, "reinstall_link_resources": { "description": "The `reinstall_link_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_user_group_resources": { "description": "The `reinstall_user_group_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_embed_resources": { "description": "The `reinstall_embed_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_preview_resources": { "description": "The `reinstall_preview_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_datacenter_resources": { "description": "The `reinstall_datacenter_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_router_resources": { "description": "The `reinstall_router_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_pwa_resources": { "description": "The `reinstall_pwa_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_api_resources": { "description": "The `reinstall_api_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "update_app_version": { "description": "The `update_app_version` API method is designed to upgrade an application to the latest build version developed within the Xuda Studio environment. When invoked, this method applies the most recent updates and enhancements to the specified application, ensuring it runs the latest features, fixes, and improvements available.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reboot_server": { "description": "The `reboot_server` API method is designed to restart the virtual private server (VPS) associated with a specific application. This method effectively reboots the server environment, ensuring that any updates or changes that require a restart are applied, and can help resolve issues related to server performance or stability. It is a crucial tool for maintaining the health and efficiency of server operations linked to the application.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "stripe_pay_invoice": { "category": "stripe_module" }, "marketplace_queries": { "category": "marketplace_module" }, "get_contact_members": { "description": "", "fields": { "team_req_stat": { "name": "Team Request Status", "description": "", "type": "array", "mandatory": false } }, "category": "team_module" }, "get_developer_members": { "description": "The 'get_developer_members' API method retrieves a list of members associated with a specific studio access within an application. This method focuses on fetching detailed information about team members, such as their roles, statuses, and any other relevant data linked to their participation in the specified application. It's particularly useful for managing user access and understanding the composition of teams within the app environment, facilitating better collaboration and security management.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "team_req_stat": { "name": "Team Request Status", "description": "", "type": "array", "mandatory": false } }, "category": "team_module" }, "get_user_group_members": { "description": "The 'get_user_group_members' API method retrieves a list of members associated with a specific user group within an application. This method focuses on fetching detailed information about team members, such as their roles, statuses, and any other relevant data linked to their participation in the specified application. It's particularly useful for managing user access and understanding the composition of teams within the app environment, facilitating better collaboration and security management.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "team_req_stat": { "name": "Team Request Status", "description": "", "type": "array", "mandatory": false } }, "category": "team_module" }, "add_contact_member": { "description": "The 'add_contact_member' API method is designed to manage the addition of new members to a contact list by sending a join request via email. Upon execution, the API sends an invitation email to the specified recipient's email address. The invitation includes a request for the recipient to join the contact list. This join request remains in a pending state until the recipient confirms their intention to join. This method facilitates controlled growth of contact lists by ensuring that new additions are confirmed and authorized by potential members, enhancing both security and user management practices.", "fields": { "access_email": { "name": "Email", "type": "string", "mandatory": true } }, "category": "team_module" }, "add_developer_member": { "description": "The 'add_developer_member' API method facilitates collaboration within the Xuda platform by sending an invitation to a developer to join a specific studio project. When this method is called, it creates a join request associated with the specified application. An invitation email is sent to the recipient, prompting them to confirm their participation. The request remains in a pending state until the invited user accepts the invitation, ensuring that only confirmed members can access the project resources. This method is crucial for managing project permissions and expanding development teams effectively within Xuda Studio.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "access_email": { "name": "Email", "type": "string", "mandatory": true } }, "category": "team_module", "min_plan": "team" }, "add_user_group_member": { "description": "The 'add_user_group_member' API method facilitates the addition of new members to a user group within an application. When called, it generates a join request and sends an invitation email to the potential new member's provided email address. This invitation includes details on how to join the user group. The membership request remains in a pending state until the recipient accepts the invitation, confirming their intent to join the group. This process helps manage user group memberships effectively by ensuring that additions are consented to by both parties.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "access_email": { "name": "Email", "type": "string", "mandatory": true } }, "category": "team_module" }, "confirm_contact_request": { "description": "The 'confirm_contact_request' API method is used to confirm and finalize the addition of a member to a contact list. Upon receiving a specific team request ID, this method approves the previously pending request, effectively adding the requested member to the contact list. This confirmation ensures that both parties have agreed to the addition, facilitating organized and consensual management of contact lists within the system.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "confirm_developer_request": { "description": "The 'confirm_developer_request' API method is used to approve a pending membership request for a team member aiming to join a group of authorized developers within the Xuda Studio. Upon execution, this method finalizes the addition of the member by confirming their join request based on the specified team request identifier. This approval process integrates new members into the development environment, granting them the necessary access and permissions to collaborate and contribute to projects within Xuda Studio.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "decline_contact_request": { "description": "The 'decline_contact_request' API method is utilized to reject a pending request for adding a member as a contact within a system. When this method is invoked, it effectively communicates to the system that the user has decided not to accept the membership request. This action prevents the requester from being added as a contact, maintaining the user's existing contact list unchanged. This method is essential for managing personal or organizational contacts, ensuring that additions are subject to user approval.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "decline_developer_request": { "description": "The 'decline_developer_request' API method is designed to handle the rejection of a membership request for a user seeking to join as a developer in Xuda Studio. This method processes a specific request identified by a unique team request identifier. When invoked, it effectively communicates to the system that the user has declined the request, ensuring that the membership does not proceed. This functionality is important for managing user roles and permissions within Xuda Studio, allowing for controlled access based on user decisions and administrative approvals.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "decline_user_group_request": { "description": "The 'decline_user_group_request' API method handles the rejection of a pending request for a user to join a specific user group. When invoked, this method updates the system to indicate that the invitation for membership has been declined. This action prevents the prospective member from joining the user group, ensuring that only approved users can access or participate in the group activities. This method is important for maintaining control over group composition and ensuring that all members meet the required criteria or have received the necessary approvals.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "cancel_contact_request": { "description": "The 'cancel_contact_request' API method is designed to cancel a previously made contact request. When executed, it updates the system to reflect that the request identified by its unique team request ID has been officially cancelled. The user who made the request or the intended recipient is notified that the request is no longer active. This method is particularly useful for managing communication or connection requests within a system, allowing users to retract requests that are no longer relevant or were made in error.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "cancel_developer_request": { "description": "The 'cancel_developer_request' API method is designed to cancel an existing request related to developer activities or permissions within Xuda Studio. When executed, it notifies the user that their pending request, identified by a unique team request ID, has been officially cancelled. This method is useful for managing the lifecycle of requests within the studio, allowing for the orderly handling of changes in project roles, development tasks, or access permissions, ensuring that only current and relevant requests are active and processed.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "cancel_user_group_request": { "description": "The 'cancel_user_group_request' API method is designed to cancel a previously made request for a user to join a user group. When this method is invoked with a specific team request identifier, it effectively nullifies the request and notifies the user that their application to join the user group has been cancelled. This ensures that the user is aware that the request is no longer active and will not be processed further, allowing for clear communication and management of user group memberships.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "create_contact_join_link": { "description": "The 'create_contact_join_link' API method generates a unique URL that contains all the necessary information for a user to join a contact list. By sharing this link, users can seamlessly add themselves to the designated contact list without the need for manual entry or approval. This method simplifies the process of expanding contact databases by facilitating easy, direct additions through a single, shareable link. This is particularly useful for managing subscriptions, memberships, or any community engagement efforts where gathering and maintaining contact details is essential.", "category": "team_module" }, "create_developer_join_link": { "description": "The `create_developer_join_link` API method generates a specialized link that contains all necessary information for a user to join as a developer on the Xuda platform using Xuda Studio. This link facilitates the onboarding process by directly integrating new developers into the specific application associated with the provided `app_id`. By sharing this URL, existing team members can easily invite new developers to collaborate, contributing to a streamlined workflow and enhanced productivity within the development environment.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "team_module" }, "create_user_group_join_link": { "description": "The `create_user_group_join_link` API method generates a unique URL that facilitates joining a user group within a specific application. When invoked, this method creates a link embedded with all necessary information required for a user to become a member of the user group. By sharing this URL with prospective members, they can directly access the group joining process. This method simplifies the process of adding new members, enhancing the user experience by providing a straightforward and efficient way to expand user group memberships through link-based invitations.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "team_module" }, "get_logs": { "category": "logs_module" }, "get_logs_counts": { "category": "logs_module" }, "get_drive_files_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "get_drive_file_info_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true }, "file_path": { "name": "File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_drive_files_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "files_arr": { "name": "Files", "description": "Array of file id's", "type": "array", "mandatory": true } }, "category": "drive_module" }, "extract_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_id": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "upload_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "create_drive_folder_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "folder_name": { "name": "Folder Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true }, "file_name_to": { "name": "New File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_folder_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "curr_path": { "name": "Current File Path", "description": "", "type": "string", "mandatory": true }, "new_path": { "name": "New File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_sharing_mode_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_file_bulk_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "server_files": { "name": "Files to Delete", "description": "Array of file names", "type": "array", "mandatory": true } }, "category": "drive_module" }, "search_drive_files_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "search_string": { "name": "Search String", "description": "", "type": "string", "mandatory": false }, "search_name": { "name": "Search Name", "description": "", "type": "string", "mandatory": false }, "date_from": { "name": "Date From", "description": "timestamp", "type": "number", "mandatory": false }, "date_to": { "name": "Date To", "description": "timestamp", "type": "number", "mandatory": false }, "mime_type": { "name": "Mime Type", "description": "", "type": "string", "mandatory": false }, "file_ext": { "name": "File Extension", "description": "", "type": "string", "mandatory": false } }, "category": "drive_module" }, "get_drive_files_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "get_drive_file_info_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true }, "file_path": { "name": "File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_drive_files_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "files_arr": { "name": "Files", "description": "Array of file id's", "type": "array", "mandatory": true } }, "category": "drive_module" }, "extract_drive_file_studio": { "fields": { "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_id": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "upload_drive_file_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "create_drive_folder_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "folder_name": { "name": "Folder Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_file_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true }, "file_name_to": { "name": "New File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_folder_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "curr_path": { "name": "Current File Path", "description": "", "type": "string", "mandatory": true }, "new_path": { "name": "New File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_sharing_mode_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_file_bulk_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "server_files": { "name": "Files to Delete", "description": "Array of file names", "type": "array", "mandatory": true } }, "category": "drive_module" }, "search_drive_files_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "search_string": { "name": "Search String", "description": "", "type": "string", "mandatory": false }, "search_name": { "name": "Search Name", "description": "", "type": "string", "mandatory": false }, "date_from": { "name": "Date From", "description": "timestamp", "type": "number", "mandatory": false }, "date_to": { "name": "Date To", "description": "timestamp", "type": "number", "mandatory": false }, "mime_type": { "name": "Mime Type", "description": "", "type": "string", "mandatory": false }, "file_ext": { "name": "File Extension", "description": "", "type": "string", "mandatory": false } }, "category": "drive_module" }, "get_drive_files_user": { "fields": { "path": { "name": "Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "get_drive_file_info_user": { "fields": { "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true }, "file_path": { "name": "File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_drive_files_user": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "files_arr": { "name": "Files", "description": "Array of file id's", "type": "array", "mandatory": true } }, "category": "drive_module" }, "extract_drive_file_user": { "fields": { "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_id": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "upload_drive_file_user": { "category": "drive_module" }, "update_drive_file_user": { "fields": { "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "create_drive_folder_user": { "fields": { "path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "folder_name": { "name": "Folder Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_file_user": { "fields": { "file_name_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true }, "file_name_to": { "name": "New File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_folder_user": { "fields": { "curr_path": { "name": "Current File Path", "description": "", "type": "string", "mandatory": true }, "new_path": { "name": "New File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_sharing_mode_user": { "fields": { "file_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_file_bulk_user": { "fields": { "server_files": { "name": "Files to Delete", "description": "Array of file names", "type": "array", "mandatory": true } }, "category": "drive_module" }, "search_drive_files_user": { "fields": { "search_string": { "name": "Search String", "description": "", "type": "string", "mandatory": false }, "search_name": { "name": "Search Name", "description": "", "type": "string", "mandatory": false }, "date_from": { "name": "Date From", "description": "timestamp", "type": "number", "mandatory": false }, "date_to": { "name": "Date To", "description": "timestamp", "type": "number", "mandatory": false }, "mime_type": { "name": "Mime Type", "description": "", "type": "string", "mandatory": false }, "file_ext": { "name": "File Extension", "description": "", "type": "string", "mandatory": false } }, "category": "drive_module" }, "update_npm_dependencies": { "description": "The `update_npm_dependencies` API method is tasked with installing and updating Node.js package dependencies for a specific application within the Xuda platform. By executing this method, the listed dependencies in the provided object are installed or updated on the Xuda Studio drive associated with the application identified by the `app_id`. This process ensures that the application's environment is up-to-date with the latest packages needed for its operation, thereby maintaining compatibility and functionality of the application's features.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "dependencies": { "name": "Dependencies", "description": "", "type": "object", "mandatory": true } }, "category": "app_module" }, "change_under_attack_mode": { "description": "The `change_under_attack_mode` API method enables the activation of an 'Under Attack Mode' for a specified application. When this mode is enabled, it enhances the security measures of the application to protect against potential threats or ongoing attacks. This could involve increasing scrutiny of incoming traffic, employing additional verification processes to ward off bots, or temporarily altering how requests are handled to mitigate the impact of the attack. This method is crucial for safeguarding the application during periods of heightened security risk.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module", "min_plan": "pro" }, "get_app_plugins": { "description": "The `get_app_plugins` API method retrieves a comprehensive list of Xuda plugins associated with a specified application. This method provides detailed information about each plugin, including its installation status, which indicates whether each plugin is currently installed within the application. This functionality is essential for managing and configuring the plugins that enhance or extend the application's capabilities, offering administrators a clear view of the application's integration with various tools and services.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "get_plugins": { "description": "The `get_plugins` API method retrieves a list of available plugins from the Xuda platform. This method provides users with access to publicly available plugins, detailing each plugin's features and potential integrations. This functionality is essential for users looking to enhance their applications with additional capabilities provided by Xuda plugins, enabling them to select suitable plugins based on their specific needs and requirements.", "category": "plugins_module" }, "install_plugin": { "description": "The `install_plugin` API method is designed to facilitate the installation of a specified plugin into an application managed on the Xuda platform. When invoked with an application identifier and the name of the plugin, this method seamlessly integrates the plugin into the application's environment. This enables the application to extend its functionality by incorporating additional features provided by the plugin, thereby enhancing the overall capabilities and user experience of the application. This process is crucial for maintaining the modularity and scalability of applications on the Xuda platform.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "plugin_name": { "name": "Plugin Name", "description": "", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "uninstall_plugin": { "description": "The `uninstall_plugin` API method facilitates the removal of a specific plugin from an application on the Xuda platform. By specifying the application's unique identifier and the name of the plugin, this method ensures that the selected plugin is completely uninstalled from the application environment. This operation is crucial for maintaining the application's performance and security by enabling the management of active plugins, allowing users to optimize their application setup by removing unnecessary or outdated plugins.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "plugin_name": { "name": "Plugin Name", "description": "", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "archive_plugin": { "description": "The `archive_plugin` API method is used to archive a specific plugin within an application. When this method is called with the identifiers for both the application and the plugin, it initiates the process of archiving the specified plugin. This action effectively disables the plugin from active use within the application while preserving its data and configuration for potential future restoration or review. This method is particularly useful for managing application resources and performance by allowing administrators to temporarily remove unused or unnecessary plugins without permanently deleting them.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "plugin_name": { "name": "Plugin Name", "description": "", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "get_platform_regions": { "description": "The `get_regions` API method retrieves a list of all available regional servers managed by the Xuda platform. This method provides comprehensive information about the different geographic locations where Xuda servers are positioned, enabling users to understand and select the most appropriate server locations for their applications based on latency, legal, or data sovereignty requirements. This functionality is essential for optimizing application performance and compliance by strategically selecting server regions.", "category": "deploy_module" }, "get_app_server_usage": { "description": "The `get_app_server_usage` API method retrieves information regarding the virtual private server (VPS) usage associated with a specific application. It provides detailed data on resources utilized by the application's server, such as CPU, memory, storage, and network usage. This method is essential for monitoring and managing the server performance and ensuring the application runs efficiently within its allocated server resources.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "ts_start": { "name": "Start Date", "description": "timestamp", "type": "number", "mandatory": true }, "ts_end": { "name": "End Date", "description": "timestamp", "type": "number", "mandatory": true } }, "category": "deploy_module" }, "update_domain_setup": { "fields": { "domain_setup": { "name": "Domain Setup", "description": "", "type": "object", "mandatory": true }, "domain_setup.type": { "name": "Domain Setup Type", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "validate_domain_setup_subdomain": { "fields": { "subdomain": { "name": "Subdomain", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "resize_server": { "description": "The `resize_server` API method is designed to adjust the virtual private server (VPS) specifications associated with a specific application on the Xuda platform. This method allows for the scaling of server resources, either upgrading or downgrading, to meet the changing needs of the application in terms of memory, CPU, and storage. By resizing the server, the application can optimize performance, handle increased traffic, or reduce costs, depending on current requirements. This operation is crucial for maintaining efficient and cost-effective server utilization throughout the application lifecycle.", "fields": { "app_hosting.app_server_type": { "name": "Server Type", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "deploy_link": { "description": "The `deploy_link` API method facilitates the creation of a deployment link for an application based on specific deployment parameters. Once executed, this method generates a URL for the specified application, which can be utilized as a standalone link, embedded directly into a webpage, or included within an iframe. This link provides direct access to the application, allowing for easy integration and distribution across various platforms and user interfaces. This functionality is particularly useful for simplifying the process of sharing and accessing applications hosted in different environments or data centers.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_router": { "description": "The `deploy_router` API method is designed to establish multiple URL paths for an application. This method facilitates the creation of a routing system within the app, allowing it to handle various URL paths efficiently. By doing so, it enhances the app's ability to serve different content or functionalities based on the specific path accessed, effectively organizing and optimizing the user's navigation experience. This is particularly useful for apps that require distinct sections or features accessible through unique URLs.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_embed": { "description": "The `deploy_embed` API method is designed to facilitate the embedding of applications into websites by generating the necessary code. This method processes key deployment details such as the application name, release ID, program ID, datacenter ID, and server type. It also configures additional features like user monitoring and a utility screen. By executing this method, users can efficiently generate an embed code that can be directly incorporated into a webpage, allowing the embedded application to function seamlessly within the host site's environment. This capability is crucial for extending the reach and functionality of applications across different platforms and websites.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_pwa": { "description": "The `deploy_pwa` API method facilitates the deployment of a Progressive Web App (PWA) associated with a specific domain. This method handles the configuration and initiation of a PWA deployment, ensuring the app meets essential PWA criteria such as reliability, fast loading times, and offline capabilities. By integrating various identifiers and settings such as application name, release ID, program ID, datacenter ID, and deployment server type, this API sets up the environment to host and run the PWA efficiently. Additional features like user monitoring and utility screens can also be enabled to enhance functionality and user experience. This method is crucial for developers looking to deploy robust web applications that offer native-like experiences on the web.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_user_group": { "description": "The `deploy_user_group` API method is designed to facilitate the deployment of a user group application within a specified environment. This method orchestrates the setup of the application based on several deployment parameters such as the application name, release ID, program ID, datacenter ID, and the type of deployment server. Additionally, it configures features like user monitoring and utility screens to enhance the functionality and manageability of the application. Once the deployment is completed, the API generates a shareable link, similar to an intranet link, that can be distributed to users to access the deployed application. This enables a streamlined and accessible way for teams or user groups to interact with the application in a controlled and efficient manner.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true }, "data.setup.users": { "name": "Users to Invite", "description": "Object array: {'email': 'xxx@gmail.com,'preferences': {'hide_create_button': false,'default_dashboard': false,'sidebar_style': 'open'}}", "type": "array", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_preview": { "description": "The `deploy_preview` API method facilitates the creation of a shareable preview link for an application. This functionality is designed primarily for demonstration purposes, allowing users to experience the app in a simulated device environment. The API enables features such as User Monitoring and a Utility Screen, enhancing the interactivity and accessibility of the preview. This method is particularly useful for developers seeking feedback or showcasing app functionalities before a full-scale deployment.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_api": { "description": "The `deploy_api` API method facilitates the creation of an API interface for a specified application. This method is designed to streamline the deployment process by linking the application with a specific release version, program identifier, and data center, and by configuring it on a server type optimized for API handling. By executing this method, developers can efficiently establish a robust API interface that enhances their application's accessibility and interaction with other systems, ensuring seamless integration and communication across different platforms.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_vps": { "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.app_region": { "name": "Deployment Region", "description": "The Deployment Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": true }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_vps_05", "shared_vps_1", "shared_vps_2", "shared_vps_4", "shared_vps_8", "optimized_vps_2", "optimized_vps_4", "optimized_vps_8", "optimized_vps_16", "performance_vps_4", "performance_vps_16", "performance_vps_24", "performance_vps_32", "large_vps_8", "large_vps_16", "large_vps_24", "large_vps_32" ], "mandatory": true } }, "category": "deploy_module" }, "deploy_marketplace": { "fields": { "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true }, "data.setup.app_images": { "name": "App Images", "description": "", "type": "array", "mandatory": true } }, "category": "deploy_module", "min_plan": "agency" }, "deploy_instance": { "fields": { "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true } }, "category": "deploy_module", "min_plan": "agency" }, "deploy_datacenter": { "description": "The `deploy_datacenter` API method is designed to establish a new datacenter server tailored to serve as a database for related deployments. This server is configured based on the specified region and server size. Additionally, the newly created datacenter has the capability to synchronize with other datacenters within the same project cluster. This synchronization facilitates data consistency and redundancy across the network, enhancing both the reliability and the scalability of the infrastructure.", "fields": { "data.create_datacenter.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_load_balancer": { "fields": { "data.create_datacenter.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true }, "data.create_datacenter.app_region": { "name": "Region", "description": "", "type": "string", "mandatory": true }, "data.create_datacenter.app_server_type": { "name": "Server Type", "description": "", "type": "string", "mandatory": true } }, "category": "deploy_module", "min_plan": "enterprise_t1" }, "deploy_another": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true }, "data.app_region": { "name": "Region", "description": "", "type": "string", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "configure_datacenter_replication": { "description": "The `configure_datacenter_replication` API method is designed to set up replication configurations for an application between data centers. This method facilitates specifying the type of replication (either 'one-time' for a single replication event or 'continuous' for ongoing synchronization), the source of the replication (either from a 'master' or another 'datacenter'), and the direction of the replication ('one_way' where data flows from the source to the destination without reciprocal updates, or 'two_way' where changes are synchronized in both directions). This configuration is crucial for ensuring data redundancy, improving access speed for geographically distributed users, and enhancing disaster recovery capabilities.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "replicate_data.create_datacenter.app_datacenter_replication.replicate_type": { "name": "Replication Type", "description": "", "type": "string", "options": [ "one-time", "continuous" ], "mandatory": true }, "replicate_data.create_datacenter.app_datacenter_replication.replicate_from": { "name": "Replicate From", "description": "", "type": "string", "options": [ "master", "datacenter" ], "mandatory": true }, "replicate_data.create_datacenter.app_datacenter_replication.replicate_direction": { "name": "Replicate Direction", "description": "", "type": "string", "options": [ "one_way", "two_way" ], "mandatory": true } }, "category": "app_module" }, "get_deploy_info": { "description": "The `get_deploy_info` API method is designed to fetch and return detailed information about a specific application deployment using the application's unique identifier, `app_id`. This method provides essential data on the deployment, including the application's unique attributes, status, user information, and specific deployment settings. It is an essential tool for monitoring and managing the lifecycle and configuration of application deployments within a system.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "create_backup": { "description": "The `create_backup` API method facilitates the creation of backups for various elements such as projects, datacenters, instances, or deployments. This function is essential for ensuring data integrity and availability by allowing users to save and restore states of critical components within their systems. It provides a safety net against data loss and aids in disaster recovery by allowing organizations to maintain copies of their operational data at different points in time.", "fields": { "data.app_replicate": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "destroy_backup": { "description": "The `destroy_backup` API method is designed to permanently delete a specific backup from a system or storage location. By providing a unique backup identifier, this method allows users to effectively manage their backup resources, ensuring that outdated or unnecessary backups are removed to free up storage space or maintain data compliance. This function is crucial for maintaining the efficiency and organization of data management practices within a system.", "fields": { "backup_id": { "name": "Backup Id", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_traffic_metrics": { "description": "The `get_app_traffic_metrics` API method provides detailed analytics related to the traffic of a specific application. Upon invocation with an application's unique identifier, this method returns a comprehensive set of data including the total number of visits, breakdown of visits by country, analysis of visits per device type, and other relevant metrics. This information is crucial for understanding user engagement, optimizing app performance, and tailoring marketing strategies to enhance user interaction and retention.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_traffic_overview": { "description": "The `get_app_traffic_overview` API method provides a comprehensive summary of user traffic statistics for a specific application. This method delivers key analytics data including the total number of visits, distribution of visits by country, and breakdown of visits by device type, among other metrics. These insights are crucial for understanding user engagement and behavior patterns, enabling developers and marketers to tailor their strategies effectively to enhance user experience and app performance.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_firewall": { "description": "The `get_app_firewall` API method retrieves firewall configuration details for a specific application, identified by its app_id. This method provides information on the firewall settings that help protect the application by controlling traffic based on predefined security rules. The returned data typically includes rules for inbound and outbound traffic, statuses of these rules, and any specific settings tailored to enhance the application's security environment. This function is essential for administrators looking to maintain or audit the security parameters that safeguard their applications.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "configure_app_firewall": { "description": "The `configure_app_firewall` API method is designed to set up and modify firewall settings for a specific application identified by its app_id. This method manages the security rules that control incoming and outgoing network traffic to the application, ensuring that only authorized access is allowed. By configuring the application's firewall, you can effectively safeguard the app against unauthorized access and potential security threats, enhancing the overall security posture of the application infrastructure.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "run_programs_checker": { "description": "The `run_programs_checker` API method is designed to perform a comprehensive check on an application within the Xuda Studio environment. This method evaluates the application's configuration, dependencies, and overall integrity to ensure it operates correctly within the platform. By invoking this method, developers can identify potential issues, inconsistencies, or errors that might affect the app's performance or stability. This proactive checking mechanism is essential for maintaining high-quality applications and ensuring seamless user experiences.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "clear_program_checks": { "description": "The `clear_program_checks` API method is designed to reset and clear all the diagnostic check results from Xuda Studio for a specified application. This operation effectively removes any stored outcomes of previous validations or error checks performed by Xuda Studio, allowing for a fresh start in monitoring and troubleshooting the application. This is particularly useful when updates or significant changes have been made to the application, necessitating a new round of checks without the clutter of old results.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_studio_docs_by_type": { "description": "The `get_studio_docs_by_type` API method retrieves various types of documents defined within the Xuda Studio for a specific application. This method focuses on extracting an assortment of document types such as tables, programs, setups, and other related content that are integral to the application's configuration and operational setup. By specifying the application identifier, the API fetches and returns these documents, enabling developers or administrators to manage and review the structured data and scripts that drive the application's functionality and user interactions.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "type": { "name": "Type", "description": "", "type": "string", "mandatory": true }, "build": { "name": "Build", "description": "", "type": "number" }, "stat": { "name": "Status", "description": "", "type": "number" } }, "category": "app_module" }, "get_app_tables": { "description": "The `get_app_tables` API method retrieves a list of all the data tables defined within an application on the Xuda platform. This method is called using the application's unique identifier and returns a structured overview of the tables configured in the Xuda Studio for that specific application. This information is crucial for developers and administrators to understand the data schema and organization within their application, facilitating better data management and integration processes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "test_email": { "category": "email_module" } } } export const public_prod_conf={ "name": "Xuda", "domain": "xuda.io", "app_domain": "xuda.app", "logo_url": "https://xuda.io/dist/images/xuda_logo.png", "logo_ico_url": "https://xuda.io/dist/images/xuda_ico.png", "allowedExts_drive": [ ".gif", ".jpeg", ".jpg", ".png", ".xls", ".xlsx", ".xslx", ".doc", ".docx", ".tiff", ".mp3", ".mp4", ".pdf", ".css", ".js", ".html", ".svg", ".webp", ".json", ".plist", ".ttf", ".woff", ".otf", ".woff2", ".css", ".js", ".txt", ".wav" ], "archive_drive_ext": [ ".tar", ".gz", ".tar.gz", ".tgz", ".bz2", ".tar.bz2", ".xz", ".tar.xz", ".zip", ".rar", ".7z", ".Z", ".tar.Z", ".cpio", ".lzh", ".lha", ".ar", ".lzma", ".rpm", ".deb", ".jar", ".war", ".ear" ], "stripe_public_key": "pk_live_51LInyXAIodQfcUQng2hr5dxGXPJHQoKpxYleAbUx2XvHjjZfXO3rJRjCIsQA7mXhtBOa33H26GitMhgxNaLZORof00ZAuFY35P", "firebaseConfig": { "apiKey": "AIzaSyAG1feuoBLw8S07S9muVIryR-LPJQNUhAA", "authDomain": "xuda-io.firebaseapp.com", "projectId": "xuda-io", "storageBucket": "xuda-io.appspot.com", "messagingSenderId": "960548334805", "appId": "1:960548334805:web:005cba364f14bea105c65c", "measurementId": "G-02ESDQLBVZ" }, "support_ticket_topics": { "Studio": { "Platform Selection": [ "Evaluation Criteria", "Industry-Specific Solutions", "Pricing and Licensing" ], "User Interface Design": [ "Drag-and-Drop Builders", "Templates and Themes", "Responsive Design" ], "Data Integration and Management": [ "Connecting to Databases", "Importing/Exporting Data", "Data Mapping and Transformation" ], "Workflow Automation": [ "Visual Workflow Builders", "Trigger-based Actions", "Scheduling and Timing" ], "Business Logic Implementation": [ "Rule Engines", "Conditional Actions", "Validation and Error Handling" ], "API Integration": [ "Pre-built Connectors", "Custom API Connections", "Webhooks" ], "Collaboration and Teamwork": [ "Multi-User Collaboration", "Version Control", "Comments and Annotations" ], "Security and Compliance": [ "Role-Based Access Control", "Data Encryption", "Compliance Standards (e.g., GDPR)" ], "Testing and Debugging": [ "Preview Modes", "Simulation and Testing", "Logging and Monitoring" ], "Deployment and Hosting": [ "One-Click Deployment", "Cloud Hosting", "Domain Configuration" ], "Monitoring and Analytics": [ "Performance Monitoring", "User Analytics", "Real-Time Dashboards" ], "Scalability and Performance": [ "Load Testing", "Auto-Scaling", "Optimization Tools" ], "Mobile App Development": [ "Mobile App Builders", "Cross-Platform Support", "App Store Submission" ], "Customer Support and Community": [ "Help Documentation", "Community Forums", "Live Chat and Support" ], "Training and Education": [ "Video Tutorials", "Guided Walkthroughs", "Certification Programs" ], "Extensions and Plugins": [ "Third-Party Integrations", "Custom Extensions", "Marketplace and App Store" ], "Localization and Globalization": [ "Multilingual Support", "Currency and Date Formatting", "Regional Compliance" ], "Accessibility": [ "Accessibility Standards", "Assistive Technologies", "Inclusive Design Practices" ], "Feedback and Continuous Improvement": [ "User Feedback Collection", "Iterative Development", "A/B Testing" ] }, "Billing": { "Invoicing": [ "Generating invoices", "Sending and receiving invoices", "Electronic invoicing" ], "Payment Methods": [ "Credit/Debit cards", "Bank transfers", "PayPal or other online payment systems", "Cash payments" ], "Late Payments and Fees": [ "Late payment penalties", "Interest charges", "Collection processes" ], "Discounts and Adjustments": [ "Early payment discounts", "Volume or loyalty discounts", "Refunds and credit adjustments" ], "Taxes and Tariffs": [ "Sales tax", "Import/export duties", "VAT/GST" ], "Subscriptions and Recurring Billing": [ "Monthly subscriptions", "Annual subscriptions", "Auto-renewals and cancellations" ], "Billing Cycles and Scheduling": [ "Monthly, quarterly, or annual billing", "Pro-rated billing" ], "Billing Disputes and Resolution": [ "Process for challenging charges", "Customer support for billing inquiries" ], "Compliance and Regulations": [ "Privacy and data security", "Industry-specific regulations (e.g., healthcare or finance)" ], "Accounting and Reporting": [ "Revenue recognition", "Financial statements and reporting", "Audit trails" ], "Usage-Based Billing": [ "Pay-as-you-go services", "Tiered pricing models" ], "International and Multi-Currency Billing": [ "Currency conversion", "Cross-border transaction fees" ] }, "Deploy": { "Deployment Environments": [ "Development", "Staging", "Production" ], "Continuous Integration Continuous Deployment": [ "Build Automation", "Testing Automation", "Deployment Automation" ], "Version Control": [ "Git Workflow", "Branching Strategies", "Release Management" ], "Containerization and Orchestration": [ "Docker", "Kubernetes", "Swarm" ], "Configuration Management": [ "Ansible", "Puppet", "Chef" ], "Monitoring and Logging": [ "Performance Monitoring", "Error Logging", "Uptime Monitoring" ], "Rollback Strategies": [ "Version Rollback", "Database Migrations Rollback" ], "Scaling Strategies": [ "Horizontal Scaling", "Vertical Scaling" ], "Security Considerations": [ "Access Control", "Secure Connections (SSL/TLS)", "Secret Management" ], "Cloud Deployment": [ "AWS", "Azure", "Google Cloud" ], "Server Provisioning": [ "Virtual Machines", "Bare Metal Servers", "Serverless Architectures" ], "Networking and Load Balancing": [ "Load Balancers", "DNS Configuration", "Traffic Routing" ], "Database Deployment": [ "Database Migrations", "Replication and Sharding", "Backup Strategies" ], "Disaster Recovery Planning": [ "Backup and Restore Strategies", "Failover Clustering" ], "Compliance and Regulations": [ "GDPR Compliance", "HIPAA Compliance", "Regulatory Audits" ], "User Acceptance Testing": [ "Staging Environment Testing", "Production Environment Testing" ], "Documentation and Knowledge Transfer": [ "Deployment Guides", "Handoff Documentation", "Training and Onboarding" ], "Mobile App Deployment": [ "App Store Deployment", "Beta Testing Distribution", "Cross-Platform Deployment" ] }, "Runtime": { "Execution Environments": [ "Virtual Machines", "Containers", "Cloud Environments" ], "Performance Monitoring and Optimization": [ "Profiling", "Resource Usage (CPU, Memory, etc.)", "Latency and Response Time" ], "Concurrency and Parallelism": [ "Threading", "Synchronization and Locking", "Asynchronous Programming" ], "Error Handling and Debugging": [ "Exception Handling", "Logging and Traceability", "Debugging Tools and Techniques" ], "Security and Access Control": [ "Authentication and Authorization", "Runtime Code Analysis", "Secure Communication (TLS, SSL)" ], "Scalability and Load Balancing": [ "Horizontal and Vertical Scaling", "Load Balancers", "Caching Strategies" ], "Dependency Management": [ "Library and Package Management", "Version Control", "Dynamic vs. Static Linking" ], "Interoperability and Integration": [ "API Communication (REST, GraphQL, etc.)", "Data Serialization (JSON, XML, etc.)", "Middleware and Connectors" ], "Memory Management": [ "Garbage Collection", "Memory Leaks Detection", "Allocation and De-allocation" ], "Data Persistence and Management": [ "Database Connections and Transactions", "Data Replication and Sharding", "Object-Relational Mapping (ORM)" ], "Networking and Communication": [ "Protocols (HTTP, TCP, UDP)", "WebSockets and Real-time Communication", "Networking Libraries and Frameworks" ], "Localization and Globalization": [ "Multi-language Support", "Time Zones and Culture-Specific Formatting" ], "Compliance and Regulations": [ "License Compliance", "Privacy Regulations (GDPR, CCPA, etc.)" ], "Testing at Runtime": [ "Integration Testing", "End-to-End Testing", "Monitoring Test Environments" ], "User Interface and Experience": [ "Responsiveness", "UI Component Rendering", "Accessibility at Runtime" ], "Disaster Recovery and Redundancy": [ "Failover Strategies", "Backup Solutions", "High Availability Configuration" ] }, "Dashboard": { "Design and Layout": [ "Responsive Design", "Widget Configuration", "Grid Layouts" ], "Data Visualization": [ "Charts and Graphs", "Heat Maps", "Geospatial Maps" ], "Real Time Data Monitoring": [ "Streaming Data", "Live Updates", "Event-Driven Alerts" ], "Data Integration and ETL": [ "APIs", "Data Transformation", "Scheduled Data Retrieval" ], "User Interaction and Customization": [ "Filters and Dropdowns", "Drill-Down Analysis", "User-Defined Views" ], "Performance Monitoring and Analytics": [ "KPI Tracking", "Trend Analysis", "Predictive Analytics" ], "Security and Access Control": [ "Role-Based Access", "Data Encryption", "Authentication and Authorization" ], "Collaboration and Sharing": [ "Report Exporting (PDF, Excel, etc.)", "Collaborative Annotations", "Shared Dashboards" ], "Mobile and Cross Platform Support": [ "Mobile Optimization", "Cross-Browser Compatibility", "Native App Integration" ], "Compliance and Regulations": [ "GDPR Compliance", "Industry-Specific Standards", "Data Privacy Policies" ], "Accessibility and Usability": [ "Color Contrast and Readability", "Assistive Technologies", "Multilingual Support" ], "Disaster Recovery and Backup": [ "Redundancy", "Automatic Backups", "Failover Strategies" ], "Integration with Other Systems": [ "CRM Integration", "ERP Integration", "Third-Party Tools and Plugins" ], "Development Frameworks and Libraries": [ "React", "Angular", "D3.js" ], "Testing and Quality Assurance": [ "Automated Testing", "Performance Testing", "User Acceptance Testing" ], "Maintenance and Support": [ "Regular Updates", "Bug Fixes", "User Support and Documentation" ], "Feedback and Continuous Improvement": [ "User Feedback Collection", "Iterative Development", "Performance Benchmarking" ] }, "Marketplace": { "Vendor Management": [ "Onboarding and verification", "Commissions and fees", "Ratings and reviews" ], "Product Listings": [ "Creating and editing listings", "Product categorization", "Inventory management" ], "Buyer-Seller Interaction": [ "Messaging and communication", "Dispute resolution", "Feedback mechanisms" ], "Payment Processing": [ "Payment gateways", "Fraud prevention", "Refunds and returns" ], "Shipping and Delivery": [ "Shipping options and tracking", "Handling international orders", "Delivery fulfillment" ], "Marketing and Promotions": [ "Advertising opportunities", "Discounts and coupons", "Affiliate programs" ], "Customer Support": [ "Help centers and FAQs", "Contact channels", "Issue resolution" ], "Legal and Compliance": [ "Terms of service", "Privacy policies", "Regulatory adherence" ], "Analytics and Reporting": [ "Sales and performance analytics", "Buyer and seller insights", "Financial reporting" ], "User Experience and Design": [ "Website or app usability", "Accessibility", "Personalization" ], "Community Engagement": [ "Community forums", "Social media integration", "Events and meetups" ], "Technology and Integration": [ "API integration", "Mobile optimization", "Security measures" ], "Internationalization and Localization": [ "Language translation", "Currency conversion", "Localized marketing" ], "Sustainability and Ethics": [ "Sustainable practices", "Ethical sourcing", "Social responsibility" ] }, "Support": { "Customer Service and Interaction": [ "Handling customer inquiries, complaints, and submit_feedback", "Managing customer expectations and satisfaction", "Communicating product information and updates" ], "Technical Support and Troubleshooting": [ "Resolving software and hardware issues", "Providing technical assistance and guidance", "Troubleshooting network and connectivity problems" ], "Account Management and Billing": [ "Assisting with account creation, updates, and recovery", "Handling billing issues, payment inquiries, and refunds" ], "Product Knowledge and Education": [ "Offering detailed information about products and services", "Providing user guides, tutorials, and how-to content", "Educating customers on new features and best practices" ], "Escalation and Problem Resolution": [ "Managing and tracking escalated issues", "Coordinating with other departments for resolution", "Following up to ensure customer satisfaction" ], "Warranty and Returns": [ "Handling warranty claims and return authorizations", "Providing information on policies and procedures" ], "Security and Privacy Support": [ "Assisting with security-related concerns", "Guiding on privacy settings and data protection measures" ], "Disaster Recovery and Emergency Support": [ "Coordinating response during critical incidents", "Assisting customers during outages and service interruptions" ], "Community and Social Media Engagement": [ "Responding to social media inquiries and comments", "Moderating community forums and discussion boards" ], "Accessibility and Special Needs Assistance": [ "Ensuring accessibility of products and services", "Addressing specific needs and requirements of diverse customers" ], "Legal and Compliance Assistance": [ "Guiding on legal inquiries and regulatory compliance", "Coordinating with legal teams when necessary" ], "Collaboration and Cross Functional Communication": [ "Collaborating with sales, marketing, development, and other teams", "Facilitating smooth communication across the organization" ], "Continuous Improvement and Quality Assurance": [ "Gathering and analyzing customer submit_feedback for improvements", "Implementing quality standards and procedures" ], "Training and Development": [ "Onboarding new team members", "Continuing education and professional development for the team" ], "International and Multilingual Support": [ "Offering support across different regions and languages", "Adhering to cultural norms and considerations" ] }, "Account": { "Account Creation and Registration": [ "Usernames and passwords", "Verification processes", "Profile setup" ], "Account Management": [ "Profile updates", "Security settings", "Account linking" ], "Authentication and Authorization": [ "Multi-factor authentication", "Permission levels", "Single sign-on (SSO)" ], "Account Security": [ "Password policies", "Security questions", "Account recovery" ], "Account Notifications": [ "Email notifications", "SMS alerts", "Push notifications" ], "Account Privacy": [ "Privacy settings", "Data sharing preferences", "GDPR compliance" ], "Billing and Subscriptions": [ "Payment methods", "Subscription management", "Invoices and billing history" ], "Account Support": [ "Customer service", "FAQ and help centers", "Technical support" ], "Account Reporting and Analytics": [ "Usage statistics", "Performance monitoring", "Reporting tools" ], "Account Termination and Suspension": [ "Deactivation processes", "Account deletion", "Suspension policies" ], "Social and Collaboration Features": [ "Friend or connection management", "Sharing settings", "Collaboration tools" ], "Integrations and API Access": [ "Third-party integrations", "API keys and management", "Webhooks" ], "Legal and Compliance": [ "Terms of service", "Acceptable use policies", "Regulatory compliance" ] }, "Vps": { "VPS Hosting Providers": [ "Comparing Hosting Providers", "Provider-Specific Features and Offerings", "Pricing and Billing Models" ], "Server Configuration and Management": [ "Operating System Installation", "Control Panels (cPanel, Plesk, etc.)", "Command Line Interface (CLI) Management" ], "Performance and Resources": [ "CPU and RAM Allocation", "Disk Space and I/O Performance", "Network Bandwidth and Throughput" ], "Security and Compliance": [ "Firewalls and Intrusion Detection Systems (IDS)", "SSL/TLS Certificates", "Regular Security Audits and Updates" ], "Scalability and Upgrades": [ "Vertical and Horizontal Scaling", "Upgrading Plans and Resources", "Migrating Between VPS Providers" ], "Backup and Disaster Recovery": [ "Regular Data Backups", "Automated Backup Solutions", "Disaster Recovery Plans" ], "Monitoring and Analytics": [ "Resource Monitoring (CPU, Memory, Disk Usage)", "Traffic Analysis and Reporting", "Alerts and Notifications" ], "Virtualization Technologies": [ "KVM, Xen, OpenVZ, etc.", "Containerization (Docker)", "Virtual Machine Management Tools" ], "Software and Application Installation": [ "Web Server Setup (Apache, Nginx, etc.)", "Database Server Setup (MySQL, PostgreSQL, etc.)", "Content Management Systems (WordPress, Joomla, etc.)" ], "Networking and IP Management": [ "IP Address Allocation", "DNS Management", "VPN and Private Networking" ], "Customer Support and Service Level Agreements": [ "Technical Support Options", "SLAs and Uptime Guarantees", "Customer Reviews and Feedback" ], "Development and Staging Environments": [ "Setting Up Development Environments", "Staging and Testing Configurations", "Continuous Integration and Deployment (CI/CD)" ], "E commerce and Online Business Solutions": [ "Shopping Cart Software", "Payment Gateway Integration", "Security Compliance (PCI DSS)" ], "Email Hosting and Management": [ "Email Server Setup (SMTP, IMAP, POP3)", "Spam Filtering", "Email Clients and Webmail Access" ], "Content Delivery Network Integration": [ "CDN Providers and Setup", "Accelerating Content Delivery", "Geo-Location Strategies" ], "Legal and Regulatory Considerations": [ "Terms of Service (ToS)", "Privacy Policies", "Compliance with Local Regulations" ] }, "Inquiries": { "Product Information": [ "Studio", "Runtime", "Dashboard", "Deploy", "Marketplace" ], "Pricing and Quotes": [ "Developer Plan", "Support Plan", "Hosting Plan", "Storage Plan" ], "Partnerships and Collaborations": [ "Reseller Programs", "Partnership Opportunities", "B2B and Enterprise Sales" ], "Demos and Trials": [ "Schedule Demo" ], "Feedback and Suggestions": [ "General Inquiry" ], "Contact Sales": [ "General Inquiry" ] } }, "notification_categories": { "account": { "icon_ph": "ph:user-duotone", "icon": "", "topics": { "account_verification": { "subject": "Account verification", "delivery_method": [ "email" ], "locked": true, "body": "
Account Verification
/dashboard/verify?id=<%= ref %>\">Click here to verify your account" }, "reset_password": { "subject": "Reset your password", "delivery_method": [ "email" ], "locked": true, "body": "
Account
//dashboard/change?id=<%= temp_pass %>\">Click here to change your password" }, "password_changed": { "subject": "Password changed", "delivery_method": [ "email" ], "locked": true, "body": "
Account
"
},
"account_billing_hold_applied": {
"subject": "Suspension risk",
"delivery_method": [
"email"
],
"locked": true,
"body": "Account at risk of SuspensionDue to a payment failure, your account was placed on a billing hold, which may restrict your ability to manage resources on our platform. To keep your account active, you need to log in to your /dashboard/settings/billing\">Billing Settings page and manually make a payment or add a valid credit card to your Xuda account. If we do not receive a payment from you soon, our system will automatically suspend your account. This will lead to termination of your service and deletion of associated data. We appreciate your business and are here to assist if you have any questions or need any help.",
"display_type": "warning"
},
"account_suspension_applied": {
"subject": "Termination risk",
"delivery_method": [
"email"
],
"locked": true,
"body": "Account at risk of TerminationBecause of a unresolved payment failure, your account is now suspended, which restrict your ability to work on our platform. To keep your account active, you need to log in to your /dashboard/settings/billing\">Billing Settings page and manually make a payment or add a valid credit card to your Xuda account. If we do not receive a payment from you soon, our system will automatically terminate your account. This will lead to deletion of associated data and turn all projects to public with no further notice. We appreciate your business and are here to assist if you have any questions or need any help.",
"display_type": "error"
},
"account_termination_applied": {
"subject": "Account termination notice",
"delivery_method": [
"email"
],
"locked": true,
"body": "Private projects are now public and resources are at risk of use by others Due to unresolved payment, your account is now terminated, which restrict your ability to work on our platform. All Instances, apps and associate data has been deleted permanently. /terms\">learn more. We are here to assist if you have any questions or need any help.",
"display_type": "error"
},
"account_plan_changed": {
"subject": "Account plan change",
"delivery_method": [
"email"
],
"locked": true,
"body": "Plan has been successfully changed to <%= new_plan %>
/pricing\">Learn more regarding the new plan options.",
"display_type": "info"
},
"account_plan_changed_to_free": {
"subject": "Plan has been downgraded",
"delivery_method": [
"email"
],
"locked": true,
"body": "Account's projects at risk to be publicDue to a downgrading plan to Free plan in your account, your projects are no longer private. We appreciate your business and are here to assist if you have any questions or need any help.",
"display_type": "info"
}
}
},
"team": {
"icon_ph": "ph:users-three-duotone",
"icon": "",
"topics": {
"access_invitation_tbd": {
"subject": "Access invitation",
"delivery_method": [
"email"
],
"locked": true,
"body": "Access invitation
<%= subject %>
By <%= email %> To join this Project, all you need to do is create a username and password or login with your existing Xuda user credentials.
/dashboard/project/<%= app_id %>\">Click here to view" }, "access_invitation_user_not_exist": { "subject": "Invitation for Access", "delivery_method": [ "email" ], "locked": true, "body": "Invitation for Access
<%= subject %>
Sent from <%= email %>. To join this Project, simply use your email along with the temporary password <%= password %> that we have generated for you, or alternatively, you can log in using your Google or Github account.
/dashboard/login\">Click here to proceed" }, "contact_invitation_user_not_exist": { "subject": "<%= subject %>", "delivery_method": [ "email" ], "locked": true, "body": "<%= subject %>
Sent from <%= email %>. To join this Project, simply use your email along with the temporary password <%= password %> that we have generated for you, or alternatively, you can log in using your Google or Github account.
/dashboard/login\">Click here to proceed" }, "access_invitation_user_exist": { "subject": "Invitation for Access", "delivery_method": [ "email" ], "locked": true, "body": "Invitation for Access
<%= subject %>
By <%= email %> To join <%= first_name %>'s connections, simply head over to your dashboard and accept the invitation.
/dashboard\">Click here to view" }, "contact_invitation_user_exist": { "subject": "<%= subject %>", "delivery_method": [ "email" ], "locked": true, "body": "<%= subject %>
By <%= email %> To join <%= first_name %>'s connections, simply head over to your dashboard and accept the invitation.
/dashboard/\">Click here to view" }, "access_invitation_confirmed": { "subject": "Access invitation confirmed", "delivery_method": [ "email" ], "locked": false, "display_type": "info", "body": "Invitation Accepted
The user <%= email %> has accepted the invitation to join <%= desc %>.
" }, "access_invitation_declined": { "subject": "Access invitation declined", "delivery_method": [ "email" ], "locked": false, "display_type": "info", "body": "Invitation Declined
The user <%= email %> has declined the invitation to join <%= desc %>.
" }, "access_invitation_cancelled": { "subject": "Access invitation cancelled", "delivery_method": [ "email" ], "locked": false, "display_type": "info", "body": "Invitation Cancelled
The user <%= email %> has cancelled the invitation to join <%= desc %>.
" }, "access_deleted": { "subject": "Access deleted", "delivery_method": [ "email" ], "locked": false, "display_type": "info", "body": "Access Deleted
The user <%= email %> has deleted <%= desc %>.
" }, "member_left_the_team": { "subject": "Member left team", "delivery_method": [ "email" ], "locked": false, "display_type": "info", "body": "Member left team
The user <%= email %> has left team <%= desc %>.
" }, "connection_disconnected_by_member": { "subject": "Connection Disconnected by Member", "delivery_method": [ "email" ], "locked": false, "display_type": "info", "body": "Connection Disconnected by Member
User <%= email %> has terminated their connection with you.
" } } }, "billing": { "icon_ph": "ph:credit-card-duotone", "icon": "", "topics": {} }, "app": { "icon_ph": "ph:app-store-logo-duotone", "icon": "", "topics": { "transfer_ownership_request": { "subject": "Transfer ownership request", "delivery_method": [ "email" ], "locked": true, "body": "Transfer
<%= subject %>
<%= msg %>
" }, "app_turned_on": { "subject": "App turned on", "delivery_method": [ "push" ], "display_type": "info", "body": "App <%= app_obj.app_name %>
Turned on
" }, "app_turned_off": { "subject": "App turned off", "delivery_method": [ "push" ], "display_type": "warning", "body": "
App <%= app_obj.app_name %>
Turned off
" }, "new_version_available": { "subject": "New version available", "delivery_method": [ "alert" ], "display_type": "info", "body": "Build number <%= build %> is now ready. Please go to the Advanced tab and select the Update Version option." }, "delete_validation_code": { "subject": "Confirmation Code for Deleting <%= app_name %>", "delivery_method": [ "email" ], "body": "
Confirmation Code
To confirm the deletion of the app #<%= app_id %>, please enter the following code for verification: <%= validation_code %>.", "display_type": "info" } } }, "system": { "icon_ph": "ph:cloud-duotone", "icon": "", "topics": { "security_event": { "subject": "Security event", "delivery_method": [], "body": "A security event occurred that could require your attention:<%= details %>", "display_type": "warning" } } }, "deploy": { "icon_ph": "ph:rocket-duotone", "icon": "", "topics": { "welcome_aboard_vps": { "subject": "Welcome Aboard! Your New VPS is Ready", "delivery_method": [ "email" ], "body": " \\n
![](\"https://xuda.io/dist/images/icons/clapping.png\"){kind=icon}
\\n VPS Ready
\\nHey <%= name %>,
\\nWe are thrilled to welcome you to our hosting family! Your Virtual Private Server (VPS) is now fully operational and ready to power your digital ventures. Below, you'll find essential details to help you get started with your new VPS.
\\n \\nVPS Access Information:
\\n- \\n
- IP Address: <%= ip %> \\n
- Username: root \\n
- Password: N/A (We strongly recommend to login with SSH key see Getting Started below) \\n
- Control Panel URL: \" target=\"_blank\"><%= dashboard_url %> \\n
Getting Started:
\\n- \\n
- Secure Your VPS: Begin by loading your ssh key to your user area in the dashboard \" target=\"_blank\"><%= dashboard_ssh_url %>. \\n
- Apply SSH key to your VPS: Navigate to your VPS Advanced tab and Assign your ssh key to your VPS \" target=\"_blank\"><%= dashboard_ssh_assign_url %>. \\n
- Set Up Your Environment: Install any necessary software to turn your VPS into a web server, database server, or anything else your project needs. \\n
- Deploy Your Projects: Transfer your websites, applications, or services to your VPS. Utilize SFTP or your control panel for secure file transfer. \\n
Support & Resources:
\\n- \\n
- Knowledge Base: Explore our Knowledge Base for tutorials, guides, and tips on managing your VPS. \\n
- Support Team: Should you have any questions or require assistance, our support team is always here for you. Contact us via Support Portal. \\n
Feedback: Your feedback is invaluable to us. Let us know what we can do to enhance your hosting experience.
\\n\\nWe're excited to see what you'll build on your new VPS. Thank you for choosing us as your hosting provider!
\\n\\nBest Regards,
\\nXuda Support Team
\\n \\n ",
"display_type": "info"
}
}
},
"support": {
"icon_ph": "ph:lifebuoy-duotone",
"icon": "",
"topics": {
"support_ticket_request": {
"subject": "Support ticket #<%= id %>",
"delivery_method": [
"email"
],
"body": "
<%= first_name %> <%= last_name %>
<%= email %>
Phone: <%= phone %>
User Plan: <%= developer_plan %>
User Support Plan: <%= support_plan %>
Communication Type: <%= communication_type %>
Support Topic: <%= ticket_topic %>
Support Sub Topic: <%= ticket_sub_topic %>
Tertiary Subtopic: <%= tertiary_sub_topic %>}
Support Subject: <%= subject %>
Support Description: <%= description %>
Agent code:<%= agent_code %>
User code: <%= user_code %>
Thank You for Submitting Your Support Ticket
Dear <%= first_name %> ,
Thank you for reaching out to <%= _conf_name %> support and submitting your ticket. We've successfully received your inquiry regarding <%= ticket_topic %>.
Our support team will review the details you've provided, and we aim to respond within <%= response_time %>.
Your ticket reference number is <%= user_code %>. In the meantime, you can view the status of your ticket or add any additional information at this link: \">Your Support Ticket.
We appreciate your trust in <%= _conf_name %> and thank you for giving us the opportunity to assist you. Best regards,<%= _conf_name %> support team ", "display_type": "info" } } }, "inquiries": { "icon_ph": "ph:ticket-duotone", "icon": "", "topics": { "inquiry_ticket_request": { "subject": "Support ticket #<%= id %>", "delivery_method": [ "email" ], "body": "
<%= first_name %> <%= last_name %>
<%= email %>
Phone: <%= phone %>
User Plan: <%= developer_plan %>
User Support Plan: <%= support_plan %>
Communication Type: <%= communication_type %>
Support Topic: <%= ticket_topic %>
Support Sub Topic: <%= ticket_sub_topic %>
Tertiary Subtopic: <%= tertiary_sub_topic %>}
Support Subject: <%= subject %>
Support Description: <%= description %>
Agent code:<%= agent_code %>
User code: <%= user_code %>
Inquiry Submission Acknowledged
Dear <%= first_name %>,
We are grateful to you for reaching out to the <%= _conf_name %> team with your inquiry. Rest assured, we have successfully received your request regarding <%= ticket_topic %>.
Our dedicated team is currently reviewing the information you provided, and we are committed to responding promptly.
Your unique inquiry reference number is <%= user_code %>. If you have an account with us, you can track the progress of your inquiry or add further details using the following link: \">Track Your Inquiry Ticket.
Thank you for placing your trust in <%= _conf_name %>. We are honored to serve you and look forward to assisting you. Warm regards, <%= _conf_name %> Team", "display_type": "info" } } }, "news": { "icon_ph": "ph:newspaper-duotone", "icon": "", "topics": {} } }, "cpi_methods": { "get_xuda_servers_info": { "category": "misc_module" }, "get_utc_ts": { "category": "misc_module" }, "test_jobs": { "category": "jobs_module" }, "get_app_info": { "description": "The get_app_info API method retrieves comprehensive information about a specific application based on the provided application ID. This API method is typically used for administrative and management purposes within a platform, providing a central view of application configuration, status, and operational metrics to support maintenance, updates, and compliance checks.", "fields": { "app_id": { "name": "App Id", "description": "This unique identifier specifies the application whose data will be retrieved.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_security_logs": { "description": "The get_security_logs API method is designed to retrieve security-related log entries for a specific application based on its unique identifier (app_id). This API is crucial for monitoring and auditing purposes, allowing administrators to track user activities, identify potential security incidents, and ensure compliance with security policies. It helps in understanding how users interact with the application and can aid in troubleshooting issues or assessing security measures.", "fields": { "app_id": { "name": "App Id", "description": "This unique identifier specifies the application whose data will be retrieved.", "type": "string", "mandatory": true } }, "category": "logs_module" }, "delete_user_logs": { "description": "The 'delete_user_logs' API method is designed to remove all logs associated with a user. This operation effectively clears the historical log data, potentially freeing up space and ensuring privacy or compliance with data retention policies. This method can be crucial for maintaining a clean and efficient logging system, especially in environments where log data accumulates quickly and needs regular purging to manage storage and maintain system performance.", "category": "logs_module" }, "delete_app_logs": { "description": "The 'delete_app_logs' API method is designed to remove all log data associated with a specific application. Upon invocation with the correct app_id, this method deletes the entire log history for that application, effectively clearing any recorded log data. This operation is useful for maintaining privacy, managing storage, or resetting log data to a clean state for troubleshooting purposes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "logs_module" }, "get_account_projects": { "description": "The 'get_account_projects' API method retrieves all projects associated with a specific account. This method outputs a list of project details, encapsulating each project's unique identifiers, names, types, status, creation dates, and other relevant metadata. This function is particularly useful for displaying a comprehensive overview of all projects tied to an account, aiding in account management and project oversight.", "category": "account_module" }, "get_account_datacenters": { "description": "The 'get_account_datacenters' API method is designed to retrieve a comprehensive list of all datacenters associated with a specific account. When invoked, it outputs a detailed JSON object containing information about each datacenter linked to the account. This information typically includes attributes such as the datacenter ID, name, location, configuration details, status, and any other relevant metadata that describes the datacenter's capabilities, resources, and operational state. This API method is useful for account management purposes, enabling administrators to overview and manage the datacenters that are provisioned under their account.", "category": "account_module" }, "get_account_deployments": { "description": "The 'get_account_deployments' API method retrieves a comprehensive list of all deployments associated with a specific account. This method does not require any parameters specific to individual deployments but operates at the account level to gather and return data on all deployment activities. The output includes details such as deployment identifiers, statuses, timestamps, configurations, and other relevant metadata that provide a full overview of the deployment history and current state within the account. This API is typically used for monitoring, managing, and auditing deployment activities across an account’s infrastructure.", "category": "account_module" }, "get_account_instances": { "category": "account_module" }, "create_project": { "description": "The 'create_project' API method on the Xuda platform is designed to initialize and register a new project within the system. When invoked, this method requires certain parameters in the 'data' object such as the project name, description, and possibly other settings like visibility (public or private) and initial configurations specific to the project's needs. Upon successful execution, the method creates a new project entry in the platform's database, allocates resources as specified, and returns details about the newly created project, such as the project ID, creation date, and initial settings. This API is crucial for users and developers who need to dynamically manage multiple projects, allowing them to automate project setup and configuration through programmable interfaces.", "fields": { "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_project_instances": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_backups": { "description": "The 'get_app_backups' API method is designed to retrieve a list of backups for a specific application. It requires an app_id as a parameter, which is the unique identifier for the application. Upon invocation, this method returns an array containing details of all the backups associated with the specified application. Each item in the array typically includes information such as the backup ID, creation date, size, and possibly other relevant metadata. This method is useful for managing and monitoring application backups, allowing users to view the history and status of their data backups directly through the API.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "get_table_counts": { "description": "The 'get_table_counts' API method is designed to retrieve the total number of records in a specific table within an application. It requires two parameters: app_id, which is the unique identifier for the application, and table_id, which identifies the specific table within that application. When called, this method returns the count of records present in the specified table, providing a quick overview of the data volume managed within that part of the application. This functionality is useful for monitoring and managing data storage, as well as for performing analytics or audits on the data usage within the application.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be query, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true } }, "category": "data_module" }, "dbs_create": { "description": "The 'dbs_create' API method is designed to create a new record in a specified table within a database. It requires an application identifier (app_id) and a table identifier (table_id) to locate the appropriate table. Additionally, it accepts table_data, which consists of key-value pairs representing the data fields and their values to be stored in the record. This method facilitates the insertion of data into the database dynamically, allowing for the expansion and management of database content programmatically.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be updated, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "table_data": { "name": "Table Data", "description": "Key-value pairs, such as {'user_name': 'John', 'last_name': 'Smith'}", "type": "object", "mandatory": true } }, "category": "data_module" }, "dbs_read": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be query, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true } }, "category": "data_module" }, "dbs_update": { "description": "The 'dbs_update' API method is used to modify an existing row in a specific table within a database. By specifying the application ID, table ID, and row ID, this method facilitates the update of row data with new key-value pairs. This functionality is essential for maintaining and adjusting database records dynamically, allowing applications to ensure their data remains accurate and up-to-date as operations evolve. This method effectively modifies only the specified row's data in the identified table, making it a targeted and efficient way to manage database contents.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be updated, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "row_id": { "name": "Row Id", "description": "The row ID uniquely identifies the document to be updated.", "type": "string", "mandatory": true }, "table_data": { "name": "Table Data", "description": "Key-value pairs, such as {'user_name': 'John', 'last_name': 'Smith'}, will replace the current data in the document.", "type": "object", "mandatory": true } }, "category": "data_module" }, "dbs_delete": { "description": "The 'dbs_delete' API method is designed for deleting specific documents from a database table within an application. This method processes a deletion request by targeting documents identified by their IDs within a specified table of a given application. It supports both soft and permanent deletions, the latter being irreversible. This functionality is crucial for managing data retention and compliance with data handling policies, allowing for precise control over the removal of records from the system's storage.", "fields": { "app_id": { "name": "App Id", "description": "", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be updated, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "ids": { "name": "Id's", "description": "Array of document IDs marked for deletion", "type": "array", "mandatory": true }, "permanent": { "name": "Permanent", "description": "Irreversible deletion of the documents (restoration not possible).", "type": "boolean", "mandatory": false } }, "category": "data_module" }, "dbs_restore": { "description": "Reinstate a previously removed row in the designated database table, except under the following conditions: 1. the table has undergone a repair operation, 2. the row was eliminated using a permanent delete option, 3. an automatic purge process has been executed.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be restored, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true }, "ids": { "name": "Id's", "description": "Array of document ids to restore", "type": "array", "mandatory": true } }, "category": "data_module" }, "copy_table": { "category": "data_module" }, "get_plans": { "description": "The 'get_plans' API method retrieves detailed information about Xuda's various service plans, including tiers such as 'Free','Pro','Team', and 'Enterprise', among others. Each plan is presented with a comprehensive set of attributes such as ranking, ID, color code, name, price, and a detailed description of what the plan offers. Features of each plan cover aspects like the number of projects, team size, storage capabilities, and additional services such as studio access, support level, and deployment options. The output is structured to provide insights into what each plan includes, helping users to understand and select the most suitable subscription based on their needs. This method is useful for presenting users with options to upgrade or modify their current service packages based on detailed plan features and pricing.", "category": "misc_module" }, "get_app_config": { "description": "The 'get_app_config' API method retrieves specific configuration properties for a given application. It returns a JSON object containing the application's icon properties, name, and branding properties. These elements include the application's visual identifiers such as logos and branding colors, the application's official name, and any additional branding-related settings that have been configured for the application. This method is useful for obtaining a snapshot of critical visual and identity aspects of an application, which can be particularly helpful for UI rendering or in situations where application branding needs to be displayed or verified.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "set_runtime_user_monitor": { "description": "The 'set_runtime_user_monitor' API method enables or disables the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment. By toggling this functionality, administrators can observe user interactions, provide remote assistance, and manage support more effectively within the application. This method adjusts the monitoring settings based on the provided application identifier and a boolean value indicating whether to enable or disable these features. The primary function is to enhance administrative oversight and support responsiveness in the application's operational context.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "enable": { "name": "Enable", "description": "", "type": "boolean", "mandatory": true } }, "category": "app_module" }, "save_deploy_settings": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "compact_database": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "clear_session_logs": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "session_module" }, "get_db_activity": { "description": "", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "set_runtime_utility_screen": { "description": "The 'set_runtime_utility_screen' API method enables or disables a utility screen during the runtime of an application based on the user's input. When activated, this utility screen offers several options to enhance user support and application management. These options include requesting remote control assistance, accessing support services, performing a hard reload of the application, and clearing the application's cache. This functionality is particularly useful for troubleshooting and ensuring the smooth operation of the application while it is running. The method primarily hinges on the application's unique identifier and a boolean parameter that dictates whether the utility screen should be enabled or disabled.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "enable": { "name": "Enable", "description": "", "type": "boolean", "mandatory": true } }, "category": "app_module" }, "get_platform_servers_info": { "description": "The 'get_platform_servers_info' API method from the Xuda platform provides a comprehensive overview of server infrastructure associated with the platform. It retrieves essential data about the platform's servers, including their unique identifiers, the countries in which they are located (countries), the current operational status of each server (server_status), and detailed information about the digital ocean data centers (do_datacenters) utilized by these servers. This method is crucial for managing and monitoring the geographical distribution and operational health of the platform's server resources.", "category": "misc_module" }, "get_price_obj": { "category": "misc_module" }, "get_account_info": { "category": "account_module" }, "build_app": { "category": "build_module" }, "destroy_app": { "category": "app_module" }, "leave_team": { "category": "team_module" }, "turn_app_off": { "description": "The 'turn_app_off' API method is designed to deactivate a specific application on the platform. By invoking this method with the appropriate application identifier, it effectively disables the application, making it non-operational until further action is taken to reactivate it. This functionality is essential for managing the lifecycle of applications, allowing administrators or users to control the availability of the application as needed for maintenance, updates, or other administrative reasons.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "turn_app_on": { "description": "The 'turn_app_on' API method is designed to activate a specific application on the platform by setting its operational status to active. This method essentially switches the selected application from an inactive or dormant state to a running state, allowing it to serve requests and perform its designated functions.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "app_visibility_on": { "description": "The 'app_visibility_on' API method is designed to change the visibility settings of a specific application on the Xuda platform by making it publicly accessible. When activated, this function lists the application in the Xuda marketplace, allowing other users to view and clone the project and its associated programs. Furthermore, the API facilitates the integration of the application into the AI training process by automatically sending data every time a program associated with the project is saved. This feature enhances the collaborative and developmental capabilities of the platform, promoting shared resources and continuous learning through AI training contributions.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "app_visibility_off": { "description": "The 'app_visibility_off' API method is designed to alter the visibility settings of an application by turning off its public access. This action effectively makes the application private, removing it from the Xuda marketplace. When invoked, this method updates the application's visibility status based on its unique identifier, ensuring that it is no longer accessible to the broader user base or visible in any public listing within the marketplace. This functionality is crucial for controlling who can access the application and maintaining privacy and exclusivity as needed.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module", "min_plan": "pro" }, "enable_auto_backup": { "description": "The 'enable_auto_backup' API method is designed to activate automatic backup functionality for a specified application. Upon invocation, it sets the system to automatically perform backups on a daily basis, using predefined default settings. This ensures that the application's data is regularly saved, minimizing data loss risks and providing a reliable way to restore information to a recent state if needed. This feature is particularly valuable for maintaining data integrity and operational continuity.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "disable_auto_backup": { "description": "The 'disable_auto_backup' API method is used to deactivate the automatic backup feature for a specified application. This operation ceases the scheduled daily backups, effectively stopping the automatic preservation of data at regular intervals. This method is useful for scenarios where automatic backups are no longer necessary or when manual backup processes are preferred.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "update_auto_backup_preferences": { "description": "The 'update_auto_backup_preferences' API method allows for the configuration of backup settings for a specified application. This method adjusts the backup preferences, such as specifying on which days backups should occur and setting the retention period for how long these backups are kept. This functionality is essential for tailoring backup operations to meet specific data management requirements and compliance standards, ensuring that backups are both efficient and aligned with organizational policies.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "backup.schedule": { "name": "Backup Schedule", "description": "", "type": "object", "mandatory": true }, "backup.retention": { "name": "Backup Retention", "description": "", "type": "object", "mandatory": true } }, "category": "backup_module" }, "restore_backup": { "category": "backup_module" }, "get_contacts": { "category": "account_module" }, "get_app_releases": { "description": "The `get_app_releases` API method is designed to retrieve detailed information about the various release versions of a specific application. This method provides comprehensive data on each release, including version numbers, release notes, and the dates on which these versions were made available. It is particularly useful for tracking the evolution of an app and managing version control, ensuring that stakeholders are informed about new updates and historical changes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "build_module" }, "get_release_note_info": { "category": "build_module" }, "add_conversion": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "data_module" }, "get_pending_conversions": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "data_module" }, "update_conversion_completion_status": { "category": "data_module" }, "install_instance_build": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "build_module" }, "query_items": { "category": "marketplace_module" }, "convert_db": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "data_module" }, "update_app_property_object": { "category": "app_module" }, "update_app_single_property": { "category": "app_module" }, "get_new_notification_count": { "category": "notification_module" }, "submit_app_notification": { "category": "notification_module" }, "get_notifications": { "category": "notification_module" }, "get_system_notifications": { "category": "notification_module" }, "set_notification_read": { "category": "notification_module" }, "update_notification_status": { "category": "notification_module" }, "update_account_info": { "category": "account_module" }, "team_get_recipients": { "category": "team_module" }, "resend_access_invitation": { "category": "team_module" }, "repair_table": { "description": "This method conducts a comprehensive scan of the entire table, row by row, applying field definitions according to the table settings to correct the following issues: 1. transforming fields with incorrect types, 2. deleting data from obsolete fields, and 3. reconstructing indexes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "table_id": { "name": "Table Id", "description": "The table_id refers to the specific table that needs to be refreshed, as outlined in the Xuda Studio database repository.", "type": "string", "mandatory": true } }, "category": "data_module" }, "get_devices_data": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "support_module" }, "reload_active_devices": {}, "get_client_error_data": { "category": "support_module" }, "get_user_emails": { "category": "email_module" }, "delete_release": { "category": "build_module" }, "reinstall_link_resources": { "description": "The `reinstall_link_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_user_group_resources": { "description": "The `reinstall_user_group_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_embed_resources": { "description": "The `reinstall_embed_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_preview_resources": { "description": "The `reinstall_preview_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_datacenter_resources": { "description": "The `reinstall_datacenter_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_router_resources": { "description": "The `reinstall_router_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_pwa_resources": { "description": "The `reinstall_pwa_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reinstall_api_resources": { "description": "The `reinstall_api_resources` API method is designed to manage the deployment resources of a specified application by wiping the existing installation and performing a fresh reinstall. This process ensures that any previous configurations, files, or settings are cleared, allowing for a clean setup with the latest versions or configurations of the deployment resources. This method is particularly useful for resolving issues stemming from corrupted files or outdated configurations, ensuring the application runs on a clean, updated base.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "update_app_version": { "description": "The `update_app_version` API method is designed to upgrade an application to the latest build version developed within the Xuda Studio environment. When invoked, this method applies the most recent updates and enhancements to the specified application, ensuring it runs the latest features, fixes, and improvements available.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "reboot_server": { "description": "The `reboot_server` API method is designed to restart the virtual private server (VPS) associated with a specific application. This method effectively reboots the server environment, ensuring that any updates or changes that require a restart are applied, and can help resolve issues related to server performance or stability. It is a crucial tool for maintaining the health and efficiency of server operations linked to the application.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "stripe_pay_invoice": { "category": "stripe_module" }, "marketplace_queries": { "category": "marketplace_module" }, "get_contact_members": { "description": "", "fields": { "team_req_stat": { "name": "Team Request Status", "description": "", "type": "array", "mandatory": false } }, "category": "team_module" }, "get_developer_members": { "description": "The 'get_developer_members' API method retrieves a list of members associated with a specific studio access within an application. This method focuses on fetching detailed information about team members, such as their roles, statuses, and any other relevant data linked to their participation in the specified application. It's particularly useful for managing user access and understanding the composition of teams within the app environment, facilitating better collaboration and security management.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "team_req_stat": { "name": "Team Request Status", "description": "", "type": "array", "mandatory": false } }, "category": "team_module" }, "get_user_group_members": { "description": "The 'get_user_group_members' API method retrieves a list of members associated with a specific user group within an application. This method focuses on fetching detailed information about team members, such as their roles, statuses, and any other relevant data linked to their participation in the specified application. It's particularly useful for managing user access and understanding the composition of teams within the app environment, facilitating better collaboration and security management.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "team_req_stat": { "name": "Team Request Status", "description": "", "type": "array", "mandatory": false } }, "category": "team_module" }, "add_contact_member": { "description": "The 'add_contact_member' API method is designed to manage the addition of new members to a contact list by sending a join request via email. Upon execution, the API sends an invitation email to the specified recipient's email address. The invitation includes a request for the recipient to join the contact list. This join request remains in a pending state until the recipient confirms their intention to join. This method facilitates controlled growth of contact lists by ensuring that new additions are confirmed and authorized by potential members, enhancing both security and user management practices.", "fields": { "access_email": { "name": "Email", "type": "string", "mandatory": true } }, "category": "team_module" }, "add_developer_member": { "description": "The 'add_developer_member' API method facilitates collaboration within the Xuda platform by sending an invitation to a developer to join a specific studio project. When this method is called, it creates a join request associated with the specified application. An invitation email is sent to the recipient, prompting them to confirm their participation. The request remains in a pending state until the invited user accepts the invitation, ensuring that only confirmed members can access the project resources. This method is crucial for managing project permissions and expanding development teams effectively within Xuda Studio.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "access_email": { "name": "Email", "type": "string", "mandatory": true } }, "category": "team_module", "min_plan": "team" }, "add_user_group_member": { "description": "The 'add_user_group_member' API method facilitates the addition of new members to a user group within an application. When called, it generates a join request and sends an invitation email to the potential new member's provided email address. This invitation includes details on how to join the user group. The membership request remains in a pending state until the recipient accepts the invitation, confirming their intent to join the group. This process helps manage user group memberships effectively by ensuring that additions are consented to by both parties.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "access_email": { "name": "Email", "type": "string", "mandatory": true } }, "category": "team_module" }, "confirm_contact_request": { "description": "The 'confirm_contact_request' API method is used to confirm and finalize the addition of a member to a contact list. Upon receiving a specific team request ID, this method approves the previously pending request, effectively adding the requested member to the contact list. This confirmation ensures that both parties have agreed to the addition, facilitating organized and consensual management of contact lists within the system.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "confirm_developer_request": { "description": "The 'confirm_developer_request' API method is used to approve a pending membership request for a team member aiming to join a group of authorized developers within the Xuda Studio. Upon execution, this method finalizes the addition of the member by confirming their join request based on the specified team request identifier. This approval process integrates new members into the development environment, granting them the necessary access and permissions to collaborate and contribute to projects within Xuda Studio.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "decline_contact_request": { "description": "The 'decline_contact_request' API method is utilized to reject a pending request for adding a member as a contact within a system. When this method is invoked, it effectively communicates to the system that the user has decided not to accept the membership request. This action prevents the requester from being added as a contact, maintaining the user's existing contact list unchanged. This method is essential for managing personal or organizational contacts, ensuring that additions are subject to user approval.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "decline_developer_request": { "description": "The 'decline_developer_request' API method is designed to handle the rejection of a membership request for a user seeking to join as a developer in Xuda Studio. This method processes a specific request identified by a unique team request identifier. When invoked, it effectively communicates to the system that the user has declined the request, ensuring that the membership does not proceed. This functionality is important for managing user roles and permissions within Xuda Studio, allowing for controlled access based on user decisions and administrative approvals.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "decline_user_group_request": { "description": "The 'decline_user_group_request' API method handles the rejection of a pending request for a user to join a specific user group. When invoked, this method updates the system to indicate that the invitation for membership has been declined. This action prevents the prospective member from joining the user group, ensuring that only approved users can access or participate in the group activities. This method is important for maintaining control over group composition and ensuring that all members meet the required criteria or have received the necessary approvals.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "cancel_contact_request": { "description": "The 'cancel_contact_request' API method is designed to cancel a previously made contact request. When executed, it updates the system to reflect that the request identified by its unique team request ID has been officially cancelled. The user who made the request or the intended recipient is notified that the request is no longer active. This method is particularly useful for managing communication or connection requests within a system, allowing users to retract requests that are no longer relevant or were made in error.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "cancel_developer_request": { "description": "The 'cancel_developer_request' API method is designed to cancel an existing request related to developer activities or permissions within Xuda Studio. When executed, it notifies the user that their pending request, identified by a unique team request ID, has been officially cancelled. This method is useful for managing the lifecycle of requests within the studio, allowing for the orderly handling of changes in project roles, development tasks, or access permissions, ensuring that only current and relevant requests are active and processed.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "cancel_user_group_request": { "description": "The 'cancel_user_group_request' API method is designed to cancel a previously made request for a user to join a user group. When this method is invoked with a specific team request identifier, it effectively nullifies the request and notifies the user that their application to join the user group has been cancelled. This ensures that the user is aware that the request is no longer active and will not be processed further, allowing for clear communication and management of user group memberships.", "fields": { "team_req_id": { "name": "Team Request Id", "type": "string", "mandatory": true } }, "category": "team_module" }, "create_contact_join_link": { "description": "The 'create_contact_join_link' API method generates a unique URL that contains all the necessary information for a user to join a contact list. By sharing this link, users can seamlessly add themselves to the designated contact list without the need for manual entry or approval. This method simplifies the process of expanding contact databases by facilitating easy, direct additions through a single, shareable link. This is particularly useful for managing subscriptions, memberships, or any community engagement efforts where gathering and maintaining contact details is essential.", "category": "team_module" }, "create_developer_join_link": { "description": "The `create_developer_join_link` API method generates a specialized link that contains all necessary information for a user to join as a developer on the Xuda platform using Xuda Studio. This link facilitates the onboarding process by directly integrating new developers into the specific application associated with the provided `app_id`. By sharing this URL, existing team members can easily invite new developers to collaborate, contributing to a streamlined workflow and enhanced productivity within the development environment.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "team_module" }, "create_user_group_join_link": { "description": "The `create_user_group_join_link` API method generates a unique URL that facilitates joining a user group within a specific application. When invoked, this method creates a link embedded with all necessary information required for a user to become a member of the user group. By sharing this URL with prospective members, they can directly access the group joining process. This method simplifies the process of adding new members, enhancing the user experience by providing a straightforward and efficient way to expand user group memberships through link-based invitations.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "team_module" }, "get_logs": { "category": "logs_module" }, "get_logs_counts": { "category": "logs_module" }, "get_drive_files_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "get_drive_file_info_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true }, "file_path": { "name": "File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_drive_files_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "files_arr": { "name": "Files", "description": "Array of file id's", "type": "array", "mandatory": true } }, "category": "drive_module" }, "extract_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_id": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "upload_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "create_drive_folder_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "folder_name": { "name": "Folder Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_file_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true }, "file_name_to": { "name": "New File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_folder_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "curr_path": { "name": "Current File Path", "description": "", "type": "string", "mandatory": true }, "new_path": { "name": "New File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_sharing_mode_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_file_bulk_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "server_files": { "name": "Files to Delete", "description": "Array of file names", "type": "array", "mandatory": true } }, "category": "drive_module" }, "search_drive_files_workspace": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "search_string": { "name": "Search String", "description": "", "type": "string", "mandatory": false }, "search_name": { "name": "Search Name", "description": "", "type": "string", "mandatory": false }, "date_from": { "name": "Date From", "description": "timestamp", "type": "number", "mandatory": false }, "date_to": { "name": "Date To", "description": "timestamp", "type": "number", "mandatory": false }, "mime_type": { "name": "Mime Type", "description": "", "type": "string", "mandatory": false }, "file_ext": { "name": "File Extension", "description": "", "type": "string", "mandatory": false } }, "category": "drive_module" }, "get_drive_files_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "get_drive_file_info_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true }, "file_path": { "name": "File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_drive_files_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "files_arr": { "name": "Files", "description": "Array of file id's", "type": "array", "mandatory": true } }, "category": "drive_module" }, "extract_drive_file_studio": { "fields": { "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_id": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "upload_drive_file_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "create_drive_folder_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "folder_name": { "name": "Folder Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_file_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_name_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true }, "file_name_to": { "name": "New File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_folder_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "curr_path": { "name": "Current File Path", "description": "", "type": "string", "mandatory": true }, "new_path": { "name": "New File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_sharing_mode_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "file_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_file_bulk_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "server_files": { "name": "Files to Delete", "description": "Array of file names", "type": "array", "mandatory": true } }, "category": "drive_module" }, "search_drive_files_studio": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "search_string": { "name": "Search String", "description": "", "type": "string", "mandatory": false }, "search_name": { "name": "Search Name", "description": "", "type": "string", "mandatory": false }, "date_from": { "name": "Date From", "description": "timestamp", "type": "number", "mandatory": false }, "date_to": { "name": "Date To", "description": "timestamp", "type": "number", "mandatory": false }, "mime_type": { "name": "Mime Type", "description": "", "type": "string", "mandatory": false }, "file_ext": { "name": "File Extension", "description": "", "type": "string", "mandatory": false } }, "category": "drive_module" }, "get_drive_files_user": { "fields": { "path": { "name": "Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "get_drive_file_info_user": { "fields": { "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true }, "file_path": { "name": "File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_drive_files_user": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "files_arr": { "name": "Files", "description": "Array of file id's", "type": "array", "mandatory": true } }, "category": "drive_module" }, "extract_drive_file_user": { "fields": { "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_id": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "upload_drive_file_user": { "category": "drive_module" }, "update_drive_file_user": { "fields": { "file_path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "file_name": { "name": "File Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "create_drive_folder_user": { "fields": { "path": { "name": "Path", "description": "", "type": "string", "mandatory": true }, "folder_name": { "name": "Folder Name", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_file_user": { "fields": { "file_name_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true }, "file_name_to": { "name": "New File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "rename_drive_folder_user": { "fields": { "curr_path": { "name": "Current File Path", "description": "", "type": "string", "mandatory": true }, "new_path": { "name": "New File Path", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "update_drive_file_sharing_mode_user": { "fields": { "file_id": { "name": "File Id", "description": "", "type": "string", "mandatory": true } }, "category": "drive_module" }, "delete_file_bulk_user": { "fields": { "server_files": { "name": "Files to Delete", "description": "Array of file names", "type": "array", "mandatory": true } }, "category": "drive_module" }, "search_drive_files_user": { "fields": { "search_string": { "name": "Search String", "description": "", "type": "string", "mandatory": false }, "search_name": { "name": "Search Name", "description": "", "type": "string", "mandatory": false }, "date_from": { "name": "Date From", "description": "timestamp", "type": "number", "mandatory": false }, "date_to": { "name": "Date To", "description": "timestamp", "type": "number", "mandatory": false }, "mime_type": { "name": "Mime Type", "description": "", "type": "string", "mandatory": false }, "file_ext": { "name": "File Extension", "description": "", "type": "string", "mandatory": false } }, "category": "drive_module" }, "update_npm_dependencies": { "description": "The `update_npm_dependencies` API method is tasked with installing and updating Node.js package dependencies for a specific application within the Xuda platform. By executing this method, the listed dependencies in the provided object are installed or updated on the Xuda Studio drive associated with the application identified by the `app_id`. This process ensures that the application's environment is up-to-date with the latest packages needed for its operation, thereby maintaining compatibility and functionality of the application's features.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "dependencies": { "name": "Dependencies", "description": "", "type": "object", "mandatory": true } }, "category": "app_module" }, "change_under_attack_mode": { "description": "The `change_under_attack_mode` API method enables the activation of an 'Under Attack Mode' for a specified application. When this mode is enabled, it enhances the security measures of the application to protect against potential threats or ongoing attacks. This could involve increasing scrutiny of incoming traffic, employing additional verification processes to ward off bots, or temporarily altering how requests are handled to mitigate the impact of the attack. This method is crucial for safeguarding the application during periods of heightened security risk.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module", "min_plan": "pro" }, "get_app_plugins": { "description": "The `get_app_plugins` API method retrieves a comprehensive list of Xuda plugins associated with a specified application. This method provides detailed information about each plugin, including its installation status, which indicates whether each plugin is currently installed within the application. This functionality is essential for managing and configuring the plugins that enhance or extend the application's capabilities, offering administrators a clear view of the application's integration with various tools and services.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "get_plugins": { "description": "The `get_plugins` API method retrieves a list of available plugins from the Xuda platform. This method provides users with access to publicly available plugins, detailing each plugin's features and potential integrations. This functionality is essential for users looking to enhance their applications with additional capabilities provided by Xuda plugins, enabling them to select suitable plugins based on their specific needs and requirements.", "category": "plugins_module" }, "install_plugin": { "description": "The `install_plugin` API method is designed to facilitate the installation of a specified plugin into an application managed on the Xuda platform. When invoked with an application identifier and the name of the plugin, this method seamlessly integrates the plugin into the application's environment. This enables the application to extend its functionality by incorporating additional features provided by the plugin, thereby enhancing the overall capabilities and user experience of the application. This process is crucial for maintaining the modularity and scalability of applications on the Xuda platform.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "plugin_name": { "name": "Plugin Name", "description": "", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "uninstall_plugin": { "description": "The `uninstall_plugin` API method facilitates the removal of a specific plugin from an application on the Xuda platform. By specifying the application's unique identifier and the name of the plugin, this method ensures that the selected plugin is completely uninstalled from the application environment. This operation is crucial for maintaining the application's performance and security by enabling the management of active plugins, allowing users to optimize their application setup by removing unnecessary or outdated plugins.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "plugin_name": { "name": "Plugin Name", "description": "", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "archive_plugin": { "description": "The `archive_plugin` API method is used to archive a specific plugin within an application. When this method is called with the identifiers for both the application and the plugin, it initiates the process of archiving the specified plugin. This action effectively disables the plugin from active use within the application while preserving its data and configuration for potential future restoration or review. This method is particularly useful for managing application resources and performance by allowing administrators to temporarily remove unused or unnecessary plugins without permanently deleting them.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "plugin_name": { "name": "Plugin Name", "description": "", "type": "string", "mandatory": true } }, "category": "plugins_module" }, "get_platform_regions": { "description": "The `get_regions` API method retrieves a list of all available regional servers managed by the Xuda platform. This method provides comprehensive information about the different geographic locations where Xuda servers are positioned, enabling users to understand and select the most appropriate server locations for their applications based on latency, legal, or data sovereignty requirements. This functionality is essential for optimizing application performance and compliance by strategically selecting server regions.", "category": "deploy_module" }, "get_app_server_usage": { "description": "The `get_app_server_usage` API method retrieves information regarding the virtual private server (VPS) usage associated with a specific application. It provides detailed data on resources utilized by the application's server, such as CPU, memory, storage, and network usage. This method is essential for monitoring and managing the server performance and ensuring the application runs efficiently within its allocated server resources.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "ts_start": { "name": "Start Date", "description": "timestamp", "type": "number", "mandatory": true }, "ts_end": { "name": "End Date", "description": "timestamp", "type": "number", "mandatory": true } }, "category": "deploy_module" }, "update_domain_setup": { "fields": { "domain_setup": { "name": "Domain Setup", "description": "", "type": "object", "mandatory": true }, "domain_setup.type": { "name": "Domain Setup Type", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "validate_domain_setup_subdomain": { "fields": { "subdomain": { "name": "Subdomain", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "resize_server": { "description": "The `resize_server` API method is designed to adjust the virtual private server (VPS) specifications associated with a specific application on the Xuda platform. This method allows for the scaling of server resources, either upgrading or downgrading, to meet the changing needs of the application in terms of memory, CPU, and storage. By resizing the server, the application can optimize performance, handle increased traffic, or reduce costs, depending on current requirements. This operation is crucial for maintaining efficient and cost-effective server utilization throughout the application lifecycle.", "fields": { "app_hosting.app_server_type": { "name": "Server Type", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "deploy_link": { "description": "The `deploy_link` API method facilitates the creation of a deployment link for an application based on specific deployment parameters. Once executed, this method generates a URL for the specified application, which can be utilized as a standalone link, embedded directly into a webpage, or included within an iframe. This link provides direct access to the application, allowing for easy integration and distribution across various platforms and user interfaces. This functionality is particularly useful for simplifying the process of sharing and accessing applications hosted in different environments or data centers.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_router": { "description": "The `deploy_router` API method is designed to establish multiple URL paths for an application. This method facilitates the creation of a routing system within the app, allowing it to handle various URL paths efficiently. By doing so, it enhances the app's ability to serve different content or functionalities based on the specific path accessed, effectively organizing and optimizing the user's navigation experience. This is particularly useful for apps that require distinct sections or features accessible through unique URLs.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_embed": { "description": "The `deploy_embed` API method is designed to facilitate the embedding of applications into websites by generating the necessary code. This method processes key deployment details such as the application name, release ID, program ID, datacenter ID, and server type. It also configures additional features like user monitoring and a utility screen. By executing this method, users can efficiently generate an embed code that can be directly incorporated into a webpage, allowing the embedded application to function seamlessly within the host site's environment. This capability is crucial for extending the reach and functionality of applications across different platforms and websites.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_pwa": { "description": "The `deploy_pwa` API method facilitates the deployment of a Progressive Web App (PWA) associated with a specific domain. This method handles the configuration and initiation of a PWA deployment, ensuring the app meets essential PWA criteria such as reliability, fast loading times, and offline capabilities. By integrating various identifiers and settings such as application name, release ID, program ID, datacenter ID, and deployment server type, this API sets up the environment to host and run the PWA efficiently. Additional features like user monitoring and utility screens can also be enabled to enhance functionality and user experience. This method is crucial for developers looking to deploy robust web applications that offer native-like experiences on the web.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_user_group": { "description": "The `deploy_user_group` API method is designed to facilitate the deployment of a user group application within a specified environment. This method orchestrates the setup of the application based on several deployment parameters such as the application name, release ID, program ID, datacenter ID, and the type of deployment server. Additionally, it configures features like user monitoring and utility screens to enhance the functionality and manageability of the application. Once the deployment is completed, the API generates a shareable link, similar to an intranet link, that can be distributed to users to access the deployed application. This enables a streamlined and accessible way for teams or user groups to interact with the application in a controlled and efficient manner.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true }, "data.setup.users": { "name": "Users to Invite", "description": "Object array: {'email': 'xxx@gmail.com,'preferences': {'hide_create_button': false,'default_dashboard': false,'sidebar_style': 'open'}}", "type": "array", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_preview": { "description": "The `deploy_preview` API method facilitates the creation of a shareable preview link for an application. This functionality is designed primarily for demonstration purposes, allowing users to experience the app in a simulated device environment. The API enables features such as User Monitoring and a Utility Screen, enhancing the interactivity and accessibility of the preview. This method is particularly useful for developers seeking feedback or showcasing app functionalities before a full-scale deployment.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true }, "data.enable_user_monitor": { "name": "Enable User Monitor", "description": "Enable User Monitor activates the monitoring of user activities, remote control capabilities, and support mechanisms within an application's runtime environment.", "type": "boolean", "mandatory": true }, "data.enable_utility_screen": { "name": "Enable Utility Screen", "description": "Enable Utility Screen activates a utility screen during an application's runtime based on user input. When enabled, this utility screen provides several options to enhance user support and manage the application.", "type": "boolean", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_api": { "description": "The `deploy_api` API method facilitates the creation of an API interface for a specified application. This method is designed to streamline the deployment process by linking the application with a specific release version, program identifier, and data center, and by configuring it on a server type optimized for API handling. By executing this method, developers can efficiently establish a robust API interface that enhances their application's accessibility and interaction with other systems, ensuring seamless integration and communication across different platforms.", "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.release_doc_id": { "name": "Release Id", "description": "The Release ID, obtained from the `get_app_releases` API, contains the build information of the application.", "type": "string", "mandatory": true }, "data.prog_id": { "name": "Prog Id", "description": "The Prog ID is the identifier for the program represented in Xuda Studio, which will be executed during the deployment startup.", "type": "string", "mandatory": true }, "data.app_datacenter": { "name": "Datacenter Id", "description": "The Datacenter ID is the identifier for the datacenter associated with the deployment.", "type": "string", "mandatory": false, "mandatory_dependencies": [ "data.create_datacenter" ] }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "service_hosting_1", "service_hosting_2", "service_hosting_4", "service_hosting_8", "service_hosting_16", "service_hosting_32", "service_hosting_48" ], "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_vps": { "fields": { "data.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.app_region": { "name": "Deployment Region", "description": "The Deployment Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": true }, "data.app_server_type": { "name": "Deployment Server Type", "description": "Deployment Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_vps_05", "shared_vps_1", "shared_vps_2", "shared_vps_4", "shared_vps_8", "optimized_vps_2", "optimized_vps_4", "optimized_vps_8", "optimized_vps_16", "performance_vps_4", "performance_vps_16", "performance_vps_24", "performance_vps_32", "large_vps_8", "large_vps_16", "large_vps_24", "large_vps_32" ], "mandatory": true } }, "category": "deploy_module" }, "deploy_marketplace": { "fields": { "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true }, "data.setup.app_images": { "name": "App Images", "description": "", "type": "array", "mandatory": true } }, "category": "deploy_module", "min_plan": "agency" }, "deploy_instance": { "fields": { "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true } }, "category": "deploy_module", "min_plan": "agency" }, "deploy_datacenter": { "description": "The `deploy_datacenter` API method is designed to establish a new datacenter server tailored to serve as a database for related deployments. This server is configured based on the specified region and server size. Additionally, the newly created datacenter has the capability to synchronize with other datacenters within the same project cluster. This synchronization facilitates data consistency and redundancy across the network, enhancing both the reliability and the scalability of the infrastructure.", "fields": { "data.create_datacenter.app_name": { "name": "App Name", "description": "Denotes the name of the deployment.", "type": "string", "mandatory": true }, "data.create_datacenter.app_region": { "name": "Datacenter Region", "description": "The Datacenter Region is the location where the server will be set up.", "type": "string", "options": [ "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "tor1", "lon1", "ams2", "ams3", "fra1", "syd1", "blr1", "sgp1" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] }, "data.create_datacenter.app_server_type": { "name": "Datacenter Server Type", "description": "Datacenter Server Type refers to the server classification that indicates the CPU, memory, and disk size.", "type": "string", "options": [ "shared_hosting_1", "shared_hosting_2", "shared_hosting_4", "shared_hosting_8", "optimized_hosting_2", "optimized_hosting_4", "optimized_hosting_8", "optimized_hosting_16", "performance_hosting_4", "performance_hosting_16", "performance_hosting_24", "performance_hosting_32", "large_hosting_8", "large_hosting_16", "large_hosting_24", "large_hosting_32" ], "mandatory": false, "mandatory_dependencies": [ "data.app_datacenter" ] } }, "category": "deploy_module", "min_plan": "pro" }, "deploy_load_balancer": { "fields": { "data.create_datacenter.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true }, "data.create_datacenter.app_region": { "name": "Region", "description": "", "type": "string", "mandatory": true }, "data.create_datacenter.app_server_type": { "name": "Server Type", "description": "", "type": "string", "mandatory": true } }, "category": "deploy_module", "min_plan": "enterprise_t1" }, "deploy_another": { "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "data.app_name": { "name": "App Name", "description": "", "type": "string", "mandatory": true }, "data.app_region": { "name": "Region", "description": "", "type": "string", "mandatory": true } }, "category": "deploy_module", "min_plan": "pro" }, "configure_datacenter_replication": { "description": "The `configure_datacenter_replication` API method is designed to set up replication configurations for an application between data centers. This method facilitates specifying the type of replication (either 'one-time' for a single replication event or 'continuous' for ongoing synchronization), the source of the replication (either from a 'master' or another 'datacenter'), and the direction of the replication ('one_way' where data flows from the source to the destination without reciprocal updates, or 'two_way' where changes are synchronized in both directions). This configuration is crucial for ensuring data redundancy, improving access speed for geographically distributed users, and enhancing disaster recovery capabilities.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "replicate_data.create_datacenter.app_datacenter_replication.replicate_type": { "name": "Replication Type", "description": "", "type": "string", "options": [ "one-time", "continuous" ], "mandatory": true }, "replicate_data.create_datacenter.app_datacenter_replication.replicate_from": { "name": "Replicate From", "description": "", "type": "string", "options": [ "master", "datacenter" ], "mandatory": true }, "replicate_data.create_datacenter.app_datacenter_replication.replicate_direction": { "name": "Replicate Direction", "description": "", "type": "string", "options": [ "one_way", "two_way" ], "mandatory": true } }, "category": "app_module" }, "get_deploy_info": { "description": "The `get_deploy_info` API method is designed to fetch and return detailed information about a specific application deployment using the application's unique identifier, `app_id`. This method provides essential data on the deployment, including the application's unique attributes, status, user information, and specific deployment settings. It is an essential tool for monitoring and managing the lifecycle and configuration of application deployments within a system.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "deploy_module" }, "create_backup": { "description": "The `create_backup` API method facilitates the creation of backups for various elements such as projects, datacenters, instances, or deployments. This function is essential for ensuring data integrity and availability by allowing users to save and restore states of critical components within their systems. It provides a safety net against data loss and aids in disaster recovery by allowing organizations to maintain copies of their operational data at different points in time.", "fields": { "data.app_replicate": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "backup_module" }, "destroy_backup": { "description": "The `destroy_backup` API method is designed to permanently delete a specific backup from a system or storage location. By providing a unique backup identifier, this method allows users to effectively manage their backup resources, ensuring that outdated or unnecessary backups are removed to free up storage space or maintain data compliance. This function is crucial for maintaining the efficiency and organization of data management practices within a system.", "fields": { "backup_id": { "name": "Backup Id", "description": "", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_traffic_metrics": { "description": "The `get_app_traffic_metrics` API method provides detailed analytics related to the traffic of a specific application. Upon invocation with an application's unique identifier, this method returns a comprehensive set of data including the total number of visits, breakdown of visits by country, analysis of visits per device type, and other relevant metrics. This information is crucial for understanding user engagement, optimizing app performance, and tailoring marketing strategies to enhance user interaction and retention.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_traffic_overview": { "description": "The `get_app_traffic_overview` API method provides a comprehensive summary of user traffic statistics for a specific application. This method delivers key analytics data including the total number of visits, distribution of visits by country, and breakdown of visits by device type, among other metrics. These insights are crucial for understanding user engagement and behavior patterns, enabling developers and marketers to tailor their strategies effectively to enhance user experience and app performance.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_app_firewall": { "description": "The `get_app_firewall` API method retrieves firewall configuration details for a specific application, identified by its app_id. This method provides information on the firewall settings that help protect the application by controlling traffic based on predefined security rules. The returned data typically includes rules for inbound and outbound traffic, statuses of these rules, and any specific settings tailored to enhance the application's security environment. This function is essential for administrators looking to maintain or audit the security parameters that safeguard their applications.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "configure_app_firewall": { "description": "The `configure_app_firewall` API method is designed to set up and modify firewall settings for a specific application identified by its app_id. This method manages the security rules that control incoming and outgoing network traffic to the application, ensuring that only authorized access is allowed. By configuring the application's firewall, you can effectively safeguard the app against unauthorized access and potential security threats, enhancing the overall security posture of the application infrastructure.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "run_programs_checker": { "description": "The `run_programs_checker` API method is designed to perform a comprehensive check on an application within the Xuda Studio environment. This method evaluates the application's configuration, dependencies, and overall integrity to ensure it operates correctly within the platform. By invoking this method, developers can identify potential issues, inconsistencies, or errors that might affect the app's performance or stability. This proactive checking mechanism is essential for maintaining high-quality applications and ensuring seamless user experiences.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "clear_program_checks": { "description": "The `clear_program_checks` API method is designed to reset and clear all the diagnostic check results from Xuda Studio for a specified application. This operation effectively removes any stored outcomes of previous validations or error checks performed by Xuda Studio, allowing for a fresh start in monitoring and troubleshooting the application. This is particularly useful when updates or significant changes have been made to the application, necessitating a new round of checks without the clutter of old results.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "get_studio_docs_by_type": { "description": "The `get_studio_docs_by_type` API method retrieves various types of documents defined within the Xuda Studio for a specific application. This method focuses on extracting an assortment of document types such as tables, programs, setups, and other related content that are integral to the application's configuration and operational setup. By specifying the application identifier, the API fetches and returns these documents, enabling developers or administrators to manage and review the structured data and scripts that drive the application's functionality and user interactions.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true }, "type": { "name": "Type", "description": "", "type": "string", "mandatory": true }, "build": { "name": "Build", "description": "", "type": "number" }, "stat": { "name": "Status", "description": "", "type": "number" } }, "category": "app_module" }, "get_app_tables": { "description": "The `get_app_tables` API method retrieves a list of all the data tables defined within an application on the Xuda platform. This method is called using the application's unique identifier and returns a structured overview of the tables configured in the Xuda Studio for that specific application. This information is crucial for developers and administrators to understand the data schema and organization within their application, facilitating better data management and integration processes.", "fields": { "app_id": { "name": "App Id", "description": "'app_id' as a parameter, which serves as the unique identifier for the application.", "type": "string", "mandatory": true } }, "category": "app_module" }, "test_email": { "category": "email_module" } } }