> For the complete documentation index, see [llms.txt](https://docs.dnscontrol.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dnscontrol.org/provider/cloudpress.md).

# CloudPress

## Configuration

To use this provider, add an entry to `creds.json` with `TYPE` set to `CLOUDPRESS` along with the base URL of your CloudPress instance and a CloudPress [API key](https://docs.cloudpress.com/API/api-keys/).

CloudPress is a brand/instance-specific platform, so there is no single default API host. Set `base_url` to the host that serves your account's API (for example `https://app.cloudpress.com`).

Example:

{% code title="creds.json" %}

```json
{
  "cloudpress": {
    "TYPE": "CLOUDPRESS",
    "base_url": "https://app.cloudpress.com",
    "api_token": "your-cloudpress-api-key"
  }
}
```

{% endcode %}

You can also use environment variables:

```shell
export CLOUDPRESS_BASE_URL=https://app.cloudpress.com
export CLOUDPRESS_API_TOKEN=XXXXXXXXX
```

{% code title="creds.json" %}

```json
{
  "cloudpress": {
    "TYPE": "CLOUDPRESS",
    "base_url": "$CLOUDPRESS_BASE_URL",
    "api_token": "$CLOUDPRESS_API_TOKEN"
  }
}
```

{% endcode %}

### Authentication

The provider authenticates with a CloudPress API key sent as a bearer token (`Authorization: Bearer <api_token>`). You can create an API key via `POST /api/api_keys`; the token value is only returned once, so store it immediately.

OAuth 2.1 access tokens are also accepted by CloudPress, but the OAuth flow is interactive (PKCE `authorization_code`) and not well suited to an unattended CLI, so an API key is recommended.

> Trial accounts cannot use the CloudPress API.

### Metadata

Some endpoints (including zone creation) require an account to be selected via the `X-Auth-Account` header. If you use a user API key and want DNSControl to create zones, set the optional `account_id` field:

{% code title="creds.json" %}

```json
{
  "cloudpress": {
    "TYPE": "CLOUDPRESS",
    "base_url": "https://app.cloudpress.com",
    "api_token": "$CLOUDPRESS_API_TOKEN",
    "account_id": "12345"
  }
}
```

{% endcode %}

### Usage

An example configuration:

{% code title="dnsconfig.js" %}

```javascript
var REG_NONE = NewRegistrar("none");
var DSP_CLOUDPRESS = NewDnsProvider("cloudpress");

D("example.com", REG_NONE, DnsProvider(DSP_CLOUDPRESS),
    A("test", "1.2.3.4"),
    MX("@", 10, "mail.example.com."),
);
```

{% endcode %}

## Activation

DNSControl uses the [CloudPress DNS API](https://docs.cloudpress.com/API/dns/) to manage your DNS records. You will need to generate an API key to use this provider.

### New domains

If a domain does not exist in your CloudPress account, DNSControl will automatically add it with the `push` command (an `account_id` may be required, see [Metadata](#metadata)).

### Caveats

* CloudPress manages the apex `NS` records itself; they are exposed through `GetNameservers()` and are not managed as ordinary records. Dual-hosting with another provider is therefore not supported.
* The provider currently manages the standard record types `A`, `AAAA`, `CNAME`, `TXT`, `MX`, `NS`, `SRV`, `CAA` and `PTR`. Other CloudPress-specific types (such as Redirect, Flatten, Pull Zone or Script records) are ignored by DNSControl and left untouched in the zone.
* Provider Type
  * [Official Support](/provider/index.md#providers-with-official-support): ❌
  * DNS Provider: ✅
  * Registrar: ❌
* Provider API
  * [Concurrency Verified](/advanced-features/concurrency-verified.md): ❔
  * [dual host](/advanced-features/dual-host.md): ❌
  * create-domains: ✅
  * [get-zones](/commands/get-zones.md): ✅
* DNS extensions
  * [`ALIAS`](/language-reference/domain-modifiers/alias.md): ❌
  * [`DNAME`](/language-reference/domain-modifiers/dname.md): ❌
  * [`LOC`](/language-reference/domain-modifiers/loc.md): ❌
  * [`PTR`](/language-reference/domain-modifiers/ptr.md): ✅
  * [`SOA`](/language-reference/domain-modifiers/soa.md): ❌
* Service discovery
  * [`DHCID`](/language-reference/domain-modifiers/dhcid.md): ❌
  * [`NAPTR`](/language-reference/domain-modifiers/naptr.md): ❌
  * [`SRV`](/language-reference/domain-modifiers/srv.md): ✅
  * [`SVCB`](/language-reference/domain-modifiers/svcb.md): ❌
* Security
  * [`CAA`](/language-reference/domain-modifiers/caa.md): ✅
  * [`HTTPS`](/language-reference/domain-modifiers/https.md): ❌
  * [`SMIMEA`](/language-reference/domain-modifiers/smimea.md): ❌
  * [`SSHFP`](/language-reference/domain-modifiers/sshfp.md): ❌
  * [`TLSA`](/language-reference/domain-modifiers/tlsa.md): ❌
* DNSSEC
  * [`AUTODNSSEC`](/language-reference/domain-modifiers/autodnssec_on.md): ✅
  * [`DNSKEY`](/language-reference/domain-modifiers/dnskey.md): ❌
  * [`DS`](/language-reference/domain-modifiers/ds.md): ❌