---
title: "get domains"
method: GET
path: "/domain"
tags: ["Domain"]
---

# get domains

`GET /domain`

Get a list of domains

## Query parameters

- `filters` string

## Response `200`

a result containing a list of domains

- MultiDomainResult
  - `result` Domain[]
    - `domain_key` string, required
    - `zone_key` string, required
    - `name` string, required
    - `port` integer, required
    - `checksum` string, required
    - `redirects` Redirect[]
      - `name` string, required — A unique (to this Domain) name for the Redirect. Must match the regexp "^[0-9a-zA-Z-]+$"
      - `from` string, required — A regexp that will be matched against the URL (not including the host/port). May include capture groups for reference in "to."
      - `to` string, required — The new URL that will be constructed from the request. Capture groups from "from" may be referenced as "$<group number>" which begins at 1.
      - `redirect_type` 'permanent' | 'temporary', required — How this redirect should be presented via HTTP response code.
      - `header_constraints` HeaderConstraint[]
        - `name` string, required — The header that is being checked. This must match the regexp "^[0-9a-zA-Z-]+$". This is checked in a case insensitive manner.
        - `value` string — If set the header's value will be compared to this. The default is to make case insensitive comparisons.
        - `case_sensitive` boolean — If set, the header value check will be case sensitive.
        - `invert` boolean — If set, the header constraint will succeed if the match described faile.
    - `gzip_enabled` boolean — Experimental: if set to true will enable gzip compression on data that passes trough this domain
    - `ssl_config` SSLConfig — Experimental: Specifies whether a domain should support SSL/TLS connections from clients. If not set the proxy will expect unencrypted HTTP traffic.
      - `cert_key_pairs` CertKeyPathPair[], required — SSLConfig must have one cert_key_pairs entry specified.
        - `certificate_path` string, required — Path to a certificate in the PEM format for the domain. If multiple certificates need to be specified then should be contained in this file in the following order: first the primary certificate followed by any intermediary certificats.
        - `key_path` string, required — Path to a file with the secret key in the PEM format for the domain.
      - `cipher_filter` string — An OpenSSL compatible filter string indicating the ciphers acceptable for this proxy to use while communicating with clients. The default value is EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH. For more information see https://wiki.openssl.org/index.php/Manual:Ciphers(1)
      - `protocols` string[] — A list of acceptable SSL/TLS protocol. The default values are TLSv1, TLSv1.1, TLSv1.2. Additional valid values are SSLv2 and SSLv3.
    - `cors_config` CORSConfig — Experimental: Controls simple CORS responses for the associated domain. The configurable properties map closely to the CORS specification which should be referenced for a full discussion on their meaning: https://www.w3.org/TR/cors/ or https://developer.mozilla.org/docs/Web/HTTP/Access_control_CORS.
      - `allowed_origins` string[], required — Must contain a single element specifying the domain (origin) allowed to make requsets to this domain. If any origin is acceptable '*' may be used as a wildcard https://www.w3.org/TR/cors/#origin-request-header, https://www.w3.org/TR/cors/#access-control-allow-origin-response-header.
      - `allow_credentials` boolean — Indicates whether the response to request can be exposed when the omit credentials flag is unset https://www.w3.org/TR/cors/#access-control-allow-credentials-response-header.
      - `exposed_headers` string[] — Indicates which response headers may be accessed from the browser. https://www.w3.org/TR/cors/#http-access-control-expose-headers.
      - `max_age` integer — Sets how long (in seconds) the response to a preflight request may be cached. A value of -1 will disable caching. https://www.w3.org/TR/cors/#access-control-max-age-response-header.
      - `allowed_methods` string[], required — Indicates which HTTP request types may be used to call an endpoint. https://www.w3.org/TR/cors/#access-control-allow-methods-response-header.
      - `allowed_headers` string[] — Specifies what headers are allowed to be set when a request is made. https://www.w3.org/TR/cors/#access-control-allow-headers-response-header.
    - `aliases` string[] — A set of alternate names that this Domain may be referenced by. May start ('*.') or end ('.*') with a wildcard.
    - `force_https` boolean — If set to true, requests must use TLS. If a request is not using TLS, (as determined by the scheme or the presence of X-Forwarded-Proto header), a 301 redirect will be sent telling the client to use HTTPS.

## Other responses

- `default` — Unexpected error

---

[API](https://skmtc.net/turbinelabs/apis/turbine-labs-api.md) · [All operations](https://skmtc.net/turbinelabs/apis/turbine-labs-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/turbinelabs/turbine-labs-api/versions/47fce18aa12f/schema)