Skip to main content
GET/api/management/projects/{projectId}/redirects/

Parameters

NameParameter typeTypeFormatDescriptionExampleRequired
projectIdpathstringThe project identifier found in the project overview screen of the management console.movieDbtrue
pageIndexquerynumberintegerThe index of the page.false
pageSizequerynumberintegerThe number of results per page. The default is 25.false
orderquerystringA comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.-version.modifiedfalse
statusCodequerynumberUsed to filter by status code301false
match.typequerystringUsed to filter by match.typebeginsWith, exactMatch or regexfalse
qquerystringA simple query to perform a 'contains' search over key properties.false

Responses

HTTP status codeReasonModel
200SuccessRedirect
401UnauthorizedError
403ForbiddenError
404Project not foundError
500Internal server errorError

Examples

Basic Pagination

HTTP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
GET /api/management/projects/{projectId}/redirects/?pageindex=0&pagesize=2 { "pageIndex": 0, "pageSize": 2, "totalCount": 3, "pageCount": 2, "items": [ { "id": "aab967ef-d2cf-43bb-96a4-c943b118c6f7", "sourceDomain": "example.com", "destination": "/new-path", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "beginsWith", "value": "/old-path" }, "version": { "created": "2023-05-04T12:05:42.376971", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-05-04T12:05:42.376975", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } }, { "id": "bbf967ef-d2cf-43bb-96a4-c943b118c6f8", "sourceDomain": "example.com", "destination": "/exact-destination", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "exactMatch", "value": "/specific-path" }, "version": { "created": "2023-06-10T10:20:30.456789", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-06-10T10:20:30.456791", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } } ] }

Filtering by Status Code

HTTP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
GET /api/management/projects/{projectId}/redirects/?statusCode=301 { "pageIndex": 0, "pageSize": 25, "totalCount": 3, "pageCount": 1, "items": [ { "id": "aab967ef-d2cf-43bb-96a4-c943b118c6f7", "sourceDomain": "example.com", "destination": "/new-path", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "beginsWith", "value": "/old-path" }, "version": { "created": "2023-05-04T12:05:42.376971", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-05-04T12:05:42.376975", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } }, { "id": "bbf967ef-d2cf-43bb-96a4-c943b118c6f8", "sourceDomain": "example.com", "destination": "/exact-destination", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "exactMatch", "value": "/specific-path" }, "version": { "created": "2023-06-10T10:20:30.456789", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-06-10T10:20:30.456791", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } }, { "id": "ccf967ef-d2cf-43bb-96a4-c943b118c6f9", "sourceDomain": "example.com", "destination": "/regex-destination", "statusCode": 301, "appendSourcePathToDestination": true, "match": { "type": "regex", "value": "^/products/(.*){{APP}}quot; }, "version": { "created": "2023-07-01T08:15:25.123456", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-07-01T08:15:25.123459", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } } ] }

Filtering by Match Type

HTTP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
GET /api/management/projects/{projectId}/redirects/?match.type=exactMatch { "pageIndex": 0, "pageSize": 25, "totalCount": 1, "pageCount": 1, "items": [ { "id": "bbf967ef-d2cf-43bb-96a4-c943b118c6f8", "sourceDomain": "example.com", "destination": "/exact-destination", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "exactMatch", "value": "/specific-path" }, "version": { "created": "2023-06-10T10:20:30.456789", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-06-10T10:20:30.456791", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } } ] }

Keyword Search

HTTP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
GET /api/management/projects/{projectId}/redirects/?q=products { "pageIndex": 0, "pageSize": 25, "totalCount": 1, "pageCount": 1, "items": [ { "id": "ccf967ef-d2cf-43bb-96a4-c943b118c6f9", "sourceDomain": "example.com", "destination": "/regex-destination", "statusCode": 301, "appendSourcePathToDestination": true, "match": { "type": "regex", "value": "^/products/(.*){{APP}}quot; }, "version": { "created": "2023-07-01T08:15:25.123456", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-07-01T08:15:25.123459", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } } ] }

Sorting Results

HTTP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
GET /api/management/projects/{projectId}/redirects/?order=-statusCode { "pageIndex": 0, "pageSize": 25, "totalCount": 3, "pageCount": 1, "items": [ { "id": "aab967ef-d2cf-43bb-96a4-c943b118c6f7", "sourceDomain": "example.com", "destination": "/new-path", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "beginsWith", "value": "/old-path" }, "version": { "created": "2023-05-04T12:05:42.376971", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-05-04T12:05:42.376975", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } }, { "id": "bbf967ef-d2cf-43bb-96a4-c943b118c6f8", "sourceDomain": "example.com", "destination": "/exact-destination", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "exactMatch", "value": "/specific-path" }, "version": { "created": "2023-06-10T10:20:30.456789", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-06-10T10:20:30.456791", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } }, { "id": "ccf967ef-d2cf-43bb-96a4-c943b118c6f9", "sourceDomain": "example.com", "destination": "/regex-destination", "statusCode": 301, "appendSourcePathToDestination": true, "match": { "type": "regex", "value": "^/products/(.*){{APP}}quot; }, "version": { "created": "2023-07-01T08:15:25.123456", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-07-01T08:15:25.123459", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } } ] }

Combining Filters

HTTP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
GET /api/management/projects/{projectId}/redirects/?statusCode=301&match.type=beginsWith&q=old-path { "pageIndex": 0, "pageSize": 25, "totalCount": 1, "pageCount": 1, "items": [ { "id": "aab967ef-d2cf-43bb-96a4-c943b118c6f7", "sourceDomain": "example.com", "destination": "/new-path", "statusCode": 301, "appendSourcePathToDestination": false, "match": { "type": "beginsWith", "value": "/old-path" }, "version": { "created": "2023-05-04T12:05:42.376971", "createdBy": "3376a167-3e97-407f-981b-600aecec0401", "modified": "2023-05-04T12:05:42.376975", "modifiedBy": "3376a167-3e97-407f-981b-600aecec0401" } } ] }

Still need help?

New support request