Moniker Reseller/Registrar Domain Name API

https://www.moniker.com/api-docs
Admin
Moniker provides an API for resellers and registrars to programmatically manage domain names,...
Tokens:711,085
Snippets:3,539
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example GET Request (for documentation purposes)

Source: https://www.moniker.com/api-docs/index_setcurrency=EUR

An illustrative example of how a GET request might be structured. Note that POST is recommended for actual use.

```APIDOC
## GET /api/example

### Description
This is a hypothetical example endpoint to demonstrate the structure of API documentation. It's intended for illustrative purposes only.

### Method
GET

### Endpoint
`/api/example`

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your unique API key.
- **password** (string) - Required - The password associated with your API key.
- **filter** (string) - Optional - A filter criteria for the request.

### Request Example
`https://api.moniker.com/api/example?apiKey=YOUR_API_KEY&password=YOUR_PASSWORD&filter=example_value`

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request (e.g., "success").
- **data** (object) - Contains the response data.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "message": "Example data retrieved successfully."
  }
}
```
```

--------------------------------

### Create Web Hosting Endpoint

Source: https://www.moniker.com/api-docs/webhosting_create

This is an example of a GET request to create web hosting. It includes parameters for API key, domain, period, location, and hosting type. The response indicates the transaction status and details.

```HTTP
GET /Webhosting/Create?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz&period=1Y&location=london&type=economy-v2
```

```HTTP Response
transactid=100ab20692904e2a0ce5a44b73a87de1
status=SUCCESS
currency=USD
price=47.88
vat=9.58
product_0_price=47.88
product_0_status=SUCCESS
product_0_expirationdate=2023/03/14
product_0_hostingpassword=$@ohvPd26H
```

--------------------------------

### Get Account Price List (TEXT Example)

Source: https://www.moniker.com/api-docs/account_price_list_get_setcurrency=GBP

This example shows how to retrieve the account price list using the API in TEXT format. It includes required parameters and optional parameters for discount codes and price levels.

```HTTP
GET /Account/Price/List/Get?apikey=YOUR_API_KEY&password=YOUR_PASSWORD&discountcode=SUPER_COM&pricelevel=Basic

```

--------------------------------

### Get Account Price List (JSON Example)

Source: https://www.moniker.com/api-docs/account_price_list_get_setcurrency=GBP

This example demonstrates how to retrieve the account price list using the API in JSON format. It includes required parameters like apikey and password, and optional parameters for currency and response format.

```HTTP
GET /Account/Price/List/Get?apikey=YOUR_API_KEY&password=YOUR_PASSWORD&responseformat=JSON&currency=EUR

```

--------------------------------

### Get Account Price List with Version 4 (Example)

Source: https://www.moniker.com/api-docs/account_price_list_get_setcurrency=JPY

Demonstrates retrieving detailed pricing information, including price levels and discounts for different periods, using version 4 of the API. Requires API key and password.

```text
product_320_currency=EUR product_320_pricelevel=Basic product_320_type=.com product_320_operation=registration product_320_discount=SUPER_COM product_320_period_1=2.81 product_320_period_2=5.66 product_320_period_3=6.61 product_320_period_4=7.08 product_320_period_5=7.35 product_320_period_6=7.53 product_320_period_7=7.66 product_320_period_8=7.75 product_320_period_9=7.82 product_320_period_10=7.88 product_468_authinforequired=YES product_468_rgp=720 product_468_minperiod=1 product_468_maxperiod=10 product_468_inc=1 product_468_registration=52.33 product_468_renewal=52.33 product_468_transfer=52.33 product_468_restore=104.65 product_468_tld=za.com product_468_currency=EUR
```

--------------------------------

### Domain Registration Example

Source: https://www.moniker.com/api-docs/domain_trade_setcurrency=GBP

This example demonstrates how to register a domain using the Moniker API.

```APIDOC
## GET /Domain/Trade

### Description
This endpoint is used to register a domain with the provided details.

### Method
GET

### Endpoint
/Domain/Trade

### Parameters
#### Query Parameters
- **ApiKey** (string) - Required - Your Moniker API key.
- **Password** (string) - Required - Your Moniker API password.
- **Domain** (string) - Required - The domain name to register (e.g., example.eu).
- **registrant_firstname** (string) - Required - The first name of the registrant.
- **registrant_lastname** (string) - Required - The last name of the registrant.
- **registrant_organization** (string) - Optional - The organization of the registrant.
- **registrant_language** (string) - Optional - The language for the registrant (e.g., en).
- **registrant_email** (string) - Required - The email address of the registrant.
- **registrant_phonenumber** (string) - Required - The phone number of the registrant.
- **registrant_street** (string) - Required - The street address of the registrant.
- **registrant_street2** (string) - Optional - Additional street information.
- **registrant_city** (string) - Required - The city of the registrant.
- **registrant_countrycode** (string) - Required - The country code of the registrant (e.g., it).
- **registrant_postalcode** (string) - Required - The postal code of the registrant.

### Request Example
```
/Domain/Trade?ApiKey=monikerapi&Password=monikerpass&Domain=example.eu&registrant_firstname=TradeUserFirstName&registrant_lastname=TradeUserLastName&registrant_organization=Domain%20Transfer&registrant_language=en&registrant_email=user@example.com&registrant_phonenumber=%2B1.4532239043&registrant_street=street1&registrant_street2=street2&registrant_city=london&registrant_countrycode=it&registrant_postalcode=2222 
```

### Response
#### Success Response (200)
- **transactid** (string) - The transaction ID for the domain registration.
- **currency** (string) - The currency used for the transaction.
- **price** (number) - The total price of the domain registration.
- **product_0_price** (number) - The price for the registered product (domain).
- **product_0_status** (string) - The status of the product registration (e.g., SUCCESS).
- **product_0_domain** (string) - The domain that was registered.

#### Response Example
```
transactid=05ea891b3004d55cb21f1893c9f59b55 
currency=USD 
price=6.03 
product_0_price=6.03 
product_0_status=SUCCESS 
product_0_domain=example.eu
```
```

--------------------------------

### Example POST Request

Source: https://www.moniker.com/api-docs/index_setcurrency=EUR

An example of how to make a POST request to the API, which is the recommended method.

```APIDOC
## POST /api/submit

### Description
This is a hypothetical example endpoint demonstrating a POST request. It's used for submitting data to the API.

### Method
POST

### Endpoint
`/api/submit`

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your unique API key.
- **password** (string) - Required - The password associated with your API key.

#### Request Body
- **payload** (object) - Required - The data to be submitted.
  - **field1** (string) - Required - The first field of the payload.
  - **field2** (integer) - Optional - The second field of the payload.

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY",
  "password": "YOUR_PASSWORD"
}
```
```json
{
  "payload": {
    "field1": "some_value",
    "field2": 123
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request (e.g., "success").
- **result** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "success",
  "result": "Data submitted successfully."
}
```
```

--------------------------------

### Get Account Price List (Text Example)

Source: https://www.moniker.com/api-docs/account_price_list_get_setcurrency=AUD

Example of how to request the account price list using the API with the default TEXT response format. Requires API key and password. Optional parameters like currency and discount code can be included.

```bash
curl -X GET "https://api.moniker.com/api/v1.0/Account/Price/List/Get?apikey=YOUR_API_KEY&password=YOUR_PASSWORD"
```

--------------------------------

### Get Account Price List (XML Example)

Source: https://www.moniker.com/api-docs/account_price_list_get_setcurrency=AUD

Example of how to request the account price list using the API with XML response format. Requires API key and password. Optional parameters like currency and discount code can be included.

```bash
curl -X GET "https://api.moniker.com/api/v1.0/Account/Price/List/Get?apikey=YOUR_API_KEY&password=YOUR_PASSWORD&responseformat=XML"
```

--------------------------------

### Web Hosting Creation Request

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=USD

This example shows how to make a GET request to the Moniker API to create a web hosting account. It includes parameters for API key, password, domain name, period, location, and hosting type.

```HTTP
/Webhosting/Create?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz&period=1Y&location=london&type=economy-v2

```

--------------------------------

### Get Account Price List (JSON Example)

Source: https://www.moniker.com/api-docs/account_price_list_get_setcurrency=AUD

Example of how to request the account price list using the API with JSON response format. Requires API key and password. Optional parameters like currency and discount code can be included.

```bash
curl -X GET "https://api.moniker.com/api/v1.0/Account/Price/List/Get?apikey=YOUR_API_KEY&password=YOUR_PASSWORD&responseformat=JSON&currency=USD"
```

--------------------------------

### Moniker API Usage Example

Source: https://www.moniker.com/api-docs/webhosting_info

This snippet shows a GET request to the Moniker API to retrieve hosting information for a specific domain. It requires an ApiKey, Password, and the domain name as parameters.

```HTTP
/Webhosting/Info?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz
```

--------------------------------

### Moniker API Usage Example

Source: https://www.moniker.com/api-docs/account_configuration_get_setcurrency=USD

This code snippet shows a typical GET request to the Moniker API for account configuration. It includes the endpoint and required parameters like ApiKey and Password. The response format is also demonstrated, showing various key-value pairs returned by the API.

```HTTP
/Account/Configuration/Get?ApiKey=monikerapi&Password=monikerpass
```

```text
transactid=8bb0eb0edcafd3d4ce54109109ec88dc
transferapprovalcss=h2{color:red}\nh3{color blue}\nh4{color:black}
resellername=Best domains
resellersenderemail=no-reply@example.com
resellersupportemail=support@example.com
resellerwhoisheader=Registration service provided by: Best
domains
Website=http://www.example.com
resellerwhoisfooter=For any questions contact us at: best domains<support@example.com>
status=SUCCESS
```

--------------------------------

### Create Web Hosting Account API Request

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=AUD

This is an example of an HTTP GET request to the Moniker API to create a web hosting account. It includes parameters for the API key, domain, period, location, and hosting type.

```HTTP
/Webhosting/Create?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz&period=1Y&location=london&type=economy-v2
```

--------------------------------

### Get Domain Host List - Example Usage (API)

Source: https://www.moniker.com/api-docs/domain_host_list_setcurrency=CAD

Demonstrates how to retrieve a list of hosts for a given domain using the Domain Host List API command. It requires an API key and password, with an optional response format parameter. The response includes transaction details and the list of hosts.

```api
/Domain/Host/List?ApiKey=monikerapi&Password=monikerpass&domain=test-api-domain7.net
```

```text
transactid=c83ac6a6be45f3198ac8204f7151f517
status=SUCCESS
total_hosts=5
host_1=ns1.test-api-domain7.net
host_2=ns2.test-api-domain7.net
host_3=ns3.test-api-domain7.net
host_4=ns4.test-api-domain7.net
host_5=ns5.test-api-domain7.net
```

--------------------------------

### Account Price List Get

Source: https://www.moniker.com/api-docs/account_price_list_get_setcurrency=GBP

Retrieves a list of products and their prices for a given currency. Requires API key and password for authentication.

```APIDOC
## GET /Account/Price/List/Get

### Description
Retrieves a list of available products and their corresponding prices in a specified currency. This endpoint is useful for displaying product catalogs and pricing information.

### Method
GET

### Endpoint
`/Account/Price/List/Get`

### Parameters
#### Query Parameters
- **ApiKey** (string) - Required - Your unique API key for authentication.
- **Password** (string) - Required - Your password associated with the API key.
- **currency** (string) - Required - The currency code (e.g., 'usd', 'eur') for which to retrieve prices.

### Request Example
```
/Account/Price/List/Get?ApiKey=monikerapi&Password=monikerpass&currency=usd
```

### Response
#### Success Response (200)
- **transactid** (string) - A unique identifier for the transaction.
- **status** (string) - The status of the request (e.g., 'SUCCESS', 'FAILED').
- **currency** (string) - The currency code for the returned prices.
- **product_X_name** (string) - The name of the product (where X is the product index).
- **product_X_price** (number) - The price of the product in the specified currency.

#### Response Example
```json
{
  "transactid": "98f9ba52c47ad067d3e5b21d423e3d31",
  "status": "SUCCESS",
  "currency": "USD",
  "product_0_name": ".asia Domain",
  "product_0_price": 7.85,
  "product_1_name": ".asia Renew",
  "product_1_price": 7.85,
  "product_2_name": ".asia Transfer",
  "product_2_price": 6.99,
  "product_3_name": ".biz Domain",
  "product_3_price": 7.65,
  "product_4_name": ".biz Renew",
  "product_4_price": 7.65
}
```
```

--------------------------------

### Moniker API: Name Server List Format Examples

Source: https://www.moniker.com/api-docs/domain_create_setcurrency=CAD

Demonstrates the correct formatting for providing a list of name servers, including examples with and without IP addresses (glue records). It also shows how to associate multiple IP addresses with a single name server.

```text
ns1.example.com, ns2.example.com
ns1.example.com 192.5.4.3, ns2.example.com 201.9.21.72
ns1.example.com 144.1.2.3 211.4.5.6, ns2.example.com 177.24.25.116
```

--------------------------------

### Domain Push API Command Example

Source: https://www.moniker.com/api-docs/domain_push

Demonstrates how to use the Domain Push command to transfer a domain between accounts. It outlines required parameters like API key, password, domain name, and destination account, along with optional parameters for response format and hosting transfer.

```shell
/Domain/Push?apikey=YOUR_API_KEY&password=YOUR_PASSWORD&domain=example.com&destination=destination@example.com
```

```shell
/Domain/Push?apikey=YOUR_API_KEY&password=YOUR_PASSWORD&domain=example.com&destination=destination@example.com&responseformat=JSON&withhosting=yes
```

--------------------------------

### API Request Methods (POST vs. GET)

Source: https://www.moniker.com/api-docs/index_setcurrency=CAD

This section highlights the API's support for both HTTPS POST and GET requests, strongly recommending POST for enhanced security and detailing that GET examples are used for simplicity. It also notes that GET requests require URL encoding.

```text
POST and GET requests are supported, but POST is recommended.
GET requests must be URL Encoded.
```

--------------------------------

### Domain Trade Command - API Example (Conceptual)

Source: https://www.moniker.com/api-docs/domain_trade

This conceptual example demonstrates how to initiate a domain trade for .fr/.re/.pm/.yt/.tf/.wf domains using the Domain Trade API command. It highlights the necessary API key and password parameters.

```curl
curl -X POST https://api.example.com/Domain/Trade?apikey=YOUR_API_KEY&password=YOUR_PASSWORD&responseformat=JSON
```

--------------------------------

### Domain Registration Example

Source: https://www.moniker.com/api-docs/domain_trade_setcurrency=USD

This endpoint demonstrates how to register a domain using the Moniker API, including required parameters and expected responses.

```APIDOC
## GET /Domain/Trade

### Description
Registers a domain with the specified details.

### Method
GET

### Endpoint
/Domain/Trade

### Parameters
#### Query Parameters
- **ApiKey** (string) - Required - API key for authentication.
- **Password** (string) - Required - Password for authentication.
- **Domain** (string) - Required - The domain name to register (e.g., example.eu).
- **registrant_firstname** (string) - Required - First name of the registrant.
- **registrant_lastname** (string) - Required - Last name of the registrant.
- **registrant_organization** (string) - Optional - Organization of the registrant.
- **registrant_language** (string) - Required - Language code for the registrant (e.g., 'en').
- **registrant_email** (string) - Required - Email address of the registrant.
- **registrant_phonenumber** (string) - Required - Phone number of the registrant.
- **registrant_street** (string) - Required - Street address of the registrant.
- **registrant_street2** (string) - Optional - Second line of the street address.
- **registrant_city** (string) - Required - City of the registrant.
- **registrant_countrycode** (string) - Required - Country code of the registrant (e.g., 'it').
- **registrant_postalcode** (string) - Required - Postal code of the registrant.

### Request Example
```
/Domain/Trade?ApiKey=monikerapi&Password=monikerpass&Domain=example.eu&registrant_firstname=TradeUserFirstName&registrant_lastname=TradeUserLastName&registrant_organization=Domain%20Transfer&registrant_language=en&registrant_email=user@example.com&registrant_phonenumber=%2B1.4532239043&registrant_street=street1&registrant_street2=street2&registrant_city=london&registrant_countrycode=it&registrant_postalcode=2222
```

### Response
#### Success Response (200)
- **transactid** (string) - Transaction ID for the domain registration.
- **currency** (string) - Currency of the transaction.
- **price** (string) - Total price of the transaction.
- **product_0_price** (string) - Price of the first product.
- **product_0_status** (string) - Status of the first product (e.g., 'SUCCESS').
- **product_0_domain** (string) - The registered domain name.

#### Response Example
```
transactid=05ea891b3004d55cb21f1893c9f59b55
currency=USD
price=6.03
product_0_price=6.03
product_0_status=SUCCESS
product_0_domain=example.eu
```
```

--------------------------------

### Request Method Recommendation

Source: https://www.moniker.com/api-docs/index

This section advises on the preferred method for API requests. While both GET and POST are accepted, POST is strongly encouraged for security and data handling reasons. GET is used in examples for simplicity.

```text
While the API accepts both HTTPS POST and HTTPS GET requests, we strongly encourage you to use HTTPS POST. In this documentation we use HTTPS GET for simplicity.
```

--------------------------------

### Create Web Hosting with Moniker API

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=GBP

This snippet shows the GET request to create a web hosting service. It includes parameters for API key, password, domain, period, location, and hosting type. The response indicates the transaction ID, status, currency, price, VAT, and product-specific details like expiration date and hosting password.

```HTTP
/Webhosting/Create?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz&period=1Y&location=london&type=economy-v2
```

```Text
transactid=100ab20692904e2a0ce5a44b73a87de1
status=SUCCESS
currency=USD
price=47.88
vat=9.58
product_0_price=47.88
product_0_status=SUCCESS
product_0_expirationdate=2023/03/14
product_0_hostingpassword=$@ohvPd26H
```

--------------------------------

### Create Host Record

Source: https://www.moniker.com/api-docs/domain_host_create_setcurrency=AUD

Example of creating a host record with specified IP addresses under a registry. This uses a GET request to the Moniker API.

```HTTP
/Domain/Host/Create?ApiKey=monikerapi&Password=monikerpass&host=ns1.test-api-domain7.net&ip_list=121.211.42.77,144.222.21.92
```

--------------------------------

### Create Web Hosting Package

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=JPY

This endpoint allows for the creation of a new web hosting package. Users must provide an API key, password, desired domain name, hosting period, location, and hosting type.

```APIDOC
## GET /websites/moniker_api-docs

### Description
Creates a web hosting package with the specified details.

### Method
GET

### Endpoint
/Webhosting/Create

### Parameters
#### Query Parameters
- **ApiKey** (string) - Required - Your API key for authentication.
- **Password** (string) - Required - Your API password for authentication.
- **domain** (string) - Required - The desired domain name for the hosting package (e.g., "some-domain-1.xyz").
- **period** (string) - Required - The duration of the hosting package (e.g., "1Y" for one year).
- **location** (string) - Required - The server location for the hosting (e.g., "london").
- **type** (string) - Required - The type of hosting package to create (e.g., "economy-v2").

### Request Example
```
/Webhosting/Create?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz&period=1Y&location=london&type=economy-v2
```

### Response
#### Success Response (200)
- **transactid** (string) - The unique transaction ID for the operation.
- **status** (string) - The status of the operation (e.g., "SUCCESS").
- **currency** (string) - The currency used for the transaction (e.g., "USD").
- **price** (string) - The total price of the hosting package.
- **vat** (string) - The amount of Value Added Tax applied.
- **product_0_price** (string) - The price of the first product in the package.
- **product_0_status** (string) - The status of the first product.
- **product_0_expirationdate** (string) - The expiration date of the first product.
- **product_0_hostingpassword** (string) - The generated password for the hosting package.

#### Response Example
```json
{
  "transactid": "100ab20692904e2a0ce5a44b73a87de1",
  "status": "SUCCESS",
  "currency": "USD",
  "price": "47.88",
  "vat": "9.58",
  "product_0_price": "47.88",
  "product_0_status": "SUCCESS",
  "product_0_expirationdate": "2023/03/14",
  "product_0_hostingpassword": "$@ohvPd26H"
}
```
```

--------------------------------

### Moniker API Usage Example: Get Web Hosting Info

Source: https://www.moniker.com/api-docs/webhosting_info_setcurrency=CAD

This snippet shows how to make a request to the Moniker API to get web hosting details for a specific domain. It requires an ApiKey and Password. The response includes a transaction ID, hosting status, type, and expiration date.

```HTTP
/Webhosting/Info?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz
```

```plaintext
transactid=21b1f88b70cef5dcbe84c1cdc2fe6704
hosting=enabled
type=economy-v2
expirationdate=2023/03/14
```

--------------------------------

### Create Web Hosting Plan

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=USD

This endpoint allows users to create a new web hosting plan by providing necessary details such as API key, password, domain, period, location, and hosting type.

```APIDOC
## GET /Webhosting/Create

### Description
Creates a new web hosting plan with specified parameters.

### Method
GET

### Endpoint
/Webhosting/Create

### Parameters
#### Query Parameters
- **ApiKey** (string) - Required - Your unique API key.
- **Password** (string) - Required - Your account password.
- **domain** (string) - Required - The domain name for the hosting plan.
- **period** (string) - Required - The duration of the hosting plan (e.g., '1Y' for one year).
- **location** (string) - Required - The preferred data center location for the hosting.
- **type** (string) - Required - The type of hosting plan (e.g., 'economy-v2').

### Request Example
```
/Webhosting/Create?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz&period=1Y&location=london&type=economy-v2
```

### Response
#### Success Response (200)
- **transactid** (string) - The transaction ID for the created hosting plan.
- **status** (string) - The status of the transaction (e.g., 'SUCCESS').
- **currency** (string) - The currency used for the transaction.
- **price** (string) - The total price of the hosting plan.
- **vat** (string) - The Value Added Tax applied.
- **product_0_price** (string) - The price of the first product.
- **product_0_status** (string) - The status of the first product.
- **product_0_expirationdate** (string) - The expiration date of the first product.
- **product_0_hostingpassword** (string) - The generated password for the hosting account.

#### Response Example
```json
{
  "transactid": "100ab20692904e2a0ce5a44b73a87de1",
  "status": "SUCCESS",
  "currency": "USD",
  "price": "47.88",
  "vat": "9.58",
  "product_0_price": "47.88",
  "product_0_status": "SUCCESS",
  "product_0_expirationdate": "2023/03/14",
  "product_0_hostingpassword": "$@ohvPd26H"
}
```
```

--------------------------------

### Webhosting Create

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=CAD

Enables the creation of a hosting product for a specified domain name. This command allows users to provision hosting services based on defined packages and periods.

```APIDOC
## POST /Webhosting/Create

### Description
This endpoint allows you to create a hosting product for a given domain name. It supports various hosting packages and billing periods.

### Method
POST

### Endpoint
/Webhosting/Create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **apikey** (string) - Required - The API key for authentication.
- **password** (string) - Required - The password for authentication.
- **domain** (string) - Required - The domain name for which to create hosting. Must be under the user's account.
- **period** (string) - Required - The hosting period (e.g., '1Y', '2Y', ..., '10Y').
- **location** (string) - Required - The hosting server location (e.g., 'USA', 'Europe', 'Asia', 'Oceania').
- **type** (string) - Required - The hosting package code name (e.g., 'hdj054ey_moniker-premium-limit', 'hdj054ey_moniker-economy-limit', 'hdj054ey_moniker-business', 'hdj054ey_moniker-firstclass').
- **responseformat** (string) - Optional - The desired response format ('TEXT', 'JSON', 'XML'). Defaults to 'TEXT'.
- **discountcode** (string) - Optional - A discount code to apply to the order.

### Request Example
```json
{
  "apikey": "YOUR_API_KEY",
  "password": "YOUR_PASSWORD",
  "domain": "example.com",
  "period": "1Y",
  "location": "USA",
  "type": "hdj054ey_moniker-premium-limit",
  "responseformat": "JSON",
  "discountcode": "SUMMER2024"
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation (e.g., 'success', 'error').
- **message** (string) - A message describing the result of the operation.
- **hosting_id** (string) - The ID of the newly created hosting product (if successful).

#### Response Example
```json
{
  "status": "success",
  "message": "Hosting product created successfully.",
  "hosting_id": "h_12345abcde"
}
```
```

--------------------------------

### Domain Availability Check (GET)

Source: https://www.moniker.com/api-docs/index_setcurrency=AUD

Checks the availability of a specified domain name. This is a basic example demonstrating how to interact with the API.

```APIDOC
## GET /Domain/Check

### Description
Checks the availability of a specified domain name.

### Method
GET

### Endpoint
https://testapi.moniker.com/Domain/Check

### Parameters
#### Query Parameters
- **ApiKey** (string) - Required - Your API key.
- **Password** (string) - Required - Your API password.
- **Domain** (string) - Required - The domain name to check (e.g., example.com).

### Request Example
```
https://testapi.moniker.com/Domain/Check?ApiKey=monikerapi&Password=monikerpass&Domain=example.com
```

### Response
#### Success Response (200)
- **Domain** (string) - The domain name that was checked.
- **Available** (boolean) - True if the domain is available, false otherwise.

#### Response Example
(Assuming domain is available)
```json
{
  "Domain": "example.com",
  "Available": true
}
```
(Assuming domain is not available)
```json
{
  "Domain": "example.com",
  "Available": false
}
```
```

--------------------------------

### List DNS Records API Request

Source: https://www.moniker.com/api-docs/domain_dnsrecord_list_setcurrency=EUR

This is an example of a GET request to the Moniker API to list DNS records for a specific domain. It requires an ApiKey, Password, and the Domain name.

```HTTP
/Domain/DnsRecord/List?ApiKey=monikerapi&Password=monikerpass&Domain=test-api-domain7.net

```

--------------------------------

### Webhosting Create

Source: https://www.moniker.com/api-docs/webhosting_create

Enables the creation of a hosting product for a given domain name.

```APIDOC
## POST /Webhosting/Create

### Description
This command is intended to enable the option to buy and create a hosting product for a specified domain.

### Method
POST

### Endpoint
/Webhosting/Create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **apikey** (string) - Required - The API key that was provided upon requesting API access.
- **password** (string) - Required - The password provided upon requesting API access.
- **domain** (string) - Required - The domain name for which the hosting product needs to be provided. Must be under the user's account.
- **period** (string) - Required - The period for which hosting is needed. Valid values are '1Y', '2Y' up to '10Y'.
- **location** (string) - Required - The hosting server location. Possible values: USA, Europe, Asia, Oceania.
- **type** (string) - Required - The hosting package code name. Examples: 'hdj054ey_moniker-premium-limit', 'hdj054ey_moniker-economy-limit', 'hdj054ey_moniker-business', 'hdj054ey_moniker-firstclass'.
- **responseformat** (string) - Optional - Specifies the response format. Possible values: 'TEXT', 'JSON', 'XML'. Defaults to 'TEXT'.
- **discountcode** (string) - Optional - A discount code to apply to the hosting purchase. If invalid, an error will be shown.

### Request Example
```json
{
  "apikey": "YOUR_API_KEY",
  "password": "YOUR_PASSWORD",
  "domain": "example.com",
  "period": "1Y",
  "location": "USA",
  "type": "hdj054ey_moniker-premium-limit",
  "responseformat": "JSON",
  "discountcode": "SUMMER2023"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.
- **message** (string) - Provides details about the operation result.

#### Response Example
```json
{
  "status": "success",
  "message": "Hosting created successfully for example.com"
}
```
```

--------------------------------

### Domain List Example (CompactList=yes)

Source: https://www.moniker.com/api-docs/domain_list_setcurrency=USD

Illustrates the output format when 'CompactList' is set to 'yes', showing a simple list of domain names separated by semicolons.

```text
Domain_0=example.com;Domain_1=example2.com;Domain_2=example3.info;Domain_3=example4.biz
```

--------------------------------

### Retrieve Account Info via API

Source: https://www.moniker.com/api-docs/account_info_setcurrency=AUD

This example demonstrates how to make a GET request to the Moniker API to fetch account details. It requires an 'ApiKey' and 'Password' as query parameters.

```HTTP
/Account/Info?ApiKey=monikerapi&Password=monikerpass
```

--------------------------------

### POST /Webhosting/Create

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=EUR

Creates a web hosting product for a given domain name. This endpoint is used to enable the purchase and creation of hosting services.

```APIDOC
## POST /Webhosting/Create

### Description
Creates a web hosting product for a given domain name. This endpoint is used to enable the purchase and creation of hosting services.

### Method
POST

### Endpoint
/Webhosting/Create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **apikey** (string) - Required - The API key that we provided to you when you requested API access for your account
- **password** (string) - Required - The password we provided when you requested API access for your account
- **domain** (string) - Required - The domain name for which the hosting product needs to be provided. Domain should be under user account.
- **period** (string) - Required - The period for which the hosting is need to be provided. The valid values are 1Y, 2Y up to 10Y where Y stands for years.
- **location** (string) - Required - The hosting server location: USA, Europe, Asia, Oceania
- **type** (string) - Required - The hosting package code names: hdj054ey_moniker-premium-limit, hdj054ey_moniker-economy-limit, hdj054ey_moniker-business, hdj054ey_moniker-firstclass
- **responseformat** (string) - Optional - This specifies how the response will be returned. Possible values are TEXT, JSON and XML. The default value is TEXT.
- **discountcode** (string) - Optional - If you have a discount code that would grant you a better price you can use it here. If the discount code is provided and it does not exist or it is not valid anymore it will show up as an error.

### Request Example
{
  "apikey": "YOUR_API_KEY",
  "password": "YOUR_PASSWORD",
  "domain": "example.com",
  "period": "1Y",
  "location": "USA",
  "type": "hdj054ey_moniker-premium-limit",
  "responseformat": "JSON",
  "discountcode": "SAVE10"
}

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.
- **message** (string) - Provides details about the result of the operation.

#### Response Example
{
  "status": "success",
  "message": "Hosting created successfully for example.com"
}
```

--------------------------------

### Check Domain Availability (HTTP GET)

Source: https://www.moniker.com/api-docs/index_setcurrency=JPY

Demonstrates how to check the availability of a domain name using the Moniker API via an HTTPS GET request. This example shows the basic structure of a request, including the API key, password, and the domain to check. Parameter names are case-insensitive, but values are case-sensitive.

```HTTP
https://testapi.moniker.com/Domain/Check?ApiKey=monikerapi&Password=monikerpass&Domain=example.com
```

--------------------------------

### Create Web Hosting Package

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=AUD

This endpoint creates a new web hosting package with the specified parameters. It requires an API key and password for authentication.

```APIDOC
## GET /Webhosting/Create

### Description
Creates a new web hosting package.

### Method
GET

### Endpoint
/Webhosting/Create

### Parameters
#### Query Parameters
- **ApiKey** (string) - Required - Your API key for authentication.
- **Password** (string) - Required - Your password for authentication.
- **domain** (string) - Required - The domain name for the hosting package.
- **period** (string) - Required - The subscription period (e.g., '1Y' for 1 year).
- **location** (string) - Required - The server location for the hosting.
- **type** (string) - Required - The type of hosting package (e.g., 'economy-v2').

### Request Example
```
/Webhosting/Create?ApiKey=monikerapi&Password=monikerpass&domain=some-domain-1.xyz&period=1Y&location=london&type=economy-v2
```

### Response
#### Success Response (200)
- **transactid** (string) - The transaction ID for the creation.
- **status** (string) - The status of the operation (e.g., 'SUCCESS').
- **currency** (string) - The currency used for the transaction.
- **price** (string) - The total price of the hosting package.
- **vat** (string) - The amount of VAT charged.
- **product_0_price** (string) - The price of the first product.
- **product_0_status** (string) - The status of the first product.
- **product_0_expirationdate** (string) - The expiration date of the first product.
- **product_0_hostingpassword** (string) - The hosting password for the first product.

#### Response Example
```json
{
  "transactid": "100ab20692904e2a0ce5a44b73a87de1",
  "status": "SUCCESS",
  "currency": "USD",
  "price": "47.88",
  "vat": "9.58",
  "product_0_price": "47.88",
  "product_0_status": "SUCCESS",
  "product_0_expirationdate": "2023/03/14",
  "product_0_hostingpassword": "$@ohvPd26H"
}
```
```

--------------------------------

### Moniker API Domain Host Info Request

Source: https://www.moniker.com/api-docs/domain_host_info_setcurrency=CAD

Example of an API request to the Moniker API to get information about a specific domain host. It requires an API key, password, and the host name.

```HTTP
/Domain/Host/Info?ApiKey=monikerapi&Password=monikerpass&host=ns1.test-api-domain7.net
```

--------------------------------

### Domain Registrant Verification Request

Source: https://www.moniker.com/api-docs/domain_registrantverification_info_setcurrency=AUD

This snippet shows an example HTTP GET request to the Moniker API for verifying domain registrant information. It includes parameters for API key, password, and the domain name.

```HTTP
/Domain/RegistrantVerification/Info?ApiKey=monikerapi&Password=monikerpass&domain=test-api-domain.net
```

--------------------------------

### Webhosting Create API

Source: https://www.moniker.com/api-docs/webhosting_create_setcurrency=GBP

Enables the creation of a hosting product for a given domain name and period.

```APIDOC
## POST /Webhosting/Create

### Description
This endpoint creates a hosting product for a specified domain name and billing period. It is designed to enable the purchase and setup of hosting services.

### Method
POST

### Endpoint
/Webhosting/Create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **apikey** (string) - Required - The API key for authentication.
- **password** (string) - Required - The password for authentication.
- **domain** (string) - Required - The domain name for which to create hosting. Must be under the user's account.
- **period** (string) - Required - The duration of the hosting package (e.g., '1Y', '2Y', '10Y').
- **location** (string) - Required - The desired hosting server location (e.g., 'USA', 'Europe', 'Asia', 'Oceania').
- **type** (string) - Required - The code name of the hosting package (e.g., 'hdj054ey_moniker-premium-limit', 'hdj054ey_moniker-economy-limit', 'hdj054ey_moniker-business', 'hdj054ey_moniker-firstclass').
- **responseformat** (string) - Optional - Specifies the response format ('TEXT', 'JSON', 'XML'). Defaults to 'TEXT'.
- **discountcode** (string) - Optional - A discount code to apply to the order. If invalid, an error will be returned.

### Request Example
```json
{
  "apikey": "YOUR_API_KEY",
  "password": "YOUR_PASSWORD",
  "domain": "example.com",
  "period": "2Y",
  "location": "USA",
  "type": "hdj054ey_moniker-premium-limit",
  "responseformat": "JSON"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.
- **message** (string) - A message providing details about the operation.
- **hosting_id** (string) - The ID of the created hosting package (if successful).

#### Response Example
```json
{
  "status": "success",
  "message": "Hosting package created successfully.",
  "hosting_id": "hosting_12345abcde"
}
```
```

--------------------------------

### Update DNS Record - GET Request Example

Source: https://www.moniker.com/api-docs/domain_dnsrecord_update

This snippet shows a sample GET request to the Moniker API for updating a DNS record. It includes parameters for API Key, Password, full record name, record type, current value, and the new value. The response indicates the transaction ID and status.

```HTTP
/Domain/DnsRecord/Update?ApiKey=monikerapi&Password=monikerpass&fullrecordname=w3.test-api-domain7.net&type=CNAME&currentvalue=www.example.com&newvalue=example.com

status=SUCCESS
```
Tokens:
Raw