Introduction

General presentation of the OVHcloud public API for domain names

Last updated 5th May 2022

Table of Contents

Connection to the API

Before reading this documentation, make sure you have read the following page. It describes the test environment setup and the OVHcloud API connection process, and also helps understanding requests signature.

Available SDKs

We have released SDKs for several languages, to help you use the API:

var client = require("ovh")({
  endpoint: "ovh-eu",
  appKey: APPLICATION_KEY,
  appSecret: APPLICATION_SECRET,
  consumerKey: APPLICATION_CONSUMER_KEY,
});
import ovh

client = ovh.Client(
    endpoint = 'ovh-eu',
    application_key = APPLICATION_KEY,
    application_secret = APPLICATION_SECRET,
    consumer_key = APPLICATION_CONSUMER_KEY,
)
package main

import (
     "fmt"
     "github.com/ovh/go-ovh/ovh"
)

func main() {
     client, err :=  ovh.NewClient(
         "ovh-eu",
         APPLICATION_KEY,
         APPLICATION_SECRET,
         APPLICATION_CONSUMER_KEY,
     )
     if err != nil {
         fmt.Printf("Error: %q\n", err)
         return
     }
}

Glossary

We are going to use the following terms throughout this documentation.

  • Registry: owner of an extension. For example, .fr belongs to Afnic, .com and .net to Verisign.
  • Registrar: domain names reseller. The registry necessarily sells domain names to final customers through a registrar. OVHcloud is a registrar.
  • Registrant: owner of a domain name. They are legally responsible of what the domain name is used for, and have all possible rights on the domain name.
  • gTLD (Generic Top Level Domain): generic extension, used world-wide, regulated by an independent third-party authority, called ICANN. Extensions .com and .net are gTLDs.
  • ccTLD (Country Code Top Level Domain): country-specific extension, regulated by the country itself. Due to that, eligibility rules, or even the selling mode or the lifecycle of domains, may totally differ from an extension to the other. It is the registrar's role to abstract this for the final customer. ccTLDs are the only extensions made from 2 letters exactly: for example, .fr for France, .io for the British Indian Ocean territory (though it is frequently used by web applications, because of the acronym I/O meaning Input/Output).

Did you find this guide useful?

Please feel free to give any suggestions in order to improve this documentation.

Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.

Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.

Thank you. Your feedback has been received.


These guides might also interest you...

OVHcloud Community

Access your community space. Ask questions, search for information, post content, and interact with other OVHcloud Community members.

Discuss with the OVHcloud community

In accordance with the 2006/112/CE Directive, modified on 01/01/2015, prices exclude VAT. VAT may vary according to the customer's country of residence.