GET api/Zone/{zone_handle}/Redirection?user={user}&urlOrigin={urlOrigin}
Get redirects associated to the zone object
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
zone_handle |
Handle od the zone |
string |
Required |
user |
Optional user handle - if empty logged in user will be used |
string |
None. |
urlOrigin |
Optional url origin |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of redirections on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error
Name | Description | Type | Additional information |
---|---|---|---|
Handle |
Redirection handle |
string |
None. |
CreatedOn |
Created on |
date |
None. |
HitsYesterday |
Number of hits yesterday |
integer |
None. |
UrlOrigin |
Url origin |
string |
None. |
UrlDestination |
Url destination |
string |
None. |
Type |
Redirection type: |
integer |
Matching regular expression pattern: 0|1|2|3|4|5|6 |
Active | boolean |
None. |
|
Title | string |
None. |
|
MetaKeyword |
Comma seperated list of meta key words |
string |
None. |
MetaDescription |
Meta description |
string |
None. |
Relative |
Is relative |
boolean |
None. |
Response Formats
application/json, text/json
[ { "Handle": "sample string 1", "CreatedOn": "2025-04-04T00:31:33.3634647+02:00", "HitsYesterday": 3, "UrlOrigin": "sample string 4", "UrlDestination": "sample string 5", "Type": 6, "Active": true, "Title": "sample string 8", "MetaKeyword": "sample string 9", "MetaDescription": "sample string 10", "Relative": true }, { "Handle": "sample string 1", "CreatedOn": "2025-04-04T00:31:33.3634647+02:00", "HitsYesterday": 3, "UrlOrigin": "sample string 4", "UrlDestination": "sample string 5", "Type": 6, "Active": true, "Title": "sample string 8", "MetaKeyword": "sample string 9", "MetaDescription": "sample string 10", "Relative": true } ]
application/xml, text/xml
<ArrayOfRedirection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone"> <Redirection> <Active>true</Active> <MetaDescription>sample string 10</MetaDescription> <MetaKeyword>sample string 9</MetaKeyword> <Relative>true</Relative> <Title>sample string 8</Title> <Type>6</Type> <UrlDestination>sample string 5</UrlDestination> <UrlOrigin>sample string 4</UrlOrigin> <CreatedOn>2025-04-04T00:31:33.3634647+02:00</CreatedOn> <Handle>sample string 1</Handle> <HitsYesterday>3</HitsYesterday> </Redirection> <Redirection> <Active>true</Active> <MetaDescription>sample string 10</MetaDescription> <MetaKeyword>sample string 9</MetaKeyword> <Relative>true</Relative> <Title>sample string 8</Title> <Type>6</Type> <UrlDestination>sample string 5</UrlDestination> <UrlOrigin>sample string 4</UrlOrigin> <CreatedOn>2025-04-04T00:31:33.3634647+02:00</CreatedOn> <Handle>sample string 1</Handle> <HitsYesterday>3</HitsYesterday> </Redirection> </ArrayOfRedirection>