DNSimple PHP Client

A PHP client for the DNSimple API v2.

Requirements

• PHP ^8.3
• An activated DNSimple account

Installation

Using Composer is the recommended way to install. The PHP client is available via Packagist under the dnsimple/dnsimple package. If Composer is installed globally on your system, you can run the following in the base directory of your project to add the package as a dependency:

composer require dnsimple/dnsimple

Usage

This library is a PHP client you can use to interact with the DNSimple API v2. Here are some examples.

use Dnsimple\Client;

$client = new Client("API_TOKEN");

$response = $client->identity->whoami();
$whoami = $response->getData();
$account_id = $whoami->account->id;

$response = $client->domains->listDomains($account_id);
$domains = $response->getData();

Configuration

Sandbox Environment

We highly recommend testing against our sandbox environment before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.

The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the base_uri option when you construct the client:

use Dnsimple\Client;

$client = new Client("API_TOKEN", ["base_uri" => 'https://api.sandbox.dnsimple.com']);

You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will not work in the sandbox environment.

Setting a custom User-Agent header

You can customize the User-Agent header for the calls made to the DNSimple API:

use Dnsimple\Client;

$client = new Client("API_TOKEN", ["user_agent" => "my-app/1.0"]);

The value you provide will be appended to the default User-Agent the client uses. For example, if you use my-app/1.0, the final header value will be dnsimple-php/x.x.x my-app/1.0 (note that it will vary depending on the client version).

Documentation

• dnsimple-php Packagist
• DNSimple API documentation
• DNSimple API examples repository
• DNSimple support documentation

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests. See CONTRIBUTING.md for guidelines.

Changelog

See CHANGELOG.md for details.

License

Copyright (c) 2015-2026 DNSimple Corporation. This is Free Software distributed under the MIT License.