Authentication

To securely interact with the mijn.host API, authentication is required using a API key-based mechanism. Each request to the mijn.host API must include your unique API key in the header. This method ensures that only authorized users can access and manage domain-related functions.

Authentication Method

You must include an API-Key header in your requests, containing your API key. This key is assigned to you when you create an account and request access to the API.

API Key Header

Header Name: API-Key

Value: Your unique API key

Example

Here's how to include the API-Key header in an API request:

HTTP Request Example

cURL Example

Obtaining Your API Key

To get your API key:

Log in to your mijn.host account.

Navigate to the API Access section in your account settings.

Create a support ticket to obtain an API key

Security Best Practices

Keep Your API Key Confidential: Treat your API key as a password. Do not share it publicly or expose it in client-side code.

Regenerate Keys if Compromised: If you suspect that your API key has been compromised, regenerate it immediately by contacting support.

Error Handling

If your request lacks a valid API-Key header or contains an incorrect key, the API will respond with an authentication error.

Response Code: 401 Unauthorized

Error Message: No valid API key set

Example Error Response

{
    "status": 401,
    "status_description": "No valid API key set"
}

Ensure every API request is authenticated correctly to avoid these errors and maintain seamless access to the mijn.host API.

Authentication Method#

API Key Header#

Example#

HTTP Request Example#

cURL Example#

Obtaining Your API Key#

Security Best Practices#

Error Handling#

Example Error Response#