Skip to main content
POST
/
domains
/
connect
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.domains.connect({
    domain: "filthy-linseed.net",
  });

  console.log(result);
}

run();
{
  "object": "<string>",
  "id": "<string>",
  "domain": "<string>",
  "dns_status": "<string>",
  "verified": true,
  "managed": true,
  "verified_at": "<string>",
  "ai_site_id": "<string>",
  "cname_target": "<string>",
  "dns_records": {},
  "created_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
​
domain
string
required

The domain to connect (e.g. shop.example.com).

​
ai_site
string

Prefix id of the site to attach the domain to. Defaults to the account's site.

​
setup_email
boolean

Also configure outbound email on this domain.

Response

Domain connected (pending verification)

​
object
string
required
​
id
string
required
​
domain
string
required
​
status
enum<string> | null
required
Available options:
pending,
ssl_pending,
active,
error,
null
​
dns_status
string | null
required
​
verified
boolean
required
​
managed
boolean
required
​
verified_at
string | null
required
​
ai_site_id
string | null
required
​
cname_target
string
required
​
dns_records
object
required
​
created_at
string
required