# Retrieve a website domain

**GET /domains/{domain}**

Read one website domain, including the records to publish and the last
reachability probe. Creator scope.



## Servers
- Production. There is no separate sandbox host.
: https://api.usecommune.com (Production. There is no separate sandbox host.
)


## Authentication methods
- Api key


## Parameters
### Headers

- **Commune-Version** (string(date))
  The contract version this request is written against, as a release date
  (`YYYY-MM-DD`). Omitting the header pins the request to the version that
  was current when the API key was issued, so an integration keeps working
  when a newer version ships. An unknown value answers `400` with
  `invalid_version`.


### Path parameters

- **domain** (string)
  The website domain's `id`, or the hostname itself. The hostname is
  unique across Commune, so either resolves.


### Query parameters

- **expand** (string)
  Comma separated list of relationship paths to inline in the response.
  Unexpanded relationships are returned as a reference object carrying
  only `id` and `object`. Each operation documents the paths it accepts,
  and an unknown path answers `400`. Nested paths use a dot, for example
  `article.newsletter`.

  One accepted path is not a relationship. `?expand=content` on
  `GET /articles/{article}` adds the Markdown rendition of the body
  beside the HTML one. It is the same trade the parameter always offers,
  a fuller response for a larger one, over a property that has more than
  one representation rather than over a reference.

- **fields** (string)
  Comma separated allow list of top level properties to return on each
  object, so a client can trim a response it does not need in full. `id`
  and `object` are always returned. An unknown property name answers
  `400`. Properties omitted by an operation, such as `content` on any
  article list, cannot be brought back with `fields`.

  A trimmed body is a subset of the schema this operation declares, and a
  property that schema marks required is absent when it was not asked for.
  That is the point of the parameter, so a client that validates responses
  against the schema either sends no `fields` or relaxes `required`.



## Responses
### 200
The website domain.

#### Body: application/json (object)
- **object** (string)
  Always `domain`.

- **id** (string(uuid))
  Stable identifier.

- **newsletter** (object | null)
  The newsletter the domain serves. A `Ref` unless `newsletter` is
  named in `?expand=`.

- **domain** (string)
  The hostname, unique across Commune.

- **verification_status** (string)
  Whether ownership of the domain was proved and a certificate issued.
  `active` does not by itself mean the site is reachable, see
  `routing_ok`.

- **ssl_status** (string | null)
  Where the certificate stands, as reported by the provider that
  issues it. Free text rather than an enum, because the vocabulary is
  the provider's and Commune passes it through.

- **dns_target** (string | null)
  What the creator must point the hostname at.

- **verification_records** (array[object])
  The records the creator must publish to prove ownership.

- **verification_error** (string | null)
  Why verification last failed. Null when it has not failed.

- **routing_ok** (boolean | null)
  Whether the domain actually resolves to Commune, from an end to end
  request rather than from certificate state. Null before the first
  probe. This is the field that catches a domain whose certificate is
  fine but whose DNS points somewhere else.

- **routing_checked_at** (string(date-time) | null)
  When that probe last ran.

- **verified_at** (string(date-time) | null)
  When ownership was first proved. Null if it never was.

- **last_checked_at** (string(date-time) | null)
  When Commune last reconciled the domain with its provider.

- **created_at** (string(date-time))
  When the domain was added.


### 400
The request was malformed: an unknown query parameter, an unparseable
cursor, an unknown `expand` path, or an unrecognised `Commune-Version`.


#### Body: application/json (object)
- **error** (object)


### 401
No API key was presented, or the key is unknown, revoked or expired.

All four answer identically, down to the wording. Saying that a key was
revoked rather than never issued confirms to whoever is holding the
string that it was once real, which a legitimate caller does not need
and a thief should not get.

#### Headers

- **WWW-Authenticate** (string)
  The authentication scheme this API accepts. Always
  `Bearer realm="Commune API"`; there is no second scheme and no
  query-parameter fallback, because a credential that can travel in a
  URL ends up in access logs and referer headers.


#### Body: application/json (object)
- **error** (object)


### 403
The key is valid but is not allowed to read this. Either it carries
public scope and the operation needs creator scope, or it is bound to a
different newsletter than the one addressed.


#### Body: application/json (object)
- **error** (object)


### 404
No such resource, or the key is not allowed to know that it exists.
Commune answers `404` rather than `403` where distinguishing the two
would leak the existence of private content.


#### Body: application/json (object)
- **error** (object)


### 429
Too many requests. Back off and retry after the interval named by the
`Retry-After` response header.

#### Headers

- **Retry-After** (integer)
  Seconds to wait before retrying.


#### Body: application/json (object)
- **error** (object)


### 500
Something failed inside Commune. The request may be retried.

#### Body: application/json (object)
- **error** (object)



[Powered by Bump.sh](https://bump.sh)