omnidns/ovh API reference

Omnidns\Ovh

OvhFactory class

final class OvhFactory extends ProviderFactory OvhFactory.php:26

OVHcloud, from its options:

application_key, application_secret, consumer_key the API's credentials (required): an application created at https://eu.api.ovh.com/createToken/ with the rights it needs - GET/POST on /order/cart*, GET/PUT/POST on /domain*, DELETE on /domain/zone/* (delete(), an update() that changes a record's type), GET/POST on /service/* endpoint ovh-eu (also ovh-ca, ovh-us, kimsufi-eu... or a URL) subsidiary the OVHcloud company carts are opened with: FR, DE, GB, CA... auto_pay true: an order is paid at once with the account's preferred means of payment; false (the default): the order waits for its payment at Order::$paymentUrl

ovh/ovh signs every call; it sends them with Guzzle - the client given to this factory, or its own.

Options

OvhFactory::__construct()

public function __construct(readonly ?Client $http = null)

OvhProvider class

final class OvhProvider implements AvailabilityInterface, RegistrarInterface, DomainsInterface, NameserversInterface, DnsInterface OvhProvider.php:34

OVHcloud's API through ovh/ovh: a domain's offers read in an order cart, a registration as a cart checked out, a renewal through the services API, the account's domains (/domain), their name servers and their zones' records (/domain/zone), each change of a zone followed by its refresh.

OvhProvider::__construct()

public function __construct(readonly Api $api, readonly string $subsidiary = 'FR', readonly bool $autoPay = false)

OvhProvider::getName()

public function getName(): string

OvhProvider::getTitle()

public function getTitle(): string

OvhProvider::capabilities()

public function capabilities(): Capabilities

OvhProvider::check()

public function check(string $domain): Availability

OvhProvider::register()

public function register(string $domain, int $years = 1, ?Contact $owner = null): Order

OvhProvider::renew()

public function renew(string $domain, int $years = 1): Order

OvhProvider::domains()

public function domains(): array

OvhProvider::domain()

public function domain(string $domain): DomainInfo

OvhProvider::nameservers()

public function nameservers(string $domain): array

OvhProvider::setNameservers()

public function setNameservers(string $domain, array $nameservers): void

OvhProvider::records()

public function records(string $zone, ?string $type = null, ?string $name = null): array

OvhProvider::add()

public function add(string $zone, Record $record): Record

OvhProvider::update()

public function update(string $zone, Record $current, Record $new): Record

OvhProvider::delete()

public function delete(string $zone, Record $record): void