# DomainControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| createDomain | POST /domains | Create Domain |
| deleteDomain | DELETE /domains/{id} | Delete a domain |
| getDomain | GET /domains/{id} | Get a domain |
| getDomains | GET /domains | Get domains |
# createDomain
DomainDto createDomain(domainOptions)
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 | Notes |
|---|---|---|---|
| domainOptions | CreateDomainOptions | domainOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# deleteDomain
deleteDomain(id)
Delete a domain
Delete a domain. This will disable any existing inboxes that use this domain.
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | id | [default to null] |
# Return type
null (empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
# getDomain
DomainDto getDomain(id)
Get a domain
Returns domain verification status and tokens for a given domain
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | id | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getDomains
List getDomains()
Get domains
List all custom domains you have created
# Parameters
This endpoint does not need any parameter.
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
