Public Api
Introduction This API allows resellers to manage their resources in a simple, programmatic way using HTTP requests. Conventions Requests The API supports…
Developer tools#openapi#hosting
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Introduction
This API allows resellers to manage their resources in a simple, programmatic way using HTTP requests.
Conventions
Requests
The API supports different methods depending on the required action.
| Method | Description |
| --- | --- |
| GET | Retrieve resources in a collection or get a single resource. Getters will never have any effect on the queried resources. |
| POST | Create a new resource in a collection. |
| PUT | Update an existing resource with its new representation. |
| DELETE | Delete an existing resource. |
HTTP status codes
The API will reply with different HTTP statuscodes:
| StatusCode | Description |
| --- | --- |
| 200 OK | The requests was processed and you receive data as a result. |
| 201 CREATED | The resource has been created. Either the Location header contains a link to the created resource, or links are being returned in the response body. The applied method will be indicated in the documentation. |
| 202 ACCEPTED | The request has been validated and accepted. Because we need to do some background processing prior to returning the result, we cannot send back a useful representation. |
| 204 NOCONTENT | The request has been processed, but no details can be returned. |
| 400 BADREQUEST | Your request is malformed. |
| 401 UNAUTHORIZED | You are not authorized. Follow the instructions in the Authorization documentation. |
| 403 FORBIDDEN | Access to the resource or operation is not allowed. |
| 404 NOTFOUND | The resource cannot be found. |
| 410 GONE | The resource is permanently no longer available. |
| 429 TOOMANYREQUESTS | The ratelimit has been exceeded. Please refer to the documentation on rate limiting for more details. |
| 500 INTERNALSERVERERROR | An error occurred during the processing of the request. The error is unexpected and most likely due to a bug in the api. |
In the event of a problem, the body of the response will usually contain an errorcode and errormessage.
In rare cases additional details about the error are reported.
Errorcodes 400-499 are considered to be client errors and indicate that there was an issue with the request.
We will not take any action besides monitoring.
Errorcodes 500-599 are considered to be server errors. The errors are monitored AND action will be taken to resolve the error.
Formatting
Snake casing is applied on resources and query parameters.
The API is strictly returning JSON. No other formats are supported.
Datetimes are returned in ISO-8601 format.
Pagination
Pagination is on by default on collections and is controlled by specifying skip and take parameters.
Skip indicates the number of results to skip and where to start the new take.
Take indicates the number of records to return. The returned number of items can be smaller than the requested take.
Paged results will have headers with useful information regarding the paging.
| Header | Description |
| --- | --- |
| X-Paging-Skipped | The number of results that have been skipped. |
| X-Paging-Take | The number of items in the current take. The number might differ from the requested take. It represents the actual number of items returned in the response. |
| X-Paging-TotalResults | The total number of results regardless of paging. |
Rate limiting
The number of requests per interval is limited. Detailed information on the rate limiting can be found in specific headers which will be sent on each request.
| Header | Description |
| --- | --- |
| X-RateLimit-Limit | The number of requests that can be made in a specific time interval. |
| X-RateLimit-Usage | The number of requests already made in the current time interval. |
| X-RateLimit-Remaining | The number of requests remaining until the reset. |
| X-RateLimit-Reset | The number of seconds until the reset. After the reset you are allowed to make as many requests as specified by the X-RateLimit-Limit header. |
| Retry-After | The number of seconds you have to wait until you can make new requests. This header is only present when the rate limit has been reached. It is identical to X-RateLimit-Reset. |
When the ratelimit has been reached, all requests will return with a HTTP statuscode 429 and ReasonPhrase 'Too many requests, retry later.'.
Authentication
The Api uses HMAC authentication.
Hash-based message authentication code (HMAC) is a mechanism for calculating a message authentication code involving a hash function in combination with a secret key.
Both the integrity and the authenticity of the message are verified this way.
Steps to generate the HMAC
- Get your api key and secret from your controlpanel.
It is absolutely vital that the secret is never exposed. Once the secret is out, anyone would be able to generate hmacs to impersonate you.
In case your secret is compromised, you can generate a new api key and secret on your controlpanel.
- Construct the input value for generating the hmac.
Concatenate:apikey, request method, path and querystring…
Endpoints 75
Accounts
- GETOverview of accounts
/accounts?skip=0&take=0&asset_type=domain&identifier=string - POSTCreate a new account
/accountsThe creation of an account requires some background processing. There is no instant feedback of the creation status. - GETGet a specific account
/accounts/:accountId?account_id=0
DNS records
- GETGet records
/dns/:domainName/records?domain_name=string&skip=0&take=0&type=string&record_name=string&service=string - POSTCreate a record
/dns/:domainName/records?domain_name=string - GETGet specific record
/dns/:domainName/records/:recordId?domain_name=string&record_id=string - PUTEdit a record
/dns/:domainName/records/:recordId?domain_name=string&record_id=string - DELETEDelete a record
/dns/:domainName/records/:recordId?domain_name=string&record_id=string
Domains
- GETOverviews of domains
/domains?skip=0&take=0 - POSTRegister a domain
/domains/registrationsRegisters an available domain.<br />Domain names with extension '.ca' are only available for registrants with country code 'CA'. - POSTTransfer a domain
/domains/transfersTransfers a domain with a transfer authorization code.<br />Domain names with extension '.ca' are only available for registrants with country code 'CA'. - GETDetails of a domain
/domains/:domainName?domain_name=string - PUTEdit domain name servers
/domains/:domainName/nameservers?domain_name=string - PUTEdit domain name renew state
/domains/:domainName/renew?domain_name=stringAllowed if can_toggle_renew is true on the domain detail:<br /><ul><li>If there are no unpaid invoices for the domain name anymore.</li><li>If the renewal…
Linux hostings
- GETOverview of linux hostings
/linuxhostings?skip=0&take=0 - GETLinux hosting detail
/linuxhostings/:domainName?domain_name=string - PUTConfigure FTP
/linuxhostings/:domainName/ftp/configuration?domain_name=string - PUTConfigure PHP APCu setting
/linuxhostings/:domainName/phpsettings/apcu?domain_name=string - GETGet the available PHP versions.
/linuxhostings/:domainName/phpsettings/availableversions?domain_name=string - PUTConfigure PHP memory limit
/linuxhostings/:domainName/phpsettings/memorylimit?domain_name=string - PUTChange the Linux hosting PHP version.
/linuxhostings/:domainName/phpsettings/version?domain_name=string - GETOverview of scheduled tasks
/linuxhostings/:domainName/scheduledtasks?domain_name=stringManage scheduled tasks which are also manageable via the control panel. - POSTAdd a scheduled task
/linuxhostings/:domainName/scheduledtasks?domain_name=string - GETGet scheduled task detail
/linuxhostings/:domainName/scheduledtasks/:scheduledTaskId?domain_name=string&scheduled_task_id=string - PUTConfigure a scheduled task
/linuxhostings/:domainName/scheduledtasks/:scheduledTaskId?domain_name=string&scheduled_task_id=string - DELETEDelete a scheduled task
/linuxhostings/:domainName/scheduledtasks/:scheduledTaskId?domain_name=string&scheduled_task_id=string - PUTEnable/disable GZIP compression
/linuxhostings/:domainName/settings/gzipcompression?domain_name=string - POSTCreate a host header
/linuxhostings/:domainName/sites/:siteName/hostheaders?domain_name=string&site_name=string - PUTConfigure HTTP/2
/linuxhostings/:domainName/sites/:siteName/http2/configuration?domain_name=string&site_name=string - PUTConfigure SSH
/linuxhostings/:domainName/ssh/configuration?domain_name=string - GETOverview of SSH keys
/linuxhostings/:domainName/ssh/keys?domain_name=string - POSTAdd a SSH key
/linuxhostings/:domainName/ssh/keys?domain_name=string - DELETEDelete a SSH key
/linuxhostings/:domainName/ssh/keys/:fingerprint?domain_name=string - PUTConfigure auto redirect
/linuxhostings/:domainName/sslsettings/:hostname/autoredirect?domain_name=string - PUTConfigure let's encrypt
/linuxhostings/:domainName/sslsettings/:hostname/letsencrypt?domain_name=string - POSTCreate a subsite
/linuxhostings/:domainName/subsites?domain_name=string - DELETEDelete a subsite
/linuxhostings/:domainName/subsites/:siteName?domain_name=string&site_name=string
Mailboxes
- GETGets your mailboxes.
/mailboxes?domain_name=stringCurrently only supports getting the mailboxes filtered by domain name. - POSTCreate a new mailbox.
/mailboxes - GETGet a specific mailbox
/mailboxes/:mailboxName?mailbox_name=string - DELETEDelete a mailbox
/mailboxes/:mailboxName?mailbox_name=string - PUTConfigure auto-forward for mailbox
/mailboxes/:mailboxName/autoforward?mailbox_name=string - PUTConfigure auto-reply for mailbox
/mailboxes/:mailboxName/autoreply?mailbox_name=string - PUTChange password for mailbox
/mailboxes/:mailboxName/password?mailbox_name=string
Mail zones
- GETGet the mail zone.
/mailzones/:domainName?domain_name=string - POSTCreate a new alias
/mailzones/:domainName/aliases?domain_name=string - PUTConfigure a alias
/mailzones/:domainName/aliases/:emailAddress?domain_name=string&email_address=string - DELETEDelete a alias
/mailzones/:domainName/aliases/:emailAddress?domain_name=string&email_address=string - PUTConfigure anti-spam for mail zone
/mailzones/:domainName/antispam?domain_name=string - POSTCreate a catch-all on the mail zone
/mailzones/:domainName/catchall?domain_name=string - DELETEDelete a catch-all on the mail zone
/mailzones/:domainName/catchall/:emailAddress?domain_name=string&email_address=string - POSTCreate an extra smtp domain
/mailzones/:domainName/smtpdomains?domain_name=string - PUTConfigure an extra smtp domain
/mailzones/:domainName/smtpdomains/:hostname?domain_name=string - DELETEDelete an extra smtp domain
/mailzones/:domainName/smtpdomains/:hostname?domain_name=string
MySql databases
- GETOverview of mysql databases
/mysqldatabases?skip=0&take=0 - POSTCreate a new mysql database
/mysqldatabases - GETGet a specific database
/mysqldatabases/:databaseName?database_name=string - DELETEDelete a mysql database
/mysqldatabases/:databaseName?database_name=string - GETOverview of mysql users
/mysqldatabases/:databaseName/users?database_name=string - POSTCreate a new mysql user
/mysqldatabases/:databaseName/users?database_name=stringThe creation of a new mysql user will result in a user with read_only rights. - DELETEDelete a mysql user
/mysqldatabases/:databaseName/users/:userName?database_name=string&user_name=stringThe deletion of a mysql user is allowed for users with read_only rights. - PUTChange password for mysql user
/mysqldatabases/:databaseName/users/:userName/password?database_name=string&user_name=string - PUTEnable/disable mysql user
/mysqldatabases/:databaseName/users/:userName/status?database_name=string&user_name=string
Provisioning jobs
- GETDetail of a provisioning job
/provisioningjobs/:jobId?job_id=3fa85f64-5717-4562-b3fc-2c963f66afa6Provisioning failures may occur. Contact support in the event of a failure or wait for error resolution.<br /> Do NOT retry provisioning until the job reports…
Servicepacks
- GETOverview of service packs
/servicepacks
SSH
- GETOverview of SSH keys
/ssh?skip=0&take=0
SSL certificate requests
- GETOverview of SSL certificate requests
/sslcertificaterequests?skip=0&take=0 - POSTAdd a SSL certificate request
/sslcertificaterequestsExecuting this method causes the purchase of a paying product.<br /> Log on to our website to see your current (renewal) prices or contact our Sales… - GETDetail of a SSL certificate request
/sslcertificaterequests/:id - PUTVerify the SSL certificate request domain validations
/sslcertificaterequests/:id
SSL certificates
- GETOverview of SSL certificates
/sslcertificates?skip=0&take=0 - GETDetail of a SSL certificate
/sslcertificates/:sha1Fingerprint?sha1_fingerprint=string - GETDownload a SSL certificate
/sslcertificates/:sha1Fingerprint/download?sha1_fingerprint=string&file_format=pfx&password=stringReturns the certifcate as binary data with the content-type and the filename information in the response headers.
Windows hostings
- GETOverview of windows hostings
/windowshostings?skip=0&take=0 - GETWindows hosting detail
/windowshostings/:domainName?domain_name=string
API details
- Authentication
- None declared in the description
- Operations
- 75 operations on 58 pathsGET 28PUT 22POST 15DELETE 10
- Main resources
- Linux hostings 23Mail zones 10MySql databases 9Mailboxes 7Domains 6DNS records 5SSL certificate requests 4Accounts 3SSL certificates 3Windows hostings 2
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
v2 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Public Api in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Public Api collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Overview of accounts” (GET /accounts?skip=0&take=0&asset_type=domain&identifier=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Public Api?
Introduction This API allows resellers to manage their resources in a simple, programmatic way using HTTP requests. Conventions Requests The API supports… It is listed under Developer tools and has 75 endpoints.
Who publishes the Public Api?
It is listed from Combell's public API description (an OpenAPI document), not published by Combell on Swastik Codes. Anyone who controls combell.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Public Api?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Public Api have?
75 operations on 58 paths (28 GET, 22 PUT, 15 POST, 10 DELETE). The largest groups are Linux hostings, Mail zones, MySql databases, Mailboxes.
Is forking the Public Api free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.