- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Redirect tasks
Redirect list
Function
The task RedirectList inquires a list of the current redirects.
You can find more information about list queries here.
Description
Route: POST /redirect/_search
Query parameters
The data of the following keywords can be queried with the query parameter ?keys[]=:
- created
- domain
- mode
- source
- target.
- title
- type
- updated
{
"filters": [{
"key": "source",
"value": "example*",
"operator": "LIKE",
"link": "AND",
"filters": []
}],
"view": {
"limit": 10,
"offset": 0,
"children": true,
"from": "2019-03-01T14:00:00.6306444Z",
"to": "2019-05-10T10:00:00.6306444Z"
}
}{
"stid": "20190701-app2-dev-15314",
"status": {
"code": "S0504",
"text": "Redirect data was inquired successfully.",
"type": "SUCCESS"
},
"object": {
"type": "Redirect",
"summary": 1
},
"data": [
{
"created": "2014-10-24T09:43:47.000+0200",
"updated": "2017-11-17T17:35:21.000+0100",
"source": "example.com",
"target": "example-target.com",
"type": "DOMAIN",
"mode": "FRAME",
"domain": "example.com"
}
]
}
Task code: 0504
Uses Redirect object
Keywords
The following keywords are returned by default:
created
mode
source
target
type
updated
The data of the following keywords can be queried with the keyword <key>:
owner
title
updater
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0504</code>
<view>
<offset>0</offset>
<limit>30</limit>
<children></children>
</view>
<key>updated</key>
<key>created</key>
<key>title</key>
<where>
<and>
<key>type</key>
<operator>eq</operator>
<value>domain</value>
</and>
<and>
<key>source</key>
<operator>like</operator>
<value>e*</value>
</and>
</where>
</task>
</request><response>
<result>
<data>
<summary>2</summary>
<redirect>
<owner>
<user>customer2</user>
<context>4</context>
</owner>
<updater>
<user>customer</user>
<context>1018945</context>
</updater>
<type>domain</type>
<mode>http</mode>
<source>example.com</source>
<target>example2.com</target>
<updated>yyyy-MM-dd hh:mm:ss</updated>
<created>yyyy-MM-dd hh:mm:ss</created>
</redirect>
<redirect>
<owner>
<user>customer3</user>
<context>4</context>
</owner>
<updater>
<user>customer</user>
<context>1018945</context>
</updater>
<type>domain</type>
<mode>frame</mode>
<source>example3.com</source>
<target>example4.com</target>
<updated>yyyy-MM-dd hh:mm:ss</updated>
<created>yyyy-MM-dd hh:mm:ss</created>
</redirect>
</data>
<status>
<text>Redirect data was inquired successfully.</text>
<type>success</type>
<code>S0504</code>
</status>
</result>
</response>