Mailbox API (BETA version)
https://api.sandbox.gandi.net/v5/mailbox
Introduction ¶
Only for existing mailbox migrated on the new mailbox offer AND for any domains not registered with Gandi.
This section of our documentation will assist you in the management of Gandi email mailboxes through our API. This product is the new mailbox product also knows at mailbox standalone.
Thanks to this API you can use mailbox for domain name registered at Gandi and also domain name registered to another registrar (external domain). This is the main new feature of this product.
A mailbox is:
- attached to what we refer to as a "slot". Consequently, it is necessary to have at least one slot available before you can create a new mailbox.
- available as one of two different types: Standard (with 10GB of storage), or Premium (with 50GB of storage)
Warning! The mailbox API does not support the ApiKey authentication, you need to create a new token (personal access token) through the Organization Admin application.
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 ¶
You will get the TXT record to add to your zonerecords dns linked to your domain.
This record will validate that you are the owner of the domain.
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
- dkim ⁠boolean
- internal ⁠boolean
- is_livedns ⁠boolean
- mx ⁠boolean
- spf ⁠boolean
- txt ⁠boolean
Optional
- date_last_validation ⁠datetime
Example - Domain details and configuration for DNS records.:{ "dkim": false, "mx": false, "spf": false, "txt": false, "internal": false, "antispam": false, "is_livedns": false, "configuration": [ { "key": "TXT", "values": [ "mailsa 10800 IN TXT \"03c77e4fabebde501d83d55cd937671a6a3760d9aa4b2e0fe47f754dc4fa213f\"" ] }, { "key": "DKIM", "values": [ "gm1._domainkey 1200 IN CNAME gm1.gandimail.net.", "gm2._domainkey 1200 IN CNAME gm2.gandimail.net.", "gm3._domainkey 1200 IN CNAME gm3.gandimail.net." ] } ] }
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
Validate configuration ¶
https://api.sandbox.gandi.net/v5/mailbox/domains/{domain}/validate
post Validate configuration ¶
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
Body
application/json
⁠objectWith the following properties:
Required
- records_to_validate ⁠array[ string ]List of elements to validate
Example - Validate DNS records.:{ "records_to_validate": [ "dkim", "spf", "txt" ] }
- records_to_validate ⁠array[ 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
Manage your forwarding addresses ¶
https://api.sandbox.gandi.net/v5/mailbox/forwards
Forwarding addresses make it possible to redirect mail from one or more of your domain's email addresses to an external address. Learn more on the documentation.
post Create a forwarding address ¶
This route creates a new forwarding address to one or several destinations forward route.
Warning! You must create at least one mailbox on the domain source to create forward.
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 ¶
This route replaces a forwarding address' destinations forward route.
Warning! You must have at least one mailbox on the domain source to update forward.
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 ¶
Name of the mailbox, config_name date, expiration date, update date, domain_part, local part.
State of the mailbox options : antispam, quota allowed/used, internal_domain. mailbox route.
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:
- ends_at ⁠datetimeResponder end date
- message ⁠stringResponder message
- starts_at ⁠datetimeResponder start date
- ends_at ⁠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 ¶
You can create a mailbox with config config_name
could be standard (10GB) or premium (50 GB).
You can set the config_name , email and password.
And add alias if it is not already on the DNS zone record domain.
Add records to your domain zone.
We make a DNS check to ensure the domain is correctly owned by you.
These records are mandatory to validate your mailbox product :mailsa 10800 IN TXT "{value}"
The MX records:
@ 10800 IN MX 50 fb.mail.gandi.net. @ 10800 IN MX 10 spool.mail.gandi.net.
The records below are strongly suggest to have functional mailbox and to send/received mails, add SPF and DKIM records to prove your mails are legitimate and diminish the possibilty for your mails to be marked as spam:
@ 10800 IN TXT "v=spf1 include:_mailcust.gandi.net ?all" gm1._domainkey 10800 IN CNAME gm1.gandimail.net. gm2._domainkey 10800 IN CNAME gm2.gandimail.net. gm3._domainkey 10800 IN CNAME gm3.gandimail.net.
You can retrieve this records using domain details API.
In case of domain registered at gandi and when you use livedns nameservers, when you have the correct right to write on livedns zone, this records are automatically added.
For external domain, you must change the zone of your domain from your registrar web admin or API, when it provides it.
Validate your DNS records.
Several times, we check your domain zone in order to validate your mailbox.
But you can also manually launch a check using this API. This call is asynchronous.
To check the response the validated or not validated records use domain details API:{ "dkim": true, "mx": true, "spf": true, "txt": true, "internal": false }
For the records dkim, mx, spf, txt:
- false => record is not valid yet.
- true => record is valid.
For the flag internal:
- internal=true => domain registered at Gandi.
- internal=false => domain registered at another registrar.
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
- duration_month ⁠integer
One of: 1, 12
The duration of the subscription 1 or 12 month(s).
Example - Create a mailbox standard for mensual subscription:{ "duration_month": 1, "config_name": "standard", "email": "hello@domain.com", "password": "fds678fdsDdsç!è" }
Example - Create a mailbox premium for annual subscription:{ "duration_month": 12, "config_name": "premium", "email": "premium@domain.com", "password": "4f56&dsqf4s" }
Example - Create a mailbox with aliases.:{ "duration_month": 12, "config_name": "premium", "email": "hi@domain.com", "password": "4f56&dsqf4s", "aliases": [ "contact", "redir" ] }
- 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 ¶
This method allows you to access mailbox details
You will be able to get all details of the mailbox:
Name of the mailbox, creation date, expiration date, update date, domain_part, local part,
State of the mailbox options : antispam , quota allowed/used etc.
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:
- ends_at ⁠datetimeResponder end date
- message ⁠stringResponder message
- starts_at ⁠datetimeResponder start date
- ends_at ⁠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 ¶
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 or disable 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"
You can change the offer of your mailbox updating your config_name it can be standard (10GB) or premium (50 GB). - password ⁠string
Minimum length: 8
Maximum length: 200
Update your password : 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
default false / true is the responder is activated
Optional
- end_date ⁠datetimeresponder end date
- message ⁠stringresponder message
- start_date ⁠datetimeresponder start date
- activated ⁠boolean
Example - Update mailbox password:{ "password": "xXXXxx4f56&dsqf4sXXxx" }
Example - Change offer to premium:{ "config_name": "premium" }
Example - Change offer to standard:{ "config_name": "standard" }
Example - Enable automatic responder:{ "responder": { "activated": true, "start_date": "2025-04-20T09:00:00Z", "end_date": "2025-05-07T19:00:00Z", "message": "Out of office" } }
Example - Disable automatic responder:{ "responder": { "activated": false } }
Example - Update aliases:{ "aliases": [ "hello", "contact" ] }
- 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 and list all available products ¶
https://api.sandbox.gandi.net/v5/mailbox/products
post Buy new mailbox ¶
If you have used the slots that you purchased but require more mailboxes on that domain,
you must purchase additional slots using this route before being able to create new mailboxes.
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.
Example - buy 2 standard mailboxes with mensual subscription:{ "config_name": "standard", "duration_month": 1, "quantity": 2 }
Example - buy premium mailbox with annual subscription and activate autorenew:{ "config_name": "premium", "duration_month": 12, "quantity": 1, "autorenew": true }
- 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 Lists all buyable product ¶
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
Headers
- Total-Count ⁠integerTotal number of items.
- Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- config ⁠arrayList config apply to this product
Of items of type:
- object
With the following properties:
- label ⁠string
- name ⁠string
- uuid ⁠stringUUID
- object
- config_name ⁠string
- description ⁠string
- label ⁠string
- prices ⁠arrayList of prices
Of items of type:
- object
With the following properties:
- currency ⁠string
- duration_unit ⁠string
- max_duration ⁠integer
- min_duration ⁠integer
- normal_price_after_taxes ⁠number
- normal_price_before_taxes ⁠number
- price_after_taxes ⁠number
- price_before_taxes ⁠number
- object
- taxes ⁠arrayList of taxes
Of items of type:
- object
With the following properties:
- name ⁠stringTax name
- name_label ⁠stringTax name label
- rate ⁠numberRate value
- type ⁠string
- name ⁠string
- object
- uuid ⁠stringProduct id
- config ⁠array
- 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
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 ¶
It means that you can know all the available slots for all the organizations you depend on You will be able to obtain, among other things, the following details of slots by using this.
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. - webhosting_pack ⁠booleanFilter the list by slot linked to a webhosting pack
- 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
- webhosting_pack ⁠booleanIf this slot is linked to a webhosting pack
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, "webhosting_pack": false } ]
- 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
- webhosting_pack ⁠booleanIf this slot is linked to a webhosting pack
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