### Get Windows Hosting Detail Response Source: https://api.combell.com/v2/documentation Response sample for retrieving the details of a specific Windows hosting. Includes site bindings and MSSQL database names. ```json { "domain_name": "string", "servicepack_id": 0, "max_size": 0, "actual_size": 0, "ip": "string", "ip_type": "dedicated", "ftp_username": "string", "application_pool": { "runtime": "string", "pipeline_mode": "string", "installed_net_core_runtimes": [ "string" ] }, "sites": [ { "name": "string", "path": "string", "bindings": [ { "protocol": "string", "host_name": "string", "ip_address": "string", "port": 0, "cert_thumbprint": "string", "ssl_enabled": true } ] } ], "mssql_database_names": [ "string" ] } ``` -------------------------------- ### Get SSL Certificates Overview Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves an overview of SSL certificates, with options to skip a specified number of items. ```APIDOC ## GET /sslcertificates ### Description Provides an overview of SSL certificates. ### Method GET ### Endpoint /sslcertificates ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. ### Response #### Success Response (200) - **response** (array of SslCertificate) - An array containing SSL certificates. ``` -------------------------------- ### Get Available PHP Versions Source: https://api.combell.com/v2/documentation Retrieve a list of available PHP versions for a Linux hosting. This is useful for determining compatible versions. ```json [ { "version": "string" } ] ``` -------------------------------- ### Get Available PHP Versions Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves a list of available PHP versions for a given Linux hosting. ```APIDOC ## GET /linuxhostings/{domainName}/phpsettings/availableversions ### Description Retrieves a list of available PHP versions for a given Linux hosting. ### Method GET ### Endpoint /linuxhostings/{domainName}/phpsettings/availableversions ### Parameters #### Path Parameters - **domainName** (string) - Required - Linux hosting domain name. ### Response #### Success Response (200) - (array of PhpVersion) - A list of available PHP versions. #### Response Example { "example": "[\n {\n \"version\": \"7.4\"\n },\n {\n \"version\": \"8.0\"\n },\n {\n \"version\": \"8.1\"\n }\n]" } ``` -------------------------------- ### Linux Hosting Detail Source: https://api.combell.com/v2/documentation Get detailed information about a specific Linux hosting, including webspace usage, FTP details, and PHP version. ```json { "domain_name": "string", "servicepack_id": 0, "max_webspace_size": 0, "max_size": 0, "webspace_usage": 0, "actual_size": 0, "ip": "string", "ip_type": "dedicated", "ftp_enabled": true, "ftp_username": "string", "ssh_host": "string", "ssh_username": "string", "php_version": "string", "sites": [ { "name": "string", "path": "string", "host_headers": [ { "name": "string", "enabled": true } ], "ssl_enabled": true, "https_redirect_enabled": true, "http2_enabled": true } ], "mysql_database_names": [ "string" ] } ``` -------------------------------- ### Get Domains Overview Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves an overview of all domains associated with the account, with options for pagination. ```APIDOC ## GET /domains ### Description Retrieves an overview of domains. ### Method GET ### Endpoint /domains #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. ### Response #### Success Response (200) - **X-Paging-Skipped** (integer) - The number of results that have been skipped. - **X-Paging-Take** (integer) - 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** (integer) - The total number of results regardless of paging. - **content** (array) - An array of domain objects. - **items** (object) - Schema for each domain object. ``` -------------------------------- ### Get Windows Hosting Detail Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves detailed information about a specific Windows hosting by its domain name. ```APIDOC ## GET /windowshostings/{domainName} ### Description Retrieves the details of a specific Windows hosting. ### Method GET ### Endpoint /windowshostings/{domainName} ### Parameters #### Path Parameters - **domainName** (string) - Required - The Windows hosting domain name. ### Response #### Success Response (200) - **schema** - Refers to `#/components/schemas/WindowsHostingDetail` #### Response Example ```json { "id": 123, "domain_name": "example.com", "account_id": 456, "servicepack_id": 789, "creation_time": "2023-01-01T10:00:00Z", "status": "active", "webspace_id": 101, "database_id": 102, "ftp_user": "user@example.com", "ip_address": "192.168.1.1" } ``` ``` -------------------------------- ### Get Linux Hosting Detail Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves detailed information about a specific Linux hosting by its domain name. ```APIDOC ## GET /linuxhostings/{domainName} ### Description Retrieves detailed information about a specific Linux hosting by its domain name. ### Method GET ### Endpoint /linuxhostings/{domainName} ### Parameters #### Path Parameters - **domainName** (string) - Required - The Linux hosting domain name. ### Response #### Success Response (200) - (LinuxHostingDetail) - The detailed information of the Linux hosting. #### Response Example { "example": "{\n \"domain_name\": \"example.com\",\n \"webspace_name\": \"webspace1\",\n \"creation_date\": \"2023-01-01T10:00:00Z\",\n \"status\": \"active\",\n \"php_version\": \"8.1\",\n \"gzip_enabled\": true\n}" } ``` -------------------------------- ### Get Mailboxes Response Sample Source: https://api.combell.com/v2/documentation This is a sample JSON response for retrieving a list of mailboxes. It includes basic information for each mailbox such as name, max size, and actual size. ```json [ { "name": "string", "max_size": 0, "actual_size": 0 } ] ``` -------------------------------- ### ConfigureDomain Source: https://api.combell.com/v2/documentation/swagger-v2.json Configures the renewal state of a domain. This operation is subject to specific conditions regarding unpaid invoices and renewal start dates, and requires the finance role. ```APIDOC ## PUT /domains/{domainName}/renew ### Description Edits the domain renewal state. This is allowed if `can_toggle_renew` is true on the domain detail, there are no unpaid invoices for the domain, and the renewal won't start within 1 month. The requesting user must also have the finance role. ### Method PUT ### Endpoint /domains/{domainName}/renew ### Parameters #### Path Parameters - **domain_name** (string) - Required - The name of the domain to configure renewal for. ### Request Body - **EditDomainWillRenewRequest** (object) - Contains the domain renew information. ### Response #### Success Response (204) - No Content ``` -------------------------------- ### Get Mailboxes Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves a list of mailboxes, optionally filtered by domain name. ```APIDOC ## GET /mailboxes ### Description Gets your mailboxes. Currently only supports getting the mailboxes filtered by domain name. ### Method GET ### Endpoint /mailboxes ### Parameters #### Query Parameters - **domain_name** (string) - Optional - Obligated domain name for getting mailboxes. ### Response #### Success Response (200) - items (array) - List of Mailbox objects. ``` -------------------------------- ### List Windows Hostings Response Source: https://api.combell.com/v2/documentation Response sample for listing Windows hostings. Includes domain name and service pack ID. ```json [ { "domain_name": "string", "servicepack_id": 0 } ] ``` -------------------------------- ### Get Scheduled Task Detail Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves the details of a specific scheduled task. ```APIDOC ## GET /linuxhostings/{domain_name}/scheduledtasks/{scheduled_task_id} ### Description Retrieves the details of a specific scheduled task. ### Method GET ### Endpoint /linuxhostings/{domain_name}/scheduledtasks/{scheduled_task_id} ### Parameters #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. - **scheduled_task_id** (string) - Required - Id of the scheduled task. ### Response #### Success Response (200) - (ScheduledTask) - OK ``` -------------------------------- ### GET /accounts Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves an overview of accounts, with options to filter and paginate the results. ```APIDOC ## GET /accounts ### Description Retrieves an overview of accounts. This endpoint allows filtering by asset type and identifier, and supports pagination using skip and take parameters. ### Method GET ### Endpoint /v2/accounts ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. - **asset_type** (AssetType) - Optional - Filters the list, returning only accounts containing the specified asset type. - **identifier** (string) - Optional - Return only accounts, matching the specified identifier. ### Response #### Success Response (200) - **X-Paging-Skipped** (integer) - The number of results that have been skipped. - **X-Paging-Take** (integer) - 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** (integer) - The total number of results regardless of paging. - (Account[]) - A collection of Account objects. ``` -------------------------------- ### Sample Response for a Service Source: https://api.combell.com/v2/documentation This is a sample JSON response for a service, detailing its ID, identifier, service pack, and any associated addons. ```json { "id": 0, "identifier": "string", "servicepack": { "id": 0, "name": "string" }, "addons": [ { "id": 0, "name": "string" } ] } ``` -------------------------------- ### List Windows Hostings Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves an overview of Windows hostings. Supports pagination with skip and take parameters. ```APIDOC ## GET /windowshostings ### Description Retrieves an overview of Windows hostings. Supports pagination with skip and take parameters. ### Method GET ### Endpoint /windowshostings ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. ``` -------------------------------- ### Get Specific MySQL Database Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves details for a specific MySQL database by its name. ```APIDOC ## GET /mysqldatabases/{databaseName} ### Description Gets a specific mysql database. ### Method GET ### Endpoint /mysqldatabases/{databaseName} ### Parameters #### Path Parameters - **database_name** (string) - Required - The name of the database. ### Response #### Success Response (200) - **name** (string) - The name of the database. - **creation_date** (string) - The date and time the database was created. - **size_in_mb** (integer) - The size of the database in megabytes. #### Response Example ```json { "name": "specific_database_name", "creation_date": "2023-01-01T10:00:00Z", "size_in_mb": 100 } ``` ``` -------------------------------- ### Linux Hosting Account Creation Source: https://api.combell.com/v2/documentation/swagger-v2.json Defines the parameters required to create a Linux hosting account. ```APIDOC ## Linux Hosting Account Creation ### Description Represents the details needed to create a Linux hosting account. ### Properties - **domain_name** (string) - Domain name for the Linux hosting account. - **servicepack_id** (integer) - Id of the Linux hosting service package (format: int32). ``` -------------------------------- ### Get Scheduled Tasks Source: https://api.combell.com/v2/documentation Retrieves a list of all scheduled tasks for a given Linux hosting domain. ```APIDOC ## Get Scheduled Tasks ### Description Retrieves a list of all scheduled tasks for a given Linux hosting domain. ### Method GET ### Endpoint /linuxhostings/{domainName}/scheduledtasks ### Parameters #### Path Parameters - **domainName** (string) - Required - Linux hosting domain name. ### Response #### Success Response (200) - **id** (string) - **enabled** (boolean) - **cron_expression** (string) - **script_location** (string) ### Response Example ```json [ { "id": "string", "enabled": true, "cron_expression": "string", "script_location": "string" } ] ``` ``` -------------------------------- ### List Accounts Response Sample Source: https://api.combell.com/v2/documentation This is a sample JSON response when listing accounts. It includes the account ID, identifier, and service pack ID. ```json [ { "id": 0, "identifier": "string", "servicepack_id": 0 } ] ``` -------------------------------- ### Create Linux Hosting Subsite Source: https://api.combell.com/v2/documentation Add a subsite to a Linux hosting. Requires the subsite's domain name and the desired path. The path must pre-exist. ```json { "domain_name": "string", "path": "string" } ``` -------------------------------- ### Get Mailbox Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves details for a specific mailbox. Requires the mailbox name as a path parameter. ```APIDOC ## GET /mailboxes/{mailboxName} ### Description Retrieves details for a specific mailbox. ### Method GET ### Endpoint /mailboxes/{mailboxName} #### Path Parameters - **mailboxName** (string) - Required - The name of the mailbox to retrieve. ### Response #### Success Response (200) - **MailboxDetail** (object) - Contains the details of the mailbox. ``` -------------------------------- ### Get records Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves DNS records for a specified domain name. Supports filtering and pagination. ```APIDOC ## GET /dns/{domainName}/records ### Description Retrieves DNS records for a specified domain name. Supports filtering and pagination. ### Method GET ### Endpoint /dns/{domainName}/records #### Path Parameters - **domainName** (string) - Required - The domain name. #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. - **type** (string) - Optional - Filters records matching the type. Most other filters only apply when this filter is specified. - **record_name** (string) - Optional - Filters records matching the record name. This filter only applies to lookups of A, AAAA, CAA, CNAME, MX, TXT, SRV and TLSA records. - **service** (string) - Optional - Filters records for the service. This filter only applies to lookups of SRV records. ### Response #### Success Response (200) - **X-Paging-Skipped** (integer) - The number of results that have been skipped. - **X-Paging-Take** (integer) - 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** (integer) - The total number of results regardless of paging. - **DnsRecord** (array) - An array of DNS records. ``` -------------------------------- ### Create Account Request Sample Source: https://api.combell.com/v2/documentation This JSON payload is used to create a new account. It requires an identifier, service pack ID, and optionally an FTP password. ```json { "identifier": "string", "servicepack_id": 0, "ftp_password": "string" } ``` -------------------------------- ### Register Domain Nameservers Source: https://api.combell.com/v2/documentation Use this snippet to register nameservers for a domain. It requires the domain name and a list of nameservers. ```json { "domain_name": "string", "name_servers": [ "string" ] } ``` -------------------------------- ### Get Specific MySQL Database Response Source: https://api.combell.com/v2/documentation This is a sample response for retrieving details of a specific MySQL database. ```json { "name": "string", "hostname": "string", "user_count": 0, "max_size": 0, "actual_size": 0, "account_id": 0 } ``` -------------------------------- ### List MySQL Databases Response Source: https://api.combell.com/v2/documentation This is a sample response for listing all MySQL databases associated with an account. ```json [ { "name": "string", "hostname": "string", "user_count": 0, "max_size": 0, "actual_size": 0, "account_id": 0 } ] ``` -------------------------------- ### Get Scheduled Task Detail Source: https://api.combell.com/v2/documentation Retrieves the details of a specific scheduled task for a Linux hosting domain. ```APIDOC ## Get Scheduled Task Detail ### Description Retrieves the details of a specific scheduled task for a Linux hosting domain. ### Method GET ### Endpoint /linuxhostings/{domainName}/scheduledtasks/{scheduledTaskId} ### Parameters #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. - **scheduled_task_id** (string) - Required - ID of the scheduled task. ### Response #### Success Response (200) - **id** (string) - **enabled** (boolean) - **cron_expression** (string) - **script_location** (string) ### Response Example ```json { "id": "string", "enabled": true, "cron_expression": "string", "script_location": "string" } ``` ``` -------------------------------- ### Create Account Source: https://api.combell.com/v2/documentation Initiates the creation of a new account. This process involves background tasks and does not provide instant feedback on the creation status. ```APIDOC ## POST /accounts ### Description Creates a new account. This operation triggers a background process, and the status of the creation is not immediately available. ### Method POST ### Endpoint https://api.combell.com/v2/accounts ### Parameters #### Request Body - **identifier** (string) - Required - An identifier for the account. Should be a domain name for hosting accounts. - **servicepack_id** (integer) - Required - The servicepack id that defines the account. - **ftp_password** (string) - Optional - Ftp password for the account. Applies only if the servicepack contains hosting. Passwords must adhere to specific rules (8-20 characters, mix of letters and digits, at least one digit and one letter, no spaces or specific special characters). ### Request Example ```json { "identifier": "string", "servicepack_id": 0, "ftp_password": "string" } ``` ### Response #### Success Response (202) Accepted #### Error Response (400) Bad Request ### Response Example (400) ```json { "validation_errors": [ { "error_code": "string", "error_text": "string" } ] } ``` ``` -------------------------------- ### Get SSL Certificate Detail Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves the details of a specific SSL certificate using its SHA-1 fingerprint. ```APIDOC ## GET /sslcertificates/{sha1Fingerprint} ### Description Retrieves the details of a specific SSL certificate using its SHA-1 fingerprint. ### Method GET ### Endpoint /sslcertificates/{sha1Fingerprint} ### Parameters #### Path Parameters - **sha1_fingerprint** (string) - Required - The SHA-1 fingerprint of the certificate. ### Response #### Success Response (200) - (SslCertificateDetail) - The details of the SSL certificate. ``` -------------------------------- ### List Linux Hostings Source: https://api.combell.com/v2/documentation Retrieve a list of Linux hostings. This endpoint supports pagination with skip and take parameters. ```json [ { "domain_name": "string", "servicepack_id": 0 } ] ``` -------------------------------- ### Get SSH Keys Source: https://api.combell.com/v2/documentation Retrieves an overview of SSH keys, with options to skip and take a specific number of items. ```APIDOC ## GET /ssh ### Description Retrieves an overview of SSH keys, with options to skip and take a specific number of items. ### Method GET ### Endpoint https://api.combell.com/v2/ssh ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. ### Response #### Success Response (200) OK ### Response Example (200) ```json [ { "fingerprint": "string", "public_key": "string", "linux_hostings": [ "string" ] } ] ``` ``` -------------------------------- ### ConfigureHttp2 Source: https://api.combell.com/v2/documentation/swagger-v2.json Configures HTTP/2 for a specific site on a Linux hosting domain. SSL must be enabled on the site for HTTP/2 to function correctly. Requires a request body with HTTP/2 configuration details. ```APIDOC ## PUT /linuxhostings/{domainName}/sites/{siteName}/http2/configuration ### Description Configures HTTP/2 for a specific site on a Linux hosting domain. SSL must be enabled on the site for HTTP/2 to function correctly. ### Method PUT ### Endpoint /linuxhostings/{domainName}/sites/{siteName}/http2/configuration ### Parameters #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. - **site_name** (string) - Required - Site name where HTTP/2 should be configured. For HTTP/2 to work correctly, the site must have ssl enabled. #### Request Body - **Http2Configuration** (object) - Required - The request body for HTTP/2 configuration. ### Responses #### Success Response (204) No Content #### Error Response (400) Bad Request ``` -------------------------------- ### Get Domain Details Source: https://api.combell.com/v2/documentation Retrieves detailed information about a specific domain, including its name servers and registrant information. ```APIDOC ## GET /domains/{domainName} ### Description Retrieves detailed information about a specific domain, including its name servers and registrant information. ### Method GET ### Endpoint /domains/{domainName} ### Parameters #### Path Parameters - **domainName** (string) - Required - The domain name. ### Response #### Success Response (200) OK #### Response Example ```json { "domain_name": "string", "expiration_date": "2026-06-14T12:59:19Z", "will_renew": true, "name_servers": [ { "name": "string", "ip": "string" } ], "registrant": { "first_name": "string", "last_name": "string", "address": "string", "postal_code": "string", "city": "string", "country_code": "string", "email": "string", "fax": "string", "phone": "string", "language_code": "string", "company_name": "string", "enterprise_number": "string" }, "can_toggle_renew": true } ``` ``` -------------------------------- ### Create MySQL Database Source: https://api.combell.com/v2/documentation/swagger-v2.json Creates a new MySQL database on a specified account. The database name provided will be prefixed during provisioning. ```APIDOC ## POST /database/mysql ### Description Creates a new MySQL database. ### Method POST ### Endpoint /database/mysql ### Parameters #### Request Body - **database_name** (string) - Required - The name for the database. This will be prefixed during provisioning. - **account_id** (integer) - Required - The id of the account on which to create the database. - **password** (string) - Required - The password for the database user. Passwords must adhere to specific complexity rules (8-20 characters, mix of letters and digits, at least one digit and one letter, no spaces, and specific disallowed characters). ``` -------------------------------- ### List Windows Hostings Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves a list of all Windows hostings associated with the account. Supports pagination via query parameters. ```APIDOC ## GET /windowshostings ### Description Retrieves a list of all Windows hostings. This endpoint supports pagination. ### Method GET ### Endpoint /windowshostings ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of results to skip. - **take** (integer) - Optional - The number of results to take. ### Response #### Success Response (200) - **X-Paging-Skipped** (integer) - The number of results that have been skipped. - **X-Paging-Take** (integer) - 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** (integer) - The total number of results regardless of paging. #### Response Example ```json [ { "id": 123, "domain_name": "example.com", "account_id": 456, "servicepack_id": 789, "creation_time": "2023-01-01T10:00:00Z", "status": "active" } ] ``` ``` -------------------------------- ### Get SSL Certificate Request Detail Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves the details of a specific SSL certificate request using its ID. ```APIDOC ## GET /sslcertificaterequests/{id} ### Description Retrieves the details of a specific SSL certificate request. ### Method GET ### Endpoint /sslcertificaterequests/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the certificate request. ### Response #### Success Response (200) - **response** (SslCertificateRequestDetail) - The details of the SSL certificate request. #### See Other Response (303) - **Location** (string) - The location referring to a resource that replaced the original resource. #### Gone Response (410) - The resource existed in the past, but is no longer available. ``` -------------------------------- ### List Linux Hostings Source: https://api.combell.com/v2/documentation Retrieves a list of Linux hostings. Supports pagination using skip and take query parameters. ```APIDOC ## GET /linuxhostings ### Description Retrieves a list of Linux hostings. Supports pagination using skip and take query parameters. ### Method GET ### Endpoint https://api.combell.com/v2/linuxhostings ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. ### Response #### Success Response (200) - **domain_name** (string) - **servicepack_id** (integer) ``` -------------------------------- ### Get a specific account Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves the details of a specific account using its ID. This endpoint is part of the Accounts API. ```APIDOC ## GET /accounts/{accountId} ### Description Retrieves the details of a specific account. ### Method GET ### Endpoint /accounts/{accountId} #### Path Parameters - **accountId** (integer) - Required - The id of the account. ### Response #### Success Response (200) - **AccountDetail** (object) - Details of the account. ``` -------------------------------- ### Servicepacks Overview Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves an overview of available service packs. ```APIDOC ## GET /servicepacks ### Description Provides an overview of available service packs. ### Method GET ### Endpoint /servicepacks ### Response #### Success Response (200) - **array of Servicepack** - A list of available service packs. ``` -------------------------------- ### Get Mail Zone Source: https://api.combell.com/v2/documentation Retrieves the details of a specific mail zone, including its configuration for aliases, catch-all addresses, and anti-spam settings. ```APIDOC ## GET /mailzones/{domainName} ### Description Retrieves the details of a specific mail zone. ### Method GET ### Endpoint https://api.combell.com/v2/mailzones/{domainName} ### Parameters #### Path Parameters - **domain_name** (string) - Required - Mail zone domain name. ### Response #### Success Response (200) - **name** (string) - **enabled** (boolean) - **available_accounts** (array of objects) - **account_id** (integer) - **size** (integer) - **aliases** (array of objects) - **anti_spam** (object) - **catch_all** (object) - **smtp_domains** (array of objects) ### Response Example ```json { "name": "string", "enabled": true, "available_accounts": [ { "account_id": 0, "size": 0 } ], "aliases": [ { "email_address": "string", "destinations": [ "string" ] } ], "anti_spam": { "type": "none", "allowed_types": [ "none" ] }, "catch_all": { "email_addresses": [ "string" ] }, "smtp_domains": [ { "hostname": "string", "enabled": true } ] } ``` ``` -------------------------------- ### SSL Certificate Request Response Sample (200 OK) Source: https://api.combell.com/v2/documentation This is a sample JSON response for a successful SSL certificate request. ```json [ { "id": 0, "certificate_type": "standard", "validation_level": "domain_validated", "vendor": "sectigo", "common_name": "string", "order_code": "string" } ] ``` -------------------------------- ### Create Subsite Source: https://api.combell.com/v2/documentation Creates a subsite for a Linux hosting. Requires the domain name, subsite domain name, and the path for the subsite in the request body. The path must pre-exist. ```APIDOC ## POST /linuxhostings/{domainName}/subsites ### Description Creates a subsite for a Linux hosting. Requires the domain name, subsite domain name, and the path for the subsite in the request body. The path must pre-exist. ### Method POST ### Endpoint https://api.combell.com/v2/linuxhostings/{domainName}/subsites ### Parameters #### Path Parameters - **domainName** (string) - Required - The Linux hosting domain name. #### Request Body - **domain_name** (string) - Required - Subsite domain name (e.g. alias.be or subsite.site.be). - **path** (string) - Required - Folder location for the subsite (when empty we use /subsites/site (e.g. /subsites/subsite.site.be). The path MUST pre-exist on the server. It WILL NOT be created automatically. ``` -------------------------------- ### Get Mail Zone Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves the mail zone details for a given domain name. Requires the domain name as a path parameter. ```APIDOC ## GET /mailzones/{domainName} ### Description Retrieves the mail zone for a specified domain. ### Method GET ### Endpoint /mailzones/{domainName} #### Path Parameters - **domainName** (string) - Required - The domain name of the mail zone to retrieve. ### Response #### Success Response (200) - **MailZone** (object) - Contains the details of the mail zone. ``` -------------------------------- ### List Linux Hostings Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves a list of Linux hostings. Supports pagination and filtering. ```APIDOC ## GET /linuxhostings ### Description Retrieves a list of Linux hostings. Supports pagination and filtering. ### Method GET ### Endpoint /linuxhostings ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of results to skip. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. ### Response #### Success Response (200) - **X-Paging-Skipped** (integer) - The number of results that have been skipped. - **X-Paging-Take** (integer) - 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** (integer) - The total number of results regardless of paging. - (array of LinuxHosting) - A list of Linux hosting objects. #### Response Example { "example": "[\n {\n \"domain_name\": \"example.com\",\n \"webspace_name\": \"webspace1\",\n \"creation_date\": \"2023-01-01T10:00:00Z\",\n \"status\": \"active\"\n }\n]" } ``` -------------------------------- ### Get DNS Records Source: https://api.combell.com/v2/documentation Retrieves a list of DNS records for a specified domain name. Supports filtering by record type, name, and service. ```APIDOC ## GET /dns/{domainName}/records ### Description Retrieves a list of DNS records for a specified domain name. Supports filtering by record type, name, and service. ### Method GET ### Endpoint https://api.combell.com/v2/dns/{domainName}/records ### Parameters #### Path Parameters - **domain_name** (string) - Required - The domain name. #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. - **type** (string) - Optional - Filters records matching the type. Most other filters only apply when this filter is specified. - **record_name** (string) - Optional - Filters records matching the record name. This filter only applies to lookups of A, AAAA, CAA, CNAME, MX, TXT, SRV, ALIAS and TLSA records. - **service** (string) - Optional - Filters records for the service. This filter only applies to lookups of SRV records. ### Response #### Success Response (200) OK - **id** (string) - Description - **type** (string) - Description - **record_name** (string) - Description - **ttl** (integer) - Description - **content** (string) - Description - **priority** (integer) - Description - **service** (string) - Description - **weight** (integer) - Description - **target** (string) - Description - **protocol** (string) - Description - **port** (integer) - Description #### Response Example ```json [ { "id": "string", "type": "string", "record_name": "string", "ttl": 3600, "content": "string", "priority": 10, "service": "string", "weight": 0, "target": "string", "protocol": "TCP", "port": 0 } ] ``` ``` -------------------------------- ### Configure HTTP/2 Source: https://api.combell.com/v2/documentation Configures HTTP/2 settings for a specific site on a Linux hosting domain. Requires the domain name and site name as path parameters, and an enabled flag in the request body. SSL must be enabled for HTTP/2 to function. ```APIDOC ## Configure HTTP/2 ### Description Enables or disables HTTP/2 for a given site on a Linux hosting account. SSL must be enabled on the site for this feature to work. ### Method PUT ### Endpoint /linuxhostings/{domainName}/sites/{siteName}/http2/configuration ### Parameters #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. - **site_name** (string) - Required - Site name where HTTP/2 should be configured. For HTTP/2 to work correctly, the site must have ssl enabled. #### Request Body schema: application/json - **enabled** (boolean) - Required - Enable or disable HTTP/2. ### Request Example ```json { "enabled": true } ``` ### Responses #### Success Response (204) No Content #### Error Response (400) Bad Request ``` -------------------------------- ### Get Scheduled Tasks Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves an overview of scheduled tasks for a Linux hosting domain. These tasks are also manageable via the control panel. ```APIDOC ## GET /linuxhostings/{domainName}/scheduledtasks ### Description Retrieves an overview of scheduled tasks for a Linux hosting domain. These tasks are also manageable via the control panel. ### Method GET ### Endpoint /linuxhostings/{domainName}/scheduledtasks #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. ``` -------------------------------- ### Get Specific DNS Record Source: https://api.combell.com/v2/documentation/swagger-v2.json Retrieves details for a specific DNS record associated with a domain. Requires the domain name and the record ID. ```APIDOC ## GET /dns/{domainName}/records/{recordId} ### Description Retrieves details for a specific DNS record. ### Method GET ### Endpoint /dns/{domainName}/records/{recordId} #### Path Parameters - **domainName** (string) - Required - The domain name. - **recordId** (string) - Required - The id of the record. ### Response #### Success Response (200) - **schema** ($ref: "#/components/schemas/DnsRecord") - The DNS record details. ``` -------------------------------- ### Create a host header Source: https://api.combell.com/v2/documentation Creates a host header for a specific site on a Linux hosting domain. Requires the domain name and site name as path parameters, and a domain name in the request body. ```APIDOC ## Create a host header ### Description Adds a host header to a specified site within a Linux hosting environment. ### Method POST ### Endpoint /linuxhostings/{domainName}/sites/{siteName}/hostheaders ### Parameters #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. - **site_name** (string) - Required - Name of the site on the Linux hosting. #### Request Body schema: application/json - **domain_name** (string) - Required - Host header domain name (e.g. alias.be or alias.site.be). ### Request Example ```json { "domain_name": "string" } ``` ### Responses #### Success Response (201) Created ``` -------------------------------- ### Accounts API Source: https://api.combell.com/v2/documentation Provides endpoints for managing account resources, including retrieving an overview, creating new accounts, and getting details of specific accounts. ```APIDOC ## GET /accounts ### Description Retrieves an overview of accounts. ### Method GET ### Endpoint /accounts ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number for pagination. - **limit** (integer) - Optional - The number of items to return per page. ### Response #### Success Response (200) - **accounts** (array) - A list of account objects. - **id** (integer) - The unique identifier for the account. - **name** (string) - The name of the account. - **status** (string) - The current status of the account. ### Request Example GET /accounts?page=1&limit=10 ### Response Example { "accounts": [ { "id": 123, "name": "Example Account", "status": "active" } ] } ``` ```APIDOC ## POST /accounts ### Description Creates a new account. ### Method POST ### Endpoint /accounts ### Parameters #### Request Body - **name** (string) - Required - The name for the new account. - **email** (string) - Required - The email address for the new account. ### Request Example { "name": "New Account", "email": "new.account@example.com" } ### Response #### Success Response (201) - **id** (integer) - The unique identifier for the newly created account. - **name** (string) - The name of the new account. - **status** (string) - The status of the new account. #### Response Example { "id": 456, "name": "New Account", "status": "pending" } ``` ```APIDOC ## GET /accounts/{id} ### Description Retrieves details of a specific account. ### Method GET ### Endpoint /accounts/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the account to retrieve. ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the account. - **name** (string) - The name of the account. - **status** (string) - The current status of the account. - **created_at** (string) - The timestamp when the account was created. ### Response Example { "id": 123, "name": "Example Account", "status": "active", "created_at": "2023-10-27T10:00:00Z" } ``` -------------------------------- ### Configure FTP Source: https://api.combell.com/v2/documentation Configures FTP settings for a Linux hosting domain. Requires the domain name as a path parameter and an enabled flag in the request body. ```APIDOC ## Configure FTP ### Description Enables or disables the FTP service for a Linux hosting domain. ### Method PUT ### Endpoint /linuxhostings/{domainName}/ftp/configuration ### Parameters #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. #### Request Body schema: application/json - **enabled** (boolean) - Required - Enable or disable FTP. ### Request Example ```json { "enabled": true } ``` ### Responses #### Success Response (204) No Content #### Error Response (400) Bad Request ``` -------------------------------- ### Configure Let's Encrypt Source: https://api.combell.com/v2/documentation/swagger-v2.json Configures Let's Encrypt SSL certificates for a specific hostname within a Linux hosting domain. ```APIDOC ## PUT /linuxhostings/{domainName}/sslsettings/{hostname}/letsencrypt ### Description Configures Let's Encrypt SSL certificates for a specific hostname within a Linux hosting domain. ### Method PUT ### Endpoint /linuxhostings/{domainName}/sslsettings/{hostname}/letsencrypt #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. - **hostname** (string) - Required - Specific hostname. #### Request Body - **schema** (LetsEncryptConfig) - Required - Let's encrypt config. ``` -------------------------------- ### SSL Certificate Detail Response Sample (200 OK) Source: https://api.combell.com/v2/documentation This JSON response provides detailed information about a specific SSL certificate request. ```json { "id": 0, "certificate_type": "standard", "validation_level": "domain_validated", "vendor": "sectigo", "common_name": "string", "order_code": "string", "subject_alt_names": [ { "type": "dns", "value": "string" } ], "validations": [ { "dns_name": "string", "type": "dns", "auto_validated": true, "email_addresses": [ "string" ], "cname_validation_name": "string", "cname_validation_content": "string", "file_validation_url_http": "string", "file_validation_url_https": "string", "file_validation_content": [ "string" ] } ], "provider_portal_url": "string" } ``` -------------------------------- ### Configure SSH Source: https://api.combell.com/v2/documentation/swagger-v2.json Configures the SSH settings for a Linux hosting. ```APIDOC ## PUT /linuxhostings/{domainName}/ssh/configuration ### Description Configures the SSH settings for a Linux hosting. ### Method PUT ### Endpoint /linuxhostings/{domainName}/ssh/configuration ### Parameters #### Path Parameters - **domain_name** (string) - Required - Linux hosting domain name. ### Request Body - SshConfiguration object. ### Response #### Success Response (204) - No Content #### Error Response (400) - Bad Request ``` -------------------------------- ### Get SSL Certificate Requests Source: https://api.combell.com/v2/documentation Retrieves an overview of SSL certificate requests, with options to skip and take a specific number of items. Used for creating new SSL certificates. ```APIDOC ## GET /sslcertificaterequests ### Description Retrieves an overview of SSL certificate requests, with options to skip and take a specific number of items. Used for creating new SSL certificates. ### Method GET ### Endpoint https://api.combell.com/v2/sslcertificaterequests ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of items to skip in the resultset. - **take** (integer) - Optional - The number of items to return in the resultset. The returned count can be equal or less than this number. ### Response #### Success Response (200) OK ```