logo
Errors (RFC 7807)Instance URIs

Problem instance URIs

What the instance field in Public API Problem Details means and how it relates to X-Request-Id.

Problem instance URIs

When an error response includes instance, its value looks like:

https://docs.inboxops.app/api/problems/instances/{id}

The {id} segment is the request correlation identifier for that HTTP request. It matches the X-Request-Id response header when the server assigned or accepted an id for the request.

Purpose

  • Support and logs: Quote X-Request-Id (or the instance path) when contacting InboxOps so we can trace a single request.
  • RFC 7807: instance may identify this specific occurrence of the problem; it is not a separate documentation page per id.

There is no catalog of /instances/… URLs—each id is opaque and unique to one request (or your client-supplied correlation value, when valid).