Converge Studios
Reference

API reference

Converge Cloud exposes a JSON API over HTTPS. Every service is a separate host under https://<service>.api3.convergecloud.com, region luzon, signed with TC3-HMAC-SHA256.

318
Actions
14
Services
2
Availability zones
Region luzon

Endpoints

How to sign a request

One host per service, all on POST /. The action goes in the X-TC-Action header and the version below in X-TC-Version — sending the wrong version returns InvalidAction, which is indistinguishable from an action that does not exist.

ServiceHostX-TC-VersionActions
asas.api3.convergecloud.com2018-04-1923
camcam.api3.convergecloud.com2019-01-1618
cbscbs.api3.convergecloud.com2017-03-1231
cdccdc.api3.convergecloud.com2020-12-146
cfscfs.api3.convergecloud.com2019-07-197
cfwcfw.api3.convergecloud.com2019-09-044
clbclb.api3.convergecloud.com2018-03-1723
cvmcvm.api3.convergecloud.com2017-03-1238
cwpcwp.api3.convergecloud.com2018-02-2846
monitormonitor.api3.convergecloud.com2018-07-2431
stssts.api3.convergecloud.com2018-08-132
tagtag.api3.convergecloud.com2018-08-1312
tketke.api3.convergecloud.com2018-05-2522
vpcvpc.api3.convergecloud.com2017-03-1255

Endpoints and region

Region
luzon

The only region on Converge Cloud is luzon. DescribeRegions returns exactly one entry. A request with any X-TC-Region value other than luzon fails with InternalError.

Zones
  • ncr-129 instance types
  • clz-121 instance types

Instance types are not identical across zones. Converge Cloud recommends verifying instance-type availability in the target zone with DescribeZoneInstanceConfigInfos prior to resource allocation.

Regions and availability zones

Services

Full capability matrix
asAuto Scaling23 actionscamCloud Access Management18 actionscbsCloud Block Storage31 actionscdcDedicated Cluster6 actionscfsCloud File Storage7 actionscfwCloud Firewall4 actionsclbCloud Load Balancer23 actionscvmCloud Virtual Machine38 actionscwpCloud Workload Protection46 actionsmonitorCloud Monitor31 actionsstsSecurity Token Service2 actionstagResource Tagging12 actionstkeKubernetes Engine22 actionsvpcVirtual Private Cloud55 actions

Object storage

Object storage is not one of the services above. It answers on its own domain, takes REST requests rather than actions, and is signed a different way — so it has its own reference.

Cloud Object Storageconvergecloudcos.comOpen the reference
Known traps for client implementations

Converge Cloud answers HTTP 200 for errors, returns Chinese error messages on some services and English on others, rejects a missing or incorrect X-TC-Region with InternalError, and has a load balancer that reports success while doing nothing. All 21 documented traps.