GET api/Zone/{zone_handle}/RedirectService?user={user}
Return the redirect services for the zone
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| zone_handle |
Zone object handle |
string |
Required |
| user |
Optional user handle - if empty logged in user will be used |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of services 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 |
Service handle |
string |
None. |
| Name | string |
None. |
|
| Status | string |
None. |
|
| ProductId |
Product id |
integer |
None. |
| Unit |
No of instances available |
integer |
None. |
| AvailableRedirect |
No of redirections available |
integer |
None. |
| UsedRedirect |
No of redirections in use |
integer |
None. |
| Created |
Date created |
date |
None. |
| Expires |
Date expires |
date |
None. |
| AutoRenew |
Has auto renew |
boolean |
None. |
Response Formats
application/json, text/json
[
{
"Handle": "sample string 1",
"Name": "sample string 2",
"Status": "sample string 3",
"ProductId": 4,
"Unit": 5,
"AvailableRedirect": 6,
"UsedRedirect": 7,
"Created": "2025-12-12T19:15:50.1262403+01:00",
"Expires": "2025-12-12T19:15:50.1262403+01:00",
"AutoRenew": true
},
{
"Handle": "sample string 1",
"Name": "sample string 2",
"Status": "sample string 3",
"ProductId": 4,
"Unit": 5,
"AvailableRedirect": 6,
"UsedRedirect": 7,
"Created": "2025-12-12T19:15:50.1262403+01:00",
"Expires": "2025-12-12T19:15:50.1262403+01:00",
"AutoRenew": true
}
]
application/xml, text/xml
<ArrayOfRedirectService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
<RedirectService>
<AutoRenew>true</AutoRenew>
<AvailableRedirect>6</AvailableRedirect>
<Created>2025-12-12T19:15:50.1262403+01:00</Created>
<Expires>2025-12-12T19:15:50.1262403+01:00</Expires>
<Handle>sample string 1</Handle>
<Name>sample string 2</Name>
<ProductId>4</ProductId>
<Status>sample string 3</Status>
<Unit>5</Unit>
<UsedRedirect>7</UsedRedirect>
</RedirectService>
<RedirectService>
<AutoRenew>true</AutoRenew>
<AvailableRedirect>6</AvailableRedirect>
<Created>2025-12-12T19:15:50.1262403+01:00</Created>
<Expires>2025-12-12T19:15:50.1262403+01:00</Expires>
<Handle>sample string 1</Handle>
<Name>sample string 2</Name>
<ProductId>4</ProductId>
<Status>sample string 3</Status>
<Unit>5</Unit>
<UsedRedirect>7</UsedRedirect>
</RedirectService>
</ArrayOfRedirectService>