API docs by Redocly

Melbicom API Documentation (1.19.1)

Download OpenAPI specification:

License: Proprietary

Simple RESTful API to manage your services with Melbicom.

All requests must include authentication token in the header with the following format "Authorization: Bearer TOKEN"

products

Retrieve a list of product that are available for purchase.

Retrieve a list of product groups

Fetches a list of all available product groups without any input parameters.

Authorizations:
bearerAuth

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/productgroups" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Retrieve a list of products

Retrieve a list of products based on the provided parameters.

Authorizations:
bearerAuth
query Parameters
productGroupId
integer

Filter products by a single product group id.

boolean or integer
Default: false

Whether to show configuration options.

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/products" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
Example
[
  • {
    }
]

services

Retrieve all client services (optionally filtered by status).

Retrieve a list of services

Fetches a list of all client services.

Authorizations:
bearerAuth
query Parameters
productName
string

Filter services by product name.

serviceStatus
string
Enum: "Active" "Suspended" "Pending" "Cancelled" "Terminated"

Filter services by product status.

serviceType
string
Example: serviceType=dedicated_server

Filter services by type — the same values returned in the serviceType response field (e.g. dedicated_server, vps, cdn, other). Unknown values return 422.

showServerDetails
boolean
Default: false

Include the dedicatedServer block (hardware and network details) for dedicated_server services. Default false.

limitstart
integer >= 0
Default: 0

Pagination offset — index of the first row to return (default 0). An offset past the end returns a 200 with an empty list.

limitnum
integer >= 1

Maximum number of records to return. If omitted, the service default applies. Values outside the accepted range return 422. List responses include X-Total-Count, X-Limit and X-Offset; Link provides available first, previous, next and last page URLs.

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/services" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a specific service

Fetches details of a specific service by service ID.

Authorizations:
bearerAuth
path Parameters
serviceId
required
integer

The unique identifier of the service.

query Parameters
showServerDetails
boolean
Default: false

Include the dedicatedServer block (hardware and network details) for dedicated_server services. Default false.

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/services/1001" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
{
  • "summary": "Example of retrieving a specific service detail",
  • "value": {
    }
}

Purge CDN cache for a resource or a specific resource path.

Purges the CDN cache for a specific resource or resource path URI across all CDN nodes.

Authorizations:
bearerAuth
path Parameters
serviceId
required
integer

The unique identifier of the service.

Request Body schema: application/json
required
resource_name
required
string <= 255 characters

The name of the CDN resource (within the specified service) to purge.

resource_url
string <= 2048 characters

Optional path within the CDN resource, for example temp/ilo2.bin. A leading slash is optional. End the path with / to purge a folder. Omit resource_url to purge the entire resource over both HTTP and HTTPS.

purge_scheme
string
Default: "both"
Enum: "both" "http" "https"

Which cached copies to remove: both (the default), or only the HTTP or only the HTTPS copy. Choosing http or https requires resource_url.

Responses

Request samples

Content type
application/json
Example
{
  • "resource_name": "cdn.resource.name"
}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "data": {
    }
}

domains

Retrieve a list of prices for domain registration, renewal and transfer.

Retrieve domain pricing information

Fetches pricing information for various domain operations, allowing filtering by extension, operation type, and currency. The numeric keys inside each currency object represent the domain operation duration in years.

Authorizations:
bearerAuth
query Parameters
extension
string

Filter by a single domain extension, exact match (e.g., .com).

operationType
string
Enum: "domainregister" "domaintransfer" "domainrenew"

Type of domain operation to retrieve pricing for.

currency
string
Enum: "EUR" "USD"

Currency in which to show pricing.

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/domain/tlds" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
Example
{
  • ".com": {
    },
  • ".net": {
    }
}

billing

Endpoints related to billing and balances.

Retrieve a list of client invoices

Fetches a list of invoices for the client, with options to filter by invoice ID, invoice number, status, and optionally include invoice items or payment transactions.

Authorizations:
bearerAuth
query Parameters
id
integer

Filter invoices by invoice ID.

invoicenum
string

Filter invoices by invoice number.

status
string
Enum: "Paid" "Unpaid" "Cancelled" "Refunded"

Filter invoices by status (e.g., Paid, Unpaid, Cancelled, Refunded).

showInvoiceItems
boolean
Default: false

Whether to include detailed invoice items in the response.

showTransactions
boolean
Default: false

Whether to include payment transactions in the response.

limitstart
integer >= 0
Default: 0

Pagination offset — index of the first invoice to return (default 0). An offset past the end returns a 200 with an empty list.

limitnum
integer >= 1

Maximum number of records to return. If omitted, the service default applies. Values outside the accepted range return 422. List responses include X-Total-Count, X-Limit and X-Offset; Link provides available first, previous, next and last page URLs.

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/billing/invoices" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Retrieve the current credit balance

Returns the current outstanding credit balance. The amount is expressed in the account's currency.

Authorizations:
bearerAuth

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/billing/creditbalance" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
{
  • "balance": "100.00",
  • "currency": "EUR"
}

utility

Utility endpoints for the client.

Retrieve API version

Provides the current version of the API without requiring any input parameters.

Authorizations:
bearerAuth

Responses

Request samples 

curl -X GET "https://api01.melbicom.net/api/version" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response samples

Content type
application/json
{
  • "success": "1",
  • "version": "1.4.0"
}