Z.com API Documentation

Identity Service

MethodURIDescription
GET / List API versions.
GET /v2.0 Show API verson details.
POST /v2.0/tokens Generates a Token

Account(Billing) Service

MethodURIDescription
GET / List API versions.
GET /v1 Show API verson details.
GET /v1/{tenant_id}/order-items List Ordered Items
GET /v1/{tenant_id}/order-items/{item_id} List All Details of Specific Item
GET /v1/{tenant_id}/product-items List Available Products
GET /v1/{tenant_id}/payment-history Show a Payment History
GET /v1/{tenant_id}/payment-summary Show a Payment Summary
GET /v1/{tenant_id}/billing-invoices List Invoices
GET /v1/{tenant_id}/billing-invoices/{invoice_id} Show Details of Invoice
GET /v1/{tenant_id}/notifications List Notifications
GET /v1/{tenant_id}/notifications/{notification_code} Show Details of Notification
PUT /v1/{tenant_id}/notifications/{notification_code} Change Read Status of Notification
GET /v1/{tenant_id}/object-storage/rrd/request Show Graph of Object Storage Usage State (Number of Request)
GET /v1/{tenant_id}/object-storage/rrd/size Show Graph of Object Storage Usage State (Volume of Use)

Compute Service

MethodURIDescription
GET / List API versions.
GET /v2 Show API verson details.
GET /v2/{tenant_id}/flavors List VM Plans
GET /v2/{tenant_id}/flavors/detail List VM Plans with Details
GET /v2/{tenant_id}/flavors/{flavor_id} List VM Plans with Details(Specific Item)
GET /v2/{tenant_id}/servers List VMs
GET /v2/{tenant_id}/servers/detail Show VM Details
GET /v2/{tenant_id}/servers/{server_id} Show VM Details (Specific Item)
POST /v2/{tenant_id}/servers Add VM
DELETE /v2/​{tenant_id}​/servers/​{server_id}​ Delete a VM
POST /v2/{tenant_id}​/servers/​{server_id}​/action Start a VM
POST /v2/{tenant_id}​/servers/​{server_id}​/action Restart a VM
POST /v2/{tenant_id}​/servers/​{server_id}​/action Forcibly shutdown VM
POST /v2/{tenant_id}​/servers/​{server_id}​/action Shutdown VM
POST /v2/{tenant_id}​/servers/​{server_id}​/action Reinstall OS
POST /v2/{tenant_id}​/servers/​{server_id}​/action Resize a VM
POST /v2/{tenant_id}​/servers/​{server_id}​/action Resize a VM(confirm)
POST /v2/{tenant_id}​/servers/​{server_id}​/action Resize a VM(revert)
POST /v2/{tenant_id}​/servers/​{server_id}​/action VNC Console
POST /v2/{tenant_id}​/servers/​{server_id}​/action Store an Image from Local Disk
POST /v2/{tenant_id}​/servers/​{server_id}​/action Change Setting of Storage Controller
POST /v2/{tenant_id}​/servers/​{server_id}​/action Change Setting of Network Adapter
POST /v2/{tenant_id}​/servers/​{server_id}​/action Change Setting of Video Device
POST /v2/{tenant_id}​/servers/​{server_id}​/action Change Key Map of Console
POST /v2/{tenant_id}​/servers/​{server_id}​/action Show an URL to web serial console(novaconsole)API
POST /v2/{tenant_id}​/servers/​{server_id}​/action Show an URL to web serial console(httpconsole)API
POST /v2/{tenant_id}​/servers/​{server_id}​/action​ Mount an ISO Image
POST /v2/{tenant_id}​/servers/​{server_id}​/action​ Unmount an ISO Image
GET /v2/{tenant_id}/servers/{server_id}/os-security-groups Show Status of Allocation of Security Group on Servers
GET /v2/​{tenant_id}​/os-keypairs List Key Pairs
GET /v2/​{tenant_id}​/os-keypairs/{keypair_name} Show Key Pair Details (Specific Item)
POST /v2/​{tenant_id}​/os-keypairs Add a Key Pair
DELETE /v2/​{tenant_id}​/os-keypairs/​{keypair_name}​ Delete a Key Pair
GET /v2/{tenant_id}/images List Images
GET /v2/{tenant_id}/images/detail Show an Image Details
GET /v2/{tenant_id}/images/{image_id} Show an Image Details(Specific Item)
GET /v2/​{tenant_id}​/servers/​{server_id}​/os-volume_attachments List Attached Volumes
GET /v2/​{tenant_id}​/servers/​{server_id}​/os-volume_attachments/​{attachment_id}​ Show a Details of Attached Volume (Specific Item)
POST /v2/​{tenant_id}​/servers/​{server_id}​/os-volume_attachments Attach Volume
DELETE /v2/​{tenant_id}​/servers/​{server_id}​/os-volume_attachments/​{attachment_id}​ Detach Volume
GET /v2/{tenant_id}​/servers/​{server_id}​/os-interface List Attached Ports
GET /v2/{tenant_id}​/servers/​{server_id}​/os-interface Show an Attached Port (Specific Item)
POST /v2/{tenant_id}​/servers/​{server_id}​/os-interface Attach a Port
DELETE /v2/​{tenant_id}​/servers/​{server_id}​/os-interface/​{attachment_id}​ Detach a Port
POST /v2/​{tenant_id}​/servers/​{server_id}​/metadata​ Update VM Metadata (Change Name Tag)
GET /v2/​{tenant_id}​/servers/​{server_id}​/metadata​ Show VM Metadata
GET /v2/​{tenant_id}​/servers/​{server_id}​/ips​ List Addresses Associated to VM
GET /v2/​{tenant_id}​/servers/​{server_id}​/ips/{network_label}​ List Addresses Associated to VM(for specific network)
GET /v2/​{tenant_id}​/servers/​{server_id}​/rrd/cpu​ Show Graph of VPS Usage State(CPU usage time)
GET /v2/​{tenant_id}​/servers/​{server_id}​/rrd/interface​ Show a Graph of VPS Usage Status (Interface Traffic)
GET /v2/​{tenant_id}​/servers/​{server_id}​/rrd/disk​ Show a Graph of VPS Usage Status (Disk I/O)
GET /v2/{tenant_id}/backup List Backups
GET /v2/{tenant_id}/backup/{backup_id} List Backups (specific backup ID)
POST /v2/{tenant_id}/backup Apply for Backup
DELETE /v2/{tenant_id}/backup/{backup_id} Cancel Backup Mode
POST /v2/{tenant_id}/backup/{backup_id}/action Restore Backup for Boot Disk
POST /v2/{tenant_id}/backup/{backup_id}/action Save Images of Boot and Additional Disk Backup
GET /v2/{tenant_id}​/iso-images List ISO Images
POST /v2/{tenant_id}​/iso-images Download an ISO Image

Block Storage Service

MethodURIDescription
GET / List API versions.
GET /v2 Show API verson details.
GET /v2/{tenant_id}/types List Volume Types
GET /v2/​{tenant_id}​/types/​{volume_type_id}​ Show Volume Type Details (Specific Item)
GET /v2/{tenant_id}/volumes List Volumes
GET /v2/{tenant_id}/volumes/detail List Volumes (detailed)
GET /v2/​{tenant_id}​/volumes/​{volume_id}​ List Volumes (detailed)(Specific Item)
POST /v2/{tenant_id}/volumes Create Volume
POST /v2/{tenant_id}/volumes Create Volume(specify the source of volume)
DELETE /v2/{tenant_id}/volumes/​{volume_id}​ Delete Volume
POST /v2/{tenant_id}/volumes/{volume_id}/action Store Images of Block Disk

Image Service

MethodURIDescription
GET / List API versions.
GET /v2/images List Images (glance)
GET /v2/images/{image_id} Show an Image Details(Specific Item)(glance)
GET /v2/schemas/images List container image schemas.
GET /v2/schemas/image List image schemas.
GET /v2/schemas/members Show image members schema.
GET /v2/schemas/member To show image member schema.
GET /v2/images/{image_id}/members List image members.
DELETE /v2/images/{image_id} Delete an Image
PUT /v2/quota Limit the Size of Image Storage
GET /v2/quota Show Size Limitation of Image Storage

Network Service

MethodURIDescription
GET / List API versions.
GET /v2.0 Show API verson details.
GET /v2.0/networks List Networks
GET /v2.0/networks/{network_id} Show Details of Network
POST /v2.0/networks Add a Network (for local net)
DELETE /v2.0/networks/{network_id} Delete a Network
GET /v2.0/ports List Ports
GET /v2.0/ports/{port_id} Show Details of Ports
POST /v2.0/ports/ Add a Port
PUT /v2.0/ports/{port_id} Update a Port/Allocate a Security Group
DELETE /v2.0/ports/{port_id} Delete a Port
GET /v2.0/subnets List Subnets
GET /v2.0/subnets/{subnet_id} Show Details of Subnet
POST /v2.0/subnets Create Subnet (for local net)
POST /v2.0/allocateips Create Subnet (for additional IP)
POST /v2.0/lb/subnets Allocate Subnet (for LB)
DELETE /v2.0/subnets/{subnet_id} Delete a Subnet
GET /v2.0/lb/pools List Pools
GET /v2.0/lb/pools/{pool_id} Show Details of a Pool
POST /v2.0/lb/pools Add a Pool (specify a balancer)
PUT /v2.0/lb/pools/{pool_id} Change a Pool (change balancer type)
DELETE /v2.0/lb/pools/{pool_id}  Delete a Pool
GET /v2.0/lb/vips List VIPs
GET /v2.0/lb/vips/{vip_id} Show Details of VIP
POST /v2.0/lb/vips Create a VIP
DELETE /v2.0/lb/vips/{vip_id} Delete a VIP
GET /v2.0/lb/members Update a Update a Delete a Delete a REAL(member)List of
GET /v2.0/lb/members/{member_id} Show Details of Update a Update a Delete a Delete a REAL(member)
POST /v2.0/lb/members Add a Update a Update a Delete a Delete a REAL(member)
PUT /v2.0/lb/members/{member_id} Update a Update a Delete a Delete a REAL(member)
DELETE /v2.0/lb/members/{member_id} Delete a Update a Update a Delete a Delete a REAL(member)
GET /v2.0/lb/health_monitors List Health Monitors
GET /v2.0/lb/health_monitors/{health_monitor_id} Show Details of Health Monitors
POST /v2.0/lb/health_monitors Create a Health Monitors
PUT /v2.0/lb/health_monitors/{health_monitor_id} Change a Health Monitor
DELETE /v2.0/lb/health_monitors/{health_monitor_id}  Delete a Health Monitor
POST /v2.0/lb/pools/​{pool_id}​/health_monitors Associate Health Monitors with a Pool
DELETE /v2.0/lb/pools/{pool_id}/health_monitors/{health_monitor_id} Dissociate Health Monitors with a Pool
GET /v2.0/security-groups security groupList of
GET /v2.0/security-groups/{security_group_id} Show Details of Security Group
POST /v2.0/security-groups Create Security Group
PUT /v2.0/security-groups/{security_group_id} Update Security Group
DELETE /v2.0/security-groups/{security_group_id} Delete Security Group
GET /v2.0/security-group-rules List Rules of Security Groups
GET /v2.0/security-group-rules/{rules-security-groups-id} Show Details of Rules of Security Groups
POST /v2.0/security-group-rules Create a Rule of Security Group
DELETE /v2.0/security-group-rules/{rules-security-groups-id} Delete a Rule of Security Group

Object Storage Service

MethodURIDescription
GET /v1/zc_{account} Show Account Information
POST /v1/zc_{account} Setting Account Quota
GET /v1/zc_{account}/{container} Show Details of Container
PUT /v1/zc_{account}/{container} Create a Container
DELETE /v1/zc_{account}/{container} Delete a Container
GET /v1/zc_{account}/{container}/{object} Show Details of Object
PUT /v1/zc_{account}/{container}/{object} Upload Objects
PUT /v1/zc_{account}/{container}/{object} To download objects
COPY /v1/zc_{account}/{container}/{object} Copy Objects
DELETE /v1/zc_{account}/{container}/{object} Delete Objects
PUT /v1/zc_{account}/{container}/{object} dynamic large objects
PUT /v1/zc_{account}/{container}/{object} static Large Object
PUT /v1/zc_{account}/{container} object versioning
POST /v1/zc_{account}/{container}/{object} schedule objects for deletio
POST /v1/zc_{account} temporary url middleware
POST /v1/zc_{account}/{container} web publishing

Database Hosting Service

MethodURIDescription
GET / List API versions.
GET /v1 Show API verson details.
POST /v1/services Create Services
GET /v1/services List Database Services
GET /v1/services/(uuid:service_id) Show Details of Database Services
PUT /v1/services/(uuid:service_id) Update Database Services
DELETE /v1/services/(uuid:service_id) Delete Database Services
GET /v1/services/(uuid:service_id)/quotas Show Quota of Database
PUT /v1/services/(uuid:service_id)/quotas Change Quota of Database
PUT /v1/services/(uuid:service_id)/action Enable/Disable Backup
POST /v1/databases Create a Database
GET /v1/databases List Databases
GET /v1/databases/(uuid:database_id) Show Details of Database
PUT /v1/databases/(uuid:database_id) Update Databases
DELETE /v1/databases/(uuid:database_id) Delete Databases
POST /v1/databases/(uuid:database_id)/grant Create Grant Permissions to a Database
GET /v1/databases/(uuid:database_id)/grant List Authorities for Database
DELETE /v1/databases/(uuid:database_id)/grant/(uuid:user_id) Delete Authorities for Database
GET /v1/databases/(uuid:database_id)/backup List Backups
POST /v1/databases/(uuid:database_id)/action Restore
POST /v1/users Create Accounts
GET /v1/users List Database Accounts
GET /v1/users/(uuid:user_id) Show Account Information
PUT /v1/users/(uuid:user_id) Update Accounts
DELETE /v1/users/(uuid:user_id) Delete Accounts

DNS Service

MethodURIDescription
GET / List API versions.
GET /v1/domains/(uuid:domain_id)/servers Show Hosting Server Details of Domain
GET /v1/domains List Domains
POST /v1/domains Create Domains
DELETE /v1/domains/(uuid:domain_id) Delete Domains
GET /v1/domains/(uuid:domain_id) Show Domain Details
PUT /v1/domains/(uuid:domain_id) Update Domains
GET /v1/domains/(uuid:domain_id)/records List Records in a Domain
POST /v1/domains/(uuid:domain_id)/records Create Records
DELETE /v1/domains/(uuid:domain_id)/records/(uuid:record_id) Delete Records
GET /v1/domains/(uuid:domain_id)/records/(uuid:record_id) Show Record Details
PUT /v1/domains/(uuid:domain_id)/records/(uuid:record_id) Update Records
POST /v2/zones Import Zone Files
GET /v2/zones/(uuid:id) Export Zone Files

Mail Hosting Service

MethodURIDescription
GET / List API versions.
GET /v1 Show API verson details.
POST /v1/services Create Services
GET /v1/services List Database Services
GET /v1/services/(uuid:service_id) Show Details of Database Services
PUT /v1/services/(uuid:service_id) Update Database Services
PUT /v1/services/(uuid:service_id)/action Change Backup Settings (Enable/Disable)
DELETE /v1/services/(uuid:service_id) Delete Database Services
GET /v1/services/(uuid:service_id)/quotas Show Quota for Mail Service
PUT /v1/services/(uuid:service_id)/quotas Change Quota for Mail Service
POST /v1/domains Create Domains
GET /v1/domains List Domains
DELETE /v1/domains/(uuid:domain_id) Delete Domains
GET /v1/domains/(uuid:domain_id)/dedicatedip Show Dedicated IP of Domain
PUT /v1/domains/(uuid:domain_id)/action Allocate Dedicated IP for Domain (enable/disable)
POST /v1/emails Create Email Addresses
GET /v1/emails List Email Addresses
GET /v1/emails/(uuid:email_id) Show Email Details
DELETE /v1/emails/(uuid:email_id) Delete Email Addresses
PUT /v1/emails/(uuid:email_id)/password Change Password for Email Address
PUT /v1/emails/(uuid:email_id)/action Set Spam Filter Status (enable/disable)
PUT /v1/emails/(uuid:email_id)/action Change Email Forwarding Settings
GET /v1/emails/(uuid:email_id)/messages List Messages
GET /v1/emails/(uuid:email_id)/messages/(uuid:message_id) Show Message Details
GET /v1/emails/(uuid:email_id)/messages/(uuid:message_id)/attachments/(uuid:attachment_id) Get Attachments from Messages
DELETE /v1/emails/(uuid:email_id)/messages/(uuid:message_id) Delete a Message
POST /v1/emails/(uuid:email_id)/webhook Create a Webhook
GET /v1/emails/(uuid:email_id)/webhook List Webhooks
PUT /v1/emails/(uuid:email_id)/webhook Update Webhooks
DELETE /v1/emails/(uuid:email_id)/webhook Delete Webhooks
GET /v1/emails/(uuid:email_id)/whitelist Show Whitelist in Spam Filter
PUT /v1/emails/(uuid:email_id)/whitelist Update Whitelist in Spam Filter
GET /v1/emails/(uuid:email_id)/blacklist Show Blacklist in Spam Filter
PUT /v1/emails/(uuid:email_id)/blacklist Update Blacklist in Spam Filter
POST /v1/forwarding Create an Email Forwarding
GET /v1/forwarding List Email Forwarding Addresses
GET /v1/forwarding/(uuid:forwarding_id) Show Email Forwarding Rules
PUT /v1/forwarding/(uuid:forwarding_id) Change the Forwarding Address
DELETE /v1/forwarding/(uuid:forwarding_id) Disable Automatic Email Forwarding