INWX DomRobot API

https://www.inwx.de/en/help/apidoc
Admin
The DomRobot API provides XML-RPC and JSON-RPC interfaces for programmatic interaction with INWX...
Tokens:217,725
Snippets:829
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Authinfo2 API Endpoints

Source: https://www.inwx.de/en/help/apidoc/f/ch02s06

Endpoints for Authinfo2 related operations, including create and get price.

```APIDOC
## Authinfo2 API Endpoints

### Description
Provides endpoints for Authinfo2 related operations.

### Endpoints
- `authinfo2.create`
- `authinfo2.getprice`
```

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

### hosting.create

Source: https://www.inwx.de/en/help/apidoc/f/ch02s16

Creates a new hosting subscription. This endpoint sets up a new hosting service for a user.

```APIDOC
## POST /hosting/create

### Description
Creates a new hosting subscription.

### Method
POST

### Endpoint
/hosting/create

### Parameters
#### Request Body
- **domainName** (string) - Required - The domain name for the hosting.
- **productId** (integer) - Required - The ID of the hosting product.

### Request Example
{
  "domainName": "example.com",
  "productId": 1
}

### Response
#### Success Response (200)
- **hostingId** (integer) - The ID of the created hosting subscription.

#### Response Example
{
  "hostingId": 123
}

```

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

### Authinfo2 API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s12

Manage Authinfo2 details and retrieve pricing information. Endpoints include creating Authinfo2 records and getting pricing.

```APIDOC
## Authinfo2 API Endpoints

### authinfo2.create

**Description**: Creates a new Authinfo2 record.

**Method**: POST

**Endpoint**: `/api/authinfo2.create`

### authinfo2.getprice

**Description**: Retrieves pricing information for Authinfo2 services.

**Method**: POST

**Endpoint**: `/api/authinfo2.getprice`
```

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

### hosting.create

Source: https://www.inwx.de/en/help/apidoc/f/ch02s14

Creates a new hosting service. Allows users to provision new hosting accounts.

```APIDOC
## POST /hosting/create

### Description
Creates a new hosting service.

### Method
POST

### Endpoint
/hosting/create

### Parameters
#### Request Body
- **domainName** (string) - Required - The domain name for the hosting service.
- **productId** (string) - Required - The ID of the hosting product.

### Request Example
{
  "domainName": "example.com",
  "productId": "basic"
}

### Response
#### Success Response (201)
- **hostingId** (string) - The ID of the newly created hosting service.

#### Response Example
{
  "hostingId": "67890"
}

```

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

### dyndnssubscription.create

Source: https://www.inwx.de/en/help/apidoc/f/ch02s08

Creates a new dynamic DNS subscription. This endpoint is used to start a subscription for dynamic DNS services for a specific domain.

```APIDOC
## POST /dyndnssubscription/create

### Description
Creates a new dynamic DNS subscription.

### Method
POST

### Endpoint
/dyndnssubscription/create

### Parameters
#### Request Body
- **domain** (string) - Required - The domain for the subscription.
- **productId** (integer) - Required - The ID of the dynamic DNS product.

### Request Example
{
  "domain": "example.com",
  "productId": 456
}

### Response
#### Success Response (201)
- **subscriptionId** (integer) - The ID of the created subscription.

#### Response Example
{
  "subscriptionId": 789
}

```

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

### nameserver.create

Source: https://www.inwx.de/en/help/apidoc/f/ch02s16

Creates a new nameserver.  This registers a new nameserver with the system.

```APIDOC
## POST /nameserver/create

### Description
Creates a new nameserver.

### Method
POST

### Endpoint
/nameserver/create

### Parameters
#### Request Body
- **nameserverName** (string) - Required - The name of the nameserver.
- **ipAddresses** (array) - Required - An array of IP addresses for the nameserver.

### Request Example
{
  "nameserverName": "ns1.example.com",
  "ipAddresses": ["1.2.3.4", "5.6.7.8"]
}

### Response
#### Success Response (200)
- **nameserverId** (integer) - The ID of the created nameserver.

#### Response Example
{
  "nameserverId": 123
}

```

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

### nameserver.create

Source: https://www.inwx.de/en/help/apidoc/f/ch02s14

Creates a new nameserver.  Allows users to register a new nameserver with a domain.

```APIDOC
## POST /nameserver/create

### Description
Creates a new nameserver.

### Method
POST

### Endpoint
/nameserver/create

### Parameters
#### Request Body
- **nameserver** (string) - Required - The name of the nameserver (e.g., ns1.example.com).
- **ipAddress** (string) - Required - The IP address of the nameserver.

### Request Example
{
  "nameserver": "ns1.example.com",
  "ipAddress": "192.168.1.1"
}

### Response
#### Success Response (201)
- **status** (string) - Status of the creation.

#### Response Example
{
  "status": "success"
}

```

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

### Certificate Management API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s11

Manage SSL certificates. This API supports operations such as canceling, creating, retrieving product details, getting certificate information, listing certificates and products, and managing renewals.

```APIDOC
## Certificate Management API

### Description
APIs for managing certificates.

### Endpoints

- `POST /api/certificate/cancel`
- `POST /api/certificate/create`
- `POST /api/certificate/getProduct`
- `POST /api/certificate/info`
- `POST /api/certificate/list`
- `POST /api/certificate/listProducts`
- `POST /api/certificate/listRemainingNeededData`
- `POST /api/certificate/log`
- `POST /api/certificate/reissue`
- `POST /api/certificate/renew`
- `POST /api/certificate/setAutorenew`
- `POST /api/certificate/setresendapproval`
- `POST /api/certificate/updateOrder`
```

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

### Hosting API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s05

Endpoints for managing hosting services, including canceling, accessing control panels, creating, getting prices, checking suspension status, listing, reinstating, unsuspending, and updating hosting periods.

```APIDOC
## hosting.cancel

### Description
Cancels a hosting service.

### Method
POST

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.cancel

## hosting.controlPanel

### Description
Provides access to the hosting control panel.

### Method
GET

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.controlPanel

## hosting.create

### Description
Creates a new hosting service.

### Method
POST

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.create

## hosting.getPrices

### Description
Retrieves pricing information for hosting services.

### Method
GET

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.getPrices

## hosting.issuspended

### Description
Checks if a hosting service is suspended.

### Method
GET

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.issuspended

## hosting.list

### Description
Lists all available hosting services.

### Method
GET

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.list

## hosting.reinstate

### Description
Reinstates a suspended hosting service.

### Method
POST

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.reinstate

## hosting.unsuspend

### Description
Unsuspends a hosting service.

### Method
POST

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.unsuspend

## hosting.updatePeriod

### Description
Updates the subscription period for a hosting service.

### Method
PUT

### Endpoint
/en/help/apidoc/f/ch02s13.html#hosting.updatePeriod
```

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

### dyndnssubscription.listProducts

Source: https://www.inwx.de/en/help/apidoc/f/ch02s14

Lists the available dynamic DNS subscription products.  Users can choose a suitable product for creating a subscription.

```APIDOC
## GET /dyndnssubscription/listProducts

### Description
Lists the available dynamic DNS subscription products.

### Method
GET

### Endpoint
/dyndnssubscription/listProducts

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **products** (array) - Array of available product objects.

#### Response Example
{
  "products": [
    {
      "productId": "standard",
      "name": "Standard",
      "price": 5.00
    }
  ]
}

```

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

### Hosting API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s17

Manage your hosting services, including canceling, controlling panel access, creating, getting prices, checking suspension status, listing, reinstating, unsuspending, and updating hosting periods.

```APIDOC
## hosting.cancel

### Description
Cancels a hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/cancel

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **hostingId** (integer) - Required - The ID of the hosting service to cancel.

### Request Example
```json
{
  "hostingId": 12345
}
```

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

#### Response Example
```json
{
  "status": "success",
  "message": "Hosting service cancelled successfully."
}
```

## hosting.controlPanel

### Description
Provides access to the hosting control panel.

### Method
GET

### Endpoint
/api/v1/hosting/controlPanel

### Parameters
#### Path Parameters
None

#### Query Parameters
- **hostingId** (integer) - Required - The ID of the hosting service.

### Request Example
None

### Response
#### Success Response (200)
- **url** (string) - The URL to access the control panel.

#### Response Example
```json
{
  "url": "https://controlpanel.example.com"
}
```

## hosting.create

### Description
Creates a new hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **planId** (integer) - Required - The ID of the hosting plan.
- **domainName** (string) - Required - The domain name for the hosting service.

### Request Example
```json
{
  "planId": 11223,
  "domainName": "newdomain.com"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.
- **message** (string) - A message describing the result of the operation.
- **hostingId** (integer) - The ID of the newly created hosting service.

#### Response Example
```json
{
  "status": "success",
  "message": "Hosting service created successfully.",
  "hostingId": 54321
}
```

## hosting.getPrices

### Description
Retrieves the prices for available hosting plans.

### Method
GET

### Endpoint
/api/v1/hosting/getPrices

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **prices** (array) - A list of hosting plan prices.
  - **planId** (integer) - The ID of the hosting plan.
  - **name** (string) - The name of the hosting plan.
  - **price** (float) - The monthly price of the plan.

#### Response Example
```json
{
  "prices": [
    {
      "planId": 11223,
      "name": "Basic Plan",
      "price": 9.99
    }
  ]
}
```

## hosting.issuspended

### Description
Checks if a hosting service is suspended.

### Method
GET

### Endpoint
/api/v1/hosting/issuspended

### Parameters
#### Path Parameters
None

#### Query Parameters
- **hostingId** (integer) - Required - The ID of the hosting service.

### Request Example
None

### Response
#### Success Response (200)
- **isSuspended** (boolean) - True if the hosting service is suspended, false otherwise.

#### Response Example
```json
{
  "isSuspended": false
}
```

## hosting.list

### Description
Lists all hosting services for the account.

### Method
GET

### Endpoint
/api/v1/hosting/list

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **hostingServices** (array) - A list of hosting service objects.
  - **hostingId** (integer) - The ID of the hosting service.
  - **domainName** (string) - The domain name associated with the service.
  - **planName** (string) - The name of the hosting plan.
  - **status** (string) - The current status of the service.

#### Response Example
```json
{
  "hostingServices": [
    {
      "hostingId": 12345,
      "domainName": "example.com",
      "planName": "Basic Plan",
      "status": "active"
    }
  ]
}
```

## hosting.reinstate

### Description
Reinstates a suspended hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/reinstate

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **hostingId** (integer) - Required - The ID of the hosting service to reinstate.

### Request Example
```json
{
  "hostingId": 12345
}
```

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

#### Response Example
```json
{
  "status": "success",
  "message": "Hosting service reinstated successfully."
}
```

## hosting.unsuspend

### Description
Unsuspends a hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/unsuspend

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **hostingId** (integer) - Required - The ID of the hosting service to unsuspend.

### Request Example
```json
{
  "hostingId": 12345
}
```

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

#### Response Example
```json
{
  "status": "success",
  "message": "Hosting service unsuspended successfully."
}
```

## hosting.updatePeriod

### Description
Updates the billing period for a hosting service.

### Method
PUT

### Endpoint
/api/v1/hosting/updatePeriod

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **hostingId** (integer) - Required - The ID of the hosting service.
- **newBillingPeriod** (string) - Required - The new billing period (e.g., "monthly", "annually").

### Request Example
```json
{
  "hostingId": 12345,
  "newBillingPeriod": "annually"
}
```

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

#### Response Example
```json
{
  "status": "success",
  "message": "Billing period updated successfully."
}
```
```

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

### Application API

Source: https://www.inwx.de/en/help/apidoc/f

Contains methods for checking and creating applications.

```APIDOC
## Application API Endpoints

### Description
Contains methods for checking and creating applications.

### Methods
- `application.check`
- `application.create`

### Endpoints
All application-related methods are typically accessed via a single API endpoint, with the specific method name included in the request payload.

### Request Example (JSON-RPC)
```json
{
  "method": "application.check",
  "params": {
    "application_id": "some_app_id"
  },
  "id": 1
}
```

### Response Example (JSON-RPC)
```json
{
  "result": {
    "status": "active"
  },
  "id": 1
}
```
```

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

### Hosting API

Source: https://www.inwx.de/en/help/apidoc/f/ch04

Manage hosting services, including canceling, controlling, creating, getting prices, checking suspension status, listing, reinstating, unsuspending, and updating billing periods.

```APIDOC
## hosting.cancel

### Description
Cancels a hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/cancel

### Parameters
#### Request Body
- **id** (integer) - Required - The ID of the hosting service to cancel.

### Request Example
```json
{
  "id": 12345
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## hosting.controlPanel

### Description
Provides access to the hosting control panel.

### Method
GET

### Endpoint
/api/v1/hosting/controlPanel

### Parameters
#### Query Parameters
- **id** (integer) - Required - The ID of the hosting service.

### Response
#### Success Response (200)
- **url** (string) - The URL to access the control panel.

#### Response Example
```json
{
  "url": "https://controlpanel.example.com"
}
```

## hosting.create

### Description
Creates a new hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/create

### Parameters
#### Request Body
- **domainId** (integer) - Required - The ID of the domain to associate with the hosting service.
- **packageId** (integer) - Required - The ID of the hosting package.

### Request Example
```json
{
  "domainId": 12345,
  "packageId": 67890
}
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the created hosting service.

#### Response Example
```json
{
  "id": 11223
}
```

## hosting.getPrices

### Description
Retrieves pricing information for hosting packages.

### Method
GET

### Endpoint
/api/v1/hosting/getPrices

### Parameters
None

### Response
#### Success Response (200)
- **prices** (array) - A list of hosting package pricing objects.
  - **packageId** (integer) - The ID of the package.
  - **name** (string) - The name of the package.
  - **price** (float) - The price of the package.

#### Response Example
```json
{
  "prices": [
    {
      "packageId": 67890,
      "name": "Basic Hosting",
      "price": 5.99
    }
  ]
}
```

## hosting.issuspended

### Description
Checks if a hosting service is suspended.

### Method
GET

### Endpoint
/api/v1/hosting/issuspended

### Parameters
#### Query Parameters
- **id** (integer) - Required - The ID of the hosting service.

### Response
#### Success Response (200)
- **suspended** (boolean) - True if the hosting service is suspended, false otherwise.

#### Response Example
```json
{
  "suspended": false
}
```

## hosting.list

### Description
Lists all hosting services for the account.

### Method
GET

### Endpoint
/api/v1/hosting/list

### Parameters
None

### Response
#### Success Response (200)
- **services** (array) - A list of hosting service objects.
  - **id** (integer) - The ID of the hosting service.
  - **domain** (string) - The domain associated with the service.
  - **package** (string) - The name of the hosting package.
  - **status** (string) - The current status of the service.

#### Response Example
```json
{
  "services": [
    {
      "id": 11223,
      "domain": "example.com",
      "package": "Basic Hosting",
      "status": "active"
    }
  ]
}
```

## hosting.reinstate

### Description
Reinstates a suspended hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/reinstate

### Parameters
#### Request Body
- **id** (integer) - Required - The ID of the hosting service to reinstate.

### Request Example
```json
{
  "id": 11223
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## hosting.unsuspend

### Description
Unsuspends a hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/unsuspend

### Parameters
#### Request Body
- **id** (integer) - Required - The ID of the hosting service to unsuspend.

### Request Example
```json
{
  "id": 11223
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## hosting.updatePeriod

### Description
Updates the billing period for a hosting service.

### Method
POST

### Endpoint
/api/v1/hosting/updatePeriod

### Parameters
#### Request Body
- **id** (integer) - Required - The ID of the hosting service.
- **period** (string) - Required - The new billing period (e.g., "monthly", "yearly").

### Request Example
```json
{
  "id": 11223,
  "period": "yearly"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### host.create

Source: https://www.inwx.de/en/help/apidoc/f/ch02s14

Creates a new host (nameserver). Allows users to register a new nameserver with a given IP address.

```APIDOC
## POST /host/create

### Description
Creates a new host (nameserver).

### Method
POST

### Endpoint
/host/create

### Parameters
#### Request Body
- **hostname** (string) - Required - The hostname for the nameserver.
- **ipAddress** (string) - Required - The IP address for the nameserver.

### Request Example
{
  "hostname": "ns1.example.com",
  "ipAddress": "192.168.1.1"
}

### Response
#### Success Response (201)
- **status** (string) - Status of the creation.

#### Response Example
{
  "status": "success"
}

```

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

### Nameserver API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s17

Manage nameserver configurations, including checking, cloning, creating, deleting, exporting, and updating nameservers and their records.

```APIDOC
## nameserver.check

### Description
Checks the status or availability of a nameserver.

### Method
GET

### Endpoint
/api/v1/nameserver/check

### Parameters
#### Path Parameters
None

#### Query Parameters
- **nameserverId** (integer) - Required - The ID of the nameserver to check.

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - The status of the nameserver (e.g., "active", "inactive").

#### Response Example
```json
{
  "status": "active"
}
```

## nameserver.clone

### Description
Clones an existing nameserver configuration.

### Method
POST

### Endpoint
/api/v1/nameserver/clone

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **sourceNameserverId** (integer) - Required - The ID of the nameserver to clone from.
- **targetNameserverId** (integer) - Required - The ID of the target nameserver to clone to.

### Request Example
```json
{
  "sourceNameserverId": 111,
  "targetNameserverId": 222
}
```

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

#### Response Example
```json
{
  "status": "success",
  "message": "Nameserver cloned successfully."
}
```

## nameserver.create

### Description
Creates a new nameserver.

### Method
POST

### Endpoint
/api/v1/nameserver/create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **nameserverName** (string) - Required - The name for the new nameserver.

### Request Example
```json
{
  "nameserverName": "ns1.example.com"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.
- **message** (string) - A message describing the result of the operation.
- **nameserverId** (integer) - The ID of the newly created nameserver.

#### Response Example
```json
{
  "status": "success",
  "message": "Nameserver created successfully.",
  "nameserverId": 333
}
```

## nameserver.createRecord

### Description
Creates a new record within a nameserver.

### Method
POST

### Endpoint
/api/v1/nameserver/createRecord

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **nameserverId** (integer) - Required - The ID of the nameserver.
- **recordType** (string) - Required - The type of the record (e.g., "A", "CNAME").
- **name** (string) - Required - The name of the record.
- **value** (string) - Required - The value of the record.
- **ttl** (integer) - Optional - The time-to-live for the record.

### Request Example
```json
{
  "nameserverId": 333,
  "recordType": "A",
  "name": "www",
  "value": "192.0.2.1",
  "ttl": 3600
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.
- **message** (string) - A message describing the result of the operation.
- **recordId** (integer) - The ID of the newly created record.

#### Response Example
```json
{
  "status": "success",
  "message": "Record created successfully.",
  "recordId": 777
}
```

## nameserver.delete

### Description
Deletes a nameserver.

### Method
DELETE

### Endpoint
/api/v1/nameserver/delete

### Parameters
#### Path Parameters
None

#### Query Parameters
- **nameserverId** (integer) - Required - The ID of the nameserver to delete.

### Request Example
None

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

#### Response Example
```json
{
  "status": "success",
  "message": "Nameserver deleted successfully."
}
```

## nameserver.deleteRecord

### Description
Deletes a record from a nameserver.

### Method
DELETE

### Endpoint
/api/v1/nameserver/deleteRecord

### Parameters
#### Path Parameters
None

#### Query Parameters
- **nameserverId** (integer) - Required - The ID of the nameserver.
- **recordId** (integer) - Required - The ID of the record to delete.

### Request Example
None

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

#### Response Example
```json
{
  "status": "success",
  "message": "Record deleted successfully."
}
```

## nameserver.export

### Description
Exports the configuration of a nameserver.

### Method
GET

### Endpoint
/api/v1/nameserver/export

### Parameters
#### Path Parameters
None

#### Query Parameters
- **nameserverId** (integer) - Required - The ID of the nameserver to export.

### Request Example
None

### Response
#### Success Response (200)
- **configuration** (string) - The exported configuration data.

#### Response Example
```json
{
  "configuration": "zone "example.com" { ... }"
}
```

## nameserver.exportlist

### Description
Exports a list of all nameservers.

### Method
GET

### Endpoint
/api/v1/nameserver/exportlist

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **nameservers** (array) - A list of nameserver objects.
  - **nameserverId** (integer) - The ID of the nameserver.
  - **nameserverName** (string) - The name of the nameserver.

#### Response Example
```json
{
  "nameservers": [
    {
      "nameserverId": 333,
      "nameserverName": "ns1.example.com"
    }
  ]
}
```

## nameserver.exportrecords

### Description
Exports all records for a specific nameserver.

### Method
GET

### Endpoint
/api/v1/nameserver/exportrecords

### Parameters
#### Path Parameters
None

#### Query Parameters
- **nameserverId** (integer) - Required - The ID of the nameserver.

### Request Example
None

### Response
#### Success Response (200)
- **records** (array) - A list of record objects.
  - **recordId** (integer) - The ID of the record.
  - **recordType** (string) - The type of the record.
  - **name** (string) - The name of the record.
  - **value** (string) - The value of the record.
  - **ttl** (integer) - The time-to-live for the record.

#### Response Example
```json
{
  "records": [
    {
      "recordId": 777,
      "recordType": "A",
      "name": "www",
      "value": "192.0.2.1",
      "ttl": 3600
    }
  ]
}
```

## nameserver.info

### Description
Retrieves information about a specific nameserver.

### Method
GET

### Endpoint
/api/v1/nameserver/info

### Parameters
#### Path Parameters
None

#### Query Parameters
- **nameserverId** (integer) - Required - The ID of the nameserver.

### Request Example
None

### Response
#### Success Response (200)
- **nameserverId** (integer) - The ID of the nameserver.
- **nameserverName** (string) - The name of the nameserver.

#### Response Example
```json
{
  "nameserverId": 333,
  "nameserverName": "ns1.example.com"
}
```

## nameserver.list

### Description
Lists all nameservers for the account.

### Method
GET

### Endpoint
/api/v1/nameserver/list

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **nameservers** (array) - A list of nameserver objects.
  - **nameserverId** (integer) - The ID of the nameserver.
  - **nameserverName** (string) - The name of the nameserver.

#### Response Example
```json
{
  "nameservers": [
    {
      "nameserverId": 333,
      "nameserverName": "ns1.example.com"
    }
  ]
}
```

## nameserver.update

### Description
Updates a nameserver configuration.

### Method
PUT

### Endpoint
/api/v1/nameserver/update

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **nameserverId** (integer) - Required - The ID of the nameserver to update.
- **newNameserverName** (string) - Required - The new name for the nameserver.

### Request Example
```json
{
  "nameserverId": 333,
  "newNameserverName": "ns2.example.com"
}
```

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

#### Response Example

```

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

### JavaScript: Handle Global Raven Library Initialization

Source: https://www.inwx.de/en/help/apidoc/f/ch02s08

This code checks if the `ravenLib` object exists on the `top` window. If it's undefined, it initializes `top.ravenLib` to null. This is likely a setup for a global error tracking or logging library.

```javascript
if (typeof(top.ravenLib) == "undefined"){
	top.ravenLib = null;
}
```

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

### Customer Login Form with HTML and JavaScript

Source: https://www.inwx.de/en/help/apidoc/f/ch02s18

This HTML snippet defines a customer login form with fields for username and password, and a submit button. It uses POST method to send credentials to the specified action URL. The associated JavaScript, within the `$(document).ready` function, likely handles form submission or client-side validation, though the provided example is commented out.

```html
<div class="inwx-login-helper inwx-col2"><div><h3>Please insert username and password!</h3><form action="https://www.inwx.de/en/customer/login" method="post">
					<div class="input_obj">
						<div>Username:</div>
						<input type="text" name="usr" id="usern" value="">
					</div>
					<div class="input_obj">
						<div>Password:</div>
						<input type="password" name="pwd" id="pword" value="" autocomplete="on">
					</div>
					<div class="input_obj" style="margin-bottom:10px;">
						<div>&nbsp;</div><input type="submit" name="btn_subm" id="btn_subm" value="Login">
					</div></form><div class="forgot-password"><a href="/en/customer/lostpwd" target="_top">Forgot your password?</a>
				    </div></div></div>
```

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

### nameserver.create

Source: https://www.inwx.de/en/help/apidoc/f/ch02s12

This endpoint allows you to create a new nameserver. It's used to register nameservers for domains.

```APIDOC
## POST /nameserver.create

### Description
Creates a new nameserver.

### Method
POST

### Endpoint
/nameserver.create

### Parameters
#### Request Body
- **name** (string) - Required - The name of the nameserver.
- **ip** (string) - Required - The IPv4 address of the nameserver.
- **domain** (string) - Required - The domain the nameserver belongs to.
- **ip6** (string) - Optional - The IPv6 address of the nameserver.

### Request Example
```json
{
  "name": "ns1.example.com",
  "ip": "192.168.1.1",
  "domain": "example.com",
  "ip6": "2001:db8::1"
}
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the request.
- **msg** (string) - A message describing the result of the request.
- **id** (integer) - The ID of the created nameserver.

#### Response Example
```json
{
  "code": 1000,
  "msg": "Command completed successfully",
  "id": 12345
}
```
```

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

### dyndnssubscription.listProducts

Source: https://www.inwx.de/en/help/apidoc/f/ch02s16

Lists available Dynamic DNS products. This endpoint provides a list of product options for DNS subscriptions.

```APIDOC
## GET /dyndnssubscription/listProducts

### Description
Lists available Dynamic DNS products.

### Method
GET

### Endpoint
/dyndnssubscription/listProducts

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **products** (array) - An array of product objects.

#### Response Example
{
  "products": [
    {
      "productId": 1,
      "name": "Basic Dynamic DNS",
      "price": 5.00
    }
  ]
}

```

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

### Application API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s03

This section details the various methods available for application management through the API.

```APIDOC
## Application API Endpoints

### application.check

#### Description
Checks the status of an application.

#### Method
GET

#### Endpoint
/api/application/check

### application.create

#### Description
Creates a new application.

#### Method
POST

#### Endpoint
/api/application/create
```

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

### Application API Methods

Source: https://www.inwx.de/en/help/apidoc/f/ch02

Documentation for methods related to application management, including checking and creating applications.

```APIDOC
## Application API Methods

### Description
This section outlines the API methods for managing applications within the DomRobot system.

### Methods

#### application.check

##### Description
Checks the status or existence of an application.

##### Method
POST or GET (depending on implementation)

##### Endpoint
`/api/application/check` (example, actual endpoint may vary)

##### Parameters
*   **applicationId** (string) - Required - The ID of the application to check.

#### application.create

##### Description
Creates a new application.

##### Method
POST or GET (depending on implementation)

##### Endpoint
`/api/application/create` (example, actual endpoint may vary)

##### Parameters
*   **applicationName** (string) - Required - The name for the new application.
*   **description** (string) - Optional - A description for the application.

```

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

### dyndnssubscription.listProducts

Source: https://www.inwx.de/en/help/apidoc/f/ch02s08

Lists available dynamic DNS products. This endpoint provides a list of available products that can be used to create a dynamic DNS subscription.

```APIDOC
## GET /dyndnssubscription/listProducts

### Description
Lists available dynamic DNS products.

### Method
GET

### Endpoint
/dyndnssubscription/listProducts

### Parameters
N/A

### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **products** (array) - An array of product objects.

#### Response Example
{
  "products": [
    {
      "productId": 456,
      "name": "Basic Dynamic DNS",
      "price": 10.00
    }
  ]
}

```

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

### Application API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s20

Manage applications through the API, including creating, deleting, retrieving information, listing applications, and updating them.

```APIDOC
## Application API Endpoints

### Description
This section details the API endpoints for managing applications.

### Endpoints
- `application.create`: Create a new application.
- `application.delete`: Delete an existing application.
- `application.info`: Retrieve information about a specific application.
- `application.list`: List all applications.
- `application.update`: Update an existing application.
```

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

### Application API

Source: https://www.inwx.de/en/help/apidoc/f/ch01s02

This section covers methods related to applications.

```APIDOC
## Application API

This section covers methods related to applications.

### application.check

#### Description
Checks the status of an application.

#### Method
POST (or relevant method for RPC calls)

#### Endpoint
/api/application/check

#### Parameters
##### Request Body
- **application_id** (integer) - Required - The ID of the application.

### application.create

#### Description
Creates a new application.

#### Method
POST (or relevant method for RPC calls)

#### Endpoint
/api/application/create

#### Parameters
##### Request Body
- **name** (string) - Required - The name of the application.
- **description** (string) - Optional - A description of the application.
```

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

### Application API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s08

API endpoints for checking and creating applications.

```APIDOC
## Application API Endpoints

### application.check

#### Description
Checks the status of an application.

#### Method
POST/GET

#### Endpoint
/api/application/check

### application.create

#### Description
Creates a new application.

#### Method
POST/GET

#### Endpoint
/api/application/create
```

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

### Application Management API

Source: https://www.inwx.de/en/help/apidoc/f

Manage applications, including creating, deleting, retrieving information, listing, and updating them.

```APIDOC
## Application Management API

This section details the API endpoints for managing applications.

### application.create

*   **Description**: Creates a new application.
*   **Method**: (Assumed POST based on common API design)
*   **Endpoint**: `/api/applications` (Assumed)

### application.delete

*   **Description**: Deletes an existing application.
*   **Method**: (Assumed DELETE based on common API design)
*   **Endpoint**: `/api/applications/{appId}` (Assumed)

### application.info

*   **Description**: Retrieves information about a specific application.
*   **Method**: (Assumed GET based on common API design)
*   **Endpoint**: `/api/applications/{appId}` (Assumed)

### application.list

*   **Description**: Lists all applications.
*   **Method**: (Assumed GET based on common API design)
*   **Endpoint**: `/api/applications` (Assumed)

### application.update

*   **Description**: Updates an existing application.
*   **Method**: (Assumed PUT or PATCH based on common API design)
*   **Endpoint**: `/api/applications/{appId}` (Assumed)

```

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

### Nameserver API

Source: https://www.inwx.de/en/help/apidoc/f/index

Manages DNS nameserver records and configurations.

```APIDOC
## Nameserver API

### Description
Manages DNS nameserver configurations and records.

### Methods
- **check**: Checks the status of a nameserver.
- **clone**: Clones an existing nameserver configuration.
- **create**: Creates a new nameserver configuration.
- **createRecord**: Creates a new record within a nameserver.
- **delete**: Deletes a nameserver configuration.
- **deleteRecord**: Deletes a record from a nameserver.
- **export**: Exports nameserver data.
- **exportlist**: Exports a list of nameservers.
- **exportrecords**: Exports records from a nameserver.
- **info**: Retrieves information about a nameserver.
- **list**: Lists available nameservers.
- **update**: Updates a nameserver configuration.
- **updateRecord**: Updates an existing record within a nameserver.

### Endpoints
- /nameserver.check
- /nameserver.clone
- /nameserver.create
- /nameserver.createRecord
- /nameserver.delete
- /nameserver.deleteRecord
- /nameserver.export
- /nameserver.exportlist
- /nameserver.exportrecords
- /nameserver.info
- /nameserver.list
- /nameserver.update
- /nameserver.updateRecord

### Parameters & Responses
(Details for each method would be specified here, including request/response bodies and parameters.)
```

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

### nameserver.clone

Source: https://www.inwx.de/en/help/apidoc/f/ch02s16

Clones an existing nameserver.  This creates a copy of an existing nameserver configuration.

```APIDOC
## POST /nameserver/clone

### Description
Clones an existing nameserver.

### Method
POST

### Endpoint
/nameserver/clone

### Parameters
#### Request Body
- **sourceNameserverId** (integer) - Required - The ID of the nameserver to clone.
- **targetNameserverName** (string) - Required - The name of the new nameserver.

### Request Example
{
  "sourceNameserverId": 123,
  "targetNameserverName": "ns2.example.com"
}

### Response
#### Success Response (200)
- **nameserverId** (integer) - The ID of the created nameserver.

#### Response Example
{
  "nameserverId": 456
}

```

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

### Nameserver API

Source: https://www.inwx.de/en/help/apidoc/f/ch02s03

Endpoints for managing nameserver records and configurations.

```APIDOC
## Nameserver API

### Description
Provides endpoints for managing nameserver configurations and records.

### Endpoints
- `nameserver.check`
- `nameserver.clone`
- `nameserver.create`
- `nameserver.createRecord`
- `nameserver.delete`
- `nameserver.deleteRecord`
- `nameserver.export`
- `nameserver.exportlist`
- `nameserver.exportrecords`
- `nameserver.info`
- `nameserver.list`
- `nameserver.update`
- `nameserver.updateRecord`
```

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

### NameserverSet API

Source: https://www.inwx.de/en/help/apidoc/f

Manage Nameserver Sets for your domain.

```APIDOC
## NameserverSet API Endpoints

This section details the API endpoints for managing Nameserver Sets.

### `nameserverset.create`

**Description:** Creates a new Nameserver Set.
**Method:** POST
**Endpoint:** `/nameserverset.create`

### `nameserverset.delete`

**Description:** Deletes an existing Nameserver Set.
**Method:** POST
**Endpoint:** `/nameserverset.delete`

### `nameserverset.info`

**Description:** Retrieves information about a specific Nameserver Set.
**Method:** POST
**Endpoint:** `/nameserverset.info`

### `nameserverset.list`

**Description:** Lists all available Nameserver Sets.
**Method:** POST
**Endpoint:** `/nameserverset.list`

### `nameserverset.update`

**Description:** Updates an existing Nameserver Set.
**Method:** POST
**Endpoint:** `/nameserverset.update`
```
Tokens:
Raw