@mxraven/admin - v2.1.0
    Preparing search index...

    Class ApiException

    A non-successful control-plane API response.

    The full decoded Problem is available from ApiException.problem. Prefer catching the status-specific subclasses (NotFoundException, ConflictException, ValidationException, ...) over inspecting the status.

    Hierarchy (View Summary)

    Index
    constructor
    code detail errors problem retryAfterMs status title traceId
    retryable
    code: string | undefined

    Stable machine-readable error code, or undefined when absent.

    detail: string | undefined

    Human-readable problem detail, or the raw body when no problem decoded.

    errors: readonly ProblemError[]

    Actionable validation issues; empty when none were provided.

    problem: Problem | undefined

    The full decoded problem, or undefined when the body was not a problem.

    retryAfterMs: number | undefined

    The server-requested retry delay in milliseconds, when available.

    status: number

    The HTTP status code of the response.

    title: string | undefined

    Short human-readable problem title, or undefined when absent.

    traceId: string | undefined

    Support correlation identifier, or undefined when absent.

    • get retryable(): boolean

      Whether the request may succeed if retried later.

      Rate limits (429) and server-side failures (5xx) are retryable.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors