Sites

Download schema

Endpoints for finding sites (virtual hosts) and their certificates across the team's servers.

Search sites

GET

https://server.chief.app/api/v1

/vhosts

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Find sites across the servers the authenticated team can see, including servers shared with it: which servers host a domain, or which certificates expire soon. Every result includes its server.

Search sites › query Parameters

domain

string | null · maxLength: 255

Only return sites serving this domain, by name or alias. A host also matches wildcard aliases covering it, and *.example.com matches every subdomain.

per_page

integer · min: 1 · max: 100

page

integer · min: 1

cert_expiring_days

integer | null · min: 0 · max: 3650

Only return sites whose certificate expires within this many days, including certificates that already expired, sorted by expiry with the soonest first.

Search sites › Responses

Paginated set of ServerVhost

object[] · required

object · required

GET/vhosts

curl https://server.chief.app/api/v1/vhosts \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "server": {
        "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
        "name": "web-01"
      },
      "source": "apache",
      "name": "shop.example.com",
      "aliases": [
        "www.shop.example.com",
        "*.shop.example.com"
      ],
      "ports": [
        80,
        443
      ],
      "ssl": true,
      "document_root": "/var/www/shop/public",
      "php_version": "8.2",
      "php_handler": "fpm",
      "php": {
        "version": "8.2",
        "resolved_version": "8.2.35",
        "package": "php8.2-fpm",
        "package_version": "8.2.35-1~deb12u1",
        "is_eol": true
      },
      "certificate": {
        "subject": "shop.example.com",
        "issuer": "R11",
        "not_after": "not_after",
        "names": [
          "string"
        ],
        "fingerprint": "3f6c1a9e0b7d4c2a8e5f1b3d7a9c0e2f4b6d8a1c3e5f7b9d0a2c4e6f8b1d3a5c",
        "expired": true,
        "days_left": 42
      },
      "config_file": "/etc/apache2/sites-enabled/shop.conf",
      "owner": "acme",
      "http2": true,
      "http3": true,
      "https_redirect": true,
      "redirect": {
        "status": 301,
        "target": "https://new.example.com$request_uri",
        "host": "new.example.com"
      },
      "url": "https://server.chief.app/team/acme/sites/01j8q8zk2f4m6n7p9r1s3t5v7x/shop.example.com"
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "url",
        "label": "label",
        "active": true
      }
    ],
    "path": "path",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}

json

application/json

Packages Certificates