Appwrite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Appwrite Domains API
55 actions
55 updates
phrasing
extends
openapi/appwrite-domains-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Appwrite's API. It is a proposal applied on top of the contract, not a document Appwrite publishes.
What the actions change
x-apievangelist-phrasing
Targets 55 · first 16 shown; the file carries all of them
$.info
$.paths['/domains'].get
$.paths['/domains'].post
$.paths['/domains/price'].get
$.paths['/domains/prices'].get
$.paths['/domains/purchases'].post
$.paths['/domains/purchases/{invoiceId}'].patch
$.paths['/domains/suggestions'].get
$.paths['/domains/transfers/in'].post
$.paths['/domains/transfers/in/{invoiceId}'].patch
$.paths['/domains/transfers/out'].post
$.paths['/domains/{domainId}'].get
$.paths['/domains/{domainId}'].delete
$.paths['/domains/{domainId}/auto-renewal'].patch
$.paths['/domains/{domainId}/nameservers'].patch
$.paths['/domains/{domainId}/nameservers/verification'].patch
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Appwrite Domains API
version: 1.0.0
extends: openapi/appwrite-domains-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 54
- target: $.paths['/domains'].get
update:
x-apievangelist-phrasing:
intent: List the project's domains
effect: read
questions:
- Which domains are registered in my Appwrite project?
- Can I search my domain list by name?
instructions:
- text: List all domains registered in this project.
- text: Search my registered domains for {search}.
slots:
search: query.search
method: generated
generated: '2026-09-26'
- target: $.paths['/domains'].post
update:
x-apievangelist-phrasing:
intent: Add a domain to a team
effect: write
questions:
- How do I add a domain I already own so I can manage its DNS here?
- What do I need to configure at my DNS provider before adding a domain?
instructions:
- text: Add domain {domain} to team {teamId}.
slots:
domain: requestBody.domain
teamId: requestBody.teamId
- text: Register {domain} as a managed domain under team {teamId} so I can edit its DNS.
slots:
domain: requestBody.domain
teamId: requestBody.teamId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/price'].get
update:
x-apievangelist-phrasing:
intent: Get the registration price for one domain
effect: read
questions:
- How much does it cost to register a single domain name?
- What is the price to register a domain for several years?
instructions:
- text: Get the registration price for {domain}.
slots:
domain: query.domain
- text: Quote the price to register {domain} for {periodYears} years.
slots:
domain: query.domain
periodYears: query.periodYears
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/prices'].get
update:
x-apievangelist-phrasing:
intent: Check availability and prices for several domains
effect: read
questions:
- Are these domain names available, and what would each cost?
- Can I check availability for a batch of domain names at once?
instructions:
- text: Check availability and prices for the domains {domains}.
slots:
domains: query.domains
- text: Tell me which of {domains} are still available to register.
slots:
domains: query.domains
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/purchases'].post
update:
x-apievangelist-phrasing:
intent: Start buying a domain
effect: write
questions:
- How do I buy a new domain name and pay for it with a saved card?
- What registrant details are required to purchase a domain?
- Can I turn on auto-renewal when I first buy a domain?
instructions:
- text: Buy {domain} for organization {organizationId} using payment method {paymentMethodId}.
slots:
domain: requestBody.domain
organizationId: requestBody.organizationId
paymentMethodId: requestBody.paymentMethodId
- text: Start a {periodYears}-year purchase of {domain} registered to {firstName} {lastName}, {email}.
slots:
periodYears: requestBody.periodYears
domain: requestBody.domain
firstName: requestBody.firstName
lastName: requestBody.lastName
email: requestBody.email
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/purchases/{invoiceId}'].patch
update:
x-apievangelist-phrasing:
intent: Confirm and finalize a domain purchase
effect: write
questions:
- How do I finish a domain purchase after completing 3D Secure?
- What happens when I confirm a pending domain purchase?
instructions:
- text: Confirm the domain purchase on invoice {invoiceId} for organization {organizationId}.
slots:
invoiceId: path.invoiceId
organizationId: requestBody.organizationId
- text: Finalize my pending domain order {invoiceId} now that 3D Secure is done, organization {organizationId}.
slots:
invoiceId: path.invoiceId
organizationId: requestBody.organizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/suggestions'].get
update:
x-apievangelist-phrasing:
intent: Suggest available domain names
effect: read
questions:
- Can you suggest domain names based on a keyword?
- Which domain name ideas are available under a certain price?
instructions:
- text: Suggest domain names for {query}.
slots:
query: query.query
- text: Suggest up to {limit} domains for {query} using the TLDs {tlds}.
slots:
limit: query.limit
query: query.query
tlds: query.tlds
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/transfers/in'].post
update:
x-apievangelist-phrasing:
intent: Start transferring a domain in
effect: write
questions:
- How do I move a domain from another registrar into Appwrite?
- Where does the authorization code go when transferring a domain in?
instructions:
- text: Transfer {domain} in for organization {organizationId} with auth code {authCode} and payment method {paymentMethodId}.
slots:
domain: requestBody.domain
organizationId: requestBody.organizationId
authCode: requestBody.authCode
paymentMethodId: requestBody.paymentMethodId
- text: Start an incoming transfer of {domain} using EPP code {authCode}, billed to organization {organizationId} via {paymentMethodId}.
slots:
domain: requestBody.domain
authCode: requestBody.authCode
organizationId: requestBody.organizationId
paymentMethodId: requestBody.paymentMethodId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/transfers/in/{invoiceId}'].patch
update:
x-apievangelist-phrasing:
intent: Confirm a pending domain transfer in
effect: write
questions:
- How do I finalize an incoming domain transfer after 3D Secure authentication?
- What submits my incoming transfer to the registry?
instructions:
- text: Confirm the incoming domain transfer on invoice {invoiceId} for organization {organizationId}.
slots:
invoiceId: path.invoiceId
organizationId: requestBody.organizationId
- text: Submit transfer-in invoice {invoiceId} to the registry after 3D Secure, organization {organizationId}.
slots:
invoiceId: path.invoiceId
organizationId: requestBody.organizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/transfers/out'].post
update:
x-apievangelist-phrasing:
intent: Get an auth code to transfer a domain out
effect: write
questions:
- How do I move my domain away to a different registrar?
- Where do I get the authorization code the gaining registrar asks for?
instructions:
- text: Generate a transfer-out auth code for domain {domainId} in organization {organizationId}.
slots:
domainId: requestBody.domainId
organizationId: requestBody.organizationId
- text: Prepare domain {domainId} to leave for another registrar, organization {organizationId}.
slots:
domainId: requestBody.domainId
organizationId: requestBody.organizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}'].get
update:
x-apievangelist-phrasing:
intent: Get a domain's details
effect: read
questions:
- What are the details of one specific domain in my project?
- Can I look up a domain by its ID?
instructions:
- text: Show the details of domain {domainId}.
slots:
domainId: path.domainId
- text: Fetch domain {domainId} and tell me its current status.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a domain from the project
effect: destructive
questions:
- How do I remove a domain from my project entirely?
- What happens to a domain once it is deleted?
instructions:
- text: Delete domain {domainId} from the project.
slots:
domainId: path.domainId
- text: Remove domain {domainId} so it is no longer available in this project.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/auto-renewal'].patch
update:
x-apievangelist-phrasing:
intent: Turn domain auto-renewal on or off
effect: write
questions:
- How do I stop my domain from renewing automatically?
- Can I enable auto-renewal on a domain I already own?
instructions:
- text: Set auto-renewal to {autoRenewal} for domain {domainId}.
slots:
autoRenewal: requestBody.autoRenewal
domainId: path.domainId
- text: Turn off automatic renewal for domain {domainId}.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/nameservers'].patch
update:
x-apievangelist-phrasing:
intent: Change a domain's registrar nameservers
effect: write
questions:
- How do I point my domain at custom nameservers at the registrar?
- Can I switch a domain back to Appwrite nameservers?
instructions:
- text: Set the registrar nameservers of domain {domainId} to {nameservers}.
slots:
domainId: path.domainId
nameservers: requestBody.nameservers
- text: Reset domain {domainId} to use Appwrite nameservers.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/nameservers/verification'].patch
update:
x-apievangelist-phrasing:
intent: Verify which nameservers a domain uses
effect: write
questions:
- How do I check whether my domain's NS records now point to Appwrite?
- Why is my domain status not updated after changing nameservers?
instructions:
- text: Verify the nameservers of domain {domainId} and refresh its status.
slots:
domainId: path.domainId
- text: Re-check whether domain {domainId} now uses Appwrite's NS records.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/google-workspace'].get
update:
x-apievangelist-phrasing:
intent: Preview Google Workspace DNS records
effect: read
questions:
- Which DNS records does Google Workspace email need on my domain?
- Can I preview the Google Workspace MX records before adding them?
instructions:
- text: Show the Google Workspace DNS records for domain {domainId}.
slots:
domainId: path.domainId
- text: Preview the Google Workspace mail records for {domainId} without applying them.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/google-workspace'].post
update:
x-apievangelist-phrasing:
intent: Add Google Workspace email records
effect: write
questions:
- How do I set up my domain's MX records for Google Workspace in one step?
- Can Appwrite add the Google Workspace mail records for me?
instructions:
- text: Add the Google Workspace MX records to domain {domainId}.
slots:
domainId: path.domainId
- text: Set up Google Workspace email hosting on domain {domainId}.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/icloud'].get
update:
x-apievangelist-phrasing:
intent: Preview iCloud Mail DNS records
effect: read
questions:
- What DNS records does iCloud custom email need?
- Can I see the iCloud mail records before applying them?
instructions:
- text: Show the iCloud DNS records for domain {domainId}.
slots:
domainId: path.domainId
- text: Preview the iCloud mail records for {domainId} without applying them.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/icloud'].post
update:
x-apievangelist-phrasing:
intent: Add iCloud Mail records
effect: write
questions:
- How do I add the MX and SPF records for iCloud Mail to my domain?
- Can I apply the iCloud email preset automatically?
instructions:
- text: Add the iCloud MX and SPF records to domain {domainId}.
slots:
domainId: path.domainId
- text: Set up iCloud custom email on domain {domainId}.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/mailgun'].get
update:
x-apievangelist-phrasing:
intent: Preview Mailgun DNS records
effect: read
questions:
- Which DNS records does Mailgun need on my sending domain?
- Can I review the Mailgun preset records first?
instructions:
- text: Show the Mailgun DNS records for domain {domainId}.
slots:
domainId: path.domainId
- text: Preview the Mailgun records for {domainId} without applying them.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/mailgun'].post
update:
x-apievangelist-phrasing:
intent: Add Mailgun DNS records
effect: write
questions:
- How do I configure my domain's DNS for Mailgun in one call?
- Can Appwrite create the records Mailgun requires?
instructions:
- text: Add the Mailgun DNS records to domain {domainId}.
slots:
domainId: path.domainId
- text: Configure domain {domainId} for sending through Mailgun.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/outlook'].get
update:
x-apievangelist-phrasing:
intent: Preview Outlook email DNS records
effect: read
questions:
- What MX records does Outlook email hosting need?
- Can I list the Outlook preset records for my domain?
instructions:
- text: Show the Outlook DNS records for domain {domainId}.
slots:
domainId: path.domainId
- text: Preview the Outlook mail records for {domainId} without applying them.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/outlook'].post
update:
x-apievangelist-phrasing:
intent: Add Outlook email records
effect: write
questions:
- How do I set up Outlook email hosting on my custom domain?
- Can the Outlook MX records be added automatically?
instructions:
- text: Add the Outlook MX records to domain {domainId}.
slots:
domainId: path.domainId
- text: Set up Outlook email hosting on domain {domainId}.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/proton-mail'].get
update:
x-apievangelist-phrasing:
intent: Preview Proton Mail DNS records
effect: read
questions:
- Which records does ProtonMail need on a custom domain?
- Can I see the ProtonMail preset before applying it?
instructions:
- text: Show the ProtonMail DNS records for domain {domainId}.
slots:
domainId: path.domainId
- text: Preview the ProtonMail records for {domainId} without applying them.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/proton-mail'].post
update:
x-apievangelist-phrasing:
intent: Add Proton Mail records
effect: write
questions:
- How do I connect my domain to ProtonMail email?
- Can Appwrite add the ProtonMail MX records for me?
instructions:
- text: Add the ProtonMail MX records to domain {domainId}.
slots:
domainId: path.domainId
- text: Set up ProtonMail on custom domain {domainId}.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/zoho'].get
update:
x-apievangelist-phrasing:
intent: Preview Zoho Mail DNS records
effect: read
questions:
- What DNS records does Zoho Mail require?
- Can I list the Zoho preset records for a domain?
instructions:
- text: Show the Zoho Mail DNS records for domain {domainId}.
slots:
domainId: path.domainId
- text: Preview the Zoho Mail records for {domainId} without applying them.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/presets/zoho'].post
update:
x-apievangelist-phrasing:
intent: Add Zoho Mail records
effect: write
questions:
- Will Appwrite configure my domain for Zoho Mail?
- Can the Zoho Mail MX records be created in one step?
instructions:
- text: Add the Zoho Mail MX records to domain {domainId}.
slots:
domainId: path.domainId
- text: Set up Zoho Mail on domain {domainId}.
slots:
domainId: path.domainId
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records'].get
update:
x-apievangelist-phrasing:
intent: List a domain's DNS records
effect: read
questions:
- What DNS records currently exist on my domain?
- Can I filter the DNS records on a domain with queries?
instructions:
- text: List all DNS records on domain {domainId}.
slots:
domainId: path.domainId
- text: List DNS records on domain {domainId} matching {queries}.
slots:
domainId: path.domainId
queries: query.queries
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/a'].post
update:
x-apievangelist-phrasing:
intent: Add an A record pointing to an IPv4 address
effect: write
questions:
- I need a subdomain to resolve to an IPv4 address; which record do I add?
- Can I add a new A record with a custom TTL?
instructions:
- text: Add an A record {name} pointing to {value} with TTL {ttl} on domain {domainId}.
slots:
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
domainId: path.domainId
- text: Point {name} on domain {domainId} at IPv4 {value} with TTL {ttl}, noting {comment}.
slots:
name: requestBody.name
domainId: path.domainId
value: requestBody.value
ttl: requestBody.ttl
comment: requestBody.comment
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/a/{recordId}'].put
update:
x-apievangelist-phrasing:
intent: Change an existing A record
effect: write
questions:
- How do I change the IPv4 address an existing A record points to?
- Can I edit the TTL of an A record I already created?
instructions:
- text: Update A record {recordId} on domain {domainId} to {name} -> {value}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
- text: Change the IPv4 on A record {recordId} of domain {domainId} to {value}, keeping name {name} and TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
value: requestBody.value
name: requestBody.name
ttl: requestBody.ttl
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/aaaa'].post
update:
x-apievangelist-phrasing:
intent: Add an AAAA record for IPv6
effect: write
questions:
- My server has an IPv6 address; can my domain point to it?
- Can I create a new AAAA record on a subdomain?
instructions:
- text: Add an AAAA record {name} pointing to IPv6 {value} with TTL {ttl} on domain {domainId}.
slots:
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
domainId: path.domainId
- text: Point {name} on domain {domainId} at IPv6 address {value}, TTL {ttl}, comment {comment}.
slots:
name: requestBody.name
domainId: path.domainId
value: requestBody.value
ttl: requestBody.ttl
comment: requestBody.comment
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/aaaa/{recordId}'].put
update:
x-apievangelist-phrasing:
intent: Change an existing AAAA record
effect: write
questions:
- How do I change the IPv6 address on an existing AAAA record?
- Can I rename the subdomain on an AAAA record I already have?
instructions:
- text: Update AAAA record {recordId} on domain {domainId} to {name} -> {value}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
- text: Change the IPv6 on AAAA record {recordId} of domain {domainId} to {value}, name {name}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
value: requestBody.value
name: requestBody.name
ttl: requestBody.ttl
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/alias'].post
update:
x-apievangelist-phrasing:
intent: Add an ALIAS record to another hostname
effect: write
questions:
- Is there a way to alias my apex domain to another hostname?
- Can I create a new ALIAS record instead of a CNAME at the root?
instructions:
- text: Add an ALIAS record {name} targeting {value} with TTL {ttl} on domain {domainId}.
slots:
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
domainId: path.domainId
- text: Alias {name} on domain {domainId} to hostname {value}, TTL {ttl}, comment {comment}.
slots:
name: requestBody.name
domainId: path.domainId
value: requestBody.value
ttl: requestBody.ttl
comment: requestBody.comment
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/alias/{recordId}'].put
update:
x-apievangelist-phrasing:
intent: Change an existing ALIAS record
effect: write
questions:
- How do I change the target of an existing ALIAS record?
- Can I update the TTL on an ALIAS record I already created?
instructions:
- text: Update ALIAS record {recordId} on domain {domainId} to {name} -> {value}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
- text: Retarget ALIAS record {recordId} on domain {domainId} to hostname {value}, name {name}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
value: requestBody.value
name: requestBody.name
ttl: requestBody.ttl
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/caa'].post
update:
x-apievangelist-phrasing:
intent: Add a CAA record to limit certificate issuers
effect: write
questions:
- How do I restrict which certificate authorities can issue SSL certificates for my domain?
- Can I add a new CAA record for a certificate authority?
instructions:
- text: Add a CAA record {name} with value {value} and TTL {ttl} on domain {domainId}.
slots:
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
domainId: path.domainId
- text: Allow only the certificate authority in {value} to issue certificates for {name} on domain {domainId}, TTL {ttl}.
slots:
value: requestBody.value
name: requestBody.name
domainId: path.domainId
ttl: requestBody.ttl
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/caa/{recordId}'].put
update:
x-apievangelist-phrasing:
intent: Change an existing CAA record
effect: write
questions:
- How do I change which certificate authority an existing CAA record allows?
- Can I edit a CAA record's TTL after creating it?
instructions:
- text: Update CAA record {recordId} on domain {domainId} to {name} with value {value}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
- text: Change the allowed certificate authority on CAA record {recordId} of domain {domainId} to {value}, name {name}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
value: requestBody.value
name: requestBody.name
ttl: requestBody.ttl
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/cname'].post
update:
x-apievangelist-phrasing:
intent: Add a CNAME record for a subdomain
effect: write
questions:
- What record maps a subdomain like www to another domain name?
- Can I create a new CNAME for www on my domain?
instructions:
- text: Add a CNAME record {name} pointing to {value} with TTL {ttl} on domain {domainId}.
slots:
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
domainId: path.domainId
- text: Make subdomain {name} of domain {domainId} an alias of {value} via CNAME, TTL {ttl}, comment {comment}.
slots:
name: requestBody.name
domainId: path.domainId
value: requestBody.value
ttl: requestBody.ttl
comment: requestBody.comment
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/cname/{recordId}'].put
update:
x-apievangelist-phrasing:
intent: Change an existing CNAME record
effect: write
questions:
- How do I repoint an existing CNAME to a different hostname?
- Can I change the TTL on a CNAME I already set up?
instructions:
- text: Update CNAME record {recordId} on domain {domainId} to {name} -> {value}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
- text: Repoint CNAME record {recordId} on domain {domainId} to {value}, name {name}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
value: requestBody.value
name: requestBody.name
ttl: requestBody.ttl
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/https'].post
update:
x-apievangelist-phrasing:
intent: Add an HTTPS DNS record
effect: write
questions:
- How do I publish an HTTPS (SVCB-style) DNS record for my domain?
- Can I add a new HTTPS record to a subdomain?
instructions:
- text: Add an HTTPS record {name} with value {value} and TTL {ttl} on domain {domainId}.
slots:
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
domainId: path.domainId
- text: Publish HTTPS service parameters {value} for {name} on domain {domainId}, TTL {ttl}, comment {comment}.
slots:
value: requestBody.value
name: requestBody.name
domainId: path.domainId
ttl: requestBody.ttl
comment: requestBody.comment
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/https/{recordId}'].put
update:
x-apievangelist-phrasing:
intent: Change an existing HTTPS DNS record
effect: write
questions:
- How do I modify the value of an existing HTTPS record on my domain?
- Can I update the TTL of an HTTPS DNS record I already have?
instructions:
- text: Update HTTPS record {recordId} on domain {domainId} to {name} with value {value}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
name: requestBody.name
value: requestBody.value
ttl: requestBody.ttl
- text: Replace the service parameters on HTTPS record {recordId} of domain {domainId} with {value}, name {name}, TTL {ttl}.
slots:
recordId: path.recordId
domainId: path.domainId
value: requestBody.value
name: requestBody.name
ttl: requestBody.ttl
method: generated
generated: '2026-09-26'
- target: $.paths['/domains/{domainId}/records/mx'].post
update:
x-apievangelist-phrasing:
intent: Add an MX mail server record
effect: write
questions:
- Which record tells the world where to deliver email for my domain?
- Can I create a new MX record by hand instead of using an email preset?
instructions:
- text: Add an MX record {name} to mail server {value} with priority {priority} and TTL {ttl} on domain {domainId}.
slots:
name: requestBody.name
value: requestBody.value
priority: requestBody.priority
ttl: requestBody.ttl
domainId: path.domainId
- text: Route mail for {name} on domain {domainId} to {value} at priority {priority}, TTL {ttl}, comment {comment}.
slots:
name: requestBody.name
domainId: path.domainId
value: requestBody.value
priority: requestBody.priority
ttl: requestBody.ttl
comment: requestBody.comment
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/overlays/appwrite-domains-api-phrasing-overlay.yaml