Replays

Stored events sent again, one at a time or in bulk. Authentication, errors and limits are on the overview.

List replays

GET /api/v1/projects/{project_id}/environments/{environment_id}/events/{event_id}/replays

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
event_id required	path	string	evt_ ID

Responses

Status	Description	Body
200	The event's replays, each with its delivery's status	ReplayList
401	No API key, or it is invalid or revoked	Problem
404	No such event, or no access	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem

Replay event

POST /api/v1/projects/{project_id}/environments/{environment_id}/events/{event_id}/replays

Send the stored event again, unchanged, as a new delivery.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
event_id required	path	string	evt_ ID

Request body

JSON, ReplayEvent.

Field	Type	Description
destination_environment_id	string | null	env_ ID of another of the project's environments the destination is in; the event's own by default.
destination_id required	string	dst_ ID: the event's original destination or another one.

Responses

Status	Description	Body
201	Replayed: its delivery's first attempt is queued	Replay
401	No API key, or it is invalid or revoked	Problem
403	A viewer, or into production from another environment without being an admin or owner	Problem
404	No such event, or no access	Problem
409	The event is quarantined: release it instead	Problem
422	No such destination	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem

Create replay job

POST /api/v1/projects/{project_id}/environments/{environment_id}/replay-jobs

Match a selection of events and count them; nothing is sent until the job is started.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID

Request body

JSON, CreateReplayJob.

Field	Type	Description
destination_environment_id	string | null	env_ ID of another of the project's environments the destination is in.
destination_id	string | null	dst_ ID to replay every event to; without one, each event goes to its original destinations.
rate_per_second	integer (int64) | null	Replays started per second, 1 to 100; default 10. The destination's own limits still apply.
selection required	Selection

Responses

Status	Description	Body
201	Counted and ready to start; at most 10,000 replays	ReplayJob
401	No API key, or it is invalid or revoked	Problem
403	A viewer, or into production from another environment without being an admin or owner	Problem
404	No such environment, or no access	Problem
422	An invalid selection or destination	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem

Get replay job

GET /api/v1/projects/{project_id}/environments/{environment_id}/replay-jobs/{replay_job_id}

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
replay_job_id required	path	string	rpj_ ID

Responses

Status	Description	Body
200	The job and its progress	ReplayJob
401	No API key, or it is invalid or revoked	Problem
404	No such job, or no access	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem

Cancel replay job

POST /api/v1/projects/{project_id}/environments/{environment_id}/replay-jobs/{replay_job_id}/cancel

Replay nothing more; its replays still in progress stop and count as failed.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
replay_job_id required	path	string	rpj_ ID

Responses

Status	Description	Body
200	Cancelled	ReplayJob
401	No API key, or it is invalid or revoked	Problem
404	No such job, or no access	Problem
409	It has finished	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem

Pause replay job

POST /api/v1/projects/{project_id}/environments/{environment_id}/replay-jobs/{replay_job_id}/pause

Stop after the current batch; replays already made go on.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
replay_job_id required	path	string	rpj_ ID

Responses

Status	Description	Body
200	Paused	ReplayJob
401	No API key, or it is invalid or revoked	Problem
404	No such job, or no access	Problem
409	It is not running	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem

Start replay job

POST /api/v1/projects/{project_id}/environments/{environment_id}/replay-jobs/{replay_job_id}/start

Start a ready job, or resume a paused one.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
replay_job_id required	path	string	rpj_ ID

Responses

Status	Description	Body
200	Running	ReplayJob
401	No API key, or it is invalid or revoked	Problem
404	No such job, or no access	Problem
409	It is running or finished	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem