---
title: "Detect the app proxy path"
description: "Find which app proxy path the storefront answers, from the paths STOQ installs with. detected is that path, or null when none answers (or the storefront password hides it)."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-app-proxy/detect-the-app-proxy-path/
api: "API v2 reference"
method: GET
path: "/back_in_stock/app_proxy/detect"
---

# Detect the app proxy path

`GET https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/detect`

Find which app proxy path the storefront answers, from the paths STOQ installs with. detected is that path, or null when none answers (or the storefront password hides it).

**Note:** Read-only: it tries each candidate path on the shop's myshopify.com storefront and saves nothing. To use the path it finds, send it as `optin.app_proxy_path_prefix` in [`PATCH /back_in_stock/settings/widget`](https://docs.stoqapp.com/v2-reference/back-in-stock-settings/update-widget-settings/). A storefront password page or a store that doesn't answer also gives `detected: null`, so null does not prove the proxy is missing. To test a path of your own, call [`GET /back_in_stock/app_proxy/verify`](https://docs.stoqapp.com/v2-reference/back-in-stock-app-proxy/verify-the-app-proxy-path/). Each try waits up to 5 seconds.

## Returns

- `detected` (string, nullable): e.g. `string`

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/detect" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "detected": "string"
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

