Request Logs

The Request Log Object

Use request logs to troubleshoot calls to the Rutter API across platforms. A log includes the recorded request and response, errors, and intermediate data when available. For asynchronous operations, it can also include the associated job's ID, idempotency key, and execution progress.

Find a request ID

Save the value of the X-Rutter-Request-ID response header from the API call you want to inspect. Pass that value as id to GET /logs/requests/{id}. This is the request ID and is returned for all requests. Don't confuse it with a resource ID or the X-Rutter-Job-ID used to fetch an asynchronous job.

Authenticate with your organization's client ID and client secret using Basic authentication.

Fetch a Request Log

GEThttps://production.rutterapi.com/versioned/logs/requests/:id

The response wraps the log in request. Request fields such as headers, params, and body are nullable JSON-encoded strings; response fields such as responseBody are JSON values. jobData is null when no associated job is available.

Credential-shaped values in recorded headers, query parameters, bodies, URLs, and response data are redacted as [REDACTED]. Some non-JSON content may be redacted in full, so logs may differ from the original request or response.

Lookups are limited to recent requests. An unknown ID, a request you don't have permission to access, or a request outside the available lookup window returns HTTP 410 with error code RESOURCE_NOT_FOUND.

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

Response Body

The Request Log dashboard

You can also inspect request logs in the Request Logs section of your Rutter Dashboard and filter by request ID.

Have questions?

Contact support for personalized guidance.

Contact support
Previous
Jobs