Redirects

Partially update one or more fields on a redirect. Set {"active": false} to deactivate without deleting, or {"active": true} to reactivate.

patch/v1/redirects/{id}

Request

  • Base URL: https://api.redirectboss.com
  • URL: https://api.redirectboss.com/v1/redirects/{id}
  • Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

Request body

activeboolean

Set to false to deactivate the redirect (stops processing requests but preserves configuration), or true to reactivate it. To permanently remove a redirect, use DELETE instead.

matchType'host' | 'exact' | 'prefix'

How to match incoming requests: "host" matches any request to the domain, "exact" matches an exact path, "prefix" matches a path prefix

pathstring http-path nullable

The path to match. Required for "exact" and "prefix", must be null or omitted for "host".

destinationUrlstring redirect-url

Target URL for the redirect

statusCode301 | 302 | 303 | 307

HTTP status code (301=permanent, 302/303/307=temporary)

preserveQueryStringboolean

Forward the original query string to the destination URL

appendPathboolean

Append the original request path to the destination URL

descriptionstring nullable

Optional note or label for this redirect

Response

Default Response

Changes

No recorded changes to this operation across all 1 revision of this API.