Cloud
36 routes. Paths are relative to https://api.intersink.com/v1. This group belongs to a feature in beta.
- GET/cloud/channels/{channelId}Cloud services, what is enabled, and whether ordering is live
- POST/cloud/channels/{channelId}/domainsRegister a domain: { domain, years, privacy, contact{…registrant} }
- PUT/cloud/channels/{channelId}/domains/{id}/auto-renewTurn auto-renew on or off: { on }
- GET/cloud/channels/{channelId}/domains/{id}/dnsDNS records of a domain
- POST/cloud/channels/{channelId}/domains/{id}/dnsAdd a record: { type, host, value, ttl?, priority? }
- POST/cloud/channels/{channelId}/domains/{id}/dns/deleteDelete a record: { type, host, value }
- GET/cloud/channels/{channelId}/domains/searchAvailability and our yearly price across popular endings: ?q=yourbrand
- GET/cloud/channels/{channelId}/domains/transferCan this domain move here, and at what price: ?domain=yourbrand.com
- POST/cloud/channels/{channelId}/domains/transferTransfer a domain in: { domain, auth_code, privacy?, contact{…registrant} } (paid now, adds a year)
- POST/cloud/channels/{channelId}/functionsDeploy a function: { name, code } (an ES module with export default { fetch })
- PUT/cloud/channels/{channelId}/functions/{id}Deploy new code: { code }
- DELETE/cloud/channels/{channelId}/functions/{id}Delete a function (billing stops today)
- GET/cloud/channels/{channelId}/functions/{id}/codeA function's current code and URL
- POST/cloud/channels/{channelId}/networksCreate a private network: { name, region }
- DELETE/cloud/channels/{channelId}/networks/{id}Delete a private network with no servers
- PUT/cloud/channels/{channelId}/networks/{id}/servers/{serverId}Attach a server: { on: true } (or detach: { on: false })
- GET/cloud/channels/{channelId}/offers/{service}Plans and our monthly prices per term for hosting, email or ssl
- POST/cloud/channels/{channelId}/orders/{product}Order hosting, email or SSL: { plan_id, months, domain, accounts?, contact? } (paid up front)
- POST/cloud/channels/{channelId}/panelA one-time sign-in link to the control panel (mailboxes, files, certificates)
- GET/cloud/channels/{channelId}/provider-catalogWhat the providers offer (read-only)
- GET/cloud/channels/{channelId}/resourcesThe channel's domains, servers… (?service=domains|vm)
- PUT/cloud/channels/{channelId}/services/{key}Enable or disable a service: { enabled }
- POST/cloud/channels/{channelId}/storageCreate a bucket: { name, region: uk|eu|us|us-west|asia }
- DELETE/cloud/channels/{channelId}/storage/{id}Delete an empty bucket (billing stops today)
- POST/cloud/channels/{channelId}/storage/{id}/keysNew S3 credentials for a bucket { label, read_only } (the secret is shown once)
- DELETE/cloud/channels/{channelId}/storage/{id}/keys/{keyId}Delete a bucket's credentials
- PUT/cloud/channels/{channelId}/storage/{id}/publicServe the bucket publicly from the CDN: { on }
- POST/cloud/channels/{channelId}/vmCreate a server: { name, plan, region, image, ssh_key }
- DELETE/cloud/channels/{channelId}/vm/{id}Cancel a server (billing stops today)
- POST/cloud/channels/{channelId}/vm/{id}/actions/{action}Start, stop or restart a server
- POST/cloud/channels/{channelId}/vm/{id}/refreshRefresh status and IP from the provider
- GET/cloud/channels/{channelId}/vm/{id}/snapshotsSnapshots of a server
- POST/cloud/channels/{channelId}/vm/{id}/snapshotsTake a snapshot: { name? }
- DELETE/cloud/channels/{channelId}/vm/{id}/snapshots/{sid}Delete a snapshot
- POST/cloud/channels/{channelId}/vm/{id}/snapshots/{sid}/restoreRestore a server to a snapshot (data after it is lost)
- GET/cloud/channels/{channelId}/vm/optionsPlans with our monthly prices, regions and OS images
Cloud services, what is enabled, and whether ordering is live
GET/cloud/channels/{channelId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Register a domain: { domain, years, privacy, contact{…registrant} }
POST/cloud/channels/{channelId}/domains
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Turn auto-renew on or off: { on }
PUT/cloud/channels/{channelId}/domains/{id}/auto-renew
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
DNS records of a domain
GET/cloud/channels/{channelId}/domains/{id}/dns
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Add a record: { type, host, value, ttl?, priority? }
POST/cloud/channels/{channelId}/domains/{id}/dns
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Delete a record: { type, host, value }
POST/cloud/channels/{channelId}/domains/{id}/dns/delete
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Availability and our yearly price across popular endings: ?q=yourbrand
GET/cloud/channels/{channelId}/domains/search
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| qrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Can this domain move here, and at what price: ?domain=yourbrand.com
GET/cloud/channels/{channelId}/domains/transfer
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| domainrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Transfer a domain in: { domain, auth_code, privacy?, contact{…registrant} } (paid now, adds a year)
POST/cloud/channels/{channelId}/domains/transfer
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Deploy a function: { name, code } (an ES module with export default { fetch })
POST/cloud/channels/{channelId}/functions
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Deploy new code: { code }
PUT/cloud/channels/{channelId}/functions/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Delete a function (billing stops today)
DELETE/cloud/channels/{channelId}/functions/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
A function's current code and URL
GET/cloud/channels/{channelId}/functions/{id}/code
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Create a private network: { name, region }
POST/cloud/channels/{channelId}/networks
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Delete a private network with no servers
DELETE/cloud/channels/{channelId}/networks/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Attach a server: { on: true } (or detach: { on: false })
PUT/cloud/channels/{channelId}/networks/{id}/servers/{serverId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path | |
| serverIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Plans and our monthly prices per term for hosting, email or ssl
GET/cloud/channels/{channelId}/offers/{service}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| servicerequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Order hosting, email or SSL: { plan_id, months, domain, accounts?, contact? } (paid up front)
POST/cloud/channels/{channelId}/orders/{product}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| productrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
A one-time sign-in link to the control panel (mailboxes, files, certificates)
POST/cloud/channels/{channelId}/panel
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
What the providers offer (read-only)
GET/cloud/channels/{channelId}/provider-catalog
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. The payload in data is of type object.
The channel's domains, servers… (?service=domains|vm)
GET/cloud/channels/{channelId}/resources
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| servicerequired | string, query |
Response
200. data is object[].
Enable or disable a service: { enabled }
PUT/cloud/channels/{channelId}/services/{key}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| keyrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Create a bucket: { name, region: uk|eu|us|us-west|asia }
POST/cloud/channels/{channelId}/storage
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Delete an empty bucket (billing stops today)
DELETE/cloud/channels/{channelId}/storage/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
New S3 credentials for a bucket { label, read_only } (the secret is shown once)
POST/cloud/channels/{channelId}/storage/{id}/keys
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Delete a bucket's credentials
DELETE/cloud/channels/{channelId}/storage/{id}/keys/{keyId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path | |
| keyIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Serve the bucket publicly from the CDN: { on }
PUT/cloud/channels/{channelId}/storage/{id}/public
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Create a server: { name, plan, region, image, ssh_key }
POST/cloud/channels/{channelId}/vm
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Cancel a server (billing stops today)
DELETE/cloud/channels/{channelId}/vm/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Start, stop or restart a server
POST/cloud/channels/{channelId}/vm/{id}/actions/{action}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path | |
| actionrequired | string, path |
Response
200. The payload in data is of type object.
Refresh status and IP from the provider
POST/cloud/channels/{channelId}/vm/{id}/refresh
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is of type object.
Snapshots of a server
GET/cloud/channels/{channelId}/vm/{id}/snapshots
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Take a snapshot: { name? }
POST/cloud/channels/{channelId}/vm/{id}/snapshots
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Delete a snapshot
DELETE/cloud/channels/{channelId}/vm/{id}/snapshots/{sid}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path | |
| sidrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Restore a server to a snapshot (data after it is lost)
POST/cloud/channels/{channelId}/vm/{id}/snapshots/{sid}/restore
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| idrequired | string, path | |
| sidrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Plans with our monthly prices, regions and OS images
GET/cloud/channels/{channelId}/vm/options
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.