Domains

Download schema

This section shows how to list, create and delete mailbox domains.

List domains in an organization.

GET

https://api.scaleway.com

/mailbox/v1alpha1/domains

The return list can be filtered with request parameters.

List domains in an organization. › query Parameters

order_by

scaleway.mailbox.v1alpha1.ListDomainsRequest.OrderBy · enum

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

name_desc

name_asc

mailbox_total_count_desc

mailbox_total_count_asc

Default: created_at_desc

page

integer · int32

page_size

integer · uint32

project_id

string

(UUID format)

statuses

scaleway.mailbox.v1alpha1.Domain.Status[]

Enum values:

unknown_status

creating

waiting_validation

validating

validation_failed

provisioning

ready

deleting

search

string

List domains in an organization. › Responses

200

scaleway.mailbox.v1alpha1.ListDomainsResponse

total_count

integer · uint64

Number of domains that match the request (without pagination).

scaleway.mailbox.v1alpha1.Domain[]

Single page of domains matching the requested criteria.

Register a domain in a project.

POST

https://api.scaleway.com

/mailbox/v1alpha1/domains

You must specify a project_id and a domain_name to register a domain in a specific Project.

Register a domain in a project. › Request Body

project_id

string

ID of the project to which the domain belongs. (UUID format)

name

string

Fully qualified domain name.

Register a domain in a project. › Responses

200

scaleway.mailbox.v1alpha1.Domain

id

string

Unique identifier of the domain. (UUID format)

project_id

string

ID of the Project to which the domain belongs. (UUID format)

organization_id

string

ID of the Organization to which the domain belongs. (UUID format)

name

string

Fully qualified domain name.

status

scaleway.mailbox.v1alpha1.Domain.Status · enum

Status of the domain.

Enum values:

unknown_status

creating

waiting_validation

validating

validation_failed

provisioning

ready

deleting

Default: unknown_status

mailbox_total_count

integer · uint64

Number of mailboxes of the domain.

created_at

string | null · date-time

Date and time of domain creation. (RFC 3339 format)

updated_at

string | null · date-time

Date and time of the domain's last update. (RFC 3339 format)

webmail_url

string

URL of the domain's webmail.

imap_url

string

URL of the domain's IMAP service.

pop3_url

string

URL of the domain's POP3 service.

smtp_url

string

URL of the domain's SMTP service.

POST/mailbox/v1alpha1/domains

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","project_id":"6170692e-7363-616c-6577-61792e636f6d"}' \
  "https://api.scaleway.com/mailbox/v1alpha1/domains"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "status": "unknown_status",
  "mailbox_total_count": 0,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "webmail_url": "webmail_url",
  "imap_url": "imap_url",
  "pop3_url": "pop3_url",
  "smtp_url": "smtp_url"
}

json

application/json

Get a domain by its ID.

GET

https://api.scaleway.com

/mailbox/v1alpha1/domains/{domain_id}

Get a domain by its ID. › path Parameters

domain_id

string · required

ID of the domain to get. (UUID format)

Get a domain by its ID. › Responses

200

scaleway.mailbox.v1alpha1.Domain

id

string

Unique identifier of the domain. (UUID format)

project_id

string

ID of the Project to which the domain belongs. (UUID format)

organization_id

string

ID of the Organization to which the domain belongs. (UUID format)

name

string

Fully qualified domain name.

status

scaleway.mailbox.v1alpha1.Domain.Status · enum

Status of the domain.

Enum values:

unknown_status

creating

waiting_validation

validating

validation_failed

provisioning

ready

deleting

Default: unknown_status

mailbox_total_count

integer · uint64

Number of mailboxes of the domain.

created_at

string | null · date-time

Date and time of domain creation. (RFC 3339 format)

updated_at

string | null · date-time

Date and time of the domain's last update. (RFC 3339 format)

webmail_url

string

URL of the domain's webmail.

imap_url

string

URL of the domain's IMAP service.

pop3_url

string

URL of the domain's POP3 service.

smtp_url

string

URL of the domain's SMTP service.

Delete a domain by its ID.

DELETE

https://api.scaleway.com

/mailbox/v1alpha1/domains/{domain_id}

Delete a domain by its ID. › path Parameters

domain_id

string · required

ID of the domain to delete. (UUID format)

Delete a domain by its ID. › Responses

200

scaleway.mailbox.v1alpha1.Domain

id

string

Unique identifier of the domain. (UUID format)

project_id

string

ID of the Project to which the domain belongs. (UUID format)

organization_id

string

ID of the Organization to which the domain belongs. (UUID format)

name

string

Fully qualified domain name.

status

scaleway.mailbox.v1alpha1.Domain.Status · enum

Status of the domain.

Enum values:

unknown_status

creating

waiting_validation

validating

validation_failed

provisioning

ready

deleting

Default: unknown_status

mailbox_total_count

integer · uint64

Number of mailboxes of the domain.

created_at

string | null · date-time

Date and time of domain creation. (RFC 3339 format)

updated_at

string | null · date-time

Date and time of the domain's last update. (RFC 3339 format)

webmail_url

string

URL of the domain's webmail.

imap_url

string

URL of the domain's IMAP service.

pop3_url

string

URL of the domain's POP3 service.

smtp_url

string

URL of the domain's SMTP service.

Get domain records by its ID.

GET

https://api.scaleway.com

/mailbox/v1alpha1/domains/{domain_id}/records

Get domain records by its ID. › path Parameters

domain_id

string · required

(Optional) ID of the domain in which to get the records. (UUID format)

Get domain records by its ID. › Responses

200

scaleway.mailbox.v1alpha1.GetDomainRecordsResponse

scaleway.mailbox.v1alpha1.DomainRecord

Record designed to automatically configure an email client with the appropriate mail server settings using a standardized XML file format.

scaleway.mailbox.v1alpha1.DomainRecord

Record designed to automate the discovery of server settings to configure email clients like Outlook.

scaleway.mailbox.v1alpha1.DomainRecord

Record that allows clients to interact with calendar data stored on a server.

scaleway.mailbox.v1alpha1.DomainRecord

Record that allows clients to interact with contact data stored on a server.

scaleway.mailbox.v1alpha1.DomainRecord

Record that allows the DKIM email authentication method to be employed to verify the authenticity of an email message.

scaleway.mailbox.v1alpha1.DomainRecord

Record that provides a mechanism for email receivers to determine if incoming messages are legitimate and were sent from authorized sources.

scaleway.mailbox.v1alpha1.DomainRecord

Record that provides a unique token to validate a domain ownership.

scaleway.mailbox.v1alpha1.DomainRecord

Record that allows accessing the mailbox with the IMAP protocol.

scaleway.mailbox.v1alpha1.DomainRecord

Record that directs emails to a mail server.

scaleway.mailbox.v1alpha1.DomainRecord

Record that allows accessing the mailbox with the POP3 protocol.

scaleway.mailbox.v1alpha1.DomainRecord

Record that lists all the servers authorized to send emails from a particular domain.

scaleway.mailbox.v1alpha1.DomainRecord

Record that allows the use of the SMTP submission mechanism.

GET/mailbox/v1alpha1/domains/{domain_id}/records

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/mailbox/v1alpha1/domains/{domain_id}/records"

Example Responses

{
  "autoconfig": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "autodiscover": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "caldav": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "carddav": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "dkim": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "dmarc": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "domain_validation": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "imap": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "mx": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "pop3": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "spf": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  },
  "submission": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
    "status": "unknown_status",
    "level": "unknown_level",
    "dns_type": "unknown_dns_type",
    "dns_name": "dns_name",
    "dns_value": "dns_value",
    "error": "error",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  }
}

json

application/json

Validate domain records by its ID.

POST

https://api.scaleway.com

/mailbox/v1alpha1/domains/{domain_id}/validate-records

Validate domain records by its ID. › path Parameters

domain_id

string · required

ID of the domain with which to validate the records. (UUID format)

Validate domain records by its ID. › Request Body

Validate domain records by its ID. › Responses

No data returned

Mailboxes