Получение списка редиректов

Возвращает список редиректов магазина с пагинацией и поиском по url_from/url_to.

Request

GET

https://api.kit.yandex.net/v1/redirects

Query parameters

Name

Description

page

Type: integer

Номер страницы.

Default: 1

Min value: 1

per_page

Type: integer

Количество элементов на странице.

Default: 25

Min value: 1

Max value: 100

url_any

Type: string

Поиск по любому из путей (url_from или url_to). Нельзя указывать вместе с url_from или url_to.

Example: /page

url_from

Type: string

Поиск по пути, с которого выполняется переадресация (подстрока).

Example: /old

url_to

Type: string

Поиск по пути, на который выполняется переадресация (подстрока).

Example: /new

Responses

200 OK

Список редиректов.

Body

application/json
{
  "redirects": [
    {
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "url_from": "/old-page",
      "url_to": "/new-page",
      "is_automatic": false
    }
  ],
  "total_count": 100
}

Name

Description

redirects

Type: Redirect[]

Example
[
  {
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "url_from": "/old-page",
    "url_to": "/new-page",
    "is_automatic": false
  }
]

total_count

Type: integer

Общее количество редиректов.

RedirectID

Идентификатор редиректа.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

Redirect

Name

Description

id

Type: RedirectID

Идентификатор редиректа.

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

is_automatic

Type: boolean

true — если редирект создан автоматически (например, при смене slug категории/коллекции), false — если вручную.

url_from

Type: string

Путь, с которого выполняется переадресация.

Example: /old-page

url_to

Type: string

Путь, на который выполняется переадресация.

Example: /new-page

Example
{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "url_from": "/old-page",
  "url_to": "/new-page",
  "is_automatic": false
}

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

401 Unauthorized

Не авторизован.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000