Category

Permission

Third-Party API

Authentication and

Authorization

Obtain public key modulus

HTTP: GET /janus/public-key

HTTP: GET /janus/v2/public-key

Verify the password

HTTP: POST /janus/authenticate

HTTP: POST /janus/v2/authenticate

Note: SCP version 6.11.3 (newly added v2) supports OAEP padding and must be used together with GET /janus/v2/public-key

Images

Obtain the list of images

HTTP: GET /janus/20180725/images

Obtain the list of service images

HTTP: GET /janus/20180725/service-images

Obtain the list of network device images

HTTP: GET /janus/20180725/vnetdev-images

Obtain the list of base images

HTTP: GET /janus/20180725/base-images

Obtain the list of base image copies

HTTP: GET

/janus/20180725/base-images/{image_id}/replicas

Create base image

HTTP: POST /janus/20180725/base-images

Edit base image

HTTP: PUT /janus/20180725/base-images/{image_id}

Delete base image

HTTP: DELETE

/janus/20180725/base-images/{image_id}

Synchronize base image copy

HTTP: POST

/janus/20180725/base-images/{image_id}/replicas/ac tions/sync

Create image from VM

HTTP: POST /janus/20180725/images/action

Create image

HTTP: POST /janus/20180725/images

Note: SCP 6.11.3 adds new parameters for creating OVA images: when container_format is set to ova and disk_format is set to hci, an OVA image will be created.

Upload image

HTTP: PUT /janus/20180725/images/{image_id}/upload

Upload ova image

HTTP: PUT /janus/20240725/images/ova/{image_id}/upload

Note:New API in SCP 6.11.3.To upload ova image.

Export built-in image (vma image)

HTTP: POST /janus/20240725/images/{image_id}/export

Note: New API in SCP 6.11.3.

Download image

HTTP: GET /janus/20240725/images/{image_id}/download

Note: New API in SCP 6.11.3. To download the built-in

Image(vma image), please call the export built-in image api first.

Custom

Attributes

Obtain the list of custom attributes

HTTP: GET /janus/20190725/custom-attributes

Obtain custom attribute details

HTTP: GET

/janus/20190725/custom-attributes/{attribute_id}

Create custom attribute

HTTP: POST /janus/20190725/custom-attributes

Edit custom attribute to bind

HTTP: PUT

/janus/20190725/custom-attributes/bindings

Edit custom attribute

HTTP: PUT

/janus/20190725/custom-attributes/{attribute_id}

Bulk delete custom attributes

HTTP: DELETE

/janus/20190725/custom-attributes/actions/bulk-delet e

Obtain the list of bound custom attributes

HTTP: GET

/janus/20190725/custom-attributes/bindings

Bulk bind with custom attributes

HTTP: POST /janus/20190725/custom-attributes/bindings/actions/bulk-create

Bulk unbind custom attributes

HTTP: POST /janus/20190725/custom-attributes/bindings/actions/bulk-delete

Network

Obtain the list of edges

HTTP: GET /janus/20180725/classic-bvswitches

Obtain the list of virtual

switches in the classic network

HTTP: GET /janus/20180725/classic-dvswitches

VMs

Obtain the list of VM groups

HTTP: GET /janus/20180725/server-groups

Obtain VM configuration

HTTP: GET /janus/20180725/servers/{server_id}

HTTP: GET /janus/20250725/servers/{server_id}

Note: The SCP&HCI 6.11.3 version (newly added 20250725) supports returning detailed information about hot-added disks and the disks' disk_id, applicable to the HotAdd transport mode. supports returning whether the VM is in restore mode (a mode specific to desktop VMs), so as to identify special‑type VMs.

Obtain the list of VMs

HTTP: GET /janus/20180725/servers

HTTP: GET /janus/20240725/servers

HTTP：GET /janus/20250725/servers

Note: The SCP&HCI 6.11.3 version (newly added 20250725)supports returning VM application type and whether the VM is in restore mode (a mode specific to desktop VMs), so as to identify special‑type VMs.

Obtain the list of VM snapshots

HTTP: GET

/janus/20180725/servers/{server_id}/snapshots

Obtain VM snapshot

HTTP: GET

/janus/20180725/servers/{server_id}/snapshots/{snapshot_id}

HTTP: GET /janus/20240725/servers/{server_id}/snapshots/{snapshot_id}

Note: The SCP&HCI 6.11.3 version (newly added 20240725): (1)supports returning the disks' disk_id, applicable to the HotAdd transport mode.

(2)Supports returning the crypto_fingerprint (crypto key fingerprint, returned only for encrypted VMs) to identify the encryption key used for backup data.

Start VM

HTTP: POST

/janus/20180725/servers/{server_id}/start

Shut down VM

HTTP: POST

/janus/20180725/servers/{server_id}/stop

Restart VM

HTTP: POST

/janus/20180725/servers/{server_id}/reboot

Delete VM

HTTP: DELETE /janus/20180725/servers/{server_id}

Allocate VM

HTTP: POST

/janus/20180725/servers/{server_id}/allocation

Create VM

HTTP: POST /janus/20180725/servers

HTTP: POST /janus/20241230/servers

Note: The SCP&HCI 6.11.3 version (newly added 20241230) :

The password field supports OAEP padding.

Reset VM password

HTTP: POST /janus/20240725/servers/{server_id}/server-password

Note: The SCP&HCI 6.11.3 version (newly added 20240725) :

The password field supports OAEP padding.

Update VM

HTTP: PUT /janus/20200725/servers/{server_id}

HTTP: PUT /janus/20200725/servers/{server_id}

Note: The SCP&HCI 6.11.3 version (newly added 20250725) :

(1)supports hot-adding linked clone disks of VM disks or disk snapshots to backup proxy VMs, applicable to the HotAdd transport mode.

(2)Supports setting backup of plaintext data (for encrypted VMs).

Retrieve the IP list of the VM network adapters.

HTTP: GET /janus/20240725/servers/network-ips

Note: The SCP 6.11.3 version adds a new API to retrieve the IP list of cloud server network interfaces.

Operate VM

HTTP: POST /janus/20180725/servers/action

Executing custom scripts/commands in the Guest OS of a VM

HTTP: POST /janus/20240725/servers/{server_id}/actions/invoke-script

HTTP: POST /janus/20241230/servers/{server_id}/actions/invoke-script

Note: New API in SCP 6.11.3. Usage: First call the "Executing custom scripts/commands in the Guest OS of a VM" API, then call the "Obtain the execution result of the script in the Guest OS of a VM" api to obtain the result.

Newly added 20241230 supports OAEP padding.

Obtain the execution result of the script in the Guest OS of a VM

HTTP: GET /janus/20240725/servers/exec-result/{text_id}

Note: New API in SCP 6.11.3.

Create VM using configuration

HTTP: POST /janus/20180725/servers/config

Restore VM to base image

HTTP: POST /janus/20240725/servers/{server_id}/recovery-baseimage

Note: Support for the API to restore cloud host system disk data to the base image was added in SCP version 6.11.3.

Obtain VM encryption key fingerprint

HTTP: GET /janus/20240725/servers/{server_id}/cryptographic-key-fingerprint

Note: Support for the API to obtain the cloud host encryption key fingerprint was added in SCP version 6.11.3.

Create VM disks

HTTP: POST /janus/20240725/servers/{server_id}/disks

HTTP: POST /janus/20250725/servers/{server_id}/disks

Note: The SCP&HCI 6.11.3 version (newly added 20250725) :

supports hot-adding linked clone disks of VM disks or disk snapshots to backup proxy VMs, applicable to the HotAdd transport mode.

VM disks action

HTTP: POST /janus/20240725/servers/{server_id}/disks/action

Obtain VM disk list

HTTP: GET /janus/20240725/servers/{server_id}/disks

HTTP: GET /janus/20250725/servers/{server_id}/disks

Note: The SCP&HCI 6.11.3 version (newly added 20250725) :

supports returning detailed information about hot-added disks and the disks' disk_id, applicable to the HotAdd transport mode.

Edit VM configuration details

HTTP: PUT

/janus/20180725/servers/{server_id}/config

VMs

Enable backup data merging for rapidly-recovered VMs

HTTP: POST

/janus/20180725/servers/{server_id}/merge-backup-data

Modify base image of the VM disk

HTTP: POST

/janus/20180725/servers/{server_id}/rebase-backing-file

Create VM snapshot

HTTP: POST /janus/20190725/servers/{server_id}/snapshots

HTTP: POST /janus/20240725/servers/{server_id}/snapshots

Note: The SCP&HCI 6.11.3 version (newly added 20240725) adds the input parameter "lifespan (expiration time)": If a third-party fails to clean up the snapshot due to an exception and the snapshot exists for longer than the lifespan, SCP will automatically clean up the snapshot.

Delete VM snapshot

HTTP: DELETE

/janus/20180725/servers/{server_id}/snapshots/{snapshot_id}

Bulk delete VM snapshots

HTTP: POST

/janus/20180725/servers/{server_id}/snapshots/action

Update VM snapshot

HTTP: PUT

/janus/20180725/servers/{server_id}/snapshots/{snapshot_id}

Recover VM from snapshot

HTTP: POST

/janus/20180725/servers/{server_id}/snapshots/{snapshot_id}/recovery

Resource Pools

Obtain the list of resource pools

HTTP: GET /janus/20180725/azs

Obtain resource pool overview

HTTP: GET /janus/20180725/azs/{az_id}

Obtain the list of physical machines

HTTP: GET /janus/20180725/hosts

HTTP: GET /janus/20190725/hosts

Obtain platform overview

HTTP: GET /janus/20180725/overview

Obtain datastore list

HTTP: GET /janus/20180725/storages

Mount NFS datastore

HTTP: POST /janus/20180725/storages/attachnfs

Unmount datastore

HTTP: DELETE /janus/20180725/storages/{storage_id}

System

Obtain SCP version

HTTP: GET /janus/20180725/platform

Obtain SCP version

HTTP: GET /janus/20180725/system/version

Clusters

Obtain cluster list

HTTP: GET /janus/20180725/clusters

Obtain cluster information

HTTP: GET /janus/20180725/clusters/{cluster_id}

Tasks

Query the list of tasks

HTTP: GET /janus/20180725/tasks

Query task details

HTTP: GET /janus/20180725/tasks/{task_id}

Backups

Obtain the list of backup policies

HTTP: GET /janus/20180725/backup-policies

Query backup policy

HTTP: GET

/janus/20180725/backup-policies/{policy_id}

Backup

Resources

Create backup resource

HTTP: POST /janus/20180725/backup-resources

Note: The SCP&HCI 6.11.3 version adds the input parameter "host_id": Backup resources preferentially run on this host.

Update backup resource

HTTP: PUT

/janus/20180725/backup-resources/{backup_resourc es_id}

Obtain backup resource

HTTP: GET

/janus/20180725/backup-resources/{backup_resources_id}

HTTP: GET

/janus/20250725/backup-resources/{backup_resources_id}

Note: The SCP&HCI 6.11.3 version (newly added 20250725) supports returning the host’s host_id where the backup resource runs.

Delete backup resource

HTTP: DELETE

/janus/20180725/backup-resources/{backup_resourc es_id}

Obtain backup resource overview

HTTP: GET /janus/20250725/backup-resources/overview

Note: Newly added in SCP&HCI 6.11.3.

Obtain the list of SDK versions and transport modes supported by backup resources

HTTP: GET

/janus/20180725/backup-resources/supports

VM CBT

Management

Obtain VM CBT information

HTTP: GET

/janus/20180725/servers/{server_id}/cbt/status

Update VM CBT

HTTP: PUT

/janus/20180725/servers/{server_id}/cbt/status

HTTP: PUT /janus/20240725/servers/{server_id}/cbt/status

Note: The SCP&HCI 6.11.3 version (newly added 20240725) supports enabling CBT for both the base image and current image of linked VM simultaneously.

Obtain CBT differential bitmap of VM disk

HTTP: GET

/janus/20180725/servers/{server_id}/cbt/changed-areas

HTTP: GET /janus/20240725/servers/{server_id}/cbt/changed-areas

Note: The SCP&HCI 6.11.3 version (newly added 20240725) supports querying the CBT bitmap of the base image, the CBT bitmap of the current image, and the merged CBT bitmap of the base image and current image for VM.

Cluster File

Management

Download file from cluster

HTTP: GET

/janus/20180725/clusters/{cluster_id}/files/download

Upload file to cluster

HTTP: POST

/janus/20180725/clusters/{cluster_id}/files/upload

Consistency Group Management

Create Consistency Group

HTTP: POST /janus/20180725/consistency-groups

Get Consistency Group Summary

HTTP: GET /janus/20180725/consistency-groups/summary

Create Consistency Group Snapshot

HTTP: POST /janus/20180725/consistency-groups/{group_id}/snapshots

Get Consistency Group Snapshot List

HTTP: GET /janus/20180725/consistency-groups/{group_id}/snapshots

Delete Consistency Group Snapshot

HTTP: DELETE /janus/20180725/consistency-groups/{group_id}/snapshots/{snap_id}