v1

latestOpenAPI 3.1.02026-07-1324323188.8 KB

Redirection

Creates a new Redirection

Use this endpoint to create a new simple redirection rule (a Source URL, a target URL and a status code).

💡 Please note that using this endpoint will create a Draft change in your ruleset, with the add status. The actual redirection rule will be used by your website only once you publish the ruleset.

post/redirections

Request body

descriptionstring nullable

This description field is used to describe the rule and share knowledge with other users

enabledboolean nullable

Set to "false" to disable this rule. Even once published, this rule will not be used by your website

priorityinteger nullable

A rule with higher priority takes precedence over lower priorities, which means that the actions defined in the higher priority rule will override the similar actions defined in a lower priority one

projectstring iri-reference required

An IRI reference to the project, of the form /projects/{project_id}.

sourcestring required

The URL to be redirected. This URL must start with /, ://, http:// or https://

statusCode301 | 302 | 307 | 308 required

The status code to use for this redirection.

tagsstring[]

Tags are useful to filter rules and retrieve them easily

targetstring required

The redirection target URL. It must can be a relative URL (starting with /) or an absolute one (starting with ://, http:// or https://).

Example request

{
  "project": "/projects/{projectID}",
  "source": "/some-source-url",
  "target": "/the-target-url"
}

Response

Draft rule resource created (with the status add)

idstring required

status'add' | 'update' | 'delete' required

The type of change that this draft represents.

Example response

{
  "rule": {
    "actions": [
      {
        "mode": "default"
      }
    ],
    "markers": [
      {
        "description": "My enum marker that only allow \"dog\" or \"cat\"",
        "name": "MyEnum",
        "transformers": [
          {
            "something": "foo",
            "with": "bar"
          }
        ]
      }
    ],
    "trigger": {
      "date": [
        {
          "operator": "equals"
        }
      ],
      "datetime": [
        {
          "operator": "after"
        }
      ],
      "ipAddress": {
        "ip": "1.2.3.4"
      },
      "methods": [
        "GET",
        "POST"
      ],
      "requestHeaders": [
        {
          "name": "Accept",
          "operator": "isNotEqualTo",
          "value": "application/json"
        }
      ],
      "responseStatusCodes": [
        500,
        503
      ],
      "sampling": 47,
      "source": "/old-url",
      "time": [
        {
          "operator": "after"
        }
      ]
    },
    "variables": [
      {
        "marker": "markerName",
        "name": "myVariable",
        "transformers": [
          {
            "something": "foo",
            "with": "bar"
          }
        ]
      }
    ]
  },
  "status": "add"
}