--- title: "GET /servers" method: GET path: "/servers" --- # GET /servers `GET /servers` ## Request - Base URL: `https://dev-cloud.acronis.com/api/dr/v2` - URL: `https://dev-cloud.acronis.com/api/dr/v2/servers` - Auth: OAuth 2 - Authorization code: `https://dev-cloud.acronis.com/api/2/idp/authorize` - Client credentials - Password - Token URL: `https://dev-cloud.acronis.com/api/2/idp/token` scopes: `dr_service::admin`, `dr::support_operator`, `protection::readonly` Fetches the list of cloud servers. ## Query parameters - `type` 'PRIMARY' | 'RECOVERY': Filters the cloud servers by type. - `recovery.resource_id` string: Filters the recovery servers by the original device resource ID. Multiple entries are accepted. - `limit` integer: Maximum number of items to fetch per page. Mutually exclusive with the 'before' and 'after' parameters. - `after` string: Token from the 'after' field in the previous response. It contains a cursor that points to the next page of the requested collection. Mutually exclusive with the 'limit' and 'before' parameters. If provided, all other query parameters will be ignored. - `before` string: Token from the 'before' field in the previous response. It contains a cursor that points to the previous page of the requested collection. Mutually exclusive with the 'limit' and 'after' parameters. If provided, all other query parameters will be ignored. ## Response `200` - object - `items` union[], required: List of the cloud servers. - union - object - `type` 'PRIMARY', required: Type of the cloud server. - `primary` object, required: Additional parameters of the primary server. - `vault_id` string, required: Generic object identifier. - `_links` union[]: Links and actions related to the primary server. - union - Item0: Link to the cloud server configuration page. The link must be opened in a web browser. - … - Item1: Link to the page with the remote console of the cloud server. The link must be opened in a web browser. - … - Item2: Link that fetches the list of recovery points that are available for the cloud server recovery and failover. - … - `_issues` Item01[]: Issues related to the primary server. - `link` 'DR_CLOUD_SERVER_REMOTE_CONSOLE_PAGE': Name of the affected link. - `domain` 'DisasterRecovery': Disaster Recovery domain. - `target` string, required: UUID of the cloud server on which the issue occurred. - `severity` 'ERROR', required: Severity of the issue. - `error` union, required - SiteNotReady: You cannot perform any operations because the DR site is being deployed or removed. - … - ServerNotReady: The operation is not applicable to cloud servers in this state. - … - `site_uuid` string, required: Universally unique object identifier. - `name` string, required: Name of the cloud server. - `created_at` string, date-time, required: Date and time when the cloud server was created. - `uuid` string, required: Universally unique object identifier. - `description` string, required: Description of the cloud server. - `status` 'CREATING' | 'DELETING' | 'FAILING_BACK' | 'FAILBACK_DATA_TRANSFER' | 'FAILBACK_SWITCHOVER' | 'FAILBACK_VALIDATION' | 'FAILOVER_PROD' | 'FAILOVER_TEST' | 'FAILOVER_TEST_AUTO' | 'FINALIZATION' | 'FINALIZATION_FAILED' | 'RESTORING_FROM_BACKUP' | 'POWERING_OFF' | 'POWERING_ON' | 'RECONFIGURING' | 'STAND_BY' | 'STARTING_FAILBACK' | 'STARTING_FAILBACK_DATA_TRANSFER_RESUME' | 'STARTING_FAILBACK_DATA_TRANSFER_STOP' | 'STARTING_FAILBACK_SWITCHOVER_BEGIN' | 'STARTING_FAILBACK_SWITCHOVER_COMPLETE' | 'STARTING_FAILBACK_COMMIT' | 'STARTING_FAILBACK_ROLLBACK' | 'STARTING_FAILOVER_PROD' | 'STARTING_FAILOVER_TEST' | 'STARTING_FAILOVER_TEST_AUTO' | 'STOPPING_FAILOVER' | 'STOPPING_RESTORE_FROM_BACKUP', required: List of available cloud server statuses. - `vm` object, required: Properties of the virtual machine. - `cpu` integer, required: Number of vCPU cores that will be allocated to the virtual machine. - `os` string: Information about the OS of the virtual machine. Not available if the status of the virtual machine is 'NOT_READY'. - `ram_mb` integer, required: Amount of RAM in mebibytes that will be allocated to the virtual machine. - `status` 'NOT_READY' | 'STARTED' | 'STOPPED' | 'SUSPENDED', required - `storage` object[]: Information about the disks that are configured for the virtual machine. Not available if the status of the virtual machine is 'NOT_READY'. - `id` string, required: Generic object identifier. - `protected` boolean, required: True if the disk cannot be removed. - `size_gb` integer, required: Size of the storage volume in gibibytes. - `public_ip` string, ipv4: Public IP address of the cloud server. Missing if the Public IP address setting of the server is not enabled. - `rpo` object: RPO and server status. - `ratio` number: Time since the last backup (in seconds) divided by the threshold (in seconds). Available only if there is a backup. - `status` 'OK' | 'WARNING' | 'ERROR' | 'CRITICAL', required: OK - compliant; warning - violates the threshold; error - violates the threshold more than 2x times; critical - violates the threshold more than 4x times. - `threshold_seconds` integer, required: Threshold for RPO status, in seconds. - `task_uuid` string: Universally unique object identifier. - object - `type` 'RECOVERY', required: Type of the cloud server. - `recovery` object, required: Additional parameters of recovery server. - `active_failover` object: Details of the failover that is in progress. Missing for servers in the STAND_BY state. - `archive_credentials_id` string: ID of the archive credentials of the backup that is used for the failover operation. Required for automated failback. Missing if failover was initiated from a non-encrypted archive. - `backup_uri` string, required: Universal URI identifier of the recovery point that is used for the failover operation. - `id` string, required: Unique identifier of the failover that is in progress. - `vault_id` string, required: Generic object identifier. - `automated_test_failover` union, required: Details of the automated test failover. All properties except the schedule are omitted if automated test failover is disabled for the server. - object: Automated test failover is disabled. - … - object: Automated test failover was performed at least one time. - … - object: Automated test failover is enabled but has not been performed yet. - … - `ip_mapped` string, ipv4: Optional mapping of the specified server IP in the production network to make the server accessible during test failover. - `resource_id` string, required: Identifier of the original device that is protected by the recovery server. - `test_failover` object: Details of the test failover. - `recovery_point` RecoveryPoint, required: Composite identifier of a recovery point. - … - `last_start` string, date-time, required: Date and time of the test failover. - `last_task_uuid` string, required: Universally unique object identifier. - `_links` union[]: Links and actions related to the recovery server. - union - Item0: Link to the cloud server configuration page. The link must be opened in a web browser. - … - Item1: Link to the page with the remote console of the cloud server. The link must be opened in a web browser. - … - Item2: Link that fetches the list of recovery points that are available for the cloud server recovery and failover. - … - object: Link used in a POST request to initiate a production failover of the cloud server. - … - object: Link to the POST request to start test failover for the cloud server. - … - object: Link to the POST request to stop failover for the cloud server. - … - `_issues` union[]: Issues related to the recovery server. - union: Describes a single issue (constraint violation). - Item01: Describes a single issue (constraint violation). - … - object: Describes a single issue (constraint violation). - … - object: Describes a single issue (constraint violation). - … - `site_uuid` string, required: Universally unique object identifier. - `name` string, required: Name of the cloud server. - `created_at` string, date-time, required: Date and time when the cloud server was created. - `uuid` string, required: Universally unique object identifier. - `description` string, required: Description of the cloud server. - `status` 'CREATING' | 'DELETING' | 'FAILING_BACK' | 'FAILBACK_DATA_TRANSFER' | 'FAILBACK_SWITCHOVER' | 'FAILBACK_VALIDATION' | 'FAILOVER_PROD' | 'FAILOVER_TEST' | 'FAILOVER_TEST_AUTO' | 'FINALIZATION' | 'FINALIZATION_FAILED' | 'RESTORING_FROM_BACKUP' | 'POWERING_OFF' | 'POWERING_ON' | 'RECONFIGURING' | 'STAND_BY' | 'STARTING_FAILBACK' | 'STARTING_FAILBACK_DATA_TRANSFER_RESUME' | 'STARTING_FAILBACK_DATA_TRANSFER_STOP' | 'STARTING_FAILBACK_SWITCHOVER_BEGIN' | 'STARTING_FAILBACK_SWITCHOVER_COMPLETE' | 'STARTING_FAILBACK_COMMIT' | 'STARTING_FAILBACK_ROLLBACK' | 'STARTING_FAILOVER_PROD' | 'STARTING_FAILOVER_TEST' | 'STARTING_FAILOVER_TEST_AUTO' | 'STOPPING_FAILOVER' | 'STOPPING_RESTORE_FROM_BACKUP', required: List of available cloud server statuses. - `vm` object, required: Properties of the virtual machine. - `cpu` integer, required: Number of vCPU cores that will be allocated to the virtual machine. - `os` string: Information about the OS of the virtual machine. Not available if the status of the virtual machine is 'NOT_READY'. - `ram_mb` integer, required: Amount of RAM in mebibytes that will be allocated to the virtual machine. - `status` 'NOT_READY' | 'STARTED' | 'STOPPED' | 'SUSPENDED', required - `storage` object[]: Information about the disks that are configured for the virtual machine. Not available if the status of the virtual machine is 'NOT_READY'. - `id` string, required: Generic object identifier. - `protected` boolean, required: True if the disk cannot be removed. - `size_gb` integer, required: Size of the storage volume in gibibytes. - `public_ip` string, ipv4: Public IP address of the cloud server. Missing if the Public IP address setting of the server is not enabled. - `rpo` object: RPO and server status. - `ratio` number: Time since the last backup (in seconds) divided by the threshold (in seconds). Available only if there is a backup. - `status` 'OK' | 'WARNING' | 'ERROR' | 'CRITICAL', required: OK - compliant; warning - violates the threshold; error - violates the threshold more than 2x times; critical - violates the threshold more than 4x times. - `threshold_seconds` integer, required: Threshold for RPO status, in seconds. - `task_uuid` string: Universally unique object identifier. - `paging` object: Response properties related to the pagination. - `count` integer, required: Number of items fetched for the current page. - `cursors` object - `after` string: Cursor that points to the next page with results, if available. - `before` string: Cursor that points to the previous page with results, if available. - `total` integer, required: Total amount of items to fetch. ## Other responses - `400`: The request could not be validated against the RAML schema. - `401`: The request was denied because the bearer access token was invalid or missing. - `403`: The request was denied because the bearer access token did not have the required privileges. - `404`: The requested resource was not found. - `429`: The response status code indicates that the service is overloaded and you must wait before the next request. - `500`: An internal server error occurred while processing the request. - `504`: Gateway time-out. --- [API](https://skmtc.dev/acronis/apis/disaster-recovery-api.md) - [All operations](https://skmtc.dev/acronis/apis/disaster-recovery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acronis/apis/disaster-recovery-api/revisions/dcf3d4b306cf?raw)