redirection.io

Creates a new domain Use this endpoint to create a new domain in your project. Once the domain is created, [it can be found in the manager](https://redirection.io/manager). 💡 Read the [documentation about how to configure a domain on the redirection.io managed instances](https://redirection.io/documentation/managed-instances/add-a-domain-to-your-project).

Creates a new project Use this endpoint to create a new project in your organization. The `metadata` attribute can be used to associate additional information about this project. Once the project is created, [it can be found in the manager](https://redirection.io/manager).

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.

Creates a new draft Rule Use this endpoint to create a new draft rule. 💡 Please note that the rule will actually be used by your website only once you publish the ruleset.

Permanently deletes a domain This endpoint allows to permanently delete a domain.

Deletes a Draft This endpoint allows to delete a draft change: * if the draft has the status `add`, then it will be removed and the redirection rule will not be added when publishing the ruleset * if the draft has the status `update`, then it will be removed and the associated redirection rule will not be updated when publishing the ruleset * if the draft has the status `delete`, then it will be removed and the associated redirection rule will not be deleted when publishing the ruleset 💡 Unlike the redirection rules of your ruleset, draft changes can not be recovered once they have been deleted.

Delete an instance Permanently deletes a project instance.

Permanently deletes a project This endpoint allows to permanently delete a project. When using this endpoint, the project and all of the associated data will be removed. 🛑 **Deleting a project is permanent and cannot be undone.** All data, including the rules, the logs, etc., will be immediately deleted and cannot be recovered afterwards. All the projects paid options will be lost and will not be refunded.

Deletes a Rule This endpoint allows to delete a rule. It will create a `Draft` to effectively remove the rule during the next publication. Please note that the rule will actually be removed only once you publish the ruleset. 💡 Even when deleted (so, after a publication), rules can be recovered using the project history.

Retrieves a ProjectDomain resource. Use this endpoint to retrieve the details of a domain.

Retrieves the collection of the domains. Retrieves the collection of the domains associated with a project.

Retrieves a Draft resource. Use this endpoint to retrieve the details of a draft rule.

Retrieves the collection of Draft rules This endpoint allows to retrieve the collection of draft rules of the project. Draft rules represent changes that have been saved in the project but not yet published. Each draft comes with a `status` property, which can be one of: * `add`: this is a new rule that is going to be added when publishing the ruleset * `update`: this is an already existing redirection rule that is going to be changed when publishing the ruleset * `delete`: this is an existing redirection rule that is going to be removed when publishing the ruleset 💡 Please note that there is pagination on this endpoint. Each page contain 100 items. Traversing the draft rules collection can be done using the `searchAfterId` query string parameter.

Retrieves a Instance resource. Retrieve the details of a project instance.

List project instances Retrieves the collection of instances associated with a project.

Retrieves the collection of Ip resources. This endpoint allows to retrieve the collection of ips used by managed instances to forward requests.

Retrieve the details of your organization This endpoint allows to retrieve the information of your redirection.io organization.

Retrieves a Project resource. Use this endpoint to retrieve the details of a project.

Retrieves the collection of Project resources. This endpoint allows to retrieve the collection of the projects in the organization associated to the provided API token.

Retrieves a Rule resource

Retrieves the usage statistics of a rule. Retrieves the usage statistics of a rule for a given time range. The statistics are grouped by a smart interval (min. 1 hour) that tries to return around 100 data points. The time range can be defined using the `start` and `end` query string parameters. If no time range is defined, the statistics from the rule creation date will be returned.

Retrieves the collection of currently published Rule resources. 💡 Please note that draft rules are **not** included in this list. If you have deleted a rule, it will still be listed here until you publish your ruleset. 💡 Also, please note that there is pagination on this endpoint. Each page contain 100 items. Traversing the rules collection can be done using the `searchAfterId` query string parameter.

Publishes the collection of Draft resources Use this endpoint to publish all the draft rules (rules in status `new`, `update` and `delete`) of this project. Publishing rules allows to make them available to the redirection.io agent. Please note that draft changes can also be used by "[test mode instances](https://redirection.io/documentation/user-documentation/managing-instances#activate-the-test-mode)" without publishing them. Once the ruleset is published, [you can found the live rules in the manager](https://redirection.io/manager/).

Updates an existing Rule Use this endpoint to update an existing rule. 💡 Please note that the rule will actually be updated on your website only once you publish the ruleset.