API docs by Redocly

Melbicom API (1.2.6)

Download OpenAPI specification:Download

Simple Restful API to manage your services with Melbicom.

All requests expect an authentification 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.

Responses

Response samples

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

Retrieve a list of products

Retrieve a list of products based on the provided parameters.

query Parameters
productGroupId
Array of strings

Filter products by product group.

boolean or integer
Default: false

Whether to show configuration options.

Responses

Response samples

Content type
application/json
Example

services

Retrieve a list of services with Active or Suspended status for the client.

Retrieve a list of services

Fetches a list of all client services.

query Parameters
productName
string

Filter services by product name.

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

Filter services by product status.

Responses

Response samples

Content type
application/json
Example

Retrieve a specific service

Fetches details of a specific service by service ID.

path Parameters
serviceId
required
integer

The unique identifier of the service.

Responses

Response samples

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

Purge CDN cache for a resource

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

path Parameters
serviceId
required
integer

The unique identifier of the service.

Request Body schema: application/json
resource_name
required
string

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "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.

query Parameters
extension
string

Filter by domain extensions, separated by commas (e.g., .com,.net).

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

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.

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.

Responses

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.

Responses

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.

Responses

Response samples

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