From 2d549fb8231a8f2ba5a1241bdc6ea394602ac8f2 Mon Sep 17 00:00:00 2001 From: Iain Learmonth Date: Fri, 12 Jul 2024 15:22:50 +0100 Subject: [PATCH] doc(rdr): adds new parameters for /link --- docs/admin/redirector/http.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/admin/redirector/http.rst b/docs/admin/redirector/http.rst index 9f7db41..8dde8ae 100644 --- a/docs/admin/redirector/http.rst +++ b/docs/admin/redirector/http.rst @@ -66,8 +66,13 @@ Generate a short link or a direct mirror link. Query Parameters: - `url` (required): The URL for which a link needs to be generated. -- `type` (optional): The type of link to generate. Valid values are "direct" or "short". If not provided, "direct" is used. +- `type` (optional): The type of link to generate. Valid values are "direct", "short", or "getsitecopy". If not provided, "direct" is used. - `key` (optional): The API key of the pool. If not provided, the public API key is used. +- `expiry` (optional): The duration that a GetSiteCopy article will remain published for. Valid values are "long" and "short". If not provided, "short" is used. +- `footer_text` (optional): Defines the footer text to be used when publishing a GetSiteCopy article. +- `footer_link` (optional): Defines the footer link to be used when publishing a GetSiteCopy article. + +When neither `footer_text` or `footer_link` are specified, if a mirror link is available to the site's homepage, this will be used for the footer link. Response: