Scaleway logo
Mailbox API
Mailbox API

Aliases

Download schema

This section shows how to manage email aliases rules for mailboxes.

List aliases for a mailbox.

GET
https://api.scaleway.com
/mailbox/v1alpha1/aliases

List aliases for a mailbox. › query Parameters

project_id
​string · required

Project ID to filter on. (UUID format)

Order aliases by specific criteria.

Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
name_desc
name_asc
Default: created_at_desc
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 100.

mailbox_id
​string

ID of the mailbox for which to list aliases. (UUID format)

(Optional) Filter aliases by their status.

Enum values:
unknown_status
provisioning
deleting
ready
Default: unknown_status

List aliases for a mailbox. › Responses

200
scaleway.mailbox.v1alpha1.ListAliasesResponse
total_count
​integer · uint64

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

Single page of aliases matching the requested criteria.

Create an alias for a mailbox.

POST
https://api.scaleway.com
/mailbox/v1alpha1/aliases

Create an alias for a mailbox. › Request Body

local_part
​string

Local part of the email address (e.g. local_part@domain.com).

mailbox_id
​string

ID of the mailbox to associate with the alias. (UUID format)

description
​string | null

(Optional) Description of the alias.

Create an alias for a mailbox. › Responses

200
scaleway.mailbox.v1alpha1.Alias
id
​string

Unique identifier of the alias. (UUID format)

email
​string

Email address of the alias as local_part@domain.

mailbox_id
​string

ID of the mailbox to which the alias belongs. (UUID format)

description
​string

Description of the alias.

Current status of the alias.

Enum values:
unknown_status
provisioning
deleting
ready
Default: unknown_status
created_at
​string | null · date-time

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

updated_at
​string | null · date-time

Date and time when the alias was last updated. (RFC 3339 format)

Get an alias by its ID.

GET
https://api.scaleway.com
/mailbox/v1alpha1/aliases/{alias_id}

Get an alias by its ID. › path Parameters

alias_id
​string · required

ID of the alias to get. (UUID format)

Get an alias by its ID. › Responses

200
scaleway.mailbox.v1alpha1.Alias
id
​string

Unique identifier of the alias. (UUID format)

email
​string

Email address of the alias as local_part@domain.

mailbox_id
​string

ID of the mailbox to which the alias belongs. (UUID format)

description
​string

Description of the alias.

Current status of the alias.

Enum values:
unknown_status
provisioning
deleting
ready
Default: unknown_status
created_at
​string | null · date-time

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

updated_at
​string | null · date-time

Date and time when the alias was last updated. (RFC 3339 format)

Delete an alias by its ID.

DELETE
https://api.scaleway.com
/mailbox/v1alpha1/aliases/{alias_id}

Delete an alias by its ID. › path Parameters

alias_id
​string · required

ID of the alias to delete. (UUID format)

Delete an alias by its ID. › Responses

200
scaleway.mailbox.v1alpha1.Alias
id
​string

Unique identifier of the alias. (UUID format)

email
​string

Email address of the alias as local_part@domain.

mailbox_id
​string

ID of the mailbox to which the alias belongs. (UUID format)

description
​string

Description of the alias.

Current status of the alias.

Enum values:
unknown_status
provisioning
deleting
ready
Default: unknown_status
created_at
​string | null · date-time

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

updated_at
​string | null · date-time

Date and time when the alias was last updated. (RFC 3339 format)

Update an alias by its ID.

PATCH
https://api.scaleway.com
/mailbox/v1alpha1/aliases/{alias_id}

Update an alias by its ID. › path Parameters

alias_id
​string · required

ID of the alias to update. (UUID format)

Update an alias by its ID. › Request Body

description
​string | null

(Optional) Description of the alias.

Update an alias by its ID. › Responses

200
scaleway.mailbox.v1alpha1.Alias
id
​string

Unique identifier of the alias. (UUID format)

email
​string

Email address of the alias as local_part@domain.

mailbox_id
​string

ID of the mailbox to which the alias belongs. (UUID format)

description
​string

Description of the alias.

Current status of the alias.

Enum values:
unknown_status
provisioning
deleting
ready
Default: unknown_status
created_at
​string | null · date-time

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

updated_at
​string | null · date-time

Date and time when the alias was last updated. (RFC 3339 format)

MailboxesForwardings