Skip to content
local-cert
Browse the documentation

OVHcloud provider

local-cert manages OVHcloud DNS zones through the OVH API, using a set of three keys limited to DNS.

1. Create the token

OVH offers a page that creates all three keys at once. Open the one for your region while logged in to your account:

AccountCreation pageValue of "API region"
Europehttps://eu.api.ovh.com/createToken/ovh-eu
Canadahttps://ca.api.ovh.com/createToken/ovh-ca
United Stateshttps://api.us.ovhcloud.com/createToken/ovh-us
  1. Application name: local-cert. Free-form description.
  2. Validity: Unlimited. A token with a limited lifetime would stop working without warning, renewals included.
  3. Rights: add these five lines (the link offered by local-cert's wizard pre-fills them):
Rights to grant
GET    /domain/zone
GET    /domain/zone/*
POST   /domain/zone/*
PUT    /domain/zone/*
DELETE /domain/zone/*
  1. Create keys. The page shows the Application Key, the Application Secret and the Consumer Key: note all three.

2. Create the provider

  1. Providers → + New provider → OVHcloud.
  2. Choose the region, give it a name, paste the three keys.
  3. Test connection: local-cert lists your zones. Then Save.

3. Add a domain

Domains → + Add a domain → this provider → the zone. The test creates and then deletes a temporary TXT record. No extra setting is needed on the OVH side: the permissions are those of the token.

Good to know

  • The domain must use OVH's DNS servers (active DNS zone in the customer area). If its name servers point elsewhere, that other host is the one to declare.
  • OVH only applies a change after a zone "refresh"; local-cert triggers one after every write. Propagation to the secondary servers can take one to two minutes: that is the normal duration of an issuance.
  • Minimum TTL: 60 seconds.

Troubleshooting

MessageCause
Invalid signatureApplication Secret or Consumer Key mistyped, or wrong region.
This credential is not validConsumer Key expired or revoked: create a new token with unlimited validity.
This call has not been grantedA line is missing from the token's rights.
This application key is invalidApplication Key from another region.