Create site redirect rules from CSV

Import rules from a CSV with a from,to,type header. Append adds to the existing rules, replace swaps them all out. Invalid and duplicate rows are skipped and reported.

Processing mode: async

POST /orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/import

Create site redirect rules from CSV

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nappend\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data; boundary=---011000010111000001101001"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

202

{
  "imported": 123,
  "invalid": [
    {
      "line": "<string>",
      "reason": "<string>",
      "from": "<string>",
      "to": "<string>",
      "type": "<string>"
    }
  ],
  "duplicates": [
    {
      "line": "<string>",
      "reason": "Repeats an earlier row in the file.",
      "from": "<string>",
      "to": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code

Authorization URL

https://forge.laravel.com/oauth/authorize

Token URL

https://forge.laravel.com/oauth/token

Scopes1

site:manage-redirects

Allow members to configure URL redirects

Path Parameters

organization · string · required

The organization slug

server · integer · required

The server ID

site · integer · required

The site ID

Body

multipart/form-data

file · file · required

The CSV file of redirect rules to import, with a from,to,type header row.

mode · enum<string> · required

How to apply the imported rules to the site's existing rules.

Available options: append, replace

Example:

"append"

Response

202

application/json

imported · integer · required

invalid · object[] · required

Show child attributes

duplicates · object[] · required

Option 1

Option 2

Show child attributes