Search documentation

Find pages, sections, and snippets across the Clog docs.

Documentation

List redirects

GET
/external/redirects

Returns a page of redirects for the bound workspace. Requires settings:read OR seo:read. Consumer sites poll this and replay redirects locally on every 404.

Authorization

ApiKeyAuth
X-API-Key<token>

Workspace-scoped API key, e.g. clog_live_AbCdEfGh.... Passed in the X-API-Key header on every request.

In: header

Query Parameters

page?integer

1-based page number. Defaults to 1.

Default1
Range1 <= value
pageSize?integer

Items per page. Defaults to 10.

Default10
Range1 <= value
order?string

Sort direction. Defaults to desc. Requires orderBy.

Default"desc"
Value in"asc" | "desc"
orderBy?string
Value in"createdAt" | "updatedAt" | "fromPath" | "toPath" | "hitCount" | "lastHitAt"
search?string

Case-insensitive search across fromPath and toPath.

type?string
Value in"Permanent301" | "Temporary302" | "Temporary307" | "Gone410" | "UnavailableForLegalReasons451"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/external/redirects"
{
  "page": 0,
  "pageSize": 0,
  "order": "asc",
  "orderBy": "string",
  "total": 0,
  "totalPages": 0,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
      "fromPath": "string",
      "toPath": "string",
      "type": "Permanent301",
      "hitCount": 0,
      "lastHitAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "code": "BAD_REQUEST",
  "message": "string",
  "details": null
}
{
  "code": "BAD_REQUEST",
  "message": "string",
  "details": null
}