# Jotelulu API Documentation Documentation ## Guides - [Entornos de acceso al API de Jotelulu](https://docs.jotelulu.com/docs/acceso-al-api-de-jotelulu.md) - [Cliente SDK PHP](https://docs.jotelulu.com/docs/cliente-sdk-php.md) - [Cliente SDK Python](https://docs.jotelulu.com/docs/cliente-sdk-python.md) - [EULA-EN](https://docs.jotelulu.com/docs/eula-en.md): EULA inglés - [EULA-ES](https://docs.jotelulu.com/docs/eula-es.md): EULA español - [EULA](https://docs.jotelulu.com/docs/eula.md) - [SDKs Jotelulu](https://docs.jotelulu.com/docs/cliente-sdk.md) - [Introducción](https://docs.jotelulu.com/docs/introducción.md): En el apartado actual se presenta el API Pública de Jotelulu para el acceso a los servicios de plataforma. - [Limitación de uso](https://docs.jotelulu.com/docs/limitación-de-uso.md) - [Cómo conectarse al entorno de Escritorio Remoto por VPN site-to-site](https://docs.jotelulu.com/docs/cómo-conectarse-al-entorno-de-escritorio-remoto-por-vpn-site-to-site-1.md) - [Cómo conectarse al entorno de Escritorio Remoto por VPN site-to-site](https://docs.jotelulu.com/docs/cómo-conectarse-al-entorno-de-escritorio-remoto-por-vpn-site-to-site.md) - [Cómo crear plantillas en un servidor para reutilizarlas en Escritorio Remoto](https://docs.jotelulu.com/docs/cómo-crear-plantillas-en-un-servidor-para-reutilizarlas-en-escritorio-remoto.md) - [Cómo instalar cualquier aplicación en tu escritorio remoto (por consola)](https://docs.jotelulu.com/docs/cómo-instalar-cualquier-aplicación-en-tu-escritorio-remoto-por-consola.md) - [Cómo integrar Almacenamiento de Archivos en tu escritorio remoto](https://docs.jotelulu.com/docs/cómo-integrar-almacenamiento-de-archivos-en-tu-escritorio-remoto.md) - [Cómo personalizar el acceso directo del Explorador de Windows en tu Escritorio Remoto](https://docs.jotelulu.com/docs/cómo-personalizar-el-acceso-directo-del-explorador-de-windows-en-tu-escritorio-remoto.md) - [Modalidades de Impresión en Escritorio Remoto](https://docs.jotelulu.com/docs/modalidades-de-impresión-en-escritorio-remoto.md) - [Guía rápida de escritorio remoto para Administradores](https://docs.jotelulu.com/docs/guía-rápida-de-escritorio-remoto-para-administradores.md) - [Guía rápida de Escritorio Remoto para Usuarios](https://docs.jotelulu.com/docs/guía-rápida-de-escritorio-remoto-para-usuarios.md) - [Inicio rápido](https://docs.jotelulu.com/docs/inicio-rápido-5.md): Cómo dar de alta el entorno de Escritorio Remoto - [Cómo crear un túnel VPN site-to-site en Jotelulu](https://docs.jotelulu.com/docs/cómo-crear-un-túnel-vpn-site-to-site-en-jotelulu.md) - [Cómo crear un VPC y asociar un TIER en Jotelulu](https://docs.jotelulu.com/docs/cómo-crear-un-vpc-y-asociar-un-tier-en-jotelulu.md) - [Cómo desplegar un FortiGate paso a paso](https://docs.jotelulu.com/docs/cómo-desplegar-un-fortigate-paso-a-paso.md): Desplegar Firewall de Fortinet con el Servicio VNF - [Como desplegar una plantilla de Pandora en un servidor de Jotelulu](https://docs.jotelulu.com/docs/como-desplegar-una-plantilla-de-pandora-en-un-servidor-de-jotelulu.md): Este tutorial explica cómo desplegar rápidamente una plantilla de Pandora FMS en un servidor de Jotelulu utilizando la imagen preconfigurada del Marketplace. Se guía al usuario para seleccionar recursos, elegir la imagen de Pandora, configurar la red y habilitar el acceso HTTPS mediante una regla de firewall. Tras el despliegue, se accede al frontal web de Pandora para comenzar su configuración según las necesidades de cada organización. - [Cómo hacer un Snapshot de servidor y restaurarlo posteriormente](https://docs.jotelulu.com/docs/cómo-hacer-un-snapshot-de-servidor-y-restaurarlo-posteriormente.md) - [Cómo reducir el tamaño de un disco virtual](https://docs.jotelulu.com/docs/cómo-reducir-el-tamaño-de-un-disco-virtual.md) - [ Migrar un FortiGate desde On-premise o Cloud a Jotelulu](https://docs.jotelulu.com/docs/migrar-un-fortigate-desde-on-premise-o-cloud-a-jotelulu.md) - [Backup](https://docs.jotelulu.com/docs/backup.md) - [Discos](https://docs.jotelulu.com/docs/discos.md) - [Servidores](https://docs.jotelulu.com/docs/servidores.md) - [Introducción](https://docs.jotelulu.com/docs/getting-started-1.md) - [Inicio rápido](https://docs.jotelulu.com/docs/inicio-rápido-6.md): Cómo desplegar un nuevo servidor en Jotelulu ## API Reference - [Create Organization User](https://docs.jotelulu.com/reference/createcoreorganizationuser.md): Add a new user to an organization with comprehensive profile setup. This endpoint allows you to create new users within an organization, setting up their complete profile including authentication preferences, contact information, and organizational details. **Key Features:** - Complete user profile creation - Optional two-factor authentication setup - Flexible password management - Timezone and language preferences **Best Practices:** - Always provide a valid email address - Use strong passwords when specified - Set appropriate timezone for user location - Configure 2FA for enhanced security - [List Organization Users](https://docs.jotelulu.com/reference/listcoreorganizationusers.md): Retrieve a comprehensive list of all users belonging to a specific organization. This endpoint provides detailed information about each user including their profile data, authentication settings, and contact information. Perfect for user management dashboards and administrative interfaces. **Use Cases:** - Display organization members in admin panels - Generate user reports and analytics - Manage user permissions and access control **Response includes:** - User profile information (name, email, position) - Authentication settings (2FA status) - Contact details and preferences - [List User Organizations](https://docs.jotelulu.com/reference/listcoreuserorganizations.md): Retrieve all organizations that the authenticated user has access to. This endpoint returns a list of organizations where the current user is a member, providing essential organization information for navigation and context switching within multi-tenant applications. **Use Cases:** - Organization selector in user interfaces - Multi-tenant application navigation - User access audit and reporting - Dashboard organization filtering **Authentication Required:** - Valid Bearer token in Authorization header - User must have active membership in at least one organization - [Get Instance Deployment Progress](https://docs.jotelulu.com/reference/getinstanceprogress.md): Retrieve the current deployment progress of a specific remote desktop instance. This endpoint provides real-time progress information during instance deployment, allowing you to monitor the provisioning process and provide feedback to users about deployment status and completion percentage. **Use Cases:** - **Progress Monitoring**: Track deployment progress in real-time - **User Interface**: Display progress bars and status updates to users - **Automated Monitoring**: Integrate with monitoring systems for deployment tracking - **Troubleshooting**: Monitor deployment stages to identify bottlenecks or issues - **User Experience**: Provide transparent deployment progress feedback **Progress Information:** - Current deployment stage and status - Completion percentage or progress indicator - Detailed status messages and deployment phase information - Timestamp of last progress update **Monitoring Benefits:** - Real-time visibility into deployment process - Early detection of deployment issues or delays - Improved user experience with progress feedback - Integration capabilities for automated monitoring systems **Usage Patterns:** - Poll this endpoint periodically during deployment - Display progress information in user interfaces - Trigger notifications based on progress milestones - Log deployment progress for audit and troubleshooting **Progress Stages:** Deployment typically progresses through multiple stages such as resource allocation, instance provisioning, configuration setup, and service initialization. - [Grant Application Access to Users](https://docs.jotelulu.com/reference/addapplicationtouser.md): Grant access to a specific application for one or more users within a remote desktop subscription. This endpoint allows you to assign application access permissions to users, enabling them to launch and use the specified application within their remote desktop environment. Perfect for implementing role-based access control and managing application licenses. **Key Features:** - **Bulk User Assignment**: Grant access to multiple users simultaneously - **Application-Level Control**: Fine-grained control over individual application access - **Permission Management**: Implement role-based access control for applications - **License Management**: Control application usage for license compliance **Access Control Scenarios:** - **Role-Based Access**: Grant access based on user roles and responsibilities - **Project-Based Access**: Provide access to project-specific applications - **Temporary Access**: Grant temporary access for specific tasks or projects - **License Optimization**: Manage application licenses by controlling user access **Best Practices:** - Grant access based on business need and user roles - Regularly review and audit application access permissions - Document access decisions for compliance and audit purposes - Consider license implications when granting application access - Implement least-privilege access principles **Security Considerations:** - Verify user authorization before granting application access - Monitor application usage for security and compliance - Implement access reviews and certification processes - Track access changes for audit and compliance purposes **Operation Details:** This endpoint initiates asynchronous user access provisioning. Users will be able to access the application once the provisioning process is complete. - [List Application Users](https://docs.jotelulu.com/reference/listapplicationusers.md): Retrieve all users who have been granted access to a specific application within a remote desktop subscription. This endpoint provides information about user access permissions for individual applications, including user identifiers and email addresses. Essential for access auditing and permission management at the application level. **Use Cases:** - **Access Auditing**: Review which users have access to specific applications - **Permission Management**: Monitor application-level user access permissions - **Compliance Reporting**: Generate reports on application access for compliance - **License Tracking**: Track application usage for license management - **Security Review**: Audit application access for security compliance **User Information:** - Remote desktop user identifiers for access management - User email addresses for identification and communication - Application-specific access permissions and assignments **Access Control Benefits:** - Granular visibility into application-level permissions - Easy identification of users with application access - Support for role-based access control implementation - Integration-ready data for access management systems **Security and Compliance:** - Track application access for audit and compliance purposes - Monitor sensitive application access permissions - Support for access certification and review processes - Enable least-privilege access principle implementation - [Revoke Application Access from User](https://docs.jotelulu.com/reference/removeapplicationfromuser.md): Remove a user's access to a specific application within a remote desktop subscription. This endpoint revokes application access permissions for a user, preventing them from launching or using the specified application within their remote desktop environment. Use with caution as this action cannot be undone. **Use Cases:** - **User Offboarding**: Remove application access when users leave the organization - **Role Changes**: Revoke access when user roles or responsibilities change - **Security Incidents**: Immediately revoke access for security reasons - **License Management**: Remove access to optimize license utilization - **Access Reviews**: Remove unnecessary access during periodic reviews **Access Revocation Impact:** - **Immediate Effect**: User loses access to the application immediately - **Session Impact**: Active application sessions may be terminated - **Data Access**: User loses access to application-specific data and features - **License Release**: Application license may be released for other users **Important Considerations:** - This action is irreversible and requires re-assignment to restore access - Active application sessions may be terminated immediately - Consider user notification before removing access to avoid disruption - Review data access implications before removing application access - Document access removal decisions for audit and compliance **Security and Compliance:** - Use this endpoint for immediate access revocation in security incidents - Monitor for any remaining active application sessions after removal - Audit access removal actions for compliance and security tracking - Implement proper approval workflows for access removal **Best Practices:** - Verify user identity and authorization before removing access - Notify users of access removal when appropriate - Document the reason for access removal - Review related application access that may also need removal - Consider temporary access suspension before permanent removal - [Deploy Application to Instance](https://docs.jotelulu.com/reference/createinstanceapplication.md): Deploy a new application to a specific remote desktop instance with flexible configuration options. This endpoint allows you to install applications either from the Jotelulu marketplace or as custom applications with specific configurations. Perfect for software deployment and application provisioning in remote desktop environments. **Deployment Options:** - **Marketplace Applications**: Deploy pre-configured applications using application ID - **Custom Applications**: Install custom applications with specific configurations - **Flexible Configuration**: Configure installation paths, executables, and arguments - **Category Assignment**: Organize applications using category tags **Marketplace Deployment:** Use the `applicationId` parameter to deploy applications from the Jotelulu marketplace. These applications come with pre-configured settings and automatic installation. **Custom Application Deployment:** For custom applications, provide detailed configuration including: - Application name and category tag - Installation directory and executable path - Command line arguments for application startup **Best Practices:** - Use marketplace applications when available for easier management - Provide descriptive names for custom applications - Use appropriate category tags for organization - Test custom application configurations before deployment - Document custom application requirements and dependencies **Deployment Process:** This endpoint initiates asynchronous application deployment. Monitor the application state to track installation progress and completion. **Configuration Requirements:** - **Marketplace**: Only `applicationId` and `instanceId` required - **Custom**: Requires `name`, `tagId`, `directory`, `executable`, and `instanceId` - [List Subscription Applications](https://docs.jotelulu.com/reference/listsubscriptionapplications.md): Retrieve all applications installed across instances within a specific remote desktop subscription. This endpoint provides comprehensive information about applications including their installation status, configuration details, user assignments, and execution state. Essential for application inventory management and user access control. **Use Cases:** - **Application Inventory**: View all applications deployed across subscription instances - **User Access Management**: Review application assignments and user access - **Application Monitoring**: Monitor application states and execution status - **License Management**: Track application deployments for licensing compliance - **Update Planning**: Identify applications that may require updates or maintenance **Application Information:** - Application identifiers, names, and installation status - Installation directories and executable paths - User assignments and access permissions - Category tags and bundle associations - Creation and modification timestamps - Parent-child application relationships **Management Benefits:** - Centralized view of all applications across instances - Easy identification of application deployment status - User access auditing and permission management - Integration-ready data for application lifecycle management **Application States:** - **installed**: Application ready for use - **installing**: Installation in progress - **failed**: Installation or configuration failed - **updating**: Application update in progress - [Update Application Configuration](https://docs.jotelulu.com/reference/updateinstanceapplication.md): Update the configuration of an existing application deployed on a remote desktop instance. This endpoint allows you to modify application settings including display name, category assignment, installation paths, executable configuration, and startup arguments. Useful for maintaining and optimizing application deployments. **Configurable Settings:** - **Display Name**: Update application name for better identification - **Category Tag**: Change application categorization and organization - **Installation Directory**: Modify application installation path - **Executable Path**: Update main executable file location - **Startup Arguments**: Configure command line arguments for application launch **Update Scenarios:** - **Application Maintenance**: Update paths after application updates - **Configuration Optimization**: Adjust startup arguments for better performance - **Organization Changes**: Update category tags for better organization - **Path Corrections**: Fix incorrect installation or executable paths - **Name Standardization**: Standardize application names across deployments **Best Practices:** - Test application functionality after configuration updates - Document configuration changes for audit and troubleshooting - Verify executable paths exist and are accessible - Use appropriate category tags for consistent organization - Consider user impact when modifying application configurations **Update Process:** This endpoint initiates asynchronous application configuration updates. Monitor the application state to track update progress and completion. **Important Notes:** - Configuration updates may require application restart - Invalid executable paths may cause application launch failures - Users may need to restart applications to see configuration changes - [List Available Applications](https://docs.jotelulu.com/reference/listapplications.md): Retrieve a comprehensive catalog of applications available for remote desktop deployment. This endpoint provides access to the complete application library, including business applications, productivity tools, development environments, and specialized software that can be deployed in remote desktop environments. **Use Cases:** - **Application Selection**: Browse available applications for remote desktop setup - **Environment Planning**: Plan application deployments based on user requirements - **Catalog Management**: Maintain inventory of available applications - **User Provisioning**: Select applications for user workspace configuration **Application Information:** - Application identifiers and display names - Application categories and classifications - Deployment compatibility and requirements - Licensing and availability information **Planning Benefits:** - Comprehensive application catalog for informed decision-making - Standardized application identifiers for automation - Category-based organization for efficient browsing - Integration-ready metadata for provisioning systems - [List Application Tags](https://docs.jotelulu.com/reference/listapplicationtags.md): Retrieve all available tags used for categorizing remote desktop applications. This endpoint provides access to the tag system used to organize and categorize applications within the remote desktop platform. Tags help users discover applications by functional category and use case. **Use Cases:** - **Category Discovery**: Explore application categories and classifications - **Filtered Browsing**: Enable category-based application filtering - **Organization Planning**: Understand application groupings for deployment planning - **User Interface**: Build category-based navigation and search interfaces **Tag Categories:** - **Productivity**: Office applications, document processing, communication tools - **Development**: Programming environments, code editors, development tools - **Design**: Graphics software, CAD applications, creative suites - **Business**: Enterprise applications, CRM, ERP, accounting software - **Utilities**: System tools, maintenance applications, administrative utilities **Integration Benefits:** - Standardized categorization system for consistent organization - Tag-based filtering capabilities for improved user experience - Hierarchical organization support for complex application catalogs - Metadata for building intelligent application recommendation systems - [List Remote Desktop Instances](https://docs.jotelulu.com/reference/listremotedesktopsubscriptioninstances.md): Retrieve all remote desktop instances associated with a specific subscription. This endpoint provides comprehensive information about remote desktop instances including their deployment status, resource associations, and operational metadata. Essential for monitoring remote desktop infrastructure and troubleshooting issues. **Use Cases:** - **Infrastructure Monitoring**: Track all instances within a subscription - **Status Dashboard**: Display instance health and deployment status - **Resource Management**: Monitor instance-to-server resource mappings - **Troubleshooting**: Identify failed or problematic instance deployments - **Capacity Planning**: Assess instance distribution and resource utilization **Instance Information:** - Instance identifiers, names, and current status - Creation and modification timestamps - Associated server subscription and instance mappings - Deployment status tracking (creating, deployed, error) **Monitoring Benefits:** - Real-time visibility into remote desktop infrastructure - Early detection of deployment issues and failures - Resource correlation between remote desktop and server instances - Historical tracking of instance lifecycle and changes **Status Interpretation:** - **creating**: Instance provisioning in progress - **deployed**: Instance ready for user access - **error**: Deployment failed, requires attention - [Create Remote Desktop Subscription](https://docs.jotelulu.com/reference/createremotedesktopsubscription.md): Create a new remote desktop subscription for an organization with comprehensive configuration options. This endpoint allows you to provision remote desktop environments with user assignments, application configurations, branding customization, and access control settings. Perfect for setting up secure remote work environments. **Key Features:** - **User Management**: Assign users with specific permissions and access levels - **Application Assignment**: Pre-configure applications for user groups - **Concurrent User Control**: Set limits on simultaneous user sessions - **Access Types**: Configure virtual desktop or launchpad access modes - **Security Settings**: Enable two-factor authentication and admin controls **Configuration Options:** - **Virtual Access**: Full desktop environment with complete OS access - **Launchpad Access**: Application-specific access without full desktop - **Admin Privileges**: Designate administrative users for subscription management - **2FA Security**: Enforce two-factor authentication for enhanced security **Best Practices:** - Plan concurrent user limits based on expected usage patterns - Assign admin privileges to trusted users for subscription management - Enable 2FA for users accessing sensitive applications or data - Use descriptive subscription names for easy identification - Pre-assign applications based on user roles and requirements **Deployment Process:** This endpoint initiates asynchronous subscription creation. Monitor the subscription status to track deployment progress from 'creating' to 'deployed' state. - [List Organization Remote Desktop Subscriptions](https://docs.jotelulu.com/reference/listorganizationremotedesktopsubscriptions.md): Retrieve all remote desktop subscriptions associated with a specific organization. This endpoint provides comprehensive information about remote desktop subscriptions including their configuration, branding, user assignments, and deployment status. Essential for managing remote access infrastructure and user provisioning. **Use Cases:** - **Subscription Management**: View all remote desktop environments for an organization - **Resource Planning**: Monitor subscription usage and capacity planning - **User Access Audit**: Review user assignments and access permissions - **Billing Overview**: Track active subscriptions for cost management **Subscription Information:** - Subscription identifiers, names, and deployment status - User assignments and permission configurations - Branding customization (logos, colors, backgrounds) - Associated server subscription details - Creation and modification timestamps **Management Benefits:** - Centralized view of all remote desktop environments - Easy identification of subscription status and configuration - Streamlined user access management and auditing - Integration-ready data for administrative dashboards - [Assign Users to Remote Desktop](https://docs.jotelulu.com/reference/createinstanceusers.md): Assign existing organization users to a remote desktop instance with comprehensive access configuration. This endpoint allows you to provision users with specific access types, permissions, virtual resource configurations, and security settings. Perfect for user onboarding and access management in remote desktop environments. **Key Features:** - **Flexible Access Types**: Configure virtual desktop or launchpad access - **Permission Control**: Assign user or administrative privileges - **Virtual Resources**: Configure printer, drive, clipboard, and RDP access - **User Types**: Support for native, local, and domain users - **Security Settings**: Enable two-factor authentication **Access Configuration:** - **Virtual Desktop**: Full desktop environment with complete OS access - **Launchpad**: Application-specific access without full desktop - **Admin Privileges**: Administrative rights within the remote desktop - **2FA Security**: Enhanced security with two-factor authentication **Virtual Resource Options:** - **Virtual Printer**: Enable printing from remote desktop to local printers - **Virtual Drives**: Access local file system from remote environment - **Virtual Clipboard**: Clipboard sharing between local and remote systems - **RDP Access**: Remote Desktop Protocol connectivity configuration **User Type Configuration:** - **Native User**: Standard organization user with default authentication - **Local User**: Custom local system user with specified username - **Domain User**: Active Directory integrated user account **Best Practices:** - Assign appropriate permission levels based on user roles - Enable 2FA for users accessing sensitive data or applications - Configure virtual resources based on user requirements and security policies - Use descriptive usernames for local and domain users - Monitor synchronization status after user assignment - [Remove User from Remote Desktop](https://docs.jotelulu.com/reference/deleteremotedesktopuser.md): Remove a user from the remote desktop subscription and revoke their access. This endpoint permanently removes user access to the remote desktop environment, including all associated permissions, virtual resource access, and application assignments. Use with caution as this action cannot be undone. **Use Cases:** - **User Offboarding**: Remove access when users leave the organization - **Access Revocation**: Immediately revoke access for security reasons - **Role Changes**: Remove users who no longer require remote desktop access - **Subscription Cleanup**: Clean up unused or inactive user accounts - **Security Incidents**: Quickly remove compromised user accounts **Removal Impact:** - **Access Termination**: Immediate loss of remote desktop access - **Session Termination**: Active user sessions may be terminated - **Application Access**: Loss of access to assigned applications - **Virtual Resources**: Removal of printer, drive, and clipboard access - **Data Persistence**: User data within the remote desktop may be preserved **Important Considerations:** - This action is irreversible and requires re-assignment to restore access - Active user sessions may be terminated immediately - Consider backing up user data before removal if necessary - Notify users before removing access to avoid disruption - Review application assignments that may be affected **Security Notes:** - Use this endpoint for immediate access revocation in security incidents - Monitor for any remaining active sessions after user removal - Audit user removal actions for compliance and security tracking - [List Remote Desktop Users](https://docs.jotelulu.com/reference/listinstanceusers.md): Retrieve all users assigned to a specific remote desktop subscription. This endpoint provides comprehensive information about users including their access permissions, connection types, virtual resource configurations, and synchronization status. Essential for user management and access auditing. **Use Cases:** - **User Management**: View all users assigned to a remote desktop environment - **Access Auditing**: Review user permissions and access configurations - **Resource Monitoring**: Check virtual resource assignments per user - **Security Review**: Audit 2FA settings and connection types - **Synchronization Status**: Monitor user data synchronization status **User Information:** - User identifiers and organization associations - Connection types (virtual desktop vs launchpad) - Permission levels (user vs admin) - Virtual resource access (printer, drives, clipboard, RDP) - Security settings (2FA status) - Synchronization status and instance associations **Access Control Details:** - **Connection Types**: Virtual desktop for full access, launchpad for app-specific access - **Permissions**: User-level or administrative privileges - **Virtual Resources**: Granular control over printer, drive, and clipboard access - **Security**: Two-factor authentication requirements and RDP access control - [Update Remote Desktop User](https://docs.jotelulu.com/reference/updateinstanceuser.md): Update an existing remote desktop user's configuration and access settings. This endpoint allows you to modify user access types, permissions, virtual resource configurations, and security settings. Useful for adapting user access as roles and requirements change over time. **Configurable Settings:** - **Connection Type**: Switch between virtual desktop and launchpad access - **Permissions**: Modify user or administrative privileges - **Virtual Resources**: Update printer, drive, clipboard, and RDP access - **User Type**: Change between native, local, and subscription user types - **Security**: Enable or disable two-factor authentication **Update Scenarios:** - **Role Changes**: Update permissions when user roles change - **Access Modifications**: Adjust virtual resource access based on requirements - **Security Updates**: Enable/disable 2FA based on security policies - **Connection Updates**: Switch between virtual desktop and launchpad modes - **Username Changes**: Update usernames for local and subscription users **Best Practices:** - Review current user configuration before making changes - Test access after updates to ensure proper functionality - Document permission changes for audit and compliance - Consider security implications when modifying access levels - Monitor user synchronization status after updates - [Retry Failed Instance Deployment](https://docs.jotelulu.com/reference/retryfailedinstance.md): Retry the deployment of a failed remote desktop server instance. This endpoint allows you to recover from failed instance deployments by initiating a retry operation. Useful for handling transient deployment failures, resource availability issues, or configuration problems that can be resolved automatically. **Use Cases:** - **Deployment Recovery**: Recover from transient deployment failures - **Resource Retry**: Retry when resources become available after initial failure - **Configuration Fix**: Retry after resolving configuration issues - **Automated Recovery**: Integrate with monitoring systems for automatic retry - **Incident Response**: Quickly recover from deployment issues **Retry Scenarios:** - **Resource Constraints**: Retry when compute resources become available - **Network Issues**: Recover from temporary network connectivity problems - **Configuration Errors**: Retry after fixing configuration issues - **Service Dependencies**: Retry when dependent services become available **Best Practices:** - Monitor instance status before initiating retry operations - Investigate root cause of failure before retrying - Implement retry limits to avoid infinite retry loops - Log retry attempts for audit and troubleshooting purposes - Consider exponential backoff for automated retry systems **Operation Details:** This endpoint initiates an asynchronous retry operation. Monitor the instance status to track retry progress and eventual success or failure. - [Create Firewall Inbound Rule](https://docs.jotelulu.com/reference/createfirewallinboundrule.md): Create a new inbound firewall rule to allow specific traffic to reach instances within an isolated network. This endpoint allows you to configure network security by creating rules that permit inbound traffic based on protocol, ports, and source IP addresses. Essential for enabling secure access to services while maintaining network security. **Protocol Support:** - **TCP/UDP Rules**: Configure port forwarding with public-to-private port mapping - **ICMP Rules**: Allow specific ICMP types and codes for network diagnostics **Key Features:** - **Port Forwarding**: Map public ports to private instance ports for TCP/UDP - **Source IP Control**: Restrict access to specific IP addresses or ranges - **Protocol Flexibility**: Support for TCP, UDP, and ICMP protocols - **Instance Targeting**: Direct traffic to specific network interface IPs **Security Best Practices:** - Use specific source IP ranges instead of 0.0.0.0/0 when possible - Configure only necessary ports and protocols - Use non-standard ports for enhanced security - Regularly review and audit firewall rules **Rule Requirements:** - **TCP/UDP**: Requires public port, private port, and target NIC IP - **ICMP**: Requires ICMP type and code specifications - **All Protocols**: Requires source IP address or range - [Delete ICMP Firewall Rule](https://docs.jotelulu.com/reference/deletefirewallinboundruleicmp.md): Delete an ICMP firewall inbound rule from the network security configuration. This endpoint removes ICMP-specific firewall rules that control ping, traceroute, and other ICMP-based network diagnostic traffic. Use this endpoint specifically for ICMP protocol rules. **Use Cases:** - **Security Hardening**: Remove unnecessary ICMP access for enhanced security - **Rule Cleanup**: Remove obsolete or unused ICMP rules - **Policy Changes**: Update network security policies by removing old rules - **Incident Response**: Quickly block ICMP traffic during security incidents **Important Notes:** - This endpoint is specifically for ICMP rules only - Rule deletion is immediate and cannot be undone - Verify rule ID before deletion to avoid removing wrong rules - Consider impact on network monitoring and diagnostics **Security Impact:** - Removing ICMP rules may affect network monitoring tools - Ping and traceroute functionality may be impacted - Network diagnostic capabilities may be reduced - [Delete TCP/UDP Firewall Rule](https://docs.jotelulu.com/reference/deletefirewallinboundruletcpudp.md): Delete a TCP or UDP firewall inbound rule and its associated port forwarding configuration. This endpoint removes port-based firewall rules that control TCP and UDP traffic to instances within the isolated network. Use this endpoint specifically for TCP and UDP protocol rules with port forwarding configurations. **Use Cases:** - **Service Decommissioning**: Remove rules for services no longer in use - **Security Hardening**: Close unnecessary ports and reduce attack surface - **Rule Management**: Clean up obsolete or conflicting port forwarding rules - **Incident Response**: Quickly block specific ports during security incidents **Important Notes:** - This endpoint is specifically for TCP and UDP rules with port forwarding - Both the firewall rule and port forwarding configuration are removed - Rule deletion is immediate and cannot be undone - Verify rule and port IDs before deletion **Service Impact:** - Services using the configured ports will become inaccessible - Existing connections may be terminated immediately - Load balancers and health checks may be affected - Consider maintenance windows for critical services **Security Considerations:** - Removing rules improves security by reducing exposed ports - Ensure alternative access methods are available if needed - Document rule changes for audit and compliance purposes - [List Network Firewall Rules](https://docs.jotelulu.com/reference/getfirewallinboundrules.md): Retrieve all inbound firewall rules configured for a specific isolated network. This endpoint provides comprehensive information about firewall rules including protocol configurations, port mappings, source IP restrictions, and rule identifiers. Essential for security auditing and network access management. **Use Cases:** - **Security Auditing**: Review all inbound access rules for compliance - **Network Troubleshooting**: Diagnose connectivity issues and rule conflicts - **Access Management**: Monitor and validate network access policies - **Compliance Reporting**: Generate security reports for regulatory requirements **Rule Information:** - Protocol-specific configurations (TCP, UDP, ICMP) - Port forwarding mappings and source IP restrictions - Rule identifiers for management and modification - Network interface associations and routing details **Security Management:** - Monitor firewall rule effectiveness and coverage - Plan additional security rules and access controls - Validate network security posture and policies - [List Server Subscription Instances](https://docs.jotelulu.com/reference/listserversubscriptioninstances.md): Retrieve all server instances associated with a specific subscription. This endpoint provides detailed information about server instances including their current state, configuration, deployment zone, and operational metadata. Essential for infrastructure monitoring and management. **Use Cases:** - **Infrastructure Dashboard**: Display all instances in a subscription - **Health Monitoring**: Check instance states and operational status - **Resource Inventory**: Track deployed instances and their configurations - **Capacity Planning**: Monitor instance usage across zones **Instance Information:** - Current operational state (creating, starting, running, stopped) - Deployment zone and resource configuration - Template and offering details - Creation and modification timestamps **Filtering & Monitoring:** - Filter by instance state for operational dashboards - Monitor instance distribution across availability zones - Track instance lifecycle and deployment history - [List Network Interface IP Addresses](https://docs.jotelulu.com/reference/listprivatenetworkipfromnic.md): Retrieve all IP addresses assigned to a specific network interface. This endpoint provides detailed information about IP address assignments on a network interface, including the specific IP addresses and their association with the network interface. Useful for IP address management and network auditing. **Use Cases:** - **IP Address Inventory**: Track all IP addresses assigned to interfaces - **Network Auditing**: Verify IP address assignments and usage - **Troubleshooting**: Diagnose IP address conflicts and connectivity issues - **Compliance Reporting**: Generate reports on IP address utilization **IP Address Information:** - Individual IP address assignments - Association with specific network interfaces - IP address assignment identifiers for management **Network Management:** - Monitor IP address utilization per interface - Plan IP address allocation and management - Validate network configuration and addressing schemes - [Create Instance Network Interface](https://docs.jotelulu.com/reference/createserverinstancenics.md): Create a new network interface (NIC) for a server instance and connect it to an isolated network. This endpoint allows you to add additional network interfaces to instances, enabling multi-homed configurations and network isolation. You can specify IP addresses and MAC addresses for precise network planning. **Key Features:** - **Network Isolation**: Connect instances to private isolated networks - **IP Address Control**: Assign specific IP addresses within network ranges - **MAC Address Management**: Set custom MAC addresses for interface identification - **Multi-homed Support**: Add multiple network interfaces to single instances **Best Practices:** - Ensure IP addresses are within the target network's CIDR range - Use unique MAC addresses to avoid conflicts - Plan network segmentation for security and performance - Document network interface purposes for operational clarity **Network Requirements:** - Target isolated network must exist and be accessible - IP address must be available within the network range - MAC address must be unique within the network segment - [List Instance Network Interfaces](https://docs.jotelulu.com/reference/listserverinstancenics.md): Retrieve all network interfaces (NICs) attached to a specific server instance. This endpoint provides comprehensive information about network interfaces including their IP addresses, MAC addresses, network associations, and default interface status. Essential for network configuration and troubleshooting. **Use Cases:** - **Network Configuration**: View current network interface setup - **IP Address Management**: Check assigned IP addresses and network associations - **Network Troubleshooting**: Diagnose connectivity issues and interface status - **Security Auditing**: Review network interface configurations for compliance **Interface Information:** - Network interface identifiers and MAC addresses - Associated isolated network connections - Primary IP address assignments - Default interface designation **Network Planning:** - Plan additional network interface requirements - Monitor network interface utilization - Validate network isolation and segmentation - [Create Isolated Network](https://docs.jotelulu.com/reference/createisolatednetwork.md): Create a new isolated private network within a subscription for secure instance communication. This endpoint allows you to create private networks with custom IP ranges, enabling network segmentation and secure communication between instances. Perfect for implementing multi-tier application architectures and security isolation. **Key Features:** - **Custom IP Ranges**: Define network ranges using standard CIDR notation - **Automatic Gateway**: Gateway IP is automatically configured within the network range - **Zone Deployment**: Networks are deployed within specific availability zones - **Security Isolation**: Complete isolation from other networks and the internet **Best Practices:** - Use RFC 1918 private IP ranges (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) - Plan network ranges to avoid conflicts with existing networks - Use descriptive names for easy identification and management - Consider future expansion when sizing network ranges **Network Requirements:** - Network address must be the first IP in the range - Gateway must be within the defined network range - Netmask must match the intended network size - Network range must not overlap with existing networks - [List Subscription Isolated Networks](https://docs.jotelulu.com/reference/listisolatednetworks.md): Retrieve all isolated networks associated with a specific subscription. This endpoint provides comprehensive information about private isolated networks including their CIDR configurations, gateway settings, and deployment zones. Essential for network planning and security architecture. **Use Cases:** - **Network Inventory**: View all private networks in a subscription - **Security Planning**: Review network isolation and segmentation - **IP Address Management**: Check network ranges and gateway configurations - **Multi-tier Architecture**: Plan network topology for application tiers **Network Information:** - Network identifiers and user-defined names - CIDR blocks and subnet configurations - Gateway IP addresses and netmask settings - Deployment zones and creation timestamps **Network Planning:** - Plan additional network segments for application isolation - Monitor network utilization and capacity - Validate network architecture and security boundaries - [Allocate Public IP](https://docs.jotelulu.com/reference/createsubscriptionpublicip.md): Allocate a new public IP address for a subscription and associate it with an isolated network. This endpoint allows you to request public IP addresses for internet connectivity, enabling inbound and outbound traffic routing through NAT configurations. Essential for services requiring external access or internet connectivity. **Key Features:** - **Internet Connectivity**: Enable external access to private network resources - **NAT Configuration**: Automatic configuration for Source NAT and Static NAT - **Network Association**: Link public IPs to specific isolated networks - **Zone-based Allocation**: Public IPs allocated within specific availability zones **Use Cases:** - **Web Services**: Provide internet access for web applications and APIs - **Remote Access**: Enable SSH, RDP, or VPN access to instances - **Load Balancing**: Configure public endpoints for load-balanced services - **Outbound Connectivity**: Enable instances to access external services and APIs **NAT Types:** - **Source NAT**: Enables outbound internet access from private instances - **Static NAT**: Provides dedicated inbound access to specific instances **Requirements:** - Target isolated network must exist within the subscription - Sufficient public IP quota must be available - Network must be deployed in a zone that supports public IP allocation - [List Subscription Public IPs](https://docs.jotelulu.com/reference/getsubscriptionpublicips.md): Retrieve all public IP addresses allocated to a specific subscription. This endpoint provides detailed information about public IP addresses including their NAT configurations, network associations, and deployment zones. Essential for managing internet connectivity and traffic routing. **Use Cases:** - **Internet Connectivity**: Monitor public IPs available for external access - **NAT Configuration**: Review Source NAT and Static NAT assignments - **Traffic Management**: Plan inbound and outbound traffic routing - **Security Auditing**: Audit public IP usage and exposure **Public IP Information:** - Assigned public IP addresses and identifiers - Associated isolated network connections - NAT configuration status (Source NAT, Static NAT) - Deployment zones and allocation details **Network Management:** - Monitor public IP utilization and availability - Plan additional public IP requirements - Configure NAT rules for traffic routing - [List Organization Server Subscriptions](https://docs.jotelulu.com/reference/listorganizationsubscriptions.md): Retrieve all server subscriptions associated with a specific organization. This endpoint provides a comprehensive list of server subscriptions, including their current status, creation dates, and configuration details. Essential for subscription management and billing oversight. **Use Cases:** - **Billing Dashboard**: Display all active server subscriptions for invoicing - **Resource Management**: Monitor server subscription usage and capacity - **Administrative Overview**: Get complete subscription inventory for an organization - **Cost Analysis**: Track subscription costs and usage patterns **Response Data:** - Subscription identifiers and names - Creation and modification timestamps - Current subscription status and configuration **Pagination:** This endpoint supports pagination for organizations with many subscriptions.