mir/acme.sh
2
0
Fork 0
mirror of https://github.com/acmesh-official/acme.sh synced 2025-08-22 01:49:43 +00:00
Code Issues Releases Wiki Activity
acme.sh/dnsapi/dns_myapi.sh

45 lines
1.3 KiB
Bash
Raw Normal View History

modify shebang to bash after install if bash is installed.
2016-04-17 19:47:22 +08:00
#!/usr/bin/env sh
DNS provider API: structured description Instead of using comments declare info in a special variable. Then the variable can be used to print the DNS API provider usage. The usage can be parsed on UI and show all needed inputs for options. The info is stored in plain string that it's both human-readable and easy to parse: dns_example_info='API name An extended description. Multiline. Domains: list of alternative domains to find Site: the dns provider website e.g. example.com Docs: Link to ACME.sh wiki for the provider Options: VARIABLE1 Title for the option1. VARIABLE2 Title for the option2. Default "default value". VARIABLE3 Title for the option3. Description to show on UI. Optional. Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>; ' Here: VARIABLE1 will be required. VARIABLE2 will be required too but will be populated with a "default value". VARIABLE3 is optional and can be empty. A DNS provider may have alternative options like CloudFlare may use API KEY or API Token. You can use a second section OptionsAlt: section. Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud. Add them to Domains: section. Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
2023-11-18 18:57:12 +02:00
# shellcheck disable=SC2034
dns_myapi_info='Custom API Example
A sample custom DNS API script.
Domains: example.com
Site: github.com/acmesh-official/acme.sh/wiki/DNS-API-Dev-Guide
Docs: github.com/acmesh-official/acme.sh/wiki/dnsapi#dns_duckdns
Options:
MYAPI_Token API Token. Get API Token from https://example.com/api/. Optional.
Issues: github.com/acmesh-official/acme.sh
Author: Neil Pang <neilgit@neilpang.com>
'
how to use cloudflare api and create custom api
2016-01-30 23:15:30 +08:00
fix compatible for sh. '-' is not allowed in function name.
2016-04-16 22:19:29 +08:00
#This file name is "dns_myapi.sh"
minor
2016-06-07 13:05:27 +08:00
#So, here must be a method dns_myapi_add()
Update dns-myapi.sh
2016-04-15 23:41:15 +12:00
#Which will be called by acme.sh to add the txt record to your api system.
minor
2016-06-07 13:05:27 +08:00
#returns 0 means success, otherwise error.
DNS provider API: structured description Instead of using comments declare info in a special variable. Then the variable can be used to print the DNS API provider usage. The usage can be parsed on UI and show all needed inputs for options. The info is stored in plain string that it's both human-readable and easy to parse: dns_example_info='API name An extended description. Multiline. Domains: list of alternative domains to find Site: the dns provider website e.g. example.com Docs: Link to ACME.sh wiki for the provider Options: VARIABLE1 Title for the option1. VARIABLE2 Title for the option2. Default "default value". VARIABLE3 Title for the option3. Description to show on UI. Optional. Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>; ' Here: VARIABLE1 will be required. VARIABLE2 will be required too but will be populated with a "default value". VARIABLE3 is optional and can be empty. A DNS provider may have alternative options like CloudFlare may use API KEY or API Token. You can use a second section OptionsAlt: section. Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud. Add them to Domains: section. Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
2023-11-18 18:57:12 +02:00
how to use cloudflare api and create custom api
2016-01-30 23:15:30 +08:00
######## Public functions #####################
update repo name
2020-01-30 12:06:39 +08:00
# Please Read this guide first: https://github.com/acmesh-official/acme.sh/wiki/DNS-API-Dev-Guide
add guide link
2019-06-10 22:35:55 +08:00
minor
2016-06-07 13:05:27 +08:00
#Usage: dns_myapi_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
fix compatible for sh. '-' is not allowed in function name.
2016-04-16 22:19:29 +08:00
dns_myapi_add() {
how to use cloudflare api and create custom api
2016-01-30 23:15:30 +08:00
fulldomain=$1
txtvalue=$2
update api template
2016-12-06 13:55:06 +08:00
_info "Using myapi"
_debug fulldomain "$fulldomain"
_debug txtvalue "$txtvalue"
how to use cloudflare api and create custom api
2016-01-30 23:15:30 +08:00
_err "Not implemented!"
Add shfmt to format source code
2016-11-09 19:30:39 +08:00
return 1
how to use cloudflare api and create custom api
2016-01-30 23:15:30 +08:00
}
support cloudflare rm function
2016-12-06 14:58:36 +08:00
#Usage: fulldomain txtvalue
spelling fixes
2016-12-14 21:32:24 +01:00
#Remove the txt record after validation.
add dns_xxx_rm function https://github.com/Neilpang/acme.sh/issues/79
2016-10-25 23:08:02 +08:00
dns_myapi_rm() {
fulldomain=$1
support cloudflare rm function
2016-12-06 14:58:36 +08:00
txtvalue=$2
_info "Using myapi"
_debug fulldomain "$fulldomain"
_debug txtvalue "$txtvalue"
add dns_xxx_rm function https://github.com/Neilpang/acme.sh/issues/79
2016-10-25 23:08:02 +08:00
}
how to use cloudflare api and create custom api
2016-01-30 23:15:30 +08:00
spelling fixes
2016-12-14 21:32:24 +01:00
#################### Private functions below ##################################
Reference in New Issue Copy Permalink