How to use OVH domain api

Quick Start

1. Create application key and secret

Option 1

https://eu.api.ovh.com/createApp/

Watch out the acme.sh output and copy/paste the validation URL. See Step 3

Option 2

If you already have created an application and know its secret (application secret) open the link https://www.ovh.com/auth/api/createToken and use hereafter settings

• GET /auth/time
• GET /domain
• GET /domain/zone/*
• GET /domain/zone/*/record
• POST /domain/zone/*/record
• POST /domain/zone/*/refresh
• PUT /domain/zone/*/record/*
• DELETE /domain/zone/*/record/*

2. Set api key and api secret.

# application key
export OVH_AK="your application key"

# application secret
export OVH_AS="your application secret"

# consumer key
export OVH_CK="your consumer key"

acme.sh --issue -d   mydomain.com   --dns   dns_ovh --server letsencrypt

If you are first time using OVH api, you are required to authenticate the api. (This only happens the first time.)

You will see some thing like bellow:

[Thu, Aug 25, 2016 10:54:03] Using OVH endpoint: ovh-eu
[Thu, Aug 25, 2016 10:54:04] OVH consumer key is empty, Let's get one:
[Thu, Aug 25, 2016 10:54:05] Please open this link to do authentication: https://eu.api.ovh.com/auth/?credentialToken=n0Qbjm6wBdBr2KiSqIuYSEnixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
[Thu, Aug 25, 2016 10:54:05] Here is a guide for you: https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api
[Thu, Aug 25, 2016 10:54:05] Please retry after the authentication is done.
[Thu, Aug 25, 2016 10:54:05] Error add txt for domain:_acme-challenge.mytest.mydomain.com

3. Authentication the api key.

(This only happens the first time.)

Open the link above:

https://eu.api.ovh.com/auth/?credentialToken=n0Qbjm6wBdBr2KiSqIuYSEnixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In the page, please select "Unlimited" for the Validity.

Click "Authorize Access"

4. Then go back to try again.

acme.sh --issue -d   mydomain.com   --dns   dns_ovh --server letsencrypt

Done.

5. OVH api support OVH, Kimsufi, SoYouStart.

The default is using ovh-eu region.

If you are using ovh-ca region,

Create app key here: https://ca.api.ovh.com/createApp/

Then please specify the region in the first step:

export OVH_END_POINT=ovh-ca
export OVH_AK="your application key"
export OVH_AS="your application secret"
acme.sh --issue -d   mydomain.com   --dns   dns_ovh --server letsencrypt

All the supported regions:

• ovh-eu default
• ovh-us
• ovh-ca
• kimsufi-eu
• kimsufi-ca
• soyoustart-eu
• soyoustart-ca

If your region is not specified then you can specify a full API URL like: export OVH_END_POINT="https://eu.api.ovh.com/1.0"

Advanced Usage

1. Create application key, secret and consumer

• OVH Europe: https://api.ovh.com/createToken/?GET=/domain/zone/*&POST=/domain/zone/*&PUT=/domain/zone/*&DELETE=/domain/zone/*/record/*
• OVH USA: https://api.us.ovhcloud.com/createToken/?GET=/domain/zone/*&POST=/domain/zone/*&PUT=/domain/zone/*&DELETE=/domain/zone/*/record/*
• OVH Canada: https://ca.api.ovh.com/createToken/?GET=/domain/zone/*&POST=/domain/zone/*&PUT=/domain/zone/*&DELETE=/domain/zone/*/record/*

In the page, please select "Unlimited" for the Validity.

2. Profite!

# Credentials
export OVH_AK="your application key"
export OVH_AS="your application secret"
export OVH_CK="your consumer key"

# Generate your certificate
acme.sh --issue -d mydomain.com --dns dns_ovh --server letsencrypt

Security

It is a good security practice to limit what a given API key can in the event it is lost, stolen or anything wrong happens to limit the potential damages. OVH API keys can be limited to a specific domain zone using a simple pattern mechanism. For example, to restrict an OVH API key to manage "mydomain.com", you may use the following settings. Of course this can easily be customized to support any or multiple domains:

• OVH Europe: https://api.ovh.com/createToken/?GET=/domain/zone/mydomain.com/*&POST=/domain/zone/mydomain.com/*&PUT=/domain/zone/mydomain.com/*&GET=/domain/zone/mydomain.com&DELETE=/domain/zone/mydomain.com/record/*
• OVH USA: https://api.us.ovhcloud.com/createToken/?GET=/domain/zone/mydomain.com/*&POST=/domain/zone/mydomain.com/*&PUT=/domain/zone/mydomain.com/*&GET=/domain/zone/mydomain.com&DELETE=/domain/zone/mydomain.com/record/*
• OVH Europe: https://api.ovh.com/createToken/?GET=/domain/zone/mydomain.com/*&POST=/domain/zone/mydomain.com/*&PUT=/domain/zone/mydomain.com/*&GET=/domain/zone/mydomain.com&DELETE=/domain/zone/mydomain.com/record/*