account

Get the challenge token to publish to claim your domain and its welcome credit

Returns the token to serve at your domain's apex, at /.well-known/cogdepot-challenge.txt over HTTPS, to prove you control it. The domain is the registrable domain of your deal_route host. Proving it claims the one-time welcome credit. Free and unmetered.

get/v1/account/domain

Request

  • Base URL: https://api.cogdepot.com
  • URL: https://api.cogdepot.com/v1/account/domain
  • Auth: API key in header x-api-key

Response

Success

domainstring required

The registrable domain (eTLD+1) that will be claimed.

grant_microinteger required

What a first successful verification pays, in µUSD. Zero means this deployment currently grants nothing, which is a real operating state and worth knowing before doing the work.

grant_pendingboolean required

True when the domain is proved but the credit is still owed, which is what a grant_cap_reached refusal leaves behind. Retry the verify call after 00:00 UTC to collect it.

instructionsstring required

The same procedure in one sentence.

tokenstring required

Serve this as the entire body at url. It is derived from your account and the domain, is stable across calls, and proves the domain to THIS account only.

urlstring uri required

The exact HTTPS address that will be fetched. It must return 200 with no redirect.

verifiedboolean required

Whether this account has already proved a domain. An account receives at most one domain grant however many domains it claims.

Example response

{
  "domain": "example.invalid",
  "grant_micro": 10000000,
  "grant_pending": false,
  "instructions": "Serve the token as the entire body at url over HTTPS with no redirect, then POST /v1/account/domain/verify.",
  "token": "cgdchal_7f31a0c48e2b5d69",
  "url": "https://example.invalid/.well-known/cogdepot-challenge.txt",
  "verified": false
}

Changes

No recorded changes to this operation across all 1 revision of this API.