lego/docs/content/dns/zz_gen_plesk.md

72 lines
2 KiB
Markdown
Raw Permalink Normal View History

2023-02-26 23:53:57 +00:00
---
title: "plesk.com"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: plesk
dnsprovider:
since: "v4.11.0"
code: "plesk"
url: "https://www.plesk.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/plesk/plesk.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Configuration for [plesk.com](https://www.plesk.com/).
<!--more-->
- Code: `plesk`
- Since: v4.11.0
Here is an example bash command using the plesk.com provider:
```bash
PLESK_SERVER_BASE_URL="https://plesk.myserver.com:8443" \
PLESK_USERNAME=xxxxxx \
PLESK_PASSWORD=yyyyyy \
lego --email you@example.com --dns plesk --domains my.example.org run
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `PLESK_PASSWORD` | API password |
| `PLESK_SERVER_BASE_URL` | Base URL of the server (ex: https://plesk.myserver.com:8443) |
| `PLESK_USERNAME` | API username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `PLESK_HTTP_TIMEOUT` | API request timeout |
| `PLESK_POLLING_INTERVAL` | Time between DNS propagation check |
| `PLESK_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `PLESK_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## More information
- [API documentation](https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference.28784/)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/plesk/plesk.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->