List replay jobs

GET

/v1/replays

This org's background replays, newest first.

Authorizations

apiKey

Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type

HTTP (bearer)

Parameters

Query Parameters

endpoint

Only this endpoint's.

Type

string

limit

Type

integer

Minimum

1

Maximum

100

Default

20

Responses

A page of replay jobs.

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": "rpj_01M2Y",

  

  

  

"endpoint": "ep_01JX9",

  

  

  

"state": "string",

  

  

  

"since": "string",

  

  

  

"until": "string",

  

  

  

"status": "string",

  

  

  

"destinations": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"replay_id": "string",

  

  

  

"stop_requested": true,

  

  

  

"total_estimate": 0,

  

  

  

"scanned": 0,

  

  

  

"replayed": 0,

  

  

  

"enqueued": 0,

  

  

  

"skipped": 0,

  

  

  

"excluded": 0,

  

  

  

"resumed_from": 0,

  

  

  

"destinations_used": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"error": "string",

  

  

  

"created_at": "string",

  

  

  

"started_at": "string",

  

  

  

"finished_at": "string"

  

  

}

  

]

}

GET

/v1/replays

Playground

Authorization

apiKey

Variables

Key

Value

endpoint

limit

Samples

Powered by VitePress OpenAPI