> For the complete documentation index, see [llms.txt](https://docs.thewalletcrew.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thewalletcrew.io/api-reference/forms/redirect.md).
# Redirect
## List short URLs
> Unpaged, unordered; includes expired ones.
```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"Redirect"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.redirect:read"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"WebRedirectEntity":{"required":["id","layout","uri"],"type":"object","properties":{"id":{"type":"string","description":"Case-sensitive code generated on create: the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of the other endpoints."},"layout":{"type":"string","description":"Path of the tenant web app page the visitor lands on."},"creationDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"integer","format":"int64"}],"description":"Creation date (UTC); unchanged by updates. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Query parameters added to the layout URL on every visit."},"options":{"description":"Label and expiry date.","$ref":"#/components/schemas/WebRedirectOptions"},"uri":{"type":"string","description":"URL to share. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404."}},"additionalProperties":false,"description":"A short URL and the page it redirects to."},"WebRedirectOptions":{"type":"object","properties":{"expirationDate":{"type":["null","string"],"description":"Informational expiry date; `null` for none.","format":"date-time"},"label":{"type":["null","string"],"description":"Admin-only label, never shown to the visitor. Omitted on update, it is cleared."},"length":{"type":"integer","description":"Length of the generated id. Default `6`.","format":"int32"}},"additionalProperties":false,"description":"Short URL settings."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/redirect":{"get":{"tags":["Redirect"],"summary":"List short URLs","description":"Unpaged, unordered; includes expired ones.","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The tenant's short URLs.","content":{"text/plain":{"schema":{"type":"array","items":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}}},"application/json":{"schema":{"type":"array","items":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}}},"text/json":{"schema":{"type":"array","items":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}}}}},"401":{"description":"The caller is not authenticated.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"403":{"description":"The caller lacks the tenant.redirect:read scope, or the endpoint is not enabled for the tenant.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"429":{"description":"Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when the limiter knows it.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```
## Create a short URL
> The id is server-generated; its length comes from \`options.length\`.
```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"Redirect"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.redirect:write"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"CreateOrUpdateModel":{"required":["layout"],"type":"object","properties":{"layout":{"minLength":1,"type":"string","description":"Target page, as a path within the tenant web app."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Query parameters added to the layout URL on every visit; a same-named visitor parameter replaces them."},"options":{"description":"Label, expiry date and id length. Omitted on update, label and expiry are cleared.","$ref":"#/components/schemas/WebRedirectOptions"}},"additionalProperties":false,"description":"Short URL to create, or the full replacement of an existing one."},"WebRedirectOptions":{"type":"object","properties":{"expirationDate":{"type":["null","string"],"description":"Informational expiry date; `null` for none.","format":"date-time"},"label":{"type":["null","string"],"description":"Admin-only label, never shown to the visitor. Omitted on update, it is cleared."},"length":{"type":"integer","description":"Length of the generated id. Default `6`.","format":"int32"}},"additionalProperties":false,"description":"Short URL settings."},"WebRedirectEntity":{"required":["id","layout","uri"],"type":"object","properties":{"id":{"type":"string","description":"Case-sensitive code generated on create: the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of the other endpoints."},"layout":{"type":"string","description":"Path of the tenant web app page the visitor lands on."},"creationDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"integer","format":"int64"}],"description":"Creation date (UTC); unchanged by updates. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Query parameters added to the layout URL on every visit."},"options":{"description":"Label and expiry date.","$ref":"#/components/schemas/WebRedirectOptions"},"uri":{"type":"string","description":"URL to share. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404."}},"additionalProperties":false,"description":"A short URL and the page it redirects to."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/redirect":{"post":{"tags":["Redirect"],"summary":"Create a short URL","description":"The id is server-generated; its length comes from `options.length`.","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Layout, parameters and options.","content":{"application/json":{"schema":{"description":"Short URL to create, or the full replacement of an existing one.","$ref":"#/components/schemas/CreateOrUpdateModel"}},"text/json":{"schema":{"description":"Short URL to create, or the full replacement of an existing one.","$ref":"#/components/schemas/CreateOrUpdateModel"}},"application/*+json":{"schema":{"description":"Short URL to create, or the full replacement of an existing one.","$ref":"#/components/schemas/CreateOrUpdateModel"}}}},"responses":{"201":{"description":"The created short URL, with the `uri` to share.","content":{"text/plain":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"application/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"text/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}}}},"400":{"description":"`layout` is missing.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"401":{"description":"The caller is not authenticated.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"403":{"description":"The caller lacks the tenant.redirect:write scope, or the endpoint is not enabled for the tenant.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"429":{"description":"Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when the limiter knows it.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```
## GET /api/{tenantId}/redirect/{id}
> Get a short URL
```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"Redirect"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.redirect:read"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"WebRedirectEntity":{"required":["id","layout","uri"],"type":"object","properties":{"id":{"type":"string","description":"Case-sensitive code generated on create: the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of the other endpoints."},"layout":{"type":"string","description":"Path of the tenant web app page the visitor lands on."},"creationDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"integer","format":"int64"}],"description":"Creation date (UTC); unchanged by updates. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Query parameters added to the layout URL on every visit."},"options":{"description":"Label and expiry date.","$ref":"#/components/schemas/WebRedirectOptions"},"uri":{"type":"string","description":"URL to share. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404."}},"additionalProperties":false,"description":"A short URL and the page it redirects to."},"WebRedirectOptions":{"type":"object","properties":{"expirationDate":{"type":["null","string"],"description":"Informational expiry date; `null` for none.","format":"date-time"},"label":{"type":["null","string"],"description":"Admin-only label, never shown to the visitor. Omitted on update, it is cleared."},"length":{"type":"integer","description":"Length of the generated id. Default `6`.","format":"int32"}},"additionalProperties":false,"description":"Short URL settings."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/redirect/{id}":{"get":{"tags":["Redirect"],"summary":"Get a short URL","parameters":[{"name":"id","in":"path","description":"Short URL id (case-sensitive).","required":true,"schema":{"minLength":3,"type":"string"}},{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The short URL.","content":{"text/plain":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"application/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"text/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}}}},"401":{"description":"The caller is not authenticated.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"403":{"description":"The caller lacks the tenant.redirect:read scope, or the endpoint is not enabled for the tenant.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"404":{"description":"Not found.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"429":{"description":"Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when the limiter knows it.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```
## Update a short URL
> Replaces layout, parameters, label and expiry (omitted ones are cleared). Id, shared URL and creation date are kept; \`options.length\` is ignored.
```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"Redirect"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.redirect:write"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"CreateOrUpdateModel":{"required":["layout"],"type":"object","properties":{"layout":{"minLength":1,"type":"string","description":"Target page, as a path within the tenant web app."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Query parameters added to the layout URL on every visit; a same-named visitor parameter replaces them."},"options":{"description":"Label, expiry date and id length. Omitted on update, label and expiry are cleared.","$ref":"#/components/schemas/WebRedirectOptions"}},"additionalProperties":false,"description":"Short URL to create, or the full replacement of an existing one."},"WebRedirectOptions":{"type":"object","properties":{"expirationDate":{"type":["null","string"],"description":"Informational expiry date; `null` for none.","format":"date-time"},"label":{"type":["null","string"],"description":"Admin-only label, never shown to the visitor. Omitted on update, it is cleared."},"length":{"type":"integer","description":"Length of the generated id. Default `6`.","format":"int32"}},"additionalProperties":false,"description":"Short URL settings."},"WebRedirectEntity":{"required":["id","layout","uri"],"type":"object","properties":{"id":{"type":"string","description":"Case-sensitive code generated on create: the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of the other endpoints."},"layout":{"type":"string","description":"Path of the tenant web app page the visitor lands on."},"creationDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"integer","format":"int64"}],"description":"Creation date (UTC); unchanged by updates. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Query parameters added to the layout URL on every visit."},"options":{"description":"Label and expiry date.","$ref":"#/components/schemas/WebRedirectOptions"},"uri":{"type":"string","description":"URL to share. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404."}},"additionalProperties":false,"description":"A short URL and the page it redirects to."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/redirect/{id}":{"put":{"tags":["Redirect"],"summary":"Update a short URL","description":"Replaces layout, parameters, label and expiry (omitted ones are cleared). Id, shared URL and creation date are kept; `options.length` is ignored.","parameters":[{"name":"id","in":"path","description":"Short URL id (case-sensitive).","required":true,"schema":{"minLength":3,"type":"string"}},{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New layout, parameters and options.","content":{"application/json":{"schema":{"description":"Short URL to create, or the full replacement of an existing one.","$ref":"#/components/schemas/CreateOrUpdateModel"}},"text/json":{"schema":{"description":"Short URL to create, or the full replacement of an existing one.","$ref":"#/components/schemas/CreateOrUpdateModel"}},"application/*+json":{"schema":{"description":"Short URL to create, or the full replacement of an existing one.","$ref":"#/components/schemas/CreateOrUpdateModel"}}}},"responses":{"200":{"description":"The updated short URL.","content":{"text/plain":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"application/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"text/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}}}},"400":{"description":"`layout` is missing.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"401":{"description":"The caller is not authenticated.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"403":{"description":"The caller lacks the tenant.redirect:write scope, or the endpoint is not enabled for the tenant.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"404":{"description":"Not found; nothing changed.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"429":{"description":"Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when the limiter knows it.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```
## Delete a short URL
> The shared URL then answers 404.
```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"Redirect"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.redirect:write"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"WebRedirectEntity":{"required":["id","layout","uri"],"type":"object","properties":{"id":{"type":"string","description":"Case-sensitive code generated on create: the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of the other endpoints."},"layout":{"type":"string","description":"Path of the tenant web app page the visitor lands on."},"creationDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"integer","format":"int64"}],"description":"Creation date (UTC); unchanged by updates. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Query parameters added to the layout URL on every visit."},"options":{"description":"Label and expiry date.","$ref":"#/components/schemas/WebRedirectOptions"},"uri":{"type":"string","description":"URL to share. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404."}},"additionalProperties":false,"description":"A short URL and the page it redirects to."},"WebRedirectOptions":{"type":"object","properties":{"expirationDate":{"type":["null","string"],"description":"Informational expiry date; `null` for none.","format":"date-time"},"label":{"type":["null","string"],"description":"Admin-only label, never shown to the visitor. Omitted on update, it is cleared."},"length":{"type":"integer","description":"Length of the generated id. Default `6`.","format":"int32"}},"additionalProperties":false,"description":"Short URL settings."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/redirect/{id}":{"delete":{"tags":["Redirect"],"summary":"Delete a short URL","description":"The shared URL then answers 404.","parameters":[{"name":"id","in":"path","description":"Short URL id (case-sensitive).","required":true,"schema":{"minLength":3,"type":"string"}},{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted; returns the short URL as it was.","content":{"text/plain":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"application/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}},"text/json":{"schema":{"description":"A short URL and the page it redirects to.","$ref":"#/components/schemas/WebRedirectEntity"}}}},"401":{"description":"The caller is not authenticated.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"403":{"description":"The caller lacks the tenant.redirect:write scope, or the endpoint is not enabled for the tenant.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"404":{"description":"Not found.","content":{"text/plain":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}},"text/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"429":{"description":"Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when the limiter knows it.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.thewalletcrew.io/api-reference/forms/redirect.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.