JSON Format

Each subdomain is described by a single JSON file at subdomains/<your-subdomain>.json in the domains repository.

Full example

{
  "$schema": "https://raw.githubusercontent.com/is-pinoy-dev/domains/main/schemas/v1/subdomain.schema.json",
  "subdomain": "yourname",
  "owner": {
    "github": "your-github-username",
    "email": "you@example.com"
  },
  "records": {
    "CNAME": {
      "value": "xxxxxxxxxxxxxxxx.vercel-dns-017.com."
    }
  }
}

Field reference

$schema

"$schema": "https://raw.githubusercontent.com/is-pinoy-dev/domains/main/schemas/v1/subdomain.schema.json"

Optional but recommended. Adding this field enables JSON schema validation in editors like VS Code — you'll see inline errors as you type.

subdomain

"subdomain": "yourname"

Required. The name you want before .is-pinoy.dev. Must:

• Match the filename exactly (e.g. yourname.json → "subdomain": "yourname")
• Be lowercase alphanumeric with hyphens only
• Be between 1 and 63 characters

See Naming Rules for the full character rules.

owner.github

"owner": {
  "github": "your-github-username"
}

Required. Must exactly match the GitHub username of the account opening the pull request. CI will reject the PR if these don't match.

owner.email

"owner": {
  "github": "your-github-username",
  "email": "you@example.com"
}

Optional. Used by maintainers to contact you if there's an issue with your subdomain. Never exposed publicly.

records

"records": {
  "CNAME": {
    "value": "yoursite.vercel.app."
  }
}

Required. Must contain at least one valid record. Supported keys: CNAME, A, TXT. See Supported Records for details on each type.

Common mistakes