Menu
Guides
API Reference

API Reference
Filter By
POST
GET
PUT
DELETE
PATCH

Release Status Log API

Query the history of your account's releases, step by step, so you can monitor release status from your own applications.

Each entry in the log is one step event of a release (for example, created, publishing, published, or failed). You choose a time window and get every event that happened in it.

To learn how to query the log, read more than 1000 entries, and monitor releases continuously, see the Monitoring release status with the Release Status Log API guide.

Common parameters

Parameter name Description Type
{{an}} Name of the VTEX account. Case-insensitive. Query variable.
{{startDate}} Start of the time window, inclusive. RFC 3339 date-time. Query variable.
{{endDate}} End of the time window, exclusive. RFC 3339 date-time. Query variable.

Limits

Limit Value
Maximum range between startDate and endDate 15 days.
Oldest allowed startDate 365 days back (history retention window).
Maximum entries per response 1000.
Rate limit 60 requests per minute per account.
Query timeout 5 seconds.

To cover a period longer than 15 days, split it into several windows of up to 15 days each.

Endpoints

Releases

SummaryMethodPath
List releasesGET/releases

Release history

SummaryMethodPath
Get release historyGET/releases/history