### Run Get Info on Registrar Configuration Contract Products

Source: https://apidocs.upmind.com/modules/web_hosting

Asynchronously triggers a 'Get Info' operation for all Contract Products associated with a given domain registrar configuration. Requires the configuration ID as a path parameter. Returns a summary of the operation, including the count of contract products affected.

```http
POST https://api.upmind.io/api/modules/web_hosting/domains/registrars/configurations/:configuration_id/info
```

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

### Run Get Info on Server Configuration CPs

Source: https://apidocs.upmind.com/modules/web_hosting

Asynchronously runs the 'Get Info' operation on all Contract Products associated with a specific Shared Hosting Server configuration. This is useful for updating or verifying the status of hosting resources.

```APIDOC
## POST /api/modules/web_hosting/shared_hosting/servers/configurations/:configuration_id/info

### Description
Run Get Info on all Contract Products belonging to this Hosting Server configuration (asynchronously).

### Method
POST

### Endpoint
https://api.upmind.io/api/modules/web_hosting/shared_hosting/servers/configurations/:configuration_id/info

### Parameters
#### Path Parameters
- **configuration_id** (integer) - Shared hosting server configuration id

### Response
#### Success Response (200)
- **data** (object) - Get Info data
  - **count** (string) - Number of contract products that will have Get Info run on them

### Request Example
{
  "url": "https://api.upmind.io/api/modules/web_hosting/shared_hosting/servers/configurations/123/info"
}

### Response Example
{
  "data": {
    "count": "10"
  }
}
```

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

### POST /api/modules/web_hosting/shared_hosting/servers/configurations/:configuration_id/usage

Source: https://apidocs.upmind.com/modules/web_hosting

Runs Get Usage on all Contract Products belonging to a specific Shared Hosting Server configuration asynchronously.

```APIDOC
## POST /api/modules/web_hosting/shared_hosting/servers/configurations/:configuration_id/usage

### Description
Run Get Usage on all Contract Products belonging to this Hosting Server configuration (asynchronously).

### Method
POST

### Endpoint
https://api.upmind.io/api/modules/web_hosting/shared_hosting/servers/configurations/:configuration_id/usage

### Parameters
#### Path Parameters
- **configuration_id** (string) - Required - Shared hosting server configuration id

### Request Example
{
  "example": "POST /api/modules/web_hosting/shared_hosting/servers/configurations/12345/usage"
}

### Response
#### Success Response (200)
- **data** (object) - Get Usage data
- **count** (string) - Number of contract products that will have Get Usage run on them

#### Response Example
{
  "example": {
    "data": {},
    "count": "5"
  }
}
```

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

### POST /api/modules/web_hosting/domains/registrars/configurations/:configuration_id/info

Source: https://apidocs.upmind.com/modules/web_hosting

Triggers a 'Get Info' operation for all Contract Products associated with a specific Domain Registrar configuration. This is performed asynchronously.

```APIDOC
## Run Get Info on Registrar Configuration CPs

### Description
Run Get Info on all Contract Products belonging to this Domain Registrar configuration (asynchronously). This endpoint initiates an information retrieval process for associated contract products.

### Method
POST

### Endpoint
/api/modules/web_hosting/domains/registrars/configurations/:configuration_id/info

### Parameters
#### Path Parameters
- **configuration_id** (string) - Required - Domain registrar configuration id

### Response
#### Success Response (200)
- **data** (object) - Get Info data
  - **count** (string) - Number of contract products that will have Get Info run on them

#### Response Example
```json
{
  "data": {
    "count": "5"
  }
}
```
```

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

### Get TLD Product Default Settings

Source: https://apidocs.upmind.com/modules/web_hosting

Retrieves the default TLD product settings for a specific TLD. This includes information such as registrar, maximum registration period, and redemption period days.

```APIDOC
## GET /api/modules/web_hosting/domains/tlds/:tld/default_settings

### Description
Get the default TLD product settings for a particular TLD.

### Method
GET

### Endpoint
`https://api.upmind.io/api/modules/web_hosting/domains/tlds/:tld/default_settings`

### Parameters
#### Path Parameters
- **tld** (string) - Required - TLD

### Response
#### Success Response (200)
- **data** (object) - Default settings for this TLD
  - **registrar** (string, optional) - Provision provider code of the particular registrar used for new orders
  - **max_reg_period_years** (integer, optional) - Maximum number of years a domain of this TLD can be registered/renewed for
  - **late_renew_days** (integer, optional) - Number of days after expiry domains of this TLD can still be renewed
  - **redemption_period_days** (integer, optional) - Number of days' redemption period for this TLD

#### Response Example
```json
{
  "data": {
    "registrar": "example_registrar",
    "max_reg_period_years": 10,
    "late_renew_days": 5,
    "redemption_period_days": 30
  }
}
```
```

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

### GET /api/modules/web_hosting/domains/registrars/configurations

Source: https://apidocs.upmind.com/modules/web_hosting

Lists all domain registrar configurations available within the system. This endpoint allows retrieval of detailed information about each registrar configuration, including its ID, provider, category, and various settings.

```APIDOC
## List Domain Registrar Configurations

### Description
List all domain registrar configurations. This endpoint retrieves a list of all configured domain registrars, including their settings and associated data.

### Method
GET

### Endpoint
/api/modules/web_hosting/domains/registrars/configurations

### Parameters
#### Query Parameters
- **with** (string) - Optional - Relations to load. Allowed values: `prices`, `provision_provider`, `contract_product_counts`

### Response
#### Success Response (200)
- **data** (object[]) - Provision configurations
  - **id** (integer) - Registrar configuration id
  - **category_id** (integer) - Domain names category id
  - **provider_id** (integer) - Registrar provider id
  - **registrar** (string) - Domain registrar provider code
  - **org_id** (integer) - Organisation id
  - **brand_id** (integer) - Brand id (0 for organisation-level configurations)
  - **category_default** (boolean) - Whether or not this is the default registrar configuration for the org/brand
  - **provider_default** (boolean) - Whether or not this is the default registrar configuration of this provider for the org/brand
  - **code** (string) - Unique registrar configuration code
  - **name** (string) - Registrar configuration name
  - **enabled** (boolean) - Whether or not this registrar configuration is enabled for use
  - **polling_enabled** (boolean) - Whether or not notification event polling is enabled
  - **dac_enabled** (boolean) - Whether or not this configuration is used for DAC searches
  - **field_values** (mixed[]) - Key/value configuration field data (password field values only stored encrypted on an adapter server)
  - **created_at** (datetime) - Registrar configuration creation date + time
  - **updated_at** (datetime) - Registrar configuration last updated date + time
  - **category** (object) - Optional - Domain names category
  - **provider** (object) - Optional - Registrar provider
  - **contract_product_counts** (object[]) - Optional - Array of contract product counts grouped by contract product status
    - **count** (integer) - Optional - Number of contract products set to this configuration with this status
    - **status_id** (integer) - Optional - Contract product status id
    - **status_code** (optional) - Contract product status code

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "category_id": 1,
      "provider_id": 1,
      "registrar": "example_registrar",
      "org_id": 1,
      "brand_id": 0,
      "category_default": true,
      "provider_default": true,
      "code": "reg_code_1",
      "name": "Example Registrar Config",
      "enabled": true,
      "polling_enabled": false,
      "dac_enabled": false,
      "field_values": [],
      "created_at": "2023-01-01T10:00:00Z",
      "updated_at": "2023-01-01T10:00:00Z",
      "category": {
        "id": 1,
        "name": "General"
      },
      "provider": {
        "id": 1,
        "code": "example_provider_code",
        "name": "Example Provider"
      },
      "contract_product_counts": [
        {
          "count": 10,
          "status_id": 1,
          "status_code": "active"
        }
      ]
    }
  ]
}
```
```

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

### Get TLD Product

Source: https://apidocs.upmind.com/modules/web_hosting

Retrieves details for a specific TLD product, identified by either its product ID or TLD. You can also specify relations to load, such as prices or provision provider details.

```APIDOC
## GET /api/modules/web_hosting/domains/tlds/:product_id|:tld

### Description
Get a TLD product.

### Method
GET

### Endpoint
`https://api.upmind.io/api/modules/web_hosting/domains/tlds/:product_id|:tld`

### Parameters
#### Query Parameters
- **with** (string, optional) - Relations to load. Allowed values: `prices`, `provision_provider`, `contract_product_counts`

#### Path Parameters
- **tld** (string, optional) - TLD (Required without product_id)
- **product_id** (string, optional) - Product id (Required without tld)

### Response
#### Success Response (200)
- **data** (object) - Catalogue Product with some additional TLD product data
  - **tld** (string) - TLD of this product
  - **enabled** (boolean) - Whether or not this TLD is available for sale (also see: clients_can_order)
  - **registrar** (string, optional) - Provision provider code of the particular registrar used for new orders
  - **max_reg_period_years** (integer, optional) - Maximum number of years a domain of this TLD can be registered/renewed for
  - **late_renew_days** (integer, optional) - Number of days after expiry domains of this TLD can still be renewed
  - **redemption_period_days** (integer, optional) - Number of days' redemption period for this TLD
  - **prices** (object[], optional) - Prices for registration/renewal/transfer (before any discounts/overrides)
    - **billing_cycle_years** (integer) - Number of years to register/renew at this price
    - **currency_id** (integer) - Currency for this price
    - **price** (double) - Price for the registration/renewal/transfer (before any discounts/overrides)
    - **pricelist_id** (integer) - Pricelist this price belongs to

#### Response Example
```json
{
  "data": {
    "tld": "example.com",
    "enabled": true,
    "registrar": "example_registrar",
    "max_reg_period_years": 10,
    "late_renew_days": 5,
    "redemption_period_days": 30,
    "prices": [
      {
        "billing_cycle_years": 1,
        "currency_id": 1,
        "price": 10.99,
        "pricelist_id": 1
      }
    ]
  }
}
```
```

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

### GET /api/modules/web_hosting/domains/search/status

Source: https://apidocs.upmind.com/modules/web_hosting

Determine the current availability/status of domain search (DAC). This endpoint helps check if the domain name search functionality is active.

```APIDOC
## GET /api/modules/web_hosting/domains/search/status

### Description
Determine the current availability/status of domain search (DAC). This endpoint helps check if the domain name search functionality is active.

### Method
GET

### Endpoint
https://api.upmind.io/api/modules/web_hosting/domains/search/status

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Header Parameters
- **Authorization** (string) - Required - "Bearer "

### Request Example
```json
{
  "Authorization": "Bearer YOUR_API_TOKEN"
}
```

### Response
#### Success Response (200)
- **data** (object) - Status of domain search
  - **enabled** (boolean) - Whether domain search is enabled
  - **message** (string) - A message indicating the status or any relevant information

#### Response Example
```json
{
  "data": {
    "enabled": true,
    "message": "Domain search is currently available."
  }
}
```
```

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

### POST /api/modules/web_hosting/domains/tlds

Source: https://apidocs.upmind.com/modules/web_hosting

Create a domain product for a specific TLD. This endpoint allows you to define TLDs, set their availability, renewal periods, and pricing.

```APIDOC
## POST /api/modules/web_hosting/domains/tlds

### Description
Create a domain product for a particular TLD. This endpoint allows you to define TLDs, set their availability, renewal periods, and pricing.

### Method
POST

### Endpoint
https://api.upmind.io/api/modules/web_hosting/domains/tlds

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **tld** (string) - Required - TLD for this product
- **registrar** (string) - Optional - Provision provider code of a particular registrar to use for new orders, if desired
- **enabled** (mixed) - Optional - Whether or not this TLD should be available for sale. Default value: `true`
- **late_renew_days** (mixed) - Optional - Number of days after expiry domains of this TLD can still be renewed
- **redemption_period_days** (mixed) - Optional - Number of days' redemption period for this TLD
- **max_reg_period_years** (mixed) - Optional - Maximum number of years a domain of this TLD can be registered/renewed for
- **prices** (object[]) - Optional - Prices for this TLD product
  - **billing_cycle_years** (integer) - Required - Number of years to register/renew at this price
  - **currency_id** (integer) - Required - Currency for this price
  - **price** (double) - Required - Price for the registration/renewal/transfer (before any discounts/overrides)
  - **pricelist_id** (integer) - Required - Pricelist this price belongs to

### Request Example
```json
{
  "tld": ".com",
  "registrar": "godaddy",
  "enabled": true,
  "late_renew_days": 10,
  "redemption_period_days": 30,
  "max_reg_period_years": 10,
  "prices": [
    {
      "billing_cycle_years": 1,
      "currency_id": 1,
      "price": 12.99,
      "pricelist_id": 1
    }
  ]
}
```

### Response
#### Success Response (200)
- **data** (object) - Catalogue Product with some additional TLD product data
  - **tld** (string) - TLD of this product
  - **enabled** (boolean) - Whether or not this TLD is available for sale
  - **registrar** (string) - Optional - Provision provider code of the particular registrar used for new orders
  - **max_reg_period_years** (integer) - Optional - Maximum number of years a domain of this TLD can be registered/renewed for
  - **late_renew_days** (integer) - Optional - Number of days after expiry domains of this TLD can still be renewed
  - **redemption_period_days** (integer) - Optional - Number of days' redemption period for this TLD
  - **prices** (object[]) - Optional - Prices for registration/renewal/transfer (before any discounts/overrides)
    - **billing_cycle_years** (integer) - Number of years to register/renew at this price
    - **currency_id** (integer) - Currency for this price
    - **price** (double) - Price for the registration/renewal/transfer (before any discounts/overrides)
    - **pricelist_id** (integer) - Pricelist this price belongs to

#### Response Example
```json
{
  "data": {
    "tld": ".com",
    "enabled": true,
    "registrar": "godaddy",
    "max_reg_period_years": 10,
    "late_renew_days": 10,
    "redemption_period_days": 30,
    "prices": [
      {
        "billing_cycle_years": 1,
        "currency_id": 1,
        "price": 12.99,
        "pricelist_id": 1
      }
    ]
  }
}
```
```

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

### Sync Registrar Configuration CP Due Dates

Source: https://apidocs.upmind.com/modules/web_hosting

Asynchronously syncs the next_due_date of active domain name contract products provisioned by a given registrar configuration with each domain name's expiry date.

```APIDOC
## POST /api/modules/web_hosting/domains/registrars/configurations/:configuration_id/due_dates

### Description
Sync the next_due_date of all active domain name contract products provisioned by the given registrar configuration, with each domain name's expiry date (asynchronously).

### Method
POST

### Endpoint
/api/modules/web_hosting/domains/registrars/configurations/:configuration_id/due_dates

### Parameters
#### Path Parameters
- **configuration_id** (string) - Required - The ID of the registrar configuration.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **data** (object) - Sync data
- **sync_count** (string) - Number of contract products whose next_due_date are being synced

#### Response Example
```json
{
  "data": {},
  "sync_count": "string"
}
```
```

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

### List Domain Registrar Configurations

Source: https://apidocs.upmind.com/modules/web_hosting

Retrieves a list of all domain registrar configurations. Supports filtering by relations such as prices, provision providers, and contract product counts. Returns an array of registrar configuration objects, each with details like ID, provider, name, and enablement status.

```http
GET https://api.upmind.io/api/modules/web_hosting/domains/registrars/configurations?with=prices
```

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

### List TLD Products

Source: https://apidocs.upmind.com/modules/web_hosting

Retrieves a list of all available TLD products. You can optionally include relations such as prices or provision provider details.

```APIDOC
## GET /api/modules/web_hosting/domains/tlds

### Description
List all TLD products.

### Method
GET

### Endpoint
`https://api.upmind.io/api/modules/web_hosting/domains/tlds`

### Parameters
#### Query Parameters
- **with** (string, optional) - Relations to load. Allowed values: `prices`, `provision_provider`, `contract_product_counts`

### Response
#### Success Response (200)
- **data** (array) - List of TLD products (structure similar to 'Get TLD Product' success response)

#### Response Example
```json
{
  "data": [
    {
      "tld": "example.com",
      "enabled": true,
      "registrar": "example_registrar",
      "max_reg_period_years": 10,
      "late_renew_days": 5,
      "redemption_period_days": 30,
      "prices": [
        {
          "billing_cycle_years": 1,
          "currency_id": 1,
          "price": 10.99,
          "pricelist_id": 1
        }
      ]
    }
  ]
}
```
```

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

### List Domain Name Contract Products

Source: https://apidocs.upmind.com/modules/web_hosting

Retrieves a list of all domain name contract products. This endpoint supports filtering by TLD and includes options to load related data such as prices and provider information.

```APIDOC
## GET /api/modules/web_hosting/domains/contract_products

### Description
List all domain name contract products.

### Method
GET

### Endpoint
https://api.upmind.io/api/modules/web_hosting/domains/contract_products

### Parameters
#### Query Parameters
- **with** (string) - Optional - Relations to load (`prices`, `provision_provider`, `contract_product_counts`)
- **tld** (string) - Optional - Filter for domain names of a specific tld

### Response
#### Success Response (200)
- **data** (object[]) - Domain name contract products

### Request Example
{
  "url": "https://api.upmind.io/api/modules/web_hosting/domains/contract_products?tld=com&with=prices"
}

### Response Example
{
  "data": [
    {
      "id": 1,
      "domain_name": "example.com",
      "status_code": "active"
    }
  ]
}
```

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

### Search Domain Names (DAC)

Source: https://apidocs.upmind.com/modules/web_hosting

Search for domain products and check domain availability for a given SLD and TLD.

```APIDOC
## GET /api/modules/web_hosting/domains/search

### Description
Search domain products and check domain availability for a given SLD / TLD.

### Method
GET

### Endpoint
https://api.upmind.io/api/modules/web_hosting/domains/search

### Parameters
#### Query Parameters
- **sld** (string) - Required - SLD to search
- **tld** (string) - Optional - TLD to return as first product result
- **tlds** (string[]) - Optional - Domain extensions to include in results. By default will search in all available tlds.
- **tlds_strict** (boolean) - Optional - Whether or not to throw an error if a requested TLD is not available for sale. Allowed values: `0`.
- **no_cache** (boolean) - Optional - Optionally don't return cached results (fresh search).
- **order_id** (integer) - Optional - The basket (draft invoice) id.
- **promotions** (string) - Optional - Promo codes, separated with comma. If these are valid, then we'll load the promotions and show the discounted amounts.
- **currency_code** (string) - Optional - Currency code for filtering the results by price.

### Headers
- **Authorization** (string) - Required - "Bearer "

### Response
#### Success Response (200)
- **data** (object[]) - Available catalogue products with some additional data
  - **domain_available** (boolean) - Whether or not the domain name is available to register
  - **tld** (string) - Domain product TLD
  - **setup_function_name** (string) - Domain setup function name. Allowed values: `register`, `transfer`
  - **sub_product_id** (integer) - Optional - Product option or attribute id to select in basket configuration for this setup function

#### Response Example
```json
{
  "data": [
    {
      "domain_available": true,
      "tld": ".com",
      "setup_function_name": "register",
      "sub_product_id": 123
    }
  ]
}
```
```

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

### List Client Domain Names

Source: https://apidocs.upmind.com/modules/web_hosting

Retrieves a list of all domain name basket/contract products for a given basket and/or client. This endpoint allows you to query domain information based on client and basket IDs.

```APIDOC
## GET /api/modules/web_hosting/domains/client_domains

### Description
List all domain name basket/contract products of the given basket and/or client.

### Method
GET

### Endpoint
https://api.upmind.io/api/modules/web_hosting/domains/client_domains

### Parameters
#### Query Parameters
- **basket_id** (integer) - Optional - Optionally specify a basket id to examine for domain name basket products
- **client_id** (integer) - Optional - Optionally specify a client id (if access != client) to examine for domain name contract products

### Response
#### Success Response (200)
- **data** (object[]) - Domain name order product information
  - **order_product_type** (string) - Type of order product (`invoice_product`, `contracts_product`)
  - **order_product_id** (integer) - Id of the order product
  - **status_code** (string) - Status code of the order product
  - **domain_name** (string) - Domain name of the order product

### Request Example
{
  "url": "https://api.upmind.io/api/modules/web_hosting/domains/client_domains?basket_id=123&client_id=456"
}

### Response Example
{
  "data": [
    {
      "order_product_type": "contracts_product",
      "order_product_id": 789,
      "status_code": "active",
      "domain_name": "example.com"
    }
  ]
}
```

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

### DELETE /api/modules/web_hosting/domains/tlds/:product_id|:tld

Source: https://apidocs.upmind.com/modules/web_hosting

Delete a TLD product. You can identify the product to delete by either its product ID or its TLD.

```APIDOC
## DELETE /api/modules/web_hosting/domains/tlds/:product_id|:tld

### Description
Delete a TLD product. You can identify the product to delete by either its product ID or its TLD.

### Method
DELETE

### Endpoint
https://api.upmind.io/api/modules/web_hosting/domains/tlds/:product_id|:tld

### Parameters
#### Path Parameters
- **tld** (string) - Optional - TLD (Required without product_id)
- **product_id** (string) - Optional - Product id (Required without tld)

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{} // No request body for DELETE
```

### Response
#### Success Response (200)
- **data** (object) - Empty response

#### Response Example
```json
{
  "data": {}
}
```
```

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

### Toggle Registrar Configuration Domain Availability Checks

Source: https://apidocs.upmind.com/modules/web_hosting

Toggles Domain Availability Checks (DAC) searching on or off for a specific registrar configuration.

```APIDOC
## PATCH /api/modules/web_hosting/domains/registrars/configurations/:configuration_id/dac

### Description
Toggle DAC searching on or off for this configuration.

### Method
PATCH

### Endpoint
/api/modules/web_hosting/domains/registrars/configurations/:configuration_id/dac

### Parameters
#### Path Parameters
- **configuration_id** (string) - Required - The ID of the registrar configuration.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **data** (object) - Provision configuration
  - **id** (integer) - Registrar configuration id
  - **category_id** (integer) - Domain names category id
  - **provider_id** (integer) - Registrar provider id
  - **registrar** (string) - Domain registrar provider code
  - **org_id** (integer) - Organisation id
  - **brand_id** (integer) - Brand id (0 for organisation-level configurations)
  - **category_default** (boolean) - Whether or not this is the default registrar configuration for the org/brand
  - **provider_default** (boolean) - Whether or not this is the default registrar configuration of this provider for the org/brand
  - **code** (string) - Unique registrar configuration code
  - **name** (string) - Registrar configuration name
  - **enabled** (boolean) - Whether or not this registrar configuration is enabled for use
  - **polling_enabled** (boolean) - Whether or not notification event polling is enabled
  - **dac_enabled** (boolean) - Whether or not this configuration is used for DAC searches
  - **field_values** (mixed[]) - Key/value configuration field data (password field values only stored encrypted on an adapter server)
  - **created_at** (datetime) - Registrar configuration creation date + time
  - **updated_at** (datetime) - Registrar configuration last updated date + time
  - **category** (object) - Domain names category (optional)
  - **provider** (object) - Registrar provider (optional)
  - **contract_product_counts** (object[]) - Array of contract product counts grouped by contract product status (optional)
    - **count** (integer) - Number of contract products set to this configuration with this status (optional)
    - **status_id** (integer) - Contract product status id (optional)
    - **status_code** (string) - Contract product status code (optional)

#### Response Example
```json
{
  "data": {
    "id": 123,
    "category_id": 456,
    "provider_id": 789,
    "registrar": "example_registrar",
    "org_id": 101,
    "brand_id": 102,
    "category_default": false,
    "provider_default": false,
    "code": "REG001",
    "name": "Example Configuration",
    "enabled": true,
    "polling_enabled": true,
    "dac_enabled": true,
    "field_values": [
      {
        "key": "username",
        "value": "user@example.com"
      }
    ],
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:00:00Z",
    "category": {},
    "provider": {},
    "contract_product_counts": [
      {
        "count": 5,
        "status_id": 1,
        "status_code": "active"
      }
    ]
  }
}
```
```

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

### Update TLD Product

Source: https://apidocs.upmind.com/modules/web_hosting

Update a TLD product's configuration, including availability, renewal periods, and pricing.

```APIDOC
## PUT /api/modules/web_hosting/domains/tlds/:product_id|:tld

### Description
Update a TLD product.

### Method
PUT

### Endpoint
https://api.upmind.io/api/modules/web_hosting/domains/tlds/:product_id|:tld

### Parameters
#### Path Parameters
- **product_id** (string) - Optional - Product id (Required without tld)
- **tld** (string) - Optional - TLD (Required without id)

#### Request Body
- **registrar** (string) - Optional - Provision provider code of a particular registrar to use for new orders, if desired.
- **enabled** (mixed) - Optional - Whether or not this TLD should be available for sale. Default value: `true`.
- **late_renew_days** (mixed) - Optional - Number of days after expiry domains of this TLD can still be renewed.
- **redemption_period_days** (mixed) - Optional - Number of days' redemption period for this TLD.
- **max_reg_period_years** (mixed) - Optional - Maximum number of years a domain of this TLD can be registered/renewed for.
- **prices** (object[]) - Optional - Prices for this TLD product
  - **billing_cycle_years** (integer) - Required - Number of years to register/renew at this price.
  - **currency_id** (integer) - Required - Currency for this price.
  - **price** (double) - Required - Price for the registration/renewal/transfer (before any discounts/overrides).
  - **pricelist_id** (integer) - Required - Pricelist this price belongs to.

### Request Example
```json
{
  "registrar": "example_registrar",
  "enabled": false,
  "prices": [
    {
      "billing_cycle_years": 1,
      "currency_id": 1,
      "price": 10.99,
      "pricelist_id": 100
    }
  ]
}
```

### Response
#### Success Response (200)
- **data** (object[]) - Catalogue Products with some additional TLD product data
  - **tld** (string) - TLD of this product
  - **enabled** (boolean) - Whether or not this TLD is available for sale (also see: clients_can_order)
  - **registrar_optional** (string) - Provision provider code of the particular registrar used for new orders
  - **max_reg_period_years** (integer) - Optional - Maximum number of years a domain of this TLD can be registered/renewed for
  - **late_renew_days** (integer) - Optional - Number of days after expiry domains of this TLD can still be renewed
  - **redemption_period_days** (integer) - Optional - Number of days' redemption period for this TLD
  - **prices** (object[]) - Optional - Prices for registration/renewal/transfer (before any discounts/overrides)
    - **billing_cycle_years** (integer) - Number of years to register/renew at this price
    - **currency_id** (integer) - Currency for this price
    - **price** (double) - Price for the registration/renewal/transfer (before any discounts/overrides)
    - **pricelist_id** (integer) - Pricelist this price belongs to

#### Response Example
```json
{
  "data": [
    {
      "tld": ".com",
      "enabled": true,
      "registrar_optional": "example_registrar",
      "max_reg_period_years": 10,
      "late_renew_days": 5,
      "redemption_period_days": 30,
      "prices": [
        {
          "billing_cycle_years": 1,
          "currency_id": 1,
          "price": 10.99,
          "pricelist_id": 100
        }
      ]
    }
  ]
}
```
```

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

### Toggle Registrar Configuration Notification Polling

Source: https://apidocs.upmind.com/modules/web_hosting

Toggles domain notification polling on or off for a specific registrar configuration.

```APIDOC
## PATCH /api/modules/web_hosting/domains/registrars/configurations/:configuration_id/polling

### Description
Toggle domain notification polling on or off for this configuration.

### Method
PATCH

### Endpoint
/api/modules/web_hosting/domains/registrars/configurations/:configuration_id/polling

### Parameters
#### Path Parameters
- **configuration_id** (string) - Required - The ID of the registrar configuration.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **data** (object) - Provision configuration
  - **id** (integer) - Registrar configuration id
  - **category_id** (integer) - Domain names category id
  - **provider_id** (integer) - Registrar provider id
  - **registrar** (string) - Domain registrar provider code
  - **org_id** (integer) - Organisation id
  - **brand_id** (integer) - Brand id (0 for organisation-level configurations)
  - **category_default** (boolean) - Whether or not this is the default registrar configuration for the org/brand
  - **provider_default** (boolean) - Whether or not this is the default registrar configuration of this provider for the org/brand
  - **code** (string) - Unique registrar configuration code
  - **name** (string) - Registrar configuration name
  - **enabled** (boolean) - Whether or not this registrar configuration is enabled for use
  - **polling_enabled** (boolean) - Whether or not notification event polling is enabled
  - **dac_enabled** (boolean) - Whether or not this configuration is used for DAC searches
  - **field_values** (mixed[]) - Key/value configuration field data (password field values only stored encrypted on an adapter server)
  - **created_at** (datetime) - Registrar configuration creation date + time
  - **updated_at** (datetime) - Registrar configuration last updated date + time
  - **category** (object) - Domain names category (optional)
  - **provider** (object) - Registrar provider (optional)
  - **contract_product_counts** (object[]) - Array of contract product counts grouped by contract product status (optional)
    - **count** (integer) - Number of contract products set to this configuration with this status (optional)
    - **status_id** (integer) - Contract product status id (optional)
    - **status_code** (string) - Contract product status code (optional)

#### Response Example
```json
{
  "data": {
    "id": 123,
    "category_id": 456,
    "provider_id": 789,
    "registrar": "example_registrar",
    "org_id": 101,
    "brand_id": 102,
    "category_default": false,
    "provider_default": false,
    "code": "REG001",
    "name": "Example Configuration",
    "enabled": true,
    "polling_enabled": true,
    "dac_enabled": false,
    "field_values": [
      {
        "key": "username",
        "value": "user@example.com"
      }
    ],
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:00:00Z",
    "category": {},
    "provider": {},
    "contract_product_counts": [
      {
        "count": 5,
        "status_id": 1,
        "status_code": "active"
      }
    ]
  }
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.