---
title: "Test a regular expression"
method: GET
path: "/v1/regex"
tags: ["Regex tester"]
---

# Test a regular expression

`GET /v1/regex`

## Request

- Base URL: `https://api.dharun.dev`
- URL: `https://api.dharun.dev/v1/regex`
- Auth: none declared

An invalid pattern answers 422 with code invalid_pattern and the engine's message; a JavaScript pattern that runs out of time answers 422 with code timeout. A group that took no part in a match has a null text, which is different from an empty one.

## Query parameters

- `pattern` string, required
- `text` string
- `flavor` 'js' | 're2'
- `flags` string
- `replace` string
- `limit` integer

## Response `200`

Success

- Envelope
  - `data` unknown, required
  - `meta` object, required
    - `limit` integer
    - `note` string
    - `offset` integer
    - `source` object: Where the data came from and the credit its licence asks for.
      - `attribution` string
      - `licence` string
      - `name` string
      - `retrieved` string
      - `url` string
      - `version` string
    - `total` integer

## Other responses

- `400`: Error
- `404`: Error
- `429`: Error

---

[API](https://skmtc.dev/dharun/apis/india-api-free-open-source-apis-for-indian-data.md) · [All operations](https://skmtc.dev/dharun/apis/india-api-free-open-source-apis-for-indian-data/llms.txt) · [OpenAPI document](https://skmtc.dev/dharun/apis/india-api-free-open-source-apis-for-indian-data/revisions/ecd8b0ec7863?raw)