Harthelm Docs
REST APIDomains

List the team's custom domains

Custom domains, ordered by name. Needs `team.view`.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/teams/{team}/domains

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Path Parameters

team*integer

Numeric resource id.

Formatint64
Range1 <= value

Query Parameters

limit?integer

Maximum number of items per page.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from next_cursor of the previous page.

Lengthlength <= 1024

Response Body

A page of domains.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/teams/1/domains'
{  "next_cursor": "string",  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "team_id": 1,      "name": "string",      "url": "string",      "restricted": true,      "use_regex": true,      "max_body_bytes": 0,      "timeout_seconds": 0,      "verification": {        "status": "unchecked",        "method": "txt",        "checked_at": "2019-08-24T14:15:22Z",        "verified_at": "2019-08-24T14:15:22Z",        "reason": "string",        "txt_missing_since": "2019-08-24T14:15:22Z",        "lapses_at": "2019-08-24T14:15:22Z"      },      "tls": {        "mode": "automated",        "status": "pending",        "reason": "string",        "not_after": "2019-08-24T14:15:22Z",        "covered_by": "string"      },      "records": [        {          "type": "CNAME",          "name": "string",          "value": "string",          "purpose": "verification"        }      ],      "routes": [        {          "path": "string",          "workspace_ids": [            1          ]        }      ],      "created_by": 1,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z"    }  ]}

Get a custom domain

One custom domain with its verification, certificate status and the DNS records to set. Needs `team.view`.

Replace the domain's routes

Team admins (`team.manage`). Routes are tried in list order: a path prefix on a segment boundary, or with `use_regex` an RE2 expression matched from the start of the path. The path is passed on unchanged. Several workspaces on one route split visitors evenly, sticky for 24 h; swapping the workspaces of a route is blue/green. Every workspace must be a live workspace of the team (422 at `/routes/<i>/workspace_ids/<j>`). An empty list takes the domain off the air.