Order

Download schema

Order a new domain or request an operation on an existing domain

Purchase domains

POST

https://api.scaleway.com

/domain/v2beta1/buy-domains

Request the registration of domain names. You can provide a domain's already existing contact or a new contact.

Purchase domains › Request Body

domains

string[] · required

duration_in_years

integer · uint32

project_id

string

owner_contact_id

string | null

administrative_contact_id

string | null

technical_contact_id

string | null

auto_renew

boolean

Enable the auto renew feature for all the requested domains. This means the domain will be automatically renewed before its expiry date.

Purchase domains › Responses

200

scaleway.domain.v2beta1.OrderResponse

domains

string[]

organization_id

string

project_id

string

task_id

string

created_at

string | null · date-time

(RFC 3339 format)

POST/domain/v2beta1/buy-domains

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "auto_renew": false,
    "domains": [
        "string"
    ],
    "duration_in_years": 42,
    "project_id": "string"
  }' \
  "https://api.scaleway.com/domain/v2beta1/buy-domains"

Example Request Body

{
  "domains": [
    "string"
  ],
  "duration_in_years": 0,
  "project_id": "project_id",
  "owner_contact_id": "owner_contact_id",
  "owner_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact_id": "administrative_contact_id",
  "administrative_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact_id": "technical_contact_id",
  "technical_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "auto_renew": true
}

json

Example Responses

{
  "domains": [
    "string"
  ],
  "organization_id": "organization_id",
  "project_id": "project_id",
  "task_id": "task_id",
  "created_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Trade a domain's contact

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/trade

Request to change a domain's contact owner.
If you specify the organization_id of the domain's new owner, the contact will change from the current owner's Scaleway account to the new owner's Scaleway account.
If the new owner's current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change.
If the new owner has never created a contact to register domains before, an error message displays.

Trade a domain's contact › path Parameters

domain

string · required

Trade a domain's contact › Request Body

project_id

google.protobuf.StringValue

new_owner_contact_id

string | null

Trade a domain's contact › Responses

200

scaleway.domain.v2beta1.OrderResponse

domains

string[]

organization_id

string

project_id

string

task_id

string

created_at

string | null · date-time

(RFC 3339 format)

POST/domain/v2beta1/domains/{domain}/trade

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/domain/v2beta1/domains/{domain}/trade"

Example Request Body

{
  "project_id": "project_id",
  "new_owner_contact_id": "new_owner_contact_id",
  "new_owner_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  }
}

json

Example Responses

{
  "domains": [
    "string"
  ],
  "organization_id": "organization_id",
  "project_id": "project_id",
  "task_id": "task_id",
  "created_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Transfer a domain

POST

https://api.scaleway.com

/domain/v2beta1/domains/transfer-domains

Request the transfer of a domain from another registrar to Scaleway Domains and DNS.

Transfer a domain › Request Body

scaleway.domain.v2beta1.TransferInDomainRequest.TransferRequest[] · required

project_id

string

owner_contact_id

string | null

administrative_contact_id

string | null

technical_contact_id

string | null

Transfer a domain › Responses

200

scaleway.domain.v2beta1.OrderResponse

domains

string[]

organization_id

string

project_id

string

task_id

string

created_at

string | null · date-time

(RFC 3339 format)

POST/domain/v2beta1/domains/transfer-domains

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domains":[""],"project_id":"string"}' \
  "https://api.scaleway.com/domain/v2beta1/domains/transfer-domains"

Example Request Body

{
  "domains": [
    {
      "domain": "domain",
      "auth_code": "auth_code"
    }
  ],
  "project_id": "project_id",
  "owner_contact_id": "owner_contact_id",
  "owner_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact_id": "administrative_contact_id",
  "administrative_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact_id": "technical_contact_id",
  "technical_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  }
}

json

Example Responses

{
  "domains": [
    "string"
  ],
  "organization_id": "organization_id",
  "project_id": "project_id",
  "task_id": "task_id",
  "created_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Register an external domain

POST

https://api.scaleway.com

/domain/v2beta1/external-domains

Request the registration of an external domain name.

Register an external domain › Request Body

domain

string

project_id

string

Register an external domain › Responses

200

scaleway.domain.v2beta1.RegisterExternalDomainResponse

domain

string

organization_id

string

validation_token

string

created_at

string | null · date-time

(RFC 3339 format)

project_id

string

Delete an external domain

DELETE

https://api.scaleway.com

/domain/v2beta1/external-domains/{domain}

Delete an external domain name.

Delete an external domain › path Parameters

domain

string · required

Delete an external domain › Responses

200

scaleway.domain.v2beta1.DeleteExternalDomainResponse

Renew domains

POST

https://api.scaleway.com

/domain/v2beta1/renew-domains

Request the renewal of one or more domain names.

Renew domains › Request Body

domains

string[] · required

duration_in_years

integer · uint32

force_late_renewal

google.protobuf.BoolValue

Renew domains › Responses

200

scaleway.domain.v2beta1.OrderResponse

domains

string[]

organization_id

string

project_id

string

task_id

string

created_at

string | null · date-time

(RFC 3339 format)

Contacts Domains