Read redirects from a file
Reads rules from the text of an nginx, Apache or CSV file and answers them with the lines it skipped. Nothing is saved: add the rules to your table and save it.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
The text of the file, as UTF-8, up to 512 KiB. Only the first 2,000 lines are read.
nginxapachecsvLimit every rule read to these domains of the site.
Returns
200 The rules read from the file, and what happened to each line.
Fields of the 200 answer
Fields of each item
What happened to the line, such as added, replaces, skipped or rejected.
One redirect rule as the API answers it.
Fields
The domains the rule is limited to. Null for every domain.
The rule's id. Null for a rule that is not saved yet, as in an import or a test of unsaved rules.
The rule's place in the table, starting at 1. A rule whose path is the address asked for (an exact rule, or a prefix rule's own path) is taken first, whatever its position. Otherwise prefix and regex rules are tried in this order, and the first match wins. On a domain, the rules limited to it are taken this way before the rules for every domain.
The id of an earlier rule that always answers first, so this one never matches.
301302exactprefixregexFields of each item
The domains the rule is limited to. Null for every domain.
The rule's id. Null for a rule that is not saved yet, as in an import or a test of unsaved rules.
The rule's place in the table, starting at 1. A rule whose path is the address asked for (an exact rule, or a prefix rule's own path) is taken first, whatever its position. Otherwise prefix and regex rules are tried in this order, and the first match wins. On a domain, the rules limited to it are taken this way before the rules for every domain.
The id of an earlier rule that always answers first, so this one never matches.
301302exactprefixregexFields of each item
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
409 | deleted | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | provisioning | The site is still being created. Try again in a few minutes. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/redirects/import \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"content": "Redirect 301 /about-us.html /about\nRedirect 302 /summer-offer /offers/autumn\n",
"format": "apache"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/redirects/import', [
'content' => 'Redirect 301 /about-us.html /about
Redirect 302 /summer-offer /offers/autumn
',
'format' => 'apache',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/redirects/import', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
content: 'Redirect 301 /about-us.html /about\nRedirect 302 /summer-offer /offers/autumn\n',
format: 'apache',
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/corestack/sites/1042/redirects/import",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"content": "Redirect 301 /about-us.html /about\nRedirect 302 /summer-offer /offers/autumn\n",
"format": "apache",
},
)
data = res.json() if res.content else None{
"duplicates": 0,
"format": "apache",
"imported": 1,
"lines": [
{
"line": 2,
"reason": "Not a redirect",
"result": "skipped"
},
{
"line": 4,
"reason": null,
"result": "added",
"rule": {
"enabled": true,
"from": "/team.html",
"hosts": null,
"id": null,
"keep_query": true,
"note": null,
"position": 1,
"shadowed_by": null,
"status": 301,
"to": "/about/team",
"type": "exact"
}
}
],
"rules": [
{
"enabled": true,
"from": "/team.html",
"hosts": null,
"id": null,
"keep_query": true,
"note": null,
"position": 1,
"shadowed_by": null,
"status": 301,
"to": "/about/team",
"type": "exact"
}
],
"skipped": 1,
"warnings": [
{
"line": 7,
"message": "RewriteCond is not supported",
"text": "RewriteCond %{HTTP_HOST} ^www\\.example\\.com$ [NC]"
}
]
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "deleted",
"message": "This site is deleted and waiting to be purged. Restore it first.",
"reason": "deleted"
}{
"code": "invalid",
"errors": {
"format": [
"The selected format is invalid."
]
},
"field": "format",
"message": "The selected format is invalid.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}