Skip to content

Update redirect

Updates a redirect's source or destination.

Needs the site:write scope.

Call

  • Tool: update_redirect
  • Scope: site:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
redirect object Yes
from_path string No
to_path string No
status 308 or 301 or 302 or 307 No
enabled boolean No Off keeps it but never resolves it.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "redirect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "from_path": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "pattern": "^/[^\\s?#]*$"
    },
    "to_path": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "pattern": "^(?:/[^\\s\\x00-\\x1F\\x7F-\\x9F]*|https?://[^\\s\\x00-\\x1F\\x7F-\\x9F]+)$"
    },
    "status": {
      "anyOf": [
        {
          "type": "number",
          "const": 308
        },
        {
          "type": "number",
          "const": 301
        },
        {
          "type": "number",
          "const": 302
        },
        {
          "type": "number",
          "const": 307
        }
      ]
    },
    "enabled": {
      "description": "Off keeps it but never resolves it.",
      "type": "boolean"
    }
  },
  "required": [
    "redirect"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
from_path string Yes
to_path string Yes
status number Yes
enabled boolean Yes
live boolean Yes Resolved: enabled and within the redirects of its kind the plan applies.
connection_ended_at string or null Yes When it was turned off because the connection that set it up ended.
created_at string or null Yes

The answer’s full shape is on its API reference page.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_found: nothing matches a reference given.
  • conflict: the call clashes with the current state; context names the field and, where it helps, its current value, and for a from, live, expect or version that no longer matches, the argument (path) and what it takes (reason).
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
  • client-fault: the server failed around the call. core_answer ok means the write landed, so don’t send it again. When reached_core is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close