Skip to content

Timeout Support for API Requests #1027

@hannah-mnq

Description

@hannah-mnq

Tell us about the task you want to perform and are unable to do so because the feature is not available

When testing APIs that return responses after a delay (for example:
https://httpstat.us/200?sleep=15000), API Dash fails with a low-level ClientException without providing any control over how long the request should wait or a clear indication that the failure was due to a timeout.

Currently:

  • There is no way to configure a request timeout duration.
  • Slow but valid APIs may be interpreted as failed requests.
  • The error message shown is technical and not clearly associated with a timeout.
  • There is no option to cancel an in-progress request.

This makes it difficult to reliably test APIs that legitimately require more time to respond.


Describe the solution/feature you'd like us to add

Introduce request timeout handling with the following behavior:

  • A global default timeout value configurable in settings.
  • An optional per-request override when required.
  • A clear timeout message such as:

    "Request timed out after X seconds."

  • Optional ability to cancel an ongoing request.

The default timeout can remain at a sensible value so that existing workflows are not affected unless users choose to modify it.


Any other feedback you would like to provide regarding the site

API Dash already provides a clean and intuitive API testing experience. Adding proper timeout handling would significantly improve reliability and clarity when working with slow or unpredictable APIs.

I would appreciate hearing the maintainers’ thoughts on whether this aligns with the project roadmap before exploring implementation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    Status

    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions