Domains

status

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

project_id

organization_id

is_external

google.protobuf.BoolValue

domain

scaleway.domain.v2beta1.ListDomainsResponse

List domains › Responses

200

total_count

integer · uint32

scaleway.domain.v2beta1.DomainSummary[]

GET/domain/v2beta1/domains

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/domain/v2beta1/domains"

Example Responses

{
  "total_count": 0,
  "domains": [
    {
      "domain": "domain",
      "project_id": "project_id",
      "auto_renew_status": "feature_status_unknown",
      "dnssec_status": "feature_status_unknown",
      "epp_code": [
        "string"
      ],
      "expired_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "registrar": "registrar",
      "is_external": true,
      "status": "status_unknown",
      "external_domain_registration_status": {
        "validation_token": "validation_token"
      },
      "transfer_registration_status": {
        "status": "status_unknown",
        "vote_current_owner": true,
        "vote_new_owner": true
      },
      "organization_id": "organization_id",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "pending_trade": true
    }
  ]
}

json

application/json

Get domain

GET

https://api.scaleway.com

/domain/v2beta1/domains/{domain}

Retrieve a specific domain and display the domain's information.

Get domain › path Parameters

domain

string · required

Get domain › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

GET/domain/v2beta1/domains/{domain}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/domain/v2beta1/domains/{domain}"

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

Update a domain's contacts

PATCH

https://api.scaleway.com

/domain/v2beta1/domains/{domain}

Update contacts for a specific domain or create a new contact.
If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles.

Update a domain's contacts › path Parameters

domain

string · required

Update a domain's contacts › Request Body

technical_contact_id

string | null

administrative_contact_id

string | null

Update a domain's contacts › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

scaleway.domain.v2beta1.GetDomainAuthCodeResponse

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

PATCH/domain/v2beta1/domains/{domain}

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

Example Request Body

{
  "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"
      }
    ]
  },
  "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"
      }
    ]
  }
}

json

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

Get a domain's authorization code

GET

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/auth-code

Retrieve the authorization code to transfer an unlocked domain. The output returns an error if the domain is locked. Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.

Get a domain's authorization code › path Parameters

domain

string · required

Get a domain's authorization code › Responses

200

auth_code

string

Disable auto renew

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/disable-auto-renew

Disable the auto renew feature for a domain. This means the domain will not be renewed before its expiry date.

Disable auto renew › path Parameters

domain

string · required

Disable auto renew › Request Body

Disable auto renew › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

POST/domain/v2beta1/domains/{domain}/disable-auto-renew

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

Example Request Body

{}

json

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

Disable a domain's DNSSEC

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/disable-dnssec

Disable DNSSEC for a domain.

Disable a domain's DNSSEC › path Parameters

domain

string · required

Disable a domain's DNSSEC › Request Body

Disable a domain's DNSSEC › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

POST/domain/v2beta1/domains/{domain}/disable-dnssec

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

Example Request Body

{}

json

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

Enable auto renew

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/enable-auto-renew

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

Enable auto renew › path Parameters

domain

string · required

Enable auto renew › Request Body

Enable auto renew › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

scaleway.domain.v2beta1.DSRecord

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

POST/domain/v2beta1/domains/{domain}/enable-auto-renew

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

Example Request Body

{}

json

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

Update domain DNSSEC

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/enable-dnssec

If your domain uses another registrar and has the default Scaleway NS, you have to update the DS record at your registrar.

Update domain DNSSEC › path Parameters

domain

string · required

Update domain DNSSEC › Request Body

Update domain DNSSEC › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

scaleway.domain.v2beta1.ListDomainHostsResponse

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

POST/domain/v2beta1/domains/{domain}/enable-dnssec

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

Example Request Body

{
  "ds_record": {
    "key_id": 0,
    "algorithm": "rsamd5",
    "digest": {
      "type": "sha_1",
      "digest": "digest",
      "public_key": {
        "key": "key"
      }
    },
    "public_key": {
      "key": "key"
    }
  }
}

json

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

List a domain's hostnames

GET

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/hosts

List a domain's hostnames using their glue IPs.

List a domain's hostnames › path Parameters

domain

string · required

List a domain's hostnames › query Parameters

page

google.protobuf.Int32Value · int32

page_size

integer · uint32

List a domain's hostnames › Responses

200

total_count

integer · uint32

scaleway.domain.v2beta1.Host[]

Create a hostname for a domain

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/hosts

Create a hostname for a domain with glue IPs.

Create a hostname for a domain › path Parameters

domain

string · required

Create a hostname for a domain › Request Body

name

string

ips

string[]

(IP address)

Create a hostname for a domain › Responses

200

scaleway.domain.v2beta1.Host

domain

string

name

string

ips

string[]

(IP address)

status

scaleway.domain.v2beta1.Host.Status · enum

Enum values:

unknown_status

active

updating

deleting

Default: unknown_status

Delete a domain's hostname

DELETE

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/hosts/{name}

Delete a domain's hostname › path Parameters

domain

string · required

name

string · required

Delete a domain's hostname › Responses

200

scaleway.domain.v2beta1.Host

domain

string

name

string

ips

string[]

(IP address)

status

scaleway.domain.v2beta1.Host.Status · enum

Enum values:

unknown_status

active

updating

deleting

Default: unknown_status

Update a domain's hostname

PATCH

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/hosts/{name}

Update a domain's hostname with glue IPs.

Update a domain's hostname › path Parameters

domain

string · required

name

string · required

Update a domain's hostname › Request Body

ips

scaleway.std.StringsValue

Update a domain's hostname › Responses

200

scaleway.domain.v2beta1.Host

domain

string

name

string

ips

string[]

(IP address)

status

scaleway.domain.v2beta1.Host.Status · enum

Enum values:

unknown_status

active

updating

deleting

Default: unknown_status

Lock the transfer of a domain

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/lock-transfer

Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar.

Lock the transfer of a domain › path Parameters

domain

string · required

Lock the transfer of a domain › Request Body

Lock the transfer of a domain › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

POST/domain/v2beta1/domains/{domain}/lock-transfer

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

Example Request Body

{}

json

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

Unlock the transfer of a domain

POST

https://api.scaleway.com

/domain/v2beta1/domains/{domain}/unlock-transfer

Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar.

Unlock the transfer of a domain › path Parameters

domain

string · required

Unlock the transfer of a domain › Request Body

Unlock the transfer of a domain › Responses

200

domain

string

organization_id

string

project_id

string

auto_renew_status

scaleway.domain.v2beta1.Domain.FeatureStatus · enum

Status of the automatic renewal of the domain.

Enum values:

feature_status_unknown

enabling

enabled

disabling

disabled

Default: feature_status_unknown

Status of the DNSSEC configuration of the domain.

epp_code

string[]

List of the domain's EPP codes.

expired_at

string | null · date-time

Date of expiration of the domain. (RFC 3339 format)

updated_at

string | null · date-time

Domain's last modification date. (RFC 3339 format)

registrar

string

is_external

boolean

Indicates whether Scaleway is the domain's registrar.

status

Status of the domain.

Enum values:

status_unknown

active

creating

create_error

renewing

renew_error

xfering

xfer_error

Default: status_unknown

List of the domain's DNS zones.

Contact information of the domain's owner.

Contact information of the domain's technical contact.

Contact information of the domain's administrative contact.

Registration status of an external domain, if available.

Status of a domain, when available for transfer.

Domain's TLD information.

linked_products

List of Scaleway resources linked to the domain.

Enum values:

unknown_product

vpc

pending_trade

boolean

Indicates if a trade is ongoing.

POST/domain/v2beta1/domains/{domain}/unlock-transfer

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

Example Request Body

{}

json

Example Responses

{
  "domain": "domain",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "auto_renew_status": "feature_status_unknown",
  "dnssec": {
    "status": "feature_status_unknown",
    "ds_records": [
      {
        "key_id": 0,
        "algorithm": "rsamd5",
        "digest": {
          "type": "sha_1",
          "digest": "digest",
          "public_key": {
            "key": "key"
          }
        },
        "public_key": {
          "key": "key"
        }
      }
    ]
  },
  "epp_code": [
    "string"
  ],
  "expired_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "registrar": "registrar",
  "is_external": true,
  "status": "status_unknown",
  "dns_zones": [
    {
      "domain": "domain",
      "subdomain": "subdomain",
      "ns": [
        "string"
      ],
      "ns_default": [
        "string"
      ],
      "ns_master": [
        "string"
      ],
      "status": "unknown",
      "message": "message",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "project_id": "project_id",
      "linked_products": [
        "unknown_product"
      ]
    }
  ],
  "owner_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact": {
    "id": "id",
    "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,
    "email_status": "email_status_unknown",
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "status": "status_unknown",
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "external_domain_registration_status": {
    "validation_token": "validation_token"
  },
  "transfer_registration_status": {
    "status": "status_unknown",
    "vote_current_owner": true,
    "vote_new_owner": true
  },
  "tld": {
    "name": "name",
    "dnssec_support": true,
    "duration_in_years_min": 0,
    "duration_in_years_max": 0,
    "idn_support": true,
    "offers": {
      "<offerKey>": {
        "action": "action",
        "operation_path": "operation_path",
        "price": {
          "currency_code": "currency_code",
          "units": 0,
          "nanos": 0
        }
      }
    },
    "specifications": {
      "<specificationKey>": "<specificationKey>"
    }
  },
  "linked_products": [
    "unknown_product"
  ],
  "pending_trade": true
}

json

application/json

List domains that can be renewed

GET

https://api.scaleway.com

/domain/v2beta1/renewable-domains

Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable.

List domains that can be renewed › query Parameters

page

google.protobuf.Int32Value · int32

page_size

integer · uint32

order_by

scaleway.domain.v2beta1.ListRenewableDomainsRequest.OrderBy · enum

Enum values:

domain_asc

domain_desc

Default: domain_asc

project_id

organization_id