Skip to main content
PUT
Update domain

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

uuid
string<uuid>
required

Domain identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

dnsRecords
DNS records · object[]

Full desired DNS record set for the domain's zone. Omitted leaves the live zone alone; an empty array empties it.

redirectUrl
string<uri>

URL visitors to this domain are forwarded to. Only domains whose zone Cargo holds can set this.

dmarcEmail
string<email>

rua mailbox published on the domain's DMARC record.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
dmarcPolicy
enum<string>

p= tag published on the domain's DMARC record.

Available options:
none,
quarantine,
reject

Response

Update domain

domain
Domain · object
required

Domain after the update.