# \DomainControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| create_domain | Post /domains | Create Domain |
| delete_domain | Delete /domains/{id} | Delete a domain |
| get_domain | Get /domains/{id} | Get a domain |
| get_domains | Get /domains | Get domains |
# create_domain
crate::models::DomainDto create_domain(domain_options) Create Domain
Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| domain_options | CreateDomainOptions | domainOptions | [required] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# delete_domain
delete_domain(id) Delete a domain
Delete a domain. This will disable any existing inboxes that use this domain.
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | String | id | [required] |
# Return type
(empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_domain
crate::models::DomainDto get_domain(id) Get a domain
Returns domain verification status and tokens for a given domain
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | String | id | [required] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_domains
Veccrate::models::DomainPreview get_domains() Get domains
List all custom domains you have created
# Parameters
This endpoint does not need any parameter.
# Return type
Veccrate::models::DomainPreview
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
