Method Reference

Every JSON method follows Node's callback convention—the last argument is always function(err, data). Arguments marked optional (in brackets) may be omitted entirely; the remaining arguments shift left. creds is a credentials object as described in Client & Authentication.

The streaming methods (publish, encrypt, ssl) return an EventEmitter instead and are covered in Publishing & Streams. Request and response bodies for each endpoint are in the API Endpoint Reference; this page maps methods to them.

Account & tokens

Orgs

Transfers

Projects & revisions

Domains, DNS & certificates

DNS methods only apply to apex domains you've pointed at Surge's name servers—see Custom Domains.

Collaborators

Settings & analytics

Billing & plans

Error handling

On success, callbacks receive (null, data) where data is the parsed response body. On failure, the error arrives as the first and only argument. Its shape depends on the endpoint:

// The common shape — the response body, with status attached
{ messages: ["domain must be valid."], details: { domain: "must be valid." }, status: 422 }

// Some endpoints use a single message (rate limits among them)
{ message: "Rate limited. (domain). Try again in 9 hours.", status: 429 }

// A failure with no JSON body — described from the status
{ messages: ["request failed (502)"], details: { request: "request failed (502)" }, status: 502 }

// A network failure — the request never completed (no status)
{ messages: ["request did not complete"], errors: ["request did not complete"], details: { request: "did not complete" } }

Check err.status for the HTTP code, and fall back through err.messages, err.message, and err.errors when displaying the failure—the CLI does exactly this.

This page as markdown · every page in llms-full.txt