# MailSlurp\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(ctx, 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.
# Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| domainOptions | CreateDomainOptions | domainOptions |
# 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]
# DeleteDomain
DeleteDomain(ctx, id)
Delete a domain
Delete a domain. This will disable any existing inboxes that use this domain.
# Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | id |
# 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]
# GetDomain
DomainDto GetDomain(ctx, id)
Get a domain
Returns domain verification status and tokens for a given domain
# Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | id |
# 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]
# GetDomains
[]DomainPreview GetDomains(ctx, )
Get domains
List all custom domains you have created
# Required Parameters
This endpoint does not need any parameter.
# 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]
