Domains

Download schema

This section lists your domains, shows you to manage them, and gives you information about them.

List domains

GET

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains

Retrieve domains in a specific Project or in a specific Organization using the region parameter.

List domains › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List domains › query Parameters

page

integer · int32

Requested page number. Value must be greater or equal to 1.

page_size

integer · uint32

Requested page size. Value must be between 1 and 1000.

project_id

string

(Optional) ID of the Project in which to list the domains. (UUID format)

status

scaleway.transactional_email.v1alpha1.Domain.Status[]

(Optional) List domains under specific statuses.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

organization_id

string

(Optional) ID of the Organization in which to list the domains. (UUID format)

name

string

(Optional) Names of the domains to list.

List domains › Responses

200

scaleway.transactional_email.v1alpha1.ListDomainsResponse

total_count

integer · uint32

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

scaleway.transactional_email.v1alpha1.Domain[]

Single page of domains matching the requested criteria.

GET/transactional-email/v1alpha1/regions/{region}/domains

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains"

Example Responses

{
  "total_count": 0,
  "domains": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "name": "name",
      "status": "unknown",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "next_check_at": "2022-03-22T12:34:56.123456Z",
      "last_valid_at": "2022-03-22T12:34:56.123456Z",
      "revoked_at": "2022-03-22T12:34:56.123456Z",
      "last_error": "last_error",
      "spf_config": "spf_config",
      "dkim_config": "dkim_config",
      "statistics": {
        "total_count": 0,
        "sent_count": 0,
        "failed_count": 0,
        "canceled_count": 0
      },
      "reputation": {
        "status": "unknown_status",
        "score": 0,
        "scored_at": "2022-03-22T12:34:56.123456Z",
        "previous_score": 0,
        "previous_scored_at": "2022-03-22T12:34:56.123456Z"
      },
      "records": {
        "dmarc": {
          "name": "name",
          "value": "value"
        },
        "dkim": {
          "name": "name",
          "value": "value"
        },
        "spf": {
          "name": "name",
          "value": "value"
        },
        "mx": {
          "name": "name",
          "value": "value"
        }
      },
      "autoconfig": true,
      "region": "region"
    }
  ]
}

json

application/json

Register a domain in a project

POST

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains

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

Register a domain in a project › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Register a domain in a project › Request Body

project_id

string

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

domain_name

string

Fully qualified domain dame.

autoconfig

boolean

Activate auto-configuration of the domain's DNS zone.

Register a domain in a project › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

POST/transactional-email/v1alpha1/regions/{region}/domains

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accept_tos": false,
    "autoconfig": false,
    "domain_name": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  }' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "domain_name": "domain_name",
  "accept_tos": true,
  "autoconfig": true
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Get information about a domain

GET

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

Retrieve information about a specific domain using the region and domain_id parameters. Monitor your domain's reputation and improve average and bad reputation statuses, using your domain's Email activity tab on the Scaleway consoleOpen in new context to get a more detailed report. Check out our dedicated documentationOpen in new context to improve your domain's reputation.

Get information about a domain › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain. (UUID format)

Get information about a domain › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

GET/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}"

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Update a domain

PATCH

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

Update a domain auto-configuration.

Update a domain › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to update. (UUID format)

Update a domain › Request Body

autoconfig

boolean

(Optional) If set to true, activate auto-configuration of the domain's DNS zone.

Update a domain › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

PATCH/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}"

Example Request Body

{
  "autoconfig": true
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Domain DNS check

POST

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/check

Perform an immediate DNS check of a domain using the region and domain_id parameters.

Domain DNS check › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to check. (UUID format)

Domain DNS check › Request Body

Domain DNS check › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

POST/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/check

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/check"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Delete a domain

POST

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/revoke

You must specify the domain you want to delete by the region and domain_id. Deleting a domain is permanent and cannot be undone.

Delete a domain › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to delete. (UUID format)

Delete a domain › Request Body

Delete a domain › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

POST/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/revoke

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/revoke"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Display SPF, DKIM, DMARC and MX records status and potential errors

GET

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/verification

Display SPF, DKIM, DMARC and MX records status and potential errors, including the found records to make debugging easier.

Display SPF, DKIM, DMARC and MX records status and potential errors › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to get records status. (UUID format)

Display SPF, DKIM, DMARC and MX records status and potential errors › Responses

200

scaleway.transactional_email.v1alpha1.DomainLastStatus

domain_id

string

The ID of the domain.

domain_name

string

The domain name (example.com).

object

The SPF record verification data.

object

The DKIM record verification data.

object

The DMARC record verification data.

object

The MX record verification data.

object

The verification state of domain auto-configuration.

GET/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/verification

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/verification"

Example Responses

{
  "domain_id": "domain_id",
  "domain_name": "domain_name",
  "spf_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "dkim_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "dmarc_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "mx_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "autoconfig_state": {
    "enabled": true,
    "autoconfigurable": true,
    "reason": "unknown_reason"
  }
}

json

application/json

Emails Statistics

Transactional Email API

Domains

Download schema

This section lists your domains, shows you to manage them, and gives you information about them.

List domains

GET

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains

Retrieve domains in a specific Project or in a specific Organization using the region parameter.

List domains › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List domains › query Parameters

page

integer · int32

Requested page number. Value must be greater or equal to 1.

page_size

integer · uint32

Requested page size. Value must be between 1 and 1000.

project_id

string

(Optional) ID of the Project in which to list the domains. (UUID format)

status

scaleway.transactional_email.v1alpha1.Domain.Status[]

(Optional) List domains under specific statuses.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

organization_id

string

(Optional) ID of the Organization in which to list the domains. (UUID format)

name

string

(Optional) Names of the domains to list.

List domains › Responses

200

scaleway.transactional_email.v1alpha1.ListDomainsResponse

total_count

integer · uint32

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

scaleway.transactional_email.v1alpha1.Domain[]

Single page of domains matching the requested criteria.

GET/transactional-email/v1alpha1/regions/{region}/domains

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains"

Example Responses

{
  "total_count": 0,
  "domains": [
    {
      "id": "id",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "name": "name",
      "status": "unknown",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "next_check_at": "2022-03-22T12:34:56.123456Z",
      "last_valid_at": "2022-03-22T12:34:56.123456Z",
      "revoked_at": "2022-03-22T12:34:56.123456Z",
      "last_error": "last_error",
      "spf_config": "spf_config",
      "dkim_config": "dkim_config",
      "statistics": {
        "total_count": 0,
        "sent_count": 0,
        "failed_count": 0,
        "canceled_count": 0
      },
      "reputation": {
        "status": "unknown_status",
        "score": 0,
        "scored_at": "2022-03-22T12:34:56.123456Z",
        "previous_score": 0,
        "previous_scored_at": "2022-03-22T12:34:56.123456Z"
      },
      "records": {
        "dmarc": {
          "name": "name",
          "value": "value"
        },
        "dkim": {
          "name": "name",
          "value": "value"
        },
        "spf": {
          "name": "name",
          "value": "value"
        },
        "mx": {
          "name": "name",
          "value": "value"
        }
      },
      "autoconfig": true,
      "region": "region"
    }
  ]
}

json

application/json

Register a domain in a project

POST

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains

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

Register a domain in a project › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Register a domain in a project › Request Body

project_id

string

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

domain_name

string

Fully qualified domain dame.

autoconfig

boolean

Activate auto-configuration of the domain's DNS zone.

Register a domain in a project › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

POST/transactional-email/v1alpha1/regions/{region}/domains

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accept_tos": false,
    "autoconfig": false,
    "domain_name": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d"
  }' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "domain_name": "domain_name",
  "accept_tos": true,
  "autoconfig": true
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Get information about a domain

GET

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

Get information about a domain › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain. (UUID format)

Get information about a domain › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

GET/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}"

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Update a domain

PATCH

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

Update a domain auto-configuration.

Update a domain › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to update. (UUID format)

Update a domain › Request Body

autoconfig

boolean

(Optional) If set to true, activate auto-configuration of the domain's DNS zone.

Update a domain › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

PATCH/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}"

Example Request Body

{
  "autoconfig": true
}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Domain DNS check

POST

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/check

Perform an immediate DNS check of a domain using the region and domain_id parameters.

Domain DNS check › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to check. (UUID format)

Domain DNS check › Request Body

Domain DNS check › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

POST/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/check

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/check"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Delete a domain

POST

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/revoke

You must specify the domain you want to delete by the region and domain_id. Deleting a domain is permanent and cannot be undone.

Delete a domain › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to delete. (UUID format)

Delete a domain › Request Body

Delete a domain › Responses

200

scaleway.transactional_email.v1alpha1.Domain

id

string

ID of the domain.

organization_id

string

ID of the domain's Organization.

project_id

string

ID of the domain's Project.

name

string

Domain name (example.com).

status

string · enum

Status of the domain.

Enum values:

unknown

checked

unchecked

invalid

locked

revoked

pending

autoconfiguring

Default: unknown

created_at

string · date-time

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

next_check_at

string · date-time

Date and time of the next scheduled check. (RFC 3339 format)

last_valid_at

string · date-time

Date and time the domain was last valid. (RFC 3339 format)

revoked_at

string · date-time

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

spf_config

string

Snippet of the SPF record to register in the DNS zone.

dkim_config

string

DKIM public key to record in the DNS zone.

object

Domain's statistics.

object

The domain's reputation is available when your domain is checked and has sent enough emails.

object

List of records to configure to validate a domain.

autoconfig

boolean

Status of auto-configuration for the domain's DNS zone.

region

string

The region you want to target

POST/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/revoke

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/revoke"

Example Request Body

{}

json

Example Responses

{
  "id": "id",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "next_check_at": "2022-03-22T12:34:56.123456Z",
  "last_valid_at": "2022-03-22T12:34:56.123456Z",
  "revoked_at": "2022-03-22T12:34:56.123456Z",
  "last_error": "last_error",
  "spf_config": "spf_config",
  "dkim_config": "dkim_config",
  "statistics": {
    "total_count": 0,
    "sent_count": 0,
    "failed_count": 0,
    "canceled_count": 0
  },
  "reputation": {
    "status": "unknown_status",
    "score": 0,
    "scored_at": "2022-03-22T12:34:56.123456Z",
    "previous_score": 0,
    "previous_scored_at": "2022-03-22T12:34:56.123456Z"
  },
  "records": {
    "dmarc": {
      "name": "name",
      "value": "value"
    },
    "dkim": {
      "name": "name",
      "value": "value"
    },
    "spf": {
      "name": "name",
      "value": "value"
    },
    "mx": {
      "name": "name",
      "value": "value"
    }
  },
  "autoconfig": true,
  "region": "region"
}

json

application/json

Display SPF, DKIM, DMARC and MX records status and potential errors

GET

https://api.scaleway.com

/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/verification

Display SPF, DKIM, DMARC and MX records status and potential errors, including the found records to make debugging easier.

Display SPF, DKIM, DMARC and MX records status and potential errors › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

domain_id

string · required

ID of the domain to get records status. (UUID format)

Display SPF, DKIM, DMARC and MX records status and potential errors › Responses

200

scaleway.transactional_email.v1alpha1.DomainLastStatus

domain_id

string

The ID of the domain.

domain_name

string

The domain name (example.com).

object

The SPF record verification data.

object

The DKIM record verification data.

object

The DMARC record verification data.

object

The MX record verification data.

object

The verification state of domain auto-configuration.

GET/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/verification

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/verification"

Example Responses

{
  "domain_id": "domain_id",
  "domain_name": "domain_name",
  "spf_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "dkim_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "dmarc_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "mx_record": {
    "status": "unknown_record_status",
    "last_valid_at": "2022-03-22T12:34:56.123456Z",
    "error": "error"
  },
  "autoconfig_state": {
    "enabled": true,
    "autoconfigurable": true,
    "reason": "unknown_reason"
  }
}

json

application/json

Emails Statistics