PUT

Update redirect rule

https://linkshift.app/api/v1/redirect-rules/{id}

Updates a redirect rule and re-runs backend validation constraints.

Operation ID:updateRedirectRuleTags: Redirect Rules

Security

  • ApiKeyAuth: apiKey | header:X-API-Key | API key generated in LinkShift dashboard (`Organization -> Manage API keys`).

Parameters

Path parameters

idrequired
Type: stringDescription: Resource identifier.

Request body schema

requestBodyobjectrequired
Payload for updating a redirect rule.
destinationstring | nullnullable
Static destination URL. Keep null when using `linkMapId`.
maxLength: 16384
linkMapIdstring | nullnullable
Optional link-map ID for key-based destinations.
matchMethodarray of string
Allowed request methods. Empty array means all methods.
pathMatchstring
Path matching strategy.
enum: exact, prefix
priorityinteger
Rule priority (higher first).
minimum: 0maximum: 1000
queryMatchstring
Query-string matching strategy.
enum: exact, ignore, subset
sourcestring
Source matcher expression.
minLength: 1maxLength: 16384
statusCodeinteger
HTTP redirect status used for rule matches.
enum: 301, 302, 307, 308

Response schema

Updated redirect rule

Content type: application/json
response 200objectrequired
Redirect rule resolved during request matching.
blockedAtstring | nullnullable
Timestamp when the rule was blocked.
format: date-time
createdAtstringrequired
Creation timestamp (UTC).
format: date-time
deletedAtstring | nullnullable
Soft-delete timestamp in UTC when deleted.
format: date-time
destinationstring | nullnullable
Static redirect destination URL. Null when dynamic destination is used via link map.
domainGroupIdstringrequired
Parent domain-group ID.
idstringrequired
Redirect-rule ID.
isBlockedboolean
Whether the rule is currently blocked from execution.
linkMapIdstring | nullnullable
Optional linked map used for key-based destinations.
matchMethodarray of stringrequired
Allowed request methods. Empty array means all methods.
pathMatchstringrequired
Path matching strategy.
enum: exact, prefix
priorityintegerrequired
Rule priority (higher first).
queryMatchstringrequired
Query-string matching strategy.
enum: exact, ignore, subset
sourcestringrequired
Source matcher expression.
statusCodeintegerrequired
HTTP redirect status returned for matches.
enum: 301, 302, 307, 308
updatedAtstringrequired
Last update timestamp (UTC).
format: date-time