RemoteGymp · API v1

Limits and errors

Read every page, respect rate limits and recover safely from errors.

  1. Rate limits

    Limits are configurable. GET /v1/operations/capabilities reports requestsPerMinute and authenticationRequestsPerMinutePerIp. After a 429, honour Retry-After and wait longer if throttling continues. Batch reads accept up to 100 IDs; individual endpoints may have smaller page or payload limits.

  2. Read every page

    Use the continuation rule for the endpoint you called, keeping the same filters. Lists can change while you read them; use snapshots when you need a consistent copy.

    PaginationContinue withStop when
    CursorPass next as after.next is null.
    Offset with nextOffsetPass nextOffset as offset.nextOffset is null.
    Offset with hasMoreIncrease offset by the number of returned items.hasMore is false.
    SoftwarePass the numeric next value as after; restart if updatedAtUtc changes.next is null.
    Event feedPass next as after.hasMore is false.
  3. Handle errors

    Read the error code as well as the HTTP status. If the response includes requestId, quote it when contacting support.

    HTTP statusWhat to do
    400Fix the request.
    401Check credentials or obtain a new access token.
    403Check scope, permissions and whether access is enabled.
    404The resource may be missing or outside your scope.
    409Read the error code and current state before deciding.
    410The snapshot or event cursor expired. Start a new baseline.
  4. If a write times out

    A timeout or 503 does not prove the action failed. For writes that return operation receipts, look up GET /v1/operations/by-key?idempotencyKey={key} before retrying. For maintenance creation, reuse the original Idempotency-Key and body.

API reference →

Content revision 3f225a253 · OpenAPI SHA-256: b12c42306a89