---
title: Creating API Credentials
description: "Create an OpusDNS API key under Developer, API Credentials: get key, client ID and secret for x-api-key or OAuth, set an expiry and revoke old keys."
---

[Skip to content](https://help.opusdns.com/creating-api-credentials#main-content)

- [English](https://help.opusdns.com/creating-api-credentials)
- [Deutsch](https://help.opusdns.com/de/creating-api-credentials)

English

Show submenu for translations

[![opusdns.com](https://help.opusdns.com/hs-fs/hubfs/v2-Status%20Center.png?width=180&height=51&name=v2-Status%20Center.png)](https://help.opusdns.com/?hsLang=en)

Open main navigation

Close main navigation

- - [English](https://help.opusdns.com/creating-api-credentials)
    - [Deutsch](https://help.opusdns.com/de/creating-api-credentials)

  English
  
  Show submenu for translations
- [Submit Ticket](https://support.opusdns.com/)

[Submit Ticket](https://support.opusdns.com/?hsLang=en)

 How can we help?

- There are no suggestions because the search field is empty.

1. [OpusDNS Knowledgebase](https://help.opusdns.com/?hsLang=en)
2. [OpusDNS Dashboard](https://help.opusdns.com/opusdns-dashboard?hsLang=en)
3. [Developer Area](https://help.opusdns.com/opusdns-dashboard?hsLang=en#developer-area)

November 15, 2026

# Creating API Credentials

## Create an API key, client ID and secret and store them safely

With API credentials, your scripts and integrations access the OpusDNS API for domain management, DNS operations and automation. Go to **Developer \> API Credentials** in the left sidebar.

At the top of the page, the box **API Credentials Information** (click to expand) explains the three values you receive:

- **API Key:** use it in the `x-api-key` HTTP header to access any endpoint directly. Shown only once.
- **Client ID:** your organization's unique identifier for OAuth authentication.
- **Client Secret:** a secret used to authenticate your requests. Shown only once.

 

#### **Create API credentials**

1. Click **New API Credential**. The dialog **Create API Credential** opens.
2. Enter a **Name** (required), for example "Production API Key" or "WHMCS Integration", and an optional **Description**.
3. Choose a **Role** (required). Admin is preselected. Pick the role with the fewest permissions your integration needs. The role applies to the key, no matter which user created it. See [Roles and Permissions for Users and API Keys](https://help.opusdns.com/roles-permissions?hsLang=en).
4. Optional: set an **Expiration Date** with date and time. Leave it empty if the credential should not expire.
5. Confirm the dialog.

 

#### **Copy your credentials right away**

The dialog **API Credential Created** shows the API Key, the Client ID and the Client Secret. Click **Copy All Credentials**, store the values in a safe place, then click **Done**.

**Important:** The API Key and the Client Secret are shown only once. If you close the dialog without copying them, you cannot retrieve them later and need to create new credentials.

 

#### **Use your credentials**

**Option 1: API key.** Send the key in the HTTP header of each request:

```
x-api-key: your-api-key-here
```

**Option 2: OAuth client credentials.** Use the Client ID and the Client Secret in the OAuth 2.0 client credentials flow to get an access token.

Details and examples are in the [API documentation](https://developers.opusdns.com).

 

#### **Manage existing credentials**

The table shows **Name** (with the description below), **Status** (Active or Revoked), **Created**, **Expires** ("Never" if no date is set) and **Last Used**. Further columns such as **API Key ID**, **Role** and **Client ID** can be shown via **Manage columns**. You can search the list and filter it by **Status**.

- **Edit** changes the name and the description only. The key itself and its role stay the same. To use a different role, create a new credential.
- **Delete** asks what should happen to the credential: 
    - **Revoke:** the credential stops working immediately and stays in the list with the status Revoked.
    - **Purge:** the credential stops working immediately and is permanently deleted. You can also purge a credential that is already revoked.

Both actions cannot be undone.

 

#### **Restrict access by IP**

For additional security, allow API access only from your own IP addresses. See [Restricting API Access by IP](https://help.opusdns.com/api-ip-restrictions?hsLang=en).

 

#### **Common mistakes**

- **Not copying the secret:** the API Key and the Client Secret are shown only once.
- **Using an expired credential:** check the column **Expires**.
- **Not revoking an exposed key:** if a key becomes known to others, revoke it immediately and create a new one.
- **Too many permissions:** the role of a credential cannot be changed later, so choose it carefully when you create it.

[![Banner linking to the OpusDNS developer documentation and sandbox](https://help.opusdns.com/hs-fs/hubfs/Sandbox%20Dark%20copy.jpg?width=670&height=174&name=Sandbox%20Dark%20copy.jpg)](https://developers.opusdns.com?utm_source=knowledgebase&utm_medium=referral&utm_campaign=signup&utm_content=cta_banner)

- [Create your OpusDNS account](https://help.opusdns.com/create-your-opusdns-account?hsLang=en#main-content)

    - [Open Your Account](https://help.opusdns.com/create-your-opusdns-account?hsLang=en#open-your-account)
    - [FAQ](https://help.opusdns.com/create-your-opusdns-account?hsLang=en#faq)
    - [Getting Help with your Registration](https://help.opusdns.com/create-your-opusdns-account?hsLang=en#getting-help-with-your-registration)
- [OpusDNS API](https://help.opusdns.com/opusdns-api?hsLang=en#main-content)

    - [Getting Started with the API](https://help.opusdns.com/opusdns-api?hsLang=en#getting-started-with-the-api)
    - [Sandbox Environment](https://help.opusdns.com/opusdns-api?hsLang=en#sandbox-environment)
    - [OpusDNS MCP Server](https://help.opusdns.com/opusdns-api?hsLang=en#opusdns-mcp-server)
    - [FAQ](https://help.opusdns.com/opusdns-api?hsLang=en#faq)
    - [Getting Help with the OpusDNS API](https://help.opusdns.com/opusdns-api?hsLang=en#getting-help-with-the-opusdns-api)
- [OpusDNS Dashboard](https://help.opusdns.com/opusdns-dashboard?hsLang=en#main-content)

    - [Getting Started](https://help.opusdns.com/opusdns-dashboard?hsLang=en#getting-started)
    - [Plans & Pricing](https://help.opusdns.com/opusdns-dashboard?hsLang=en#plans-pricing)
    - [Billing & Payments](https://help.opusdns.com/opusdns-dashboard?hsLang=en#billing-payments)
    - [User & Organization Management](https://help.opusdns.com/opusdns-dashboard?hsLang=en#user-organization-management)
    - [Whitelabeling](https://help.opusdns.com/opusdns-dashboard?hsLang=en#whitelabeling)
    - [Account & Settings](https://help.opusdns.com/opusdns-dashboard?hsLang=en#account-settings)
    - [Security](https://help.opusdns.com/opusdns-dashboard?hsLang=en#security)
    - [AI Concierge](https://help.opusdns.com/opusdns-dashboard?hsLang=en#ai-concierge)
    - [Managing Contacts](https://help.opusdns.com/opusdns-dashboard?hsLang=en#managing-contacts)
    - [Managing DNS Zones & Nameservers](https://help.opusdns.com/opusdns-dashboard?hsLang=en#managing-dns-zones-nameservers)
    - [Register & Transfer Domains](https://help.opusdns.com/opusdns-dashboard?hsLang=en#register-transfer-domains)
    - [Managing Domains](https://help.opusdns.com/opusdns-dashboard?hsLang=en#managing-domains)
    - [Bulk Jobs](https://help.opusdns.com/opusdns-dashboard?hsLang=en#bulk-jobs)
    - [Developer Area](https://help.opusdns.com/opusdns-dashboard?hsLang=en#developer-area)
    - [Dashboard Functionality](https://help.opusdns.com/opusdns-dashboard?hsLang=en#dashboard-functionality)
    - [Dashboard home page](https://help.opusdns.com/opusdns-dashboard?hsLang=en#dashboard-home-page)
- [Services & Features](https://help.opusdns.com/services-features?hsLang=en#main-content)

    - [Domain forwarding](https://help.opusdns.com/services-features?hsLang=en#domain-forwarding)
    - [Email forwarding](https://help.opusdns.com/services-features?hsLang=en#email-forwarding)
    - [Reports](https://help.opusdns.com/services-features?hsLang=en#reports)
    - [Domain parking](https://help.opusdns.com/services-features?hsLang=en#domain-parking)
    - [WHMCS Integration](https://help.opusdns.com/services-features?hsLang=en#whmcs-integration)
    - [Hostware Integration](https://help.opusdns.com/services-features?hsLang=en#hostware-integration)
    - [Terraform Integration](https://help.opusdns.com/services-features?hsLang=en#terraform-integration)
    - [GO Integration](https://help.opusdns.com/services-features?hsLang=en#go-integration)
    - [Certificate Management with ACME and OpusDNS](https://help.opusdns.com/services-features?hsLang=en#certificate-management-with-acme-and-opusdns)
- [New to the Domain Industry?](https://help.opusdns.com/new-to-the-domain-industry?hsLang=en#main-content)

    - [Everything about Domains](https://help.opusdns.com/new-to-the-domain-industry?hsLang=en#everything-about-domains)
    - [Domain Industry](https://help.opusdns.com/new-to-the-domain-industry?hsLang=en#domain-industry)
    - [Reseller Essentials](https://help.opusdns.com/new-to-the-domain-industry?hsLang=en#reseller-essentials)
- [TLD information](https://help.opusdns.com/tld-information?hsLang=en)

- [OpusDNS Homepage](https://www.opusdns.com/)
- [Legal Notice](https://www.opusdns.com/legal/notice-impressum)
- [Privacy Policy](https://www.opusdns.com/legal/privacy-policy)
- [Terms & Conditions](https://www.opusdns.com/legal/terms-conditions)

[![OpusDNS Homepage](https://help.opusdns.com/hubfs/6722ae7333e645c8919a4751_opusDNS-VT-3c-white-tagline.svg "OpusDNS Homepage")](https://www.opusdns.com/)

©2025 OpusDNS GmbH. All rights reserved.

<https://www.linkedin.com/company/opusdns/>

![icann](https://help.opusdns.com/hubfs/icann.svg).