NewHost Docs

Postman collection

The collection has all 39 endpoints of this reference, in one folder per section, with example request bodies and example responses. It is a Postman Collection v2.1 file and is updated whenever the reference changes.

Use the Postman collection

Download Postman collection

  1. Download the collection with the button above. It has every endpoint in this reference, in one folder per section.
  2. In Postman, click Import and choose the downloaded file.
  3. Open the collection, go to its Variables tab and paste your secret key (sk_live_…) into the Current value of apiKey. Every request sends it as Authorization: Bearer, so you set it once.
  4. Open Account → Retrieve the account and click Send. A 200 response with your account details means you're ready to try the rest.

Variables

VariableWhat it is
baseUrlNewHost API base URL. Request paths start with /v1 (or /ai/v1 for the AI gateway).
apiKeyYour secret key (sk_live_...). Never commit or share it.
appIdThe app ID. Copy it from a list request.
previewIdThe preview ID. Copy it from a list request.
deploymentIdThe deployment ID. Copy it from a list request.
domainIdThe domain ID. Copy it from a list request.
recordIdRecord ID from List DNS records. Copy it from a list request.
subscriptionIdThe subscription ID. Copy it from a list request.
aliasIdAlias ID from List website aliases. Copy it from a list request.
invoiceIdThe invoice ID. Copy it from a list request.
webhookIdThe webhook ID. Copy it from a list request.

To call one resource, run its list request first (for example Applications → List applications), copy an ID into the matching variable (appId), and the requests that need it are ready to send. The same goes for domainId, invoiceId and the others.

Keep your key in Postman's Current value column. That value stays on your machine and is not synced or exported with the collection.