From 82d0b513b0b2b008a41011d2ccf64ed414f2d97f Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch> Date: Wed, 14 Sep 2022 11:23:42 +0200 Subject: [PATCH] update readme --- README.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 88d9a2f..f6a19fe 100644 --- a/README.md +++ b/README.md @@ -110,14 +110,6 @@ written to STDERR. To hide them add a 2>/dev/null to hide the comments. [] ``` -### dns-api.sh - -Low level command to access the api. It is called from ./dns-search.sh too - but can be started manually for custom api urls. - -`dns-api.sh [METHOD] URL` - -This script is used by dns-search.sh ans show_ttls.sh. - ### show_ttls.sh This helper searches for all **host** entries that override the default @@ -154,4 +146,28 @@ host2.example.com ``` Between the json data are lines starting with a semikolon - these are comments -written to STDERR. To hide them add a 2>/dev/null to hide the comments. \ No newline at end of file +written to STDERR. To hide them add a 2>/dev/null to hide the comments. + +### dns-api.sh + +This is a low level command to access the api. +This script is used by dns-search.sh ans show_ttls.sh. +But it can be started manually for custom api urls. + +`dns-api.sh [METHOD] URL` + +Example: + +As an additional information for show_ttl.sh: how to get the default TTL? + +```txt +./dns-api.sh GET '/zone_auth?fqdn=example.com&_return_fields=soa_default_ttl,use_grid_zone_timer' +; === DNS API :: GET /zone_auth?fqdn=example.com&_return_fields=soa_default_ttl,use_grid_zone_timer +[ + { + "_ref": "zone_auth/RFID:example.com/default", + "soa_default_ttl": 28800, + "use_grid_zone_timer": false + } +] +``` -- GitLab