Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
          "id": 7424,
          "hub_id": 24601,
          "enabled": 1,
          "priority": 1,
          "redirect_type": "permanent",
          "parameters_syntax": "exact",
          "syntax": "exact",
          "source_scheme": null,
          "source_path_pattern": null,
          "source_parameters_pattern": null,
          "source_remove_path_trailing_slash": 1,
          "destination_type": "hub",
          "destination_path_template": null,
          "destination_hub_id": 7624,
          "destination_collection_id": null,
          "destination_author_id": null,
          "destination_parameters_template": null,
          "destination_append_source_parameters": 0,
          "created_at": "2016-12-18T03:51:40-0500",
          "modified_at": "2016-12-18T03:51:40-0500"
        },
        {
          "id": 7428,
          "hub_id": 24601,
          "enabled": 1,
          "priority": 1,
          "redirect_type": "permanent",
          "parameters_syntax": "exact",
          "syntax": "exact",
          "source_scheme": null,
          "source_path_pattern": null,
          "source_parameters_pattern": null,
          "source_remove_path_trailing_slash": 1,
          "destination_type": "author",
          "destination_path_template": null,
          "destination_hub_id": 7624,
          "destination_collection_id": null,
          "destination_author_id": 13703,
          "destination_parameters_template": null,
          "destination_append_source_parameters": 0,
          "created_at": "2016-12-18T03:51:42-0500",
          "modified_at": "2016-12-18T03:51:42-0500"
        }
    ],
    "meta": {
        ...
    }
}

The response will contain a redirect rules collection:

Body Parameters

Type

Description

data

Array

The collection of redirect rules

meta

Object

See: Pagination

Each rule in the collection will have properties:

Body Parameters

Type

Description

id

Integer

The asset identifier

hub_id

Integer

The hub identifier

enabled

Boolean

Whether the rule is enabled

priority

Integer

The priority of the redirect rule

redirect_type

String

The type of redirect (permanent, temporary)

redirect_stage

String

The stage of redirect (dispatch, not_found)

parameters_syntax

String

The syntax used to match parameters (exact, regex, starts)

syntax

String

The syntax used to match the path (exact, regex, starts)

source_scheme

String

The source path header (http, https)

source_path_pattern

String

The source path URL

source_parameters_pattern

String

The source query parameters regex pattern

source_remove_path_trailing_slash

Boolean

Whether the rule removes trailing slash

destination_type

String

The type of destination (path, hub, stream, author)

destination_path_template

String

The destination path URL

destination_hub_id

Integer

The destination hub identifier

destination_collection_id

Integer

The destination stream identifier

destination_author_id

Integer

The destination author identifier

destination_parameters_template

String

The destination path query parameters

destination_append_source_parameters

Boolean

Whether the source query parameter(s) should be appended to the destination

created_at

Date

The rule created date

modified_at

Date

The rule last modified date