Name.com API

https://www.name.com/api-docs
Admin
Name.com API allows developers to programmatically manage domain registrations, DNS records,...
Tokens:18,964
Snippets:136
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /v4/hello

Source: https://www.name.com/api-docs/hello

HelloFunc returns some information about the API server.

```APIDOC
## GET /v4/hello

### Description
HelloFunc returns some information about the API server.

### Method
GET

### Endpoint
/v4/hello

### Response
#### Success Response (200)
- **serverName** (string) - ServerName is an identfier for which server is being accessed.
- **motd** (string) - Motd is a message of the day. It might provide some useful information.
- **username** (string) - Username is the account name you are currently logged into.
- **serverTime** (string) - ServerTime is the current date/time at the server.

#### Response Example
{
    "serverName": "api01",
    "motd": "Welcome to the Name.com API-v4 server",
    "username": "username",
    "serverTime": "2017-11-13T22:58:35Z"
}
```

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

### Pagination Link Header Example

Source: https://www.name.com/api-docs

Example of the Link header returned by list functions to facilitate navigation through paginated results.

```http
Link: <https://api.name.com/v4/domains?page=3>; rel="next",
<https://api.name.com/v4/domains?page=20>; rel="last", 
<https://api.name.com/v4/domains>; rel="first", 
<https://api.name.com/v4/domains>; rel="prev"
```

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

### HelloFunc JSON response structure

Source: https://www.name.com/api-docs/Hello

Example of the JSON object returned by the HelloFunc endpoint.

```json
{
    "serverName": "api01",
    "motd": "Welcome to the Name.com API-v4 server",
    "username": "username",
    "serverTime": "2017-11-13T22:58:35Z"
}
```

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

### CreateRecord JSON response example

Source: https://www.name.com/api-docs/DNS

The expected JSON response body returned after successfully creating a new DNS record.

```json
{
    "id": 12345,
    "domainName": "example.org",
    "host": "www",
    "fqdn": "www.example.org",
    "type": "A",
    "answer": "10.0.0.1",
    "ttl": 300
}
```

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

### GET /v4/hello

Source: https://www.name.com/api-docs/Hello

Returns information about the API server, including server identity, message of the day, current username, and server time.

```APIDOC
## GET /v4/hello

### Description
HelloFunc returns some information about the API server.

### Method
GET

### Endpoint
/v4/hello

### Response
#### Success Response (200)
- **serverName** (string) - ServerName is an identifier for which server is being accessed.
- **motd** (string) - Motd is a message of the day. It might provide some useful information.
- **username** (string) - Username is the account name you are currently logged into.
- **serverTime** (string) - ServerTime is the current date/time at the server.

### Response Example
{
    "serverName": "api01",
    "motd": "Welcome to the Name.com API-v4 server",
    "username": "username",
    "serverTime": "2017-11-13T22:58:35Z"
}
```

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

### GetOrder Response JSON Structure

Source: https://www.name.com/api-docs/Orders

Example JSON response returned by the GetOrder endpoint.

```json
{
    "id": 123456789,
    "createDate": "2017-11-13T22:58:35Z",
    "registrar": "name.com",
    "status": "success",
    "currency": "USD",
    "orderItems": [
        {
            "id": 123456781,
            "status": "success",
            "name": "example.com",
            "tld": "com",
            "type": "registration",
            "price": 12.99,
            "quantity": 1,
            "duration": 1,
            "interval": "year"
        },
        {
            "id": 123456780,
            "status": "success",
            "name": "example.ninja",
            "tld": "ninja",
            "type": "registration",
            "price": 10.99,
            "originalPrice": 10.99,
            "quantity": 1,
            "duration": 1,
            "interval": "year"
        }
    ],
    "authAmount": 23.98,
    "totalCapture": 23.98,
    "finalAmount": "23.98",
    "currencyRate": 0.085474999999999995
}
```

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

### CreateTransfer Request and Response

Source: https://www.name.com/api-docs/Transfers

Example of a POST request to initiate a domain transfer and the corresponding JSON response.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/transfers' -X POST -H 'Content-Type: application/json' --data '{"domainName":"example.org","authCode":"Authc0de","purchasePrice":12.99}'
```

```json
{
    "transfer": {
        "domainName": "example.org",
        "status": "Retrieving Email"
    },
    "order": 123456,
    "totalPaid": 12.99
}
```

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

### GET /v4/accountinfo/balance

Source: https://www.name.com/api-docs/AccountInfo

Retrieves the current account credit balance for the authenticated account.

```APIDOC
## GET /v4/accountinfo/balance

### Description
CheckAccountBalance returns the current account credit balance for the authenticated account.

### Method
GET

### Endpoint
/v4/accountinfo/balance

### Response
#### Success Response (200)
- **balance** (float64) - Balance is the current account balance in USD. Any empty JSON object ("{}") indicates a zero balance.

#### Response Example
{
    "balance": 125.43000000000001
}
```

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

### Get Vanity Nameserver Details

Source: https://www.name.com/api-docs/VanityNameservers

Retrieve detailed information, including IP addresses, for a specific vanity nameserver.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers/ns1.example.org'
```

```json
{
    "domainName": "example.org",
    "hostname": "ns1.example.org",
    "ips": [
        "192.168.1.1",
        "fd01:4860:4860::8888"
    ]
}
```

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

### List DNS Records

Source: https://www.name.com/api-docs/DNS

Retrieve all records for a specific zone using a GET request.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/records'
```

```json
{
    "records": [
        {
            "id": 12345,
            "domainName": "example.org",
            "host": "www",
            "fqdn": "www.example.org",
            "type": "A",
            "answer": "10.0.0.1",
            "ttl": 300
        }
    ]
}
```

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

### GET /v4/domains/{domainName}/vanity_nameservers/{hostname}

Source: https://www.name.com/api-docs/VanityNameservers

Retrieves the full details for a specific vanity nameserver, including its associated IP addresses.

```APIDOC
## GET /v4/domains/{domainName}/vanity_nameservers/{hostname}

### Description
Gets the details for a vanity nameserver registered with the registry, including IP addresses used for glue records.

### Method
GET

### Endpoint
/v4/domains/{domainName}/vanity_nameservers/{hostname}

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain for the vanity nameserver.
- **hostname** (string) - Required - Hostname is the hostname for the vanity nameserver.

### Response
#### Success Response (200)
- **domainName** (string) - The domain the nameserver is a subdomain of.
- **hostname** (string) - The hostname of the nameserver.
- **ips** (array) - List of IP addresses used for glue records.

### Response Example
{
    "domainName": "example.org",
    "hostname": "ns1.example.org",
    "ips": [
        "192.168.1.1",
        "fd01:4860:4860::8888"
    ]
}
```

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

### Get DNS Record Details

Source: https://www.name.com/api-docs/DNS

Retrieve details for a specific DNS record by its ID.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/records/12345'
```

```json
{
    "id": 12345,
    "domainName": "example.org",
    "host": "www",
    "fqdn": "www.example.org",
    "type": "A",
    "answer": "10.0.0.1",
    "ttl": 300
}
```

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

### Get Email Forwarding

Source: https://www.name.com/api-docs/emailforwardings

Retrieve the configuration for a specific email forwarding box.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/email/forwarding/admin'
```

```json
{
    "domainName": "example.org",
    "emailBox": "admin",
    "emailTo": "webmaster@example.net"
}
```

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

### GET /v4/notifications

Source: https://www.name.com/api-docs/WebhookNotification

Retrieve a list of all events you have currently subscribed to.

```APIDOC
## GET /v4/notifications

### Description
List all of the events you have subscribed to.

### Method
GET

### Endpoint
/v4/notifications

### Response
#### Success Response (200)
- **subscriptions** (array) - A list of subscription records.

#### Response Example
{
    "subscriptions": [
        {
            "id": 1,
            "eventName": "domain.transfer.status_change",
            "url": "https://example.com/incomingnotification",
            "active": true,
            "createDate": "2025-02-17T22:58:35Z",
            "updateDate": "2025-02-17T22:58:35Z"
        }
    ]
}
```

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

### GET /v4/transfers/{domainName}

Source: https://www.name.com/api-docs/Transfers

Retrieves detailed information for a specific domain transfer request.

```APIDOC
## GET /v4/transfers/{domainName}

### Description
Gets details for a specific transfer request using the domain name.

### Method
GET

### Endpoint
/v4/transfers/{domainName}

### Parameters
#### Path Parameters
- **domainName** (string) - Required - The domain name to get transfer information for.

### Response
#### Success Response (200)
- **domainName** (string) - The domain to be transferred.
- **email** (string) - The email address where the approval email was sent.
- **status** (string) - The current status of the transfer.

### Response Example
{
    "domainName": "example.org",
    "email": "admin@example.org",
    "status": "Pending Approval"
}
```

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

### GET /v4/orders/{orderId}

Source: https://www.name.com/api-docs/Orders

Retrieves the details of a specific order by its unique identifier.

```APIDOC
## GET /v4/orders/{orderId}

### Description
GetOrder returns details about a specific order.

### Method
GET

### Endpoint
/v4/orders/{orderId}

### Parameters
#### Path Parameters
- **orderId** (int32) - Required - OrderId is the unique identifier of the requested order.

### Response
#### Success Response (200)
- **id** (int32) - Id is the unique identifier of the order.
- **createDate** (string) - CreateDate is the date the order was placed.
- **registrar** (string) - Registrar is registrar with which order is placed.
- **status** (string) - Status indicates the state of the order ('success', 'failed').
- **currency** (string) - Currency indicates currency of the order ('USD', 'CNY').
- **orderItems** (array) - OrderItems is the collection of 1 or more items in the order.
- **authAmount** (float32) - AuthAmount is the amount authorized to complete the order purchase.
- **totalCapture** (float32) - TotalCapture is the amount captured.
- **totalRefund** (float32) - TotalRefund is the amount, if any, refunded.
- **finalAmount** (string) - FinalAmount is the final amount of the order, after discounts and refunds.
- **currencyRate** (float32) - CurrencyRate is the conversion rate from USD to order's currency.

#### Response Example
{
    "id": 123456789,
    "createDate": "2017-11-13T22:58:35Z",
    "registrar": "name.com",
    "status": "success",
    "currency": "USD",
    "orderItems": [
        {
            "id": 123456781,
            "status": "success",
            "name": "example.com",
            "tld": "com",
            "type": "registration",
            "price": 12.99,
            "quantity": 1,
            "duration": 1,
            "interval": "year"
        }
    ],
    "authAmount": 23.98,
    "totalCapture": 23.98,
    "finalAmount": "23.98",
    "currencyRate": 0.085474999999999995
}
```

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

### GET /v4/domains/{domainName}/vanity_nameservers

Source: https://www.name.com/api-docs/VanityNameservers

Lists all vanity nameservers registered with the registry for a given domain. Note that this endpoint omits IP addresses from the response.

```APIDOC
## GET /v4/domains/{domainName}/vanity_nameservers

### Description
Lists all vanity nameservers registered with the registry for a given domain. It omits the IP addresses from the response.

### Method
GET

### Endpoint
/v4/domains/{domainName}/vanity_nameservers

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain to list the vanity nameservers for.

#### Query Parameters
- **perPage** (int32) - Optional - Per Page is the number of records to return per request. Defaults to 1,000.
- **page** (int32) - Optional - Page is which page to return.

### Response
#### Success Response (200)
- **vanityNameservers** (array) - List of vanity nameservers.
- **nextPage** (int32) - Identifier for the next page of results.
- **lastPage** (int32) - Identifier for the final page of results.

### Response Example
{
    "vanityNameservers": [
        {
            "domainName": "example.org",
            "hostname": "ns1.example.org"
        }
    ]
}
```

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

### CreateTransfer API Response

Source: https://www.name.com/api-docs/transfers

Example JSON response returned after a successful domain transfer request.

```json
{
    "transfer": {
        "domainName": "example.org",
        "status": "Retrieving Email"
    },
    "order": 123456,
    "totalPaid": 12.99
}
```

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

### GET /v4/domains/{domainName}/url/forwarding/{host}

Source: https://www.name.com/api-docs/URLForwardings

Returns a specific URL forwarding entry for a given host under a domain.

```APIDOC
## GET /v4/domains/{domainName}/url/forwarding/{host}

### Description
GetURLForwarding returns an URL forwarding entry.

### Method
GET

### Endpoint
/v4/domains/{domainName}/url/forwarding/{host}

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain to list URL forwarding entry for.
- **host** (string) - Required - Host is the part of the domain name before the domain.

### Response
#### Success Response (200)
- **domainName** (string) - DomainName is the domain part of the hostname to forward.
- **host** (string) - Host is the entirety of the hostname.
- **forwardsTo** (string) - ForwardsTo is the URL this host will be forwarded to.
- **type** (string) - Type is the type of forwarding (Masked or Redirect).
- **title** (string) - Title is the title for the html page to use if the type is masked.
- **meta** (string) - Meta is the meta tags to add to the html page if the type is masked.

### Response Example
{
    "domainName": "example.org",
    "host": "www.example.org",
    "forwardsTo": "https://www.example.net",
    "type": "redirect"
}
```

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

### GET /v4/domains/{domainName}/url/forwarding

Source: https://www.name.com/api-docs/URLForwardings

Returns a paginated list of URL forwarding entries for a specified domain.

```APIDOC
## GET /v4/domains/{domainName}/url/forwarding

### Description
ListURLForwardings returns a paginated list of URL forwarding entries for a domain.

### Method
GET

### Endpoint
/v4/domains/{domainName}/url/forwarding

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain to list URL forwarding entries for.

#### Query Parameters
- **perPage** (int32) - Optional - Per Page is the number of records to return per request. Per Page defaults to 1,000.
- **page** (int32) - Optional - Page is which page to return.

### Response
#### Success Response (200)
- **urlForwarding** (array) - URLForwarding is the list of URL forwarding entries.
- **nextPage** (int32) - NextPage is the identifier for the next page of results.
- **lastPage** (int32) - LastPage is the identifier for the final page of results.

### Response Example
{
    "urlForwarding": [
        {
            "domainName": "example.org"
        }
    ]
}
```

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

### GET /v4/orders

Source: https://www.name.com/api-docs/Orders

ListOrders returns all orders in the account. It omits some information that can be retrieved from GetOrder.

```APIDOC
## GET /v4/orders

### Description
ListOrders returns all orders in the account. It omits some information that can be retrieved from GetOrder.

### Method
GET

### Endpoint
/v4/orders

### Parameters
#### Query Parameters
- **perPage** (int32) - Optional - Per Page is the number of records to return per request. Per Page defaults to 1,000.
- **page** (int32) - Optional - Page is which page to return

### Response
#### Success Response (200)
- **parentAccountId** (int32) - ParentAccountId field is populated when requesting account has a parent account id.
- **orders** (array) - Orders is the collection of orders, if any, in the requesting account.
- **nextPage** (int32) - NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
- **lastPage** (int32) - LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.

#### Response Example
{
    "parentAccountId": 34567891,
    "orders": [
        {
            "id": 123456789,
            "createDate": "2022-01-13T22:58:35Z",
            "status": "success",
            "currency": "USD",
            "orderItems": [
                {
                    "id": 123456781,
                    "status": "success",
                    "name": "example.com",
                    "tld": "com",
                    "type": "registration",
                    "price": 12.99,
                    "quantity": 1,
                    "duration": 1,
                    "interval": "year"
                },
                {
                    "id": 123456780,
                    "status": "success",
                    "name": "example.ninja",
                    "tld": "ninja",
                    "type": "registration",
                    "price": 10.99,
                    "quantity": 1,
                    "duration": 1,
                    "interval": "year"
                }
            ],
            "authAmount": 12.99,
            "totalCapture": 12.99,
            "finalAmount": "12.99"
        }
    ]
}
```

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

### GET /v4/domains/{domainName}/email/forwarding

Source: https://www.name.com/api-docs/emailforwardings

Returns a paginated list of email forwarding entries for a specified domain.

```APIDOC
## GET /v4/domains/{domainName}/email/forwarding

### Description
ListEmailForwardings returns a paginated list of email forwarding entries for a domain.

### Method
GET

### Endpoint
/v4/domains/{domainName}/email/forwarding

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain to list email forwarded boxes for.

#### Query Parameters
- **perPage** (int32) - Optional - Per Page is the number of records to return per request. Per Page defaults to 1,000.
- **page** (int32) - Optional - Page is which page to return.

### Response
#### Success Response (200)
- **emailForwarding** (array) - List of forwarded email boxes.
- **nextPage** (int32) - The identifier for the next page of results.
- **lastPage** (int32) - The identifier for the final page of results.

### Response Example
{
    "emailForwarding": [
        {
            "domainName": "example.org",
            "emailBox": "admin",
            "emailTo": "webmaster@example.net"
        }
    ]
}
```

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

### GET /v4/domains/{domainName}/email/forwarding/{emailBox}

Source: https://www.name.com/api-docs/emailforwardings

Returns a specific email forwarding entry for a given domain and email box.

```APIDOC
## GET /v4/domains/{domainName}/email/forwarding/{emailBox}

### Description
GetEmailForwarding returns an email forwarding entry.

### Method
GET

### Endpoint
/v4/domains/{domainName}/email/forwarding/{emailBox}

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain to list email forwarded box for.
- **emailBox** (string) - Required - EmailBox is which email box to retrieve.

### Response
#### Success Response (200)
- **domainName** (string) - DomainName is the domain part of the email address to forward.
- **emailBox** (string) - EmailBox is the user portion of the email address to forward.
- **emailTo** (string) - EmailTo is the entire email address to forward email to.

### Response Example
{
    "domainName": "example.org",
    "emailBox": "admin",
    "emailTo": "webmaster@example.net"
}
```

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

### ListOrders API Response

Source: https://www.name.com/api-docs/Orders

Example JSON response body returned by the ListOrders endpoint containing order details and items.

```json
{
    "parentAccountId": 34567891,
    "orders": [
        {
            "id": 123456789,
            "createDate": "2022-01-13T22:58:35Z",
            "status": "success",
            "currency": "USD",
            "orderItems": [
                {
                    "id": 123456781,
                    "status": "success",
                    "name": "example.com",
                    "tld": "com",
                    "type": "registration",
                    "price": 12.99,
                    "quantity": 1,
                    "duration": 1,
                    "interval": "year"
                },
                {
                    "id": 123456780,
                    "status": "success",
                    "name": "example.ninja",
                    "tld": "ninja",
                    "type": "registration",
                    "price": 10.99,
                    "quantity": 1,
                    "duration": 1,
                    "interval": "year"
                }
            ],
            "authAmount": 12.99,
            "totalCapture": 12.99,
            "finalAmount": "12.99"
        },
        {
            "id": 123456790,
            "createDate": "2021-12-10T22:58:35Z",
            "status": "failed",
            "currency": "USD",
            "orderItems": [
                {
                    "id": 12345677,
                    "status": "refunded",
                    "name": "example2.com",
                    "tld": "com",
                    "type": "registration",
                    "price": 9.9900000000000002,
                    "quantity": 1,
                    "duration": 1,
                    "interval": "year"
                }
            ],
            "authAmount": 9.9900000000000002,
            "totalCapture": 9.9900000000000002,
            "totalRefund": 9.9900000000000002
        }
    ]
}
```

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

### GET /v4/domains/{domainName}/dnssec

Source: https://www.name.com/api-docs/dnssecs

Lists all DNSSEC keys registered with the registry for a specific domain.

```APIDOC
## GET /v4/domains/{domainName}/dnssec

### Description
Lists all of the DNSSEC keys registered with the registry for the specified domain.

### Method
GET

### Endpoint
/v4/domains/{domainName}/dnssec

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain name to list keys for.

### Response
#### Success Response (200)
- **dnssec** (array) - List of registered DNSSEC keys.
- **nextPage** (int32) - Identifier for the next page of results.
- **lastPage** (int32) - Identifier for the final page of results.

### Response Example
{
    "dnssec": [
        {
            "domainName": "example.org",
            "keyTag": 30909,
            "algorithm": 8,
            "digestType": 2,
            "digest": "E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766"
        }
    ]
}
```

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

### GET /v4/domains/{domainName}/records

Source: https://www.name.com/api-docs/DNS

Retrieves a list of all DNS records associated with a specific domain zone.

```APIDOC
## GET /v4/domains/{domainName}/records

### Description
ListRecords returns all records for a zone.

### Method
GET

### Endpoint
/v4/domains/{domainName}/records

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the zone to list the records for.

#### Query Parameters
- **perPage** (int32) - Optional - Per Page is the number of records to return per request. Per Page defaults to 1,000.
- **page** (int32) - Optional - Page is which page to return

### Response
#### Success Response (200)
- **records** (array) - Records contains the records in the zone
- **nextPage** (int32) - NextPage is the identifier for the next page of results.
- **lastPage** (int32) - LastPage is the identifier for the final page of results.

### Response Example
{
    "records": [
        {
            "id": 12345,
            "domainName": "example.org",
            "host": "www",
            "fqdn": "www.example.org",
            "type": "A",
            "answer": "10.0.0.1",
            "ttl": 300
        }
    ]
}
```

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

### GET /v4/transfers

Source: https://www.name.com/api-docs/Transfers

Lists all pending transfer requests. Supports pagination via perPage and page parameters.

```APIDOC
## GET /v4/transfers

### Description
Lists all pending transfer requests. To get information for a non-pending transfer, use the GetTransfer endpoint.

### Method
GET

### Endpoint
/v4/transfers

### Parameters
#### Query Parameters
- **perPage** (int32) - Optional - Number of records to return per request (defaults to 1,000).
- **page** (int32) - Optional - The page number to return.

### Response
#### Success Response (200)
- **transfers** (array) - List of pending transfers.
- **nextPage** (int32) - Identifier for the next page of results.
- **lastPage** (int32) - Identifier for the final page of results.

### Response Example
{
    "transfers": [
        {
            "domainName": "example.org",
            "status": "Retrieving Email"
        }
    ]
}
```

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

### Get URL Forwarding via cURL

Source: https://www.name.com/api-docs/URLForwardings

Retrieve details for a specific URL forwarding entry using the domain and host.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/url/forwarding/www'
```

```json
{
    "domainName": "example.org",
    "host": "www.example.org",
    "forwardsTo": "https://www.example.net",
    "type": "redirect"
}
```

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

### GET /v4/domains/{domainName}/dnssec/{digest}

Source: https://www.name.com/api-docs/dnssecs

Retrieves the details for a specific DNSSEC key registered with the registry.

```APIDOC
## GET /v4/domains/{domainName}/dnssec/{digest}

### Description
Retrieves the details for a key registered with the registry using the domain name and digest.

### Method
GET

### Endpoint
/v4/domains/{domainName}/dnssec/{digest}

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain name.
- **digest** (string) - Required - Digest is the digest for the DNSKEY RR to retrieve.

### Response
#### Success Response (200)
- **domainName** (string) - DomainName is the domain name.
- **keyTag** (int32) - KeyTag contains the key tag value of the DNSKEY RR.
- **algorithm** (int32) - Algorithm is an integer identifying the algorithm used for signing.
- **digestType** (int32) - DigestType is an integer identifying the algorithm used to create the digest.
- **digest** (string) - Digest is a digest of the DNSKEY RR.

### Response Example
{
    "domainName": "example.org",
    "keyTag": 30909,
    "algorithm": 8,
    "digestType": 2,
    "digest": "E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766"
}
```

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

### CancelTransfer Response Example

Source: https://www.name.com/api-docs/Transfers

The JSON response body returned after a successful cancel request, providing the domain name, associated email, and current status.

```json
{
    "domainName": "example.org",
    "email": "admin@example.org",
    "status": "Pending Approval"
}
```

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

### GET /v4/domains/{domainName}/records/{id}

Source: https://www.name.com/api-docs/DNS

Retrieves the details of a specific DNS record using its unique identifier.

```APIDOC
## GET /v4/domains/{domainName}/records/{id}

### Description
GetRecord returns details about an individual record.

### Method
GET

### Endpoint
/v4/domains/{domainName}/records/{id}

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the zone the record exists in
- **id** (int32) - Required - ID is the server-assigned unique identifier for this record

### Response
#### Success Response (200)
- **id** (int32) - Unique record id.
- **domainName** (string) - DomainName is the zone that the record belongs to.
- **host** (string) - Host is the hostname relative to the zone.
- **fqdn** (string) - FQDN is the Fully Qualified Domain Name.
- **type** (string) - Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.
- **answer** (string) - Answer is the record value.
- **ttl** (uint32) - TTL is the time this record can be cached for in seconds.
- **priority** (uint32) - Priority is only required for MX and SRV records.

### Response Example
{
    "id": 12345,
    "domainName": "example.org",
    "host": "www",
    "fqdn": "www.example.org",
    "type": "A",
    "answer": "10.0.0.1",
    "ttl": 300
}
```

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

### Get Transfer Details API Request and Response

Source: https://www.name.com/api-docs/Transfers

Retrieve specific details for a transfer request by providing the domain name in the path. The response contains the domain name, associated email, and current status.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/transfers/example.org'
```

```json
{
    "domainName": "example.org",
    "email": "admin@example.org",
    "status": "Pending Approval"
}
```

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

### CreateVanityNameserver

Source: https://www.name.com/api-docs/types/vanitynameserver

Creates a new vanity nameserver configuration.

```APIDOC
## POST /v4/vanity-nameservers

### Description
Create a new vanity nameserver.

### Method
POST

### Endpoint
/v4/vanity-nameservers
```

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

### PUT /v4/domains/{domainName}/vanity_nameservers/{hostname}

Source: https://www.name.com/api-docs/VanityNameservers

Updates the glue record IP addresses for an existing vanity nameserver.

```APIDOC
## PUT /v4/domains/{domainName}/vanity_nameservers/{hostname}

### Description
UpdateVanityNameserver allows you to update the glue record IP addresses at the registry.

### Method
PUT

### Endpoint
/v4/domains/{domainName}/vanity_nameservers/{hostname}

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain the nameserver is a subdomain of.
- **hostname** (string) - Required - Hostname is the hostname of the nameserver.

#### Request Body
- **ips** (array of strings) - Optional - IPs is a list of IP addresses that are used for glue records for this nameserver.

### Request Example
{
  "ips": ["192.168.1.1", "fd01:4860:4860::8888"]
}

### Response
#### Success Response (200)
- **domainName** (string) - DomainName is the domain the nameserver is a subdomain of.
- **hostname** (string) - Hostname is the hostname of the nameserver.
- **ips** (array of strings) - IPs is a list of IP addresses that are used for glue records for this nameserver.

#### Response Example
{
  "domainName": "example.org",
  "hostname": "ns1.example.org",
  "ips": ["192.168.1.1", "fd01:4860:4860::8888"]
}
```

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

### Create Vanity Nameserver Request

Source: https://www.name.com/api-docs/VanityNameservers

Registers a new nameserver with the registry using a POST request.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers' -X POST -H 'Content-Type: application/json' --data '{"hostname":"ns1.example.org","ips":["192.168.1.1","fd01:4860:4860::8888"]}'
```

```json
{
    "domainName": "example.org",
    "hostname": "ns1.example.org",
    "ips": [
        "192.168.1.1",
        "fd01:4860:4860::8888"
    ]
}
```

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

### CreateRecord

Source: https://www.name.com/api-docs/dns

Creates a new DNS record.

```APIDOC
## CreateRecord

### Description
Creates a new DNS record for a domain.

### Method
POST

### Endpoint
/dns/records
```

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

### POST /v4/domains/{domainName}/vanity_nameservers

Source: https://www.name.com/api-docs/VanityNameservers

Registers a new vanity nameserver with the registry for a specific domain.

```APIDOC
## POST /v4/domains/{domainName}/vanity_nameservers

### Description
CreateVanityNameserver registers a nameserver with the registry.

### Method
POST

### Endpoint
/v4/domains/{domainName}/vanity_nameservers

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the domain the nameserver is a subdomain of.

#### Request Body
- **hostname** (string) - Required - Hostname is the hostname of the nameserver.
- **ips** (array of strings) - Optional - IPs is a list of IP addresses that are used for glue records for this nameserver.

### Request Example
{
  "hostname": "ns1.example.org",
  "ips": ["192.168.1.1", "fd01:4860:4860::8888"]
}

### Response
#### Success Response (200)
- **domainName** (string) - DomainName is the domain the nameserver is a subdomain of.
- **hostname** (string) - Hostname is the hostname of the nameserver.
- **ips** (array of strings) - IPs is a list of IP addresses that are used for glue records for this nameserver.

#### Response Example
{
  "domainName": "example.org",
  "hostname": "ns1.example.org",
  "ips": ["192.168.1.1", "fd01:4860:4860::8888"]
}
```

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

### Retrieve server information via cURL

Source: https://www.name.com/api-docs/Hello

Use this command to authenticate and fetch server details from the API.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/hello'
```

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

### Retrieve API server information

Source: https://www.name.com/api-docs/hello

Use this request to fetch server metadata. Requires authentication via username and token.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/hello'
```

```json
{
    "serverName": "api01",
    "motd": "Welcome to the Name.com API-v4 server",
    "username": "username",
    "serverTime": "2017-11-13T22:58:35Z"
}
```

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

### Create a DNS record using cURL

Source: https://www.name.com/api-docs/DNS

Use this command to send a POST request to the CreateRecord endpoint with authentication credentials.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/records' -X POST -H 'Content-Type: application/json' --data '{"host":"www","type":"A","answer":"10.0.0.1","ttl":300}'
```

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

### List subscribed notifications

Source: https://www.name.com/api-docs/WebhookNotification

Use this GET request to retrieve all active notification subscriptions.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/notifications'
```

```json
{
    "subscriptions": [
        {
            "id": 1,
            "eventName": "domain.transfer.status_change",
            "url": "https://example.com/incomingnotification",
            "active": true,
            "createDate": "2025-02-17T22:58:35Z",
            "updateDate": "2025-02-17T22:58:35Z"
        }
    ]
}
```

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

### GetVanityNameserver

Source: https://www.name.com/api-docs/types/vanitynameserver

Retrieves details for a specific vanity nameserver.

```APIDOC
## GET /v4/vanity-nameservers/{hostname}

### Description
Retrieve the details of a specific vanity nameserver by its hostname.

### Method
GET

### Endpoint
/v4/vanity-nameservers/{hostname}

### Parameters
#### Path Parameters
- **hostname** (string) - Required - The hostname of the vanity nameserver.
```

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

### UpdateVanityNameserver

Source: https://www.name.com/api-docs/types/vanitynameserver

Updates an existing vanity nameserver configuration.

```APIDOC
## PUT /v4/vanity-nameservers/{hostname}

### Description
Update the configuration of an existing vanity nameserver.

### Method
PUT

### Endpoint
/v4/vanity-nameservers/{hostname}

### Parameters
#### Path Parameters
- **hostname** (string) - Required - The hostname of the vanity nameserver.
```

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

### ListVanityNameservers

Source: https://www.name.com/api-docs/types/vanitynameserver

Retrieves a list of vanity nameservers associated with the account.

```APIDOC
## GET /v4/vanity-nameservers

### Description
List all vanity nameservers configured for the account.

### Method
GET

### Endpoint
/v4/vanity-nameservers
```

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

### Create URL Forwarding via cURL

Source: https://www.name.com/api-docs/URLForwardings

Use this command to create a new URL forwarding entry by sending a POST request with authentication credentials.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/url/forwarding' -X POST -H 'Content-Type: application/json' --data '{"host":"www.example.org","forwardsTo":"https:\/\/www.example.net","type":"redirect"}'
```

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

### List DNSSEC keys for a domain

Source: https://www.name.com/api-docs/dnssecs

Retrieves all DNSSEC keys registered for a specific domain.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/dnssec'
```

```json
{
    "dnssec": [
        {
            "domainName": "example.org",
            "keyTag": 30909,
            "algorithm": 8,
            "digestType": 2,
            "digest": "E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766"
        }
    ]
}
```

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

### List Vanity Nameservers

Source: https://www.name.com/api-docs/VanityNameservers

Retrieve a list of all vanity nameservers for a specific domain.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers'
```

```json
{
    "vanityNameservers": [
        {
            "domainName": "example.org",
            "hostname": "ns1.example.org"
        }
    ]
}
```

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

### POST /v4/domains/{domainName}/records

Source: https://www.name.com/api-docs/DNS

Creates a new DNS record in the specified zone.

```APIDOC
## POST /v4/domains/{domainName}/records

### Description
CreateRecord creates a new record in the zone.

### Method
POST

### Endpoint
/v4/domains/{domainName}/records

### Parameters
#### Path Parameters
- **domainName** (string) - Required - DomainName is the zone that the record belongs to.

#### Request Body
- **host** (string) - Optional - Host is the hostname relative to the zone.
- **type** (string) - Required - Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.
- **answer** (string) - Required - Answer is the IP address, target, or text for the record.
- **ttl** (uint32) - Optional - TTL is the time this record can be cached for in seconds.
- **priority** (uint32) - Optional - Priority is only required for MX and SRV records.

### Request Example
{
    "host": "www",
    "type": "A",
    "answer": "10.0.0.1",
    "ttl": 300
}

### Response
#### Success Response (200)
- **id** (int32) - Unique record id.
- **domainName** (string) - The zone that the record belongs to.
- **host** (string) - The hostname relative to the zone.
- **fqdn** (string) - The Fully Qualified Domain Name.
- **type** (string) - The record type.
- **answer** (string) - The record answer.
- **ttl** (uint32) - The TTL in seconds.
- **priority** (uint32) - The record priority.

#### Response Example
{
    "id": 12345,
    "domainName": "example.org",
    "host": "www",
    "fqdn": "www.example.org",
    "type": "A",
    "answer": "10.0.0.1",
    "ttl": 300
}
```

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

### CreateURLForwarding

Source: https://www.name.com/api-docs/types/urlforwarding

Creates a new URL forwarding entry.

```APIDOC
## CreateURLForwarding

### Description
Creates a new URL forwarding entry for a domain.
```

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

### ListOrders API Request

Source: https://www.name.com/api-docs/Orders

Use this cURL command to authenticate and retrieve the list of orders from the API.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/orders'
```

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

### Update Vanity Nameserver Request

Source: https://www.name.com/api-docs/VanityNameservers

Updates the glue record IP addresses for an existing nameserver using a PUT request.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers/ns1.example.org' -X PUT -H 'Content-Type: application/json' --data '{"ips":["192.168.1.1","fd01:4860:4860::8888"]}'
```

```json
{
    "domainName": "example.org",
    "hostname": "ns1.example.org",
    "ips": [
        "192.168.1.1",
        "fd01:4860:4860::8888"
    ]
}
```

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

### Check Account Balance Request and Response

Source: https://www.name.com/api-docs/AccountInfo

Use this endpoint to retrieve the current account credit balance. The response returns the balance as a float64 value.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/accountinfo/balance'
```

```json
{
    "balance": 125.43000000000001
}
```

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

### CreateTransfer API Request

Source: https://www.name.com/api-docs/transfers

Initiates a domain transfer request using a POST request with authentication credentials and JSON payload.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/transfers' -X POST -H 'Content-Type: application/json' --data '{"domainName":"example.org","authCode":"Authc0de","purchasePrice":12.99}'
```

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

### Retrieve Order Details via cURL

Source: https://www.name.com/api-docs/Orders

Use this cURL command to fetch details for a specific order by its ID.

```bash
curl -u 'username:token' 'https://api.dev.name.com/v4/orders/123456789'
```
Tokens:
Raw