Developer Domains1.0.0-beta.1

Get domain forwarding settings

Returns active URL forwarding for a domain in the token’s Space. A domain without an active rule returns null. Any username or password embedded in a legacy destination is removed from the response.

GET/api/v1/domains/{domain}/forwarding

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is domains:forwarding:read. Scopes are independent.

This operation uses 1 credit from a shared budget of 60 credits per token and 300 per Space each UTC minute.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

domainstringRequired: Registered domain in lowercase ASCII or punycode. Minimum length: 3. Maximum length: 253.

Query parameters

None documented.

Header parameters

None documented.

Request body

No content type declared

No request body schema is documented.

Request & response examples

Copy an example in your preferred language.

request.sh

: "${DASHIO_API_TOKEN:?Set DASHIO_API_TOKEN before running this example}"

curl --fail-with-body --include --silent --show-error --connect-timeout 10 --max-time 30 \
  --request GET 'https://app.dashio.net/api/v1/domains/{domain}/forwarding' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN"

Replace URL parameters, credentials, and schema placeholders before running. No request is sent by this page.

API response example.

{
  "forwarding": {
    "targetUrl": "https://www.example.com/",
    "redirectType": 301,
    "preservePath": true,
    "preserveQueryString": true
  }
}

Run examples on a trusted server. Configure the environment variables and replace URL or schema placeholders. For a write, reuse its saved idempotency key only when retrying the identical request.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional: Server-generated ID to include in a support request.

200

The active redirect settings or null when forwarding is disabled.

Response headers

RateLimit-LimitintegerOptional: Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptional: Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptional: Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

forwardingobject | nullRequired: No field description supplied.

400

The domain name is invalid or an unexpected query parameter was supplied.

application/json

statusCodeintegerRequired: Minimum: 400. Maximum: 599.
statusMessagestringOptional: A safe explanation suitable for display.
dataobjectRequired: No field description supplied.

401

A valid developer token is required.