OVH API - Tout sur l'API du manager OVH

• domain
• subdomain
• target

Modifie un sous-domaine

• nic

Renvoit le nom et le prénom du propriétaire d’un nichandle

Ce site a été créé pour centraliser les informations relatives à l’API du manager OVH.

L’idée est d’avoir une liste complète des fonctions de l’API, et de regrouper exemples, projets, etc… Une des idées fortes est de promouvoir les commentaires sur chaque fonctions. Si vous avez découvert quelque chose à propos d’une fonction, etc… ajoutez un commentaire, partagez l’information avec tout le monde.

Vous pouvez trouver ici toutes les fonctions disponibles à la date d’aujourd’hui, même celles qui ne sont pas décrites dans la nouvelle documentation officielle. Au jour d’aujourd’hui, la documentation officielle, bien que tres bien faite, n’est pas complete, et ce site reste encore plus exhaustif.

Pour ceux qui veulent participer à la rédaction du site, pas de problèmes, envoyez moi un email. Nous recherchons des tutoriaux expliquant ce qu’est l’API, et comment commencer une simple implementation.

• nic

Renvoie les infos concernant le nic.

• domain
• ml
• email

Ajoute un modérateur à une mailing list.

• host
• domain
• comment

Efface un host. Renvoie l’id de la tâche en attente d’éxecution.

• host
• domain
• ip[ ]
[ip1, ip2, …]
• comment

Change les IPs associées à un host. Renvoie l’id de la tâche en attente d’éxecution.

• host
• domain
• ip
• comment

Crée un host. Renvoie l’id de la tâche en attente d’éxecution.

• host
• domain

Renvoie la liste des adresses IP.

• domain

Renvoie la liste des hosts pour un domain.

• domain

Renvoie la liste des DNS associés au domaine.

• domain

Renvoie les informations DNS relatives au domaine.

'0' => {
   ’fieldtype’ => ‘A’,
   ’target’ => ‘81.100.86.15′,
   ’ttl’ => ‘60′,
   ’subdomain’ => ’server’,
}
‘12′ => {
   ’fieldtype’ => ‘CNAME’
   ’target’ => ‘ns0.ovh.net.’
   ’ttl’ => ‘0′
   ’subdomain’ => ‘pop3′
}

• nic

Renvoie la liste des domaines auquels le NIC a accès.

• domain
• target
• subdomain

Efface une redirection ORT.

• domain
• type INVISIBLE|VISIBLE
• target
• subdomain
• overwrite 1|0

Ajoute une redirection ORT pour un domaine.

Note: Le paramètre ‘target’ est sous la forme domain.com (pas de http://).
Note: OrtDomainAdd crée automatiquement le DnsSetDomainPlanType correspondant.

• domain

Renvoie la liste des redirections ORT pour une domaine.

• domain
• db

Efface une base de données.

Info: Cette fonction est inactive.

• domain
• subdomain
• multidomain
• multisubdomain
• overwrite optionel
• target optionel sauf si on crée le subdomain

Installe un sous-domaine sur un hébergement multidomaine.

Note: Le paramètre ‘target’ est à utiliser si on veut créer le sous-domaine en même temps.

• domain

Renvoie la liste des sous-domaines attachés à un domaine.

Array
(
[domain] => webotheque.be
[status] => 100
[value] => Array
(
[0] => Array
(
[prefix] => manager
[dir] => www/manager
[login] => webotheq
)

[nbsdoms] => 3
)


• domain
• subdomain

Efface un sous-domaine.

• domain
• subdomain
• target

Crée un sous domaine.

• key

Efface une donnée de la session.

ATTENTION : Cette fonction risque de disparaître.

• key
• value

Permet de sauver une donnée dans la session.

ATTENTION : Cette fonction risque de disparaître.

• responder
• domain
• content
• nic

Modifie un répondeur.

• domain
• pop

Renvoie la liste des répondeurs associés à un pop.

• domain

Renvoie la liste des répondeurs installés sur un domaine.

• domain
• responder

Renvoie les informations relatives à un répondeur.

• responder
• domain

Efface un répondeur.

• responder
• domain
• content
• delivered_to optionel
• nic optionel

Crée un répondeur.

• domain

Liste les redirections d’emails (alias + forward).

• domain
• redirected
• target
• nic
• subdomain optionnel

Efface une redirection email.

• domain
• subdomain optionnel
• redirected
• target
• nic optionnel

Crée un alias ou un forward (le choix est automatique et basé sur le domaine de destination).

Note: Il s’agit des fonction de redirections de mails pour les domaines ayant un mxplan ou un hébergement.

• domain

Renvoie les infos sur le service real d’un domaine.

'usedspace' => '0',
‘active’ => 1

• domain
• password

Change le password pour le service Real d’un domaine.

• domain

Active les services Real pour un domaine.

• domain
• pop

Renvoie toutes les informations concernant un compte pop.

• pop
• domain
• desc

Modifie la description d’un compte pop.

• domain

Renvoie la liste des comptes pop d’un domaine sous la forme d’un tableau.

• pop
• domain

Renvoie un hash avec les infos d’un pop.

'nic' => 'aucun',
‘name’ => ‘postmaster’,
‘description’ => ‘Postmaster’,
’size’ => ‘25000000′

• domain
• pop

Renvoie les alias d’un compte pop.

• pop
• domain

Efface un compte pop.

• pop
• domain
• password
• desc
• nic

Crée un compte pop.

• pop
• domain
• password

Modifie le mot de passe d’un compte pop.

• pop
• domain
• nic_to_attach

Associe un pop à un nic pour lui en déleguer la gestion.

• nic

Renvoie la liste des pops isolés manageable par le nic.

• nic
• language

Modifie la langue d’un nic.

• nic
• address
• city
• area
• zip
• country
• phonenumber

Modifie l’adresse d’un nic.

• password
• firstname
• name
• email
• language optionnel [fr|en|pl|es|de]
• phone
• fax
• address
• city
• area optionnel
• zip optionnel
• country [be|fr|pl|es|lu|ch|de|…]
• organisation optionnel
• legalform optionnel [corporation|individual|association|other]
• vat optionnel

Permet de créer un nic avec toutes les informations classiques. Renvoit nicowner.

• nic
• password

Permet de changer le mot de passe d’un nic.

• domain

Renvoie la liste de multiftp d’un domaine.

• domain
• loginsuffix
• directory
• password

Crée un multiftp.

• domain
• login
• password

Modifie le password d’un multiftp.

• domain
• login
• directory

Modifie le répertoire d’un multiftp.

• domain
• subdomain
• multidomain
• target optionel

Modifie la configuration d’un multidomaine.

Note: Le paramètre ‘target’ est à utiliser si on veut créer le sous-domaine en même temps.

• domain

Renvoie la liste des multidomaines installés sur un domaine.

• domain
• multidomain

Efface un multidomaine.

• domain
• subdomain
• multidomain
• overwrite optionel
• target optionel

Installe un multidomaine sur un hébergement.

Note: Le paramètre ‘target’ est à utiliser si on veut créer le sous-domaine en même temps.

• domain
• ml
• email

Desinscrit un email d’une mailing liste .

• domain
• ml
• email

Envoie la liste des abonnés d’une mailing liste à une adresse email.

• domain
• ml

Renvoie la liste des abonnés d’une mailing liste.

• domain
• ml
• emails
array[ ]

Inscrit une tableau d’email à une mailing liste.

• domain
• ml
• email

Inscrit un email à une mailing liste.

• domain
• ml
• moderator
• message_moderation
• users_post_only
• subscription_moderation

Modifie les options de moderation/abonnement d’une mailing list.

• domain
• ml

Renvoie la liste des modérateurs d’une mailing liste.

• domain

Renvoie la liste des mailing liste d’un domaine.

'owner' => 'a@o.net',
‘domain’ => ‘bozoid.org’,
‘ml’ => ‘papaa’,
‘nic’ => undef

• domain
• ml

Renvoie des infos de configuration sur une mailing liste.

'lang' => undef,
‘users_post_only’ => ‘’,
‘message_moderation’ => 1,
‘nic’ => undef,
‘name’ => ‘limoges’,
‘moderator’ => ‘bozo@nobodix.org’,
‘domain’ => undef,
’subscription_moderation’ => ‘’

• domain
• ml

Renvoie les infos sur la mailing liste avec la liste de abonnés et celle des modérateurs.

• domain
• ml
• email

Retire un modérateur d’une mailing liste.

• domain
• ml

Efface une mailing liste.

• domain
• ml
• moderator
• message_moderation 0|1
• users_post_only 0|1
• subscription_moderation 0|1
• ml_language en|fr|es optionel
• replyto mailinglist|lastuser|email@domain.org optionel

Crée une mailing liste sur un domaine .

“replyto” définit à qui se fait la réponse à une mailing-list.
Ce paramètre peut prendre trois valeurs différentes :
- mailinglist, pour que la réponse se fasse à la liste elle-même (ancien comportement par défaut)
- lastuser, pour que la réponse se fasse à la personne qui a envoyé l’email
- une adresse email quelconque

• domain ???
• pop ???

Renvoie un résumé complet sur tous les comptes pop du domaine, avec les information concernant les alias, les répondeurs …

Renvoie un résumé de chacun des domaines auxquels le nic a accès.
Lazzzyyyy Just stay in bed, don’t want no money, don’t want no bread.

Renvoie toutes les informations concernant les emails des domaines controlés par le nichandle.

• domain

Renvoie les capacités du plan sur lequel est hébérgé le domaine.

'webspace' => 240,
‘cgi’ => 1,
‘databases’ => -1,
’ssh’ => 1,
‘multidomain’ => 1,
‘anonymousftp’ => 240,
’subdomains’ => -1,
‘pop’ => -1,
‘realservices’ => 240,
‘multiftp’ => 0

• domain

Renvoie un résumé sur le domaine.

'databases' => '2',
‘name’ => ‘bozoid.org’,
‘nbmultidomains’ => ‘1′,
‘ftp_used_space’ => ‘61856′,
‘realservices_used_space’ => ‘12′,
‘plan’ => ‘720Plan’,
‘anonymous_ftp_used_space’ => ‘0′,
’subdomains’ => ‘4′

• domains
ARRAY [ ]

La même que HostingDomainSummary mais pour une liste de domaines.

• nic

Renvoie la liste des hostings auxquels le nic a accès (même les mut.dns).

• nic

Renvoie la liste des accès detaillés.

• billnum

Renvoie les informations relatives à une facture.

• delay

Renvoie les références (domaines, hébergements, serveurs …) sur le point d’expirer.

Note: delay est exprimé en jours

• domain

Renvoie l’espace utilisé sur le ftp du domaine.

• domain

Renvoie les informations relatives à l’espace FTP de base d’un domaine.

• domain
• password

Change le mot de passe du ftp du domaine.

• domain
• subdomain optionnel
• target
• local

Modifie une redirection email.

Note: Pour l’instant pas de toto@xxx.domain.tld que des toto@domain.tld

• domain

Renvoit la liste des redirections emails d’un domaine.

'distant' => 'oles@ovh.net',
‘local’ => ‘local@saloperie.com’

• domain
• subdomain optionnel
• target
• local

Efface une redirection email.

• domain
• subdomain
optionnel
• target
• local
• nic

Crée une redirection email.

Note: Pour l’instant pas de toto@xxx.domain.tld que des toto@domain.tld

Note: Il s’agit des fonction de redirections de mails pour les domaines qui ne sont ni mxplan ni hébergement.

• pop
• domain
• filter
• priority

Modifie la priorité d’un filtre.

• pop
• domain
• filter

Augmente la priorité d’un filtre.

• pop
• domain

Renvoie la liste des filtres associé à un compte pop.

'test' => {
   ’priority’ => ‘2′,
   ’action_parameter’ => ‘’,
   ’action’ => ‘del’,
   ’rules’ => {
      ’contains’ => 1,
      ’element’ => ‘a’,
      ’header’ => ‘From’
   }
}

• pop
• domain
• filter

Diminue la priorité d’un filtre.

• pop
• domain
• filter

Désactive un filtre attaché à un pop.

• pop
• domain
• filter

Efface un filtre associé à un pop.

• pop
• domain
• filter
• action [pop|accept|del|redir|bounce]
• action_parameter
• priority
• active 0|1
• rules[ ]

Crée un filtre associé à un compte pop.

pour action = pop ou for action_parameter contient une adresse mail
pour aciton = bounce action_parameter contient un texte accompagnant le renvoi du mail a son expéditeur

Une règle (rule) se présente sous la forme: header + contains + element

Exemples de rules:

filtre anti spam:
array("contains"=>1,"header"=>"X-Spam-Tag","element"=>"YES")

filtre spam probable:
array("contains"=>1,"header"=>"X-Probably-Spam-Tag","element"=>"YES")

filtre antivirus:
array("contains” =>1, “header” => “X-Virus-Tag", “element” => “YES")

Autres filtres:

array("contains” => [0|1], “header” => [From|Cc|Subject|To],"element” => texte ou pop)

Exemple d’appel de la fonction en PHP:

$rules = array();
$rules[]=array("contains"=>1,"header"=>"X-Probably-Spam-Tag","element"=>"YES")
$rules[]=array("contains"=>1,"header"=>"X-Spam-Tag","element"=>"YES")
$rules[]=array("contains” =>1, “header” => “X-Virus-Tag", “element” => “YES")

foreach($rules as $k => $v) {
$rules[$k] = new soap_value('’,'’,$v);
}

$rules2 = array("action” => $action, “action_parameter” => $action_param, “domain” => $_POST[’domaine’],"pop” => $_POST[’pop’],"filter” => $_POST[’name’],"priority” => 1, “active” => 1, “rules” => $rules);
$rules2 = new soap_value('’ ,'’, $rules2);
$res = filterCreate($_SESSION[’id_soap_session’],$rules2);

Que Nicolas Merlet recoive ici toute ma gratitude. Sans lui cette documentation sur la création des filtres n’aurait pas pu être réalisée.

Oli

• pop
• domain
• filter

Active ou désactive un filtre.

• domain
• subdomain optionnel
• mxtype

Change la configuration du domaine par rapport au filtrage emails: NO_FILTERING|SIMPLE_FILTERING|FULL_FILTERING (CUSTOM)

• domain
• pop
• type
DISTANT|LOCAL|DELETE|BOUNCE
• address

Configure l’email collecteur du domaine.

• domain
• admin

Determine le nic établi en tant que ‘domain master’ d’un domaine (pour la délégation des droits des emails).