---
title: Creating API Credentials
description: Generate API keys for programmatic access.
---

[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)

June 15, 2026

# Creating API Credentials

## Generate API keys for programmatic access

### Creating API Credentials

Create API credentials to access the OpusDNS API programmatically for domain management, DNS operations, and automation.

#### **Where to Find It**

**Path:** Left sidebar → Developer → API Credentials

**Direct URL:** `/developer/api-credentials` 

#### **What You'll See**

The API Credentials page shows a table of existing credentials with columns: Name, API Key ID, Status (Active/Revoked), Created, Expires, and Last Used. Above the table is a button to create new credentials.

An informational alert at the top explains the three values you'll receive:

- **API Key** — Use in the `x-api-key` HTTP header for direct API access
- **Client ID** — Your organization's unique identifier for OAuth authentication
- **Client Secret** — Used to authenticate OAuth requests

#### **Step-by-Step**

1. Navigate to **Developer** in the left sidebar.
2. Go to the **API Credentials** section.
3. Click the **create** button.
4. Fill in the form: 
     1. **Name** (required) — A descriptive name for this credential (e.g., "Production API Key", "WHMCS Integration")
     2. **Description** (optional) — Additional notes about the credential's purpose
     3. **Expiration Date** (optional) — Set an expiry date or leave blank for no expiration
5. Submit the form.
6. **⚠️ CRITICAL: Copy your credentials immediately!**

![Screenshot 2026-05-19 at 14.25.25](https://help.opusdns.com/hs-fs/hubfs/Screenshot%202026-05-19%20at%2014.25.25.png?width=670&height=443&name=Screenshot%202026-05-19%20at%2014.25.25.png)

 

#### **After Creation — Copy Your Secrets**

A success dialog displays three values:

- **API Key** — The full API key for the `x-api-key` header
- **Client ID** — Your organization identifier
- **Client Secret** — The OAuth client secret

**⚠️ Important Security Notice:** The **API Key** and **Client Secret** are shown **only once** during creation. If you close this dialog without copying them, you cannot retrieve them later. You will need to create new credentials.

#### **Using Your Credentials**

**Option 1: API Key (Direct Access)**

Include the API key in your HTTP request headers:

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

 

**Option 2: OAuth Client Credentials**

Use the Client ID and Client Secret for OAuth 2.0 client credentials flow to obtain an access token.

#### **Managing Existing Credentials**

In the credentials table, you can:

- See when a key was **last used**
- Check if it's **Active** or **Revoked**
- See the **expiration date** (or "Never" if not set)
- **Revoke** a credential when it's no longer needed (this cannot be undone)

#### **Restricting API Access by IP**

For additional security, navigate to **Developer → API Security** to configure IP address restrictions that limit which IPs can use your API credentials.

#### **Common Mistakes**

- **Not copying the secret** — The most common issue. The secret is shown only once.
- **Using an expired credential** — Check the expiration date in the table.
- **Forgetting to revoke compromised keys** — If a key is exposed, revoke it immediately and create a new one.

 

 

[![Sandbox Dark copy](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)
    - [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 Integraton](https://help.opusdns.com/services-features?hsLang=en#go-integraton)
    - [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).