1---
2title: "OVH"
3date: 2019-03-03T16:39:46+01:00
4draft: false
5slug: ovh
6---
7
8<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
9<!-- providers/dns/ovh/ovh.toml -->
10<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
11
12Since: v0.4.0
13
14Configuration for [OVH](https://www.ovh.com/).
15
16
17<!--more-->
18
19- Code: `ovh`
20
21Here is an example bash command using the OVH provider:
22
23```bash
24OVH_APPLICATION_KEY=1234567898765432 \
25OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
26OVH_CONSUMER_KEY=256vfsd347245sdfg \
27OVH_ENDPOINT=ovh-eu \
28lego --email myemail@example.com --dns ovh --domains my.example.org run
29```
30
31
32
33
34## Credentials
35
36| Environment Variable Name | Description |
37|-----------------------|-------------|
38| `OVH_APPLICATION_KEY` | Application key |
39| `OVH_APPLICATION_SECRET` | Application secret |
40| `OVH_CONSUMER_KEY` | Consumer key |
41| `OVH_ENDPOINT` | Endpoint URL (ovh-eu or ovh-ca) |
42
43The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
44More information [here](/lego/dns/#configuration-and-credentials).
45
46
47## Additional Configuration
48
49| Environment Variable Name | Description |
50|--------------------------------|-------------|
51| `OVH_HTTP_TIMEOUT` | API request timeout |
52| `OVH_POLLING_INTERVAL` | Time between DNS propagation check |
53| `OVH_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
54| `OVH_TTL` | The TTL of the TXT record used for the DNS challenge |
55
56The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
57More information [here](/lego/dns/#configuration-and-credentials).
58
59## Application Key and Secret
60
61Application key and secret can be created by following the [OVH guide](https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/).
62
63When requesting the consumer key, the following configuration can be use to define access rights:
64
65```json
66{
67  "accessRules": [
68    {
69      "method": "POST",
70      "path": "/domain/zone/*"
71    },
72    {
73      "method": "DELETE",
74      "path": "/domain/zone/*"
75    }
76  ]
77}
78```
79
80
81
82## More information
83
84- [API documentation](https://eu.api.ovh.com/)
85- [Go client](https://github.com/ovh/go-ovh)
86
87<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
88<!-- providers/dns/ovh/ovh.toml -->
89<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
90