Mailbox API
https://api.sandbox.gandi.net/v5/mailbox
Listing domains and get information about them ¶
https://api.sandbox.gandi.net/v5/mailbox/domains
get Lists all your domains ¶
Request
Query String
Optional
- page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page.
- page ⁠integer
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- Total-Count ⁠integerTotal number of items.
Optional
- Link ⁠stringLinks to next and last page.
- Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- fqdn ⁠string
Example:[ { "fqdn": "domain.com" } ]
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Domain detail ¶
https://api.sandbox.gandi.net/v5/mailbox/domains/{domain}
get Get domain detail ¶
Request
URI Parameters
- domain ⁠stringThe domain
- domain ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- antispam ⁠boolean
- configuration ⁠array
Of items of type:
- object
With the following properties:
- key ⁠string
- values ⁠array[ string ]
- object
- date_last_validation ⁠datetime
- dkim ⁠boolean
- internal ⁠boolean
- is_livedns ⁠boolean
- mx ⁠boolean
- spf ⁠boolean
- txt ⁠boolean
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
/v5/mailbox/domains/{domain}/validate ¶
https://api.sandbox.gandi.net/v5/mailbox/domains/{domain}/validate
post Validate configuration ¶
Request
URI Parameters
- domain ⁠stringThe domain
- domain ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- dkim ⁠booleanState of dkim records after validation
- internal ⁠booleanState internal state of domain
- mx ⁠booleanState of mx records after validation
- spf ⁠booleanState of spf records after validation
- txt ⁠booleanState of txt (ownership) after validation
- dkim ⁠boolean
Manage your forwarding addresses ¶
https://api.sandbox.gandi.net/v5/mailbox/forwards
post Create a forwarding address ¶
Request
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- destinations ⁠array[ string ]A list of email addresses.
- source ⁠stringThe source email address.
Example:{ "source": "alice@gandi.net", "destinations": [ "alice.doe@example.org", "ruth@example.org" ] }
- destinations ⁠array[ string ]
Responses
201
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
404
- The domain of the source email has not been validated.
- The source email is not linked to a domain.
- There is no mailbox with the source email's domain.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
409
- The mail forwarding has already been created.
- The soure email is the address of a Gandi mailbox.
- The user try to create a mail forwarding loop.
- The one thousand limit of mail forwardings per domain has been reached.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
422
- The user wants to create an alias.
- The user wants to create a mail forwarding to the source email.
- The data sent is not in accordance with the parameters requirement.
423
- The limit number of forwards per domain and per week has been reached.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
get List forwarding addresses ¶
Request
Query String
Optional
- page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page. - search ⁠stringFilter the list by source or destination.Example:
lice@mydomain
Example:alice
Example:domain.com
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sort_by ⁠string
One of: "source", "-source"
Default: "source"
Result sorting field.
- page ⁠integer
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- X-Total-Count ⁠integerTotal number of items after filtering.
- X-Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- destinations ⁠stringemail addresses to forward emails to.
- source ⁠stringThe source email address.
- destinations ⁠string
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Forwarding address details ¶
https://api.sandbox.gandi.net/v5/mailbox/forwards/{source}
put Update a forwarding address ¶
Request
URI Parameters
- source ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- destinations ⁠array[ string ]A list of email addresses.
Example:{ "destinations": [ "alice@example.org", "hello.world@gandi.net" ] }
- destinations ⁠array[ string ]
Responses
201
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
404
- The domain of the source email has not been validated.
- The source email is not linked to a domain.
- There is no mailbox with the source email's domain.
- No mail forward from the source email has been created.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
409
- The user try to create a mail forwarding loop.
- The one thousand limit of mail forwardings per domain has been reached.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
422
- The user wants to create an alias.
- The user wants to create a mail forwarding to the source email.
- The data sent is not in accordance with the parameters requirement.
423
- The limit number of forwards per domain and per week has been reached.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
delete Delete a forwarding address ¶
Request
URI Parameters
- source ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
404
- The domain of the source email has not been validated.
- The source email is not linked to a domain.
- There is no mailbox with the source email's domain.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
422
- The data sent is not in accordance with the parameters requirement.
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Manage your mailboxes ¶
https://api.sandbox.gandi.net/v5/mailbox/mailboxes
get List mailboxes ¶
Request
Query String
Optional
- address ⁠stringFilter by exact loginExample:
alice
- domain_part ⁠stringFilter by exact fqdnExample:
mydomain.com
- local_part ⁠stringFilter by exact loginExample:
alice
- page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page. - search ⁠stringSearch by login, complete email or domain name.Example:
lice@mydomain
Example:alice
Example:domain.com
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sort_by ⁠string
One of: "id", "-id", "local_part", "-local_part", "config_name", "-config_name", "expire_at", "-expire_at", "quota", "-quota", "autorenew", "-autorenew"
Default: "id"
Result sorting field.
- address ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- X-Total-Count ⁠integerTotal number of items after filtering.
- X-Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- address ⁠stringComplete address of mailbox
- antispam ⁠booleanAntispam is enabled
- config ⁠objectMailbox configuration
With the following properties:
- label ⁠stringLabel of configuration
- name ⁠stringTechnical name of configuration
- quota_kb ⁠integerQuota in Kb
- uuid ⁠stringConfiguration ID
- label ⁠string
- created_at ⁠datetimeCreation date
- data_access ⁠booleanInformation about access
- domain_part ⁠stringDomain name
- expires_at ⁠datetimeExpiry date
- internal_domain ⁠booleanInformation about internal domain
- last_paid_duration ⁠integerDuration of last subscription
- local_part ⁠stringMailbox login
- quota ⁠integerQuota allowed
- quota_used ⁠integerQuota used
- updated_at ⁠datetimeUpdated date
- uuid ⁠stringMailbox ID
Optional
- autorenew ⁠objectObject with info about autorenew, can be null
With the following properties:
- duration ⁠integer
One of: 1, 12
Duration for renew - duration_type ⁠string
One of: "m", "y"
Month or Year for renewal duration - sharing_id ⁠stringOrganization will be billed
- duration ⁠integer
- issues ⁠array[ string ]Array with potentials issues
- responder ⁠objectInformation about responder's state
With the following properties:
- end_date ⁠datetimeResponder end date
- message ⁠stringResponder message
- start_date ⁠datetimeResponder start date
- end_date ⁠datetime
- address ⁠string
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
post Create new mailbox ¶
config_name
could be standard (10GB) or premium (50 GB).Request
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- config_name ⁠stringSpecify the config of the product (standard/premium).
- email ⁠string
- password ⁠string
Minimum length: 8
Maximum length: 200
Password of the mailbox.
Optional
- aliases ⁠array
Of items of type:
- stringA local-part (what comes before the "@") of an email address. It can contain a wildcard "*" before or after at least two characters to redirect everything thats matches the local-part pattern.
- string
- config_name ⁠string
Responses
202
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Mailbox detail ¶
https://api.sandbox.gandi.net/v5/mailbox/mailboxes/{email}
get Get mailbox detail ¶
Request
URI Parameters
- email ⁠stringThe email address
- email ⁠string
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- address ⁠stringComplete address of mailbox
- antispam ⁠booleanAntispam is enabled
- config ⁠objectMailbox configuration
With the following properties:
- label ⁠stringLabel of configuration
- name ⁠stringTechnical name of configuration
- quota_kb ⁠integerQuota in Kb
- uuid ⁠stringConfiguration ID
- label ⁠string
- created_at ⁠datetimeCreation date
- data_access ⁠booleanInformation about access
- domain_part ⁠stringDomain name
- expires_at ⁠datetimeExpiry date
- internal_domain ⁠booleanInformation about internal domain
- last_paid_duration ⁠integerDuration of last subscription
- local_part ⁠stringMailbox login
- quota ⁠integerQuota allowed
- quota_used ⁠integerQuota used
- updated_at ⁠datetimeUpdated date
- uuid ⁠stringMailbox ID
Optional
- aliases ⁠array[ string ]secondary emails of a mailbox
- autorenew ⁠objectObject with info about autorenew, can be null
With the following properties:
- duration ⁠integer
One of: 1, 12
Duration for renew - duration_type ⁠string
One of: "m", "y"
Month or Year for renewal duration - sharing_id ⁠stringOrganization will be billed
- duration ⁠integer
- issues ⁠arrayArray with potentials issues
- responder ⁠objectInformation about responder's state
With the following properties:
- end_date ⁠datetimeResponder end date
- message ⁠stringResponder message
- start_date ⁠datetimeResponder start date
- end_date ⁠datetime
- address ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
patch Update mailbox ¶
Thanks to this method you are able to update your mailbox:
- You can change the offer of your mailbox updating your config
config_name
could be standard (10GB) or premium (50 GB). - Update your
password
. - Activate or deactivate
autorenew
. - Add/remove
aliases
. - Enable or disable
autoresponder
. - Enable or disable
antispam
.
Request
URI Parameters
- email ⁠stringThe email address
- email ⁠string
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Optional
- aliases ⁠array
Of items of type:
- stringA local-part (what comes before the "@") of an email address. It can contain a wildcard "*" before or after at least two characters to redirect everything thats matches the local-part pattern.
- string
- antispam ⁠boolean
Default: true
Enable antispam - autorenew ⁠object
With the following properties:
Required
- activated ⁠booleanSpecify true to enable autorenew, false to disable it.
- duration ⁠integer
One of: 1, 12
Duration for autorenew in month(s).
- activated ⁠boolean
- config_name ⁠string
One of: "standard", "premium"
Specify the config of the product (standard/premium). - password ⁠string
Minimum length: 8
Maximum length: 200
Mailbox password.
Must contain between 8 and 200 characters, containing at least 1 upper-case letter, 3 numbers, and a special character.
You can also send a hashed password in SHA512-CRYPT ie: $6$xxxx$yyyy
- responder ⁠object
With the following properties:
Required
- activated ⁠boolean
Default: false
true if the responder is activated
Optional
- message ⁠stringresponder message
- activated ⁠boolean
- aliases ⁠array
Responses
204
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
delete Delete mailbox ¶
Request
URI Parameters
- email ⁠stringThe email address
- email ⁠string
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
204
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Renew mailbox ¶
https://api.sandbox.gandi.net/v5/mailbox/mailboxes/{email}/renew
post Renew a mailbox ¶
Request
URI Parameters
- email ⁠stringThe email address
- email ⁠string
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
Optional
- Dry-Run ⁠integerIf this header's value is
1
the request's parameters will only be checked; the operation will not actually be performed.
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- duration ⁠integerThe duration (in month) of the renewal.
Example - Renewal for 1 month:{ "duration": 1 }
Example - Renewal for 12 months:{ "duration": 12 }
- duration ⁠integer
Responses
200
Dry-Run: 1
header.Headers
Optional
- Warning ⁠stringWarning message
- Warning ⁠string
Body
application/json
⁠objectWith the following properties:
- status ⁠string
One of: "success", "error"
Response status.
Optional
- errors ⁠arrayA list of all the errors encountered during validation.
Of items of type:
- object
With the following properties:
- description ⁠stringError message.
- location ⁠string
One of: "header", "path", "querystring", "body"
The field's location in the HTTP response. - name ⁠stringThe xpath of the field.
- description ⁠string
- object
- status ⁠string
202
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Buy mailbox ¶
https://api.sandbox.gandi.net/v5/mailbox/products
post Buy new mailbox ¶
Request
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- config_name ⁠string
One of: "standard", "premium"
Specify the name of the product (standard/premium). - duration_month ⁠integer
One of: 1, 12
The duration of the subscription 1 or 12 month(s). - quantity ⁠integerThe quantity of slots to purchase.
Optional
- autorenew ⁠boolean
Default: false
true
to enable the autorenewal.
- config_name ⁠string
Responses
202
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Get mailboxes quotas. ¶
https://api.sandbox.gandi.net/v5/mailbox/quotas
get Get mailboxes available and mailboxes already used. ¶
Request
Query String
Optional
- sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- annually ⁠objectQuota for mailboxes paid in annually subscription.
With the following properties:
- available ⁠integerThe count of mailboxes available to create mailbox.
- total ⁠integerThe total represents mailboxes available to create mailbox and mailbox already used.
- used ⁠integerThe count of mailboxes already used.
- available ⁠integer
- config_name ⁠stringConfiguration name of the mailbox.
- label ⁠stringLabel of the offer.
- monthly ⁠objectQuota for mailboxes paid in monthly subscription.
With the following properties:
- available ⁠integerThe count of mailboxes available to create mailbox.
- total ⁠integerThe total represents mailboxes available to create mailbox and mailbox already used.
- used ⁠integerThe count of mailboxes already used.
- available ⁠integer
- quota ⁠stringQuota of the mailbox expressed in giga byte (GB).
- annually ⁠object
Example:[ { "annually": { "available": 0, "total": 1, "used": 1 }, "config_name": "standard", "label": "Standard 10Gb", "monthly": { "available": 1, "total": 1, "used": 0 }, "quota": "10Gb" }, { "annually": { "available": 1, "total": 3, "used": 2 }, "config_name": "premium", "label": "Premium 50Gb", "monthly": { "available": 0, "total": 0, "used": 0 }, "quota": "50Gb" } ]
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Listing slots ¶
https://api.sandbox.gandi.net/v5/mailbox/slots
get Lists all your slots ¶
Request
Query String
Optional
- config_name ⁠stringFilter the list by configuration name
- expires_at_gte ⁠datetimeSlot expiration date.
- expires_at_lte ⁠datetimeSlot expiration date.
- last_paid_duration ⁠integer
One of: 1, 12
Filters the list by last paid duration - page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page. - refundable ⁠string
One of: "true", "false"
Filter the list by slots that are refundable - sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sort_by ⁠string
One of: "refund_expires_at", "-refund_expires_at"
Default: "refund_expires_at"
Used to specify how you want the results sorted.
- config_name ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- Total-Count ⁠integerTotal number of items.
Optional
- Link ⁠stringLinks to next and last page.
- Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- config ⁠objectInformation on the configuration applied to this slot
With the following properties:
- label ⁠stringCommercial label of configuration
- name ⁠stringInternal name of configuration
- uuid ⁠stringConfig id
- label ⁠string
- refund_info ⁠objectInformation about the refundable process, may be false if there no refundable possibility
With the following properties:
- currency ⁠stringRefund currency
- price ⁠numberRefund amout
- refund_expires_at ⁠datetimeThis is the date on which refund is possible
- currency ⁠string
- refundable ⁠booleanIf this slot can be refundable
- uuid ⁠stringSlot id
Optional
- autorenew ⁠objectStatus of autorenew on the slot, may be false if there is no active autorenew
With the following properties:
- duration_month ⁠integer
One of: 1, 12
Duration in months to be used for autorenewal - sharing_id ⁠stringSharing who paid for this autorenewal process
- duration_month ⁠integer
- expires_at ⁠datetimeWhen the slot expires
- last_paid_duration ⁠integer
One of: 1, 12
Duration of last paid renewal
- config ⁠object
Example:[ { "uuid": "5156f881-cf33-11ee-aa2a-c889f3cdfda1", "autorenew": { "duration_month": 12, "sharing_id": "5156f881-cf33-11ee-aa2a-c000f3cdfda8" }, "config": { "label": "Premium 50 Go", "name": "premium-50go", "uuid": "5156f876-cf33-11ee-aa4a-c889f3cdfda7" }, "expires_at": "2024-03-20T14:29:41Z", "last_paid_duration": 1, "refund_info": { "currency": "EUR", "price": 61.8, "refund_expires_at": "2025-03-04T14:29:41Z" }, "refundable": true } ]
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Slot detail ¶
https://api.sandbox.gandi.net/v5/mailbox/slots/{slot_id}
get Get slot detail ¶
Request
URI Parameters
- slot_id ⁠stringIdentifier of the slot, an uuid.
- slot_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- config ⁠objectInformation on the configuration applied to this slot
With the following properties:
- label ⁠stringCommercial label of configuration
- name ⁠stringInternal name of configuration
- uuid ⁠stringConfig id
- label ⁠string
- refund_info ⁠objectInformation about the refundable process, may be false if there no refundable possibility
With the following properties:
- currency ⁠stringRefund currency
- price ⁠numberRefund amout
- refund_expires_at ⁠datetimeThis is the date on which refund is possible
- currency ⁠string
- refundable ⁠booleanIf this slot can be refundable
- uuid ⁠stringSlot id
Optional
- autorenew ⁠objectStatus of autorenew on the slot, may be false if there is no active autorenew
With the following properties:
- duration_month ⁠integer
One of: 1, 12
Duration in months to be used for autorenewal - sharing_id ⁠stringSharing who paid for this autorenewal process
- duration_month ⁠integer
- expires_at ⁠datetimeWhen the slot expires
- last_paid_duration ⁠integer
One of: 1, 12
Duration of last paid renewal
- config ⁠object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Http Authorization Scheme
This authentication scheme allows you to pass your Personal Access Token and be granted access to permissions and resources scoped by this token.
Tokens are created in the Organization Tab of the Gandi Admin application, choose the organization the token will have access too. Then go to the sharing tab, and click on "Create a token" button.
The authentication scheme Apikey allows also you to pass your Gandi API Key, but has been deprecated.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withBearer
for access token, orApikey
depending of the authentication scheme.Apikey
is deprecated and be replaced by personal access token.Example:Bearer pat_abc-123
Example:Apikey your-api-key
- Authorization ⁠string