guide.en-au.md

title	excerpt	updated
Introduction	General presentation of the OVHcloud public API for domain names	2022-05-05

Table of Contents

• Introduction
• Order a Domain Name
• Tasks Management
• Manage Contacts of a Domain Name
• Managing Eligibility Rules
• Configure the Display of Contact Data in the Whois
• Configure the DNS of your Domain Name
• Transfer a Domain Name

We remind you that the given API routes links lead to European API. Do not forget to replace https://eu.api.ovh.com with https://ca.api.ovh.com in API URLs to use it with your identifier.

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.

• First Steps with the OVHcloud APIs

Available SDKs

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

• Node.js: https://github.com/ovh/node-ovh
• Python: https://github.com/ovh/python-ovh
• Go : https://github.com/ovh/go-ovh
• C#: https://github.com/ovh/csharp-ovh
• PHP: https://github.com/ovh/php-ovh
• Perl: https://github.com/ovh/perl-ovh
• Swift*: https://github.com/ovh/swift-ovh

* Archived since 2019

[!tabs] JavaScript

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

Python

import ovh

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

Go

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).