Start
Guides
Concepts
API endpoints
POST
Simulate redirect rule matching
https://linkshift.app/api/v1/redirect-rules/simulateEvaluates request samples against current rules without applying live redirects.
Operation ID:
simulateRedirectRulesTags: Redirect RulesSecurity
- ApiKeyAuth: apiKey | header:X-API-Key | API key generated in LinkShift dashboard (`Organization -> Manage API keys`).
Parameters
This endpoint has no parameters.
Request body schema
requestBodyobjectrequired
Batch request payload for rule simulation.
entriesarray of objectrequired
Request samples that should be evaluated by the simulation engine.
domainGroupIdstringrequired
Domain-group scope for this sample.
headersobject
Optional request headers map.
[key: string]string
hostnamestring
Optional request host header.
ipstring
Optional client IP used by conditional rules.
methodstring
HTTP request method.
pathstringrequired
Request path (without protocol/host).
protocolstring
Request protocol used in matching context.
queryobject
Optional query parameters map.
[key: string]unknown
Additional properties are allowed
userAgentstring
Optional user-agent used by conditional rules.
Response schema
Simulation results
Content type:
application/jsonresponse 200objectrequired
Simulation result payload for each input request sample.
resultsarray of objectrequired
Simulation result rows matching the input order.
domainGroupIdstringrequired
Domain-group scope used in simulation.
hostnamestringrequired
Effective host used for matching.
indexintegerrequired
Index of input entry.
matchedbooleanrequired
Whether a redirect rule matched.
methodstringrequired
Effective HTTP method used for matching.
pathstringrequired
Effective request path used for matching.
statusCodeintegerrequired
Resulting HTTP status code.
targetstring | nullnullable
Resolved redirect target URL when matched.