# Account › Profile API > Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt > The Account product's sections: https://developers.eu.ovhcloud.com/reference/account/llms.txt > Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt > 212 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com. Page: https://developers.eu.ovhcloud.com/reference/account/profile/ OpenAPI v1: https://api.eu.ovhcloud.com/1.0/__schemas/developer-hub-navigation/account/profile.json?format=openapi3 OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/account/profile.json?format=openapi3 ## Operations - `GET /contact/form` — Get form characteristics - `POST /contact/form/send` — Send form following characteristics of /contact/form - `GET /me` — Get details about your nichandle - `PUT /me` — Update details of your nichandle - `GET /me/accessRestriction/backupCode` — Get this object properties - `POST /me/accessRestriction/backupCode` — Add a SOTP access restriction - `DELETE /me/accessRestriction/backupCode` — Delete this Two-Factor - `POST /me/accessRestriction/backupCode/disable` — Disable this SOTP account - `POST /me/accessRestriction/backupCode/enable` — Enable this SOTP account - `POST /me/accessRestriction/backupCode/validate` — Validate your SOTP account - `GET /me/accessRestriction/developerMode` — Get this object properties - `PUT /me/accessRestriction/developerMode` — Alter this object properties - `GET /me/accessRestriction/ip` — List of IP restrictions - `POST /me/accessRestriction/ip` — Add an IP access restriction - `GET /me/accessRestriction/ip/{id}` — Get this object properties - `PUT /me/accessRestriction/ip/{id}` — Alter this object properties - `DELETE /me/accessRestriction/ip/{id}` — Delete this restriction rule - `GET /me/accessRestriction/ipDefaultRule` — Get this object properties - `PUT /me/accessRestriction/ipDefaultRule` — Alter this object properties - `GET /me/accessRestriction/sms` — List of Sms accounts - `POST /me/accessRestriction/sms` — Add a SMS access restriction - `GET /me/accessRestriction/sms/{id}` — Get this object properties - `PUT /me/accessRestriction/sms/{id}` — Alter this object properties - `DELETE /me/accessRestriction/sms/{id}` — Delete this Two-Factor - `POST /me/accessRestriction/sms/{id}/disable` — Disable this SMS account - `POST /me/accessRestriction/sms/{id}/enable` — Enable this SMS account - `POST /me/accessRestriction/sms/{id}/sendCode` — Send a SMS to this account - `POST /me/accessRestriction/sms/{id}/validate` — Validate your SMS account - `GET /me/accessRestriction/totp` — List of TOTP accounts - `POST /me/accessRestriction/totp` — Add a TOTP access restriction - `GET /me/accessRestriction/totp/{id}` — Get this object properties - `PUT /me/accessRestriction/totp/{id}` — Alter this object properties - `DELETE /me/accessRestriction/totp/{id}` — Delete this Two-Factor - `POST /me/accessRestriction/totp/{id}/disable` — Disable this TOTP account - `POST /me/accessRestriction/totp/{id}/enable` — Enable this TOTP account - `POST /me/accessRestriction/totp/{id}/validate` — Validate your TOTP account - `GET /me/accessRestriction/u2f` — List of U2F accounts - `POST /me/accessRestriction/u2f` — Add a U2F access restriction - `GET /me/accessRestriction/u2f/{id}` — Get this object properties - `PUT /me/accessRestriction/u2f/{id}` — Alter this object properties - `DELETE /me/accessRestriction/u2f/{id}` — Delete this Two-Factor - `POST /me/accessRestriction/u2f/{id}/disable` — Disable this U2F account - `POST /me/accessRestriction/u2f/{id}/enable` — Enable this U2F account - `POST /me/accessRestriction/u2f/{id}/validate` — Validate your U2F account - `POST /me/account` — Create a new account whose billing will be linked to your current account's billing - `GET /me/api/credential` — List of your Api Credentials - `GET /me/api/credential/{credentialId}` — Get this object properties - `PUT /me/api/credential/{credentialId}` — Alter this object properties - `DELETE /me/api/credential/{credentialId}` — Remove this credential - `GET /me/api/credential/{credentialId}/application` — Get this object properties - `GET /me/api/logs/self` — List of Api calls done with your account - `GET /me/api/logs/self/{logId}` — Get this object properties - `GET /me/api/logs/services` — List of Api calls done on services you have access to - `GET /me/api/logs/services/{logId}` — Get this object properties - `GET /me/autorenew` — Get this object properties - `POST /me/autorenew` — Activate auto renew for this nic - `PUT /me/autorenew` — Alter this object properties - `GET /me/availableAutomaticPaymentMeans` — List available payment methods in this Nic's country - `GET /me/bill` — List of all the bills the logged account has - `POST /me/bill/export` — Exports a bundle of invoices - `GET /me/bill/{billId}` — Get this object properties - `GET /me/bill/{billId}/debt` — Get this object properties - `GET /me/bill/{billId}/debt/operation` — All operations related to these debts - `GET /me/bill/{billId}/debt/operation/{operationId}` — Get this object properties - `GET /me/bill/{billId}/debt/operation/{operationId}/associatedObject` — Return main data about the object related to this debt operation - `POST /me/bill/{billId}/debt/pay` — Create an order in order to pay this order's debt - `GET /me/bill/{billId}/details` — Give access to all entries of the bill - `GET /me/bill/{billId}/details/{billDetailId}` — Get this object properties - `GET /me/bill/{billId}/payment` — Get this object properties - `GET /me/billing/invoicesByPostalMail` — Send invoices through postal mail - `POST /me/billing/invoicesByPostalMail` — Enable or disable invoices by postal mail - `GET /me/bringYourOwnIp/token` — Get your Bring your own IP token - `GET /me/certificates` — Get all certificates of the account - `POST /me/changeEmail` — Initiate an email change procedure - `POST /me/changePassword` — Initiate a password change procedure - `GET /me/consent` — List all consent campaign available - `GET /me/consent/{campaignName}` — Retrieve information about a consent campaign - `GET /me/consent/{campaignName}/decision` — Get decision value for a consent campaign - `PUT /me/consent/{campaignName}/decision` — Update decision of a consent campaign - `GET /me/contact` — Retrieve every contact your created - `POST /me/contact` — Create a new contact - `GET /me/contact/{contactId}` — Retrieve information about a contact - `PUT /me/contact/{contactId}` — Update an existing contact - `GET /me/contact/{contactId}/fields` — Get mandatory/read-only information about the fields of a contact - `GET /me/correctiveInvoice` — List of all the correctiveInvoice the logged account has - `GET /me/correctiveInvoice/{correctiveInvoiceId}` — Get this object properties - `GET /me/correctiveInvoice/{correctiveInvoiceId}/debt` — Get this object properties - `GET /me/correctiveInvoice/{correctiveInvoiceId}/debt/operation` — All operations related to these debts - `GET /me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}` — Get this object properties - `GET /me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}/associatedObject` — Return main data about the object related to this debt operation - `POST /me/correctiveInvoice/{correctiveInvoiceId}/debt/pay` — Create an order in order to pay this order's debt - `GET /me/correctiveInvoice/{correctiveInvoiceId}/details` — Give access to all entries of the CorrectiveInvoice - `GET /me/correctiveInvoice/{correctiveInvoiceId}/details/{correctiveInvoiceDetailId}` — Get this object properties - `GET /me/correctiveInvoice/{correctiveInvoiceId}/payment` — Get this object properties - `GET /me/debtAccount` — Get this object properties - `GET /me/debtAccount/debt` — All debts related to your account - `GET /me/debtAccount/debt/{debtId}` — Get this object properties - `GET /me/debtAccount/debt/{debtId}/operation` — All operations related to these debts - `GET /me/debtAccount/debt/{debtId}/operation/{operationId}` — Get this object properties - `GET /me/debtAccount/debt/{debtId}/operation/{operationId}/associatedObject` — Return main data about the object related to this debt operation - `POST /me/debtAccount/debt/{debtId}/pay` — Create an order in order to pay this order's debt - `POST /me/debtAccount/pay` — Create an order in order to pay all your due debts - `GET /me/deposit` — List of all the deposits made to your prepaid account or debt account - `GET /me/deposit/{depositId}` — Get this object properties - `GET /me/deposit/{depositId}/details` — Give access to all entries of this deposit - `GET /me/deposit/{depositId}/details/{depositDetailId}` — Get this object properties - `GET /me/deposit/{depositId}/paidBills` — Get invoices paid by this deposit - `GET /me/deposit/{depositId}/paidBills/{billId}` — Get this object properties - `GET /me/deposit/{depositId}/paidBills/{billId}/debt` — Get this object properties - `GET /me/deposit/{depositId}/paidBills/{billId}/debt/operation` — All operations related to these debts - `GET /me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}` — Get this object properties - `GET /me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}/associatedObject` — Return main data about the object related to this debt operation - `POST /me/deposit/{depositId}/paidBills/{billId}/debt/pay` — Create an order in order to pay this order's debt - `GET /me/deposit/{depositId}/paidBills/{billId}/details` — Give access to all entries of the bill - `GET /me/deposit/{depositId}/paidBills/{billId}/details/{billDetailId}` — Get this object properties - `GET /me/deposit/{depositId}/paidBills/{billId}/payment` — Get this object properties - `GET /me/deposit/{depositId}/payment` — Get this object properties - `GET /me/document` — List of documents added in your account - `POST /me/document` — Create new document - `POST /me/document/cors` — Add CORS support on your container - `GET /me/document/{id}` — Get this object properties - `PUT /me/document/{id}` — Alter this object properties - `DELETE /me/document/{id}` — Delete a document - `GET /me/downPaymentInvoice` — List of all the downPaymentInvoice the logged account has - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}` — Get this object properties - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}/debt` — Get this object properties - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation` — All operations related to these debts - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}` — Get this object properties - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}/associatedObject` — Return main data about the object related to this debt operation - `POST /me/downPaymentInvoice/{downPaymentInvoiceId}/debt/pay` — Create an order in order to pay this order's debt - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}/details` — Give access to all entries of the DownPaymentInvoice - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}/details/{downPaymentInvoiceDetailId}` — Get this object properties - `GET /me/downPaymentInvoice/{downPaymentInvoiceId}/payment` — Get this object properties - `GET /me/fax/customDomains` — Get the fax custom domains linked to the customer account - `POST /me/fax/customDomains` — Create a custom domain for your fax services - `GET /me/fax/customDomains/{id}` — Get this object properties - `DELETE /me/fax/customDomains/{id}` — Delete a custom domain of your fax services - `GET /me/fidelityAccount` — Get this object properties - `PUT /me/fidelityAccount` — Alter this object properties - `POST /me/fidelityAccount/creditOrder` — Generate an order that can be paid in order to credit the fidelity account - `GET /me/fidelityAccount/movements` — List of entries of the fidelity account - `GET /me/fidelityAccount/movements/{movementId}` — Get this object properties - `GET /me/insight` — Get your insight access token - `GET /me/ipOrganisation` — List of organisations - `POST /me/ipOrganisation` — Add an organisation - `GET /me/ipOrganisation/{organisationId}` — Get this object properties - `PUT /me/ipOrganisation/{organisationId}` — Alter this object properties - `DELETE /me/ipOrganisation/{organisationId}` — Delete this organisation - `GET /me/mailingList/availableLists` — List of mailing list you can subscribe - `POST /me/mailingList/subscribe` — Subscribe an email to a restricted mailing list - `GET /me/notification/email/history` — List of all your email notifications - `GET /me/notification/email/history/{id}` — Get this object properties - `GET /me/ovhAccount` — List of OVH accounts the logged account has - `GET /me/ovhAccount/{ovhAccountId}` — Get this object properties - `PUT /me/ovhAccount/{ovhAccountId}` — Alter this object properties - `POST /me/ovhAccount/{ovhAccountId}/creditOrder` — Generate an order that can be paid in order to credit the OVH account - `GET /me/ovhAccount/{ovhAccountId}/movements` — Details about an entry of the OVH account - `GET /me/ovhAccount/{ovhAccountId}/movements/{movementId}` — Get this object properties - `POST /me/ovhAccount/{ovhAccountId}/movements/{movementId}/requestRefund` — request a refund of this credit note to your original payment method - `POST /me/ovhAccount/{ovhAccountId}/retrieveMoney` — Transfer money from ovhAccount to your bank account - `POST /me/passwordRecover` — Request a password recover - `GET /me/refund` — List of all the refunds the logged account has - `POST /me/refund/export` — Exports a bundle of refunds - `GET /me/refund/{refundId}` — Get this object properties - `GET /me/refund/{refundId}/details` — Give access to all entries of the refund - `GET /me/refund/{refundId}/details/{refundDetailId}` — Get this object properties - `GET /me/refund/{refundId}/payment` — Get this object properties - `GET /me/reverseBill` — List all the bills sent by the current account - `GET /me/reverseBill/{reverseBillId}` — Get this object properties - `GET /me/reverseBill/{reverseBillId}/details` — Give access to all entries of this withdrawal - `GET /me/reverseBill/{reverseBillId}/details/{reverseBillDetailId}` — Get this object properties - `GET /me/reverseBill/{reverseBillId}/payment` — Get this object properties - `GET /me/sla` — List active SLA - `GET /me/sla/{id}` — Get this object properties - `POST /me/sla/{id}/apply` — Ask for SLA application - `GET /me/sla/{id}/canBeApplied` — Check whether this SLA can be applied on your services - `GET /me/sla/{id}/services` — Get services impacted by this SLA - `GET /me/sla/{id}/status` — Get the status request of this SLA - `GET /me/subAccount` — List of sub-accounts - `POST /me/subAccount` — Create a new sub-account - `GET /me/subAccount/{id}` — Get this object properties - `PUT /me/subAccount/{id}` — Alter this object properties - `POST /me/subAccount/{id}/createConsumerKey` — Create a consumer key for the current application - `GET /me/subscription` — List of all OVH things you can subscribe to - `GET /me/subscription/{subscriptionType}` — Get this object properties - `PUT /me/subscription/{subscriptionType}` — Alter this object properties - `GET /me/task/contactChange` — List of service contact change tasks you are involved in - `GET /me/task/contactChange/{id}` — Get this object properties - `POST /me/task/contactChange/{id}/accept` — Accept this change request - `POST /me/task/contactChange/{id}/refuse` — Refuse this change request - `POST /me/task/contactChange/{id}/resendEmail` — This call will send you a new email, containing a new token - `GET /me/task/emailChange` — List of email change tasks you are involved in - `GET /me/task/emailChange/{id}` — Get this object properties - `POST /me/task/emailChange/{id}/accept` — Accept this change request - `POST /me/task/emailChange/{id}/refuse` — Refuse this change request - `GET /me/telephony/defaultIpRestriction` — The default SIP IP restictions for your future VoIP lines - `POST /me/telephony/defaultIpRestriction` — Create a default IP restriction for your future VoIP lines - `GET /me/telephony/defaultIpRestriction/{id}` — Get this object properties - `DELETE /me/telephony/defaultIpRestriction/{id}` — Delete a default IP restriction for your future VoIP lines - `GET /me/telephony/settings` — Get the telephony settings linked to the customer account - `POST /me/telephony/settings` — Change the telephony settings linked to the customer account - `GET /me/vipStatus` — VIP Status of this account - `POST /me/voucher/checkValidity` — Verify existing voucher - `GET /me/withdrawal` — List of all the withdrawals made from your prepaid account - `GET /me/withdrawal/{withdrawalId}` — Get this object properties - `GET /me/withdrawal/{withdrawalId}/details` — Give access to all entries of this withdrawal - `GET /me/withdrawal/{withdrawalId}/details/{withdrawalDetailId}` — Get this object properties - `GET /me/withdrawal/{withdrawalId}/payment` — Get this object properties - `GET /me/xdsl/setting` — Get xdsl settings linked to the nichandle - `POST /me/xdsl/setting` — Change xdsl settings linked to the nichandle - `GET /account/api/revision` — Get the current and available API revisions - `PUT /account/api/revision` — Update the current API revision ## Get form characteristics `GET /1.0/contact/form` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-contact-form **Status:** Stable production version **Authentication:** none (public operation) ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | contact.FormCharacteristic[] | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `keys` | contact.KeyFormCharacteristic[] | | Form keys to send | | `keys[].key` | string | | Key name | | `keys[].required` | boolean | | Key required or not | | `type` | string | | Form type | ```json [ { "keys": [ { "key": "string", "required": true } ], "type": "string" } ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/contact/form" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/contact/form") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/contact/form"); print_r($result); ?> ``` ## Send form following characteristics of /contact/form `POST /1.0/contact/form/send` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-contact-form-send **Status:** Stable production version **Authentication:** none (public operation) ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `form` | complexType.SafeKeyValue_string[] | yes | Form informations | | `form[].key` | string | | | | `form[].value` | string | | | | `type` | string | yes | Form type | ```json { "form": [ { "key": "string", "value": "string" } ], "type": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/contact/form/send" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/contact/form/send", form = None, # Form informations (type: complexType.SafeKeyValue[]) type = None, # Form type (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/contact/form/send", array( form => null, // Form informations (type: complexType.SafeKeyValue[]) type => null, // Form type (type: string) )); print_r($result); ?> ``` ## Get details about your nichandle `GET /1.0/me` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#getAccountDetails **Status:** Stable production version **IAM actions:** `account:apiovh:me/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.Nichandle | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | string | | | | `area` | string | | | | `birthCity` | string | | | | `birthDay` | string | | | | `city` | string | | | | `companyNationalIdentificationNumber` | string | | | | `corporationType` | string | | | | `country` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `currency` | nichandle.Currency | read-only | Customer currency | | `currency.code` | string | | Currency code | | `currency.symbol` | string | | Currency symbol | | `customerCode` | string | read-only | Your customer code (a numerical value used for identification when contacting support via phone call) | | `email` | string | read-only | | | `fax` | string | | | | `firstname` | string | | | | `italianSDI` | string | | | | `language` | nichandle.LanguageEnum | | Languages a nichandle can choose — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `legalform` | nichandle.LegalFormEnum | | Legal forms a nichandle can be registered as — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `name` | string | | | | `nationalIdentificationNumber` | string | | | | `nichandle` | string | read-only | | | `organisation` | string | | | | `ovhCompany` | nichandle.OvhCompanyEnum | read-only | OVH companies — one of `kimsufi`, `ovh`, `soyoustart` | | `ovhSubsidiary` | nichandle.OvhSubsidiaryEnum | read-only | OVH subsidiaries — one of `ASIA`, `AU`, `CA`, `CZ`, `DE`, `ES`, `EU`, `FI`, `FR`, `GB`, `IE`, `IN`, … | | `phone` | string | | | | `phoneCountry` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `sex` | nichandle.GenderEnum | | All genders a person can choose — one of `female`, `male` | | `spareEmail` | string | | | | `state` | nichandle.StateEnum | read-only | States a nichandle can be in — one of `complete`, `incomplete` | | `vat` | string | | | | `zip` | string | | | ```json { "address": "string", "area": "string", "birthCity": "string", "birthDay": "string", "city": "string", "companyNationalIdentificationNumber": "string", "corporationType": "string", "country": "AC", "currency": { "code": "string", "symbol": "string" }, "customerCode": "string", "email": "string", "fax": "string", "firstname": "string", "italianSDI": "string", "language": "cs_CZ", "legalform": "administration", "name": "string", "nationalIdentificationNumber": "string", "nichandle": "string", "organisation": "string", "ovhCompany": "kimsufi", "ovhSubsidiary": "ASIA", "phone": "string", "phoneCountry": "AC", "sex": "female", "spareEmail": "string", "state": "complete", "vat": "string", "zip": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me"); print_r($result); ?> ``` ## Update details of your nichandle `PUT /1.0/me` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#editAccountDetails **Status:** Stable production version **IAM actions:** `account:apiovh:me/edit` ### Request body (required) Type: `nichandle.Nichandle` | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | string | | | | `area` | string | | | | `birthCity` | string | | | | `birthDay` | string | | | | `city` | string | | | | `companyNationalIdentificationNumber` | string | | | | `corporationType` | string | | | | `country` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `currency` | nichandle.Currency | read-only | Customer currency | | `currency.code` | string | | Currency code | | `currency.symbol` | string | | Currency symbol | | `customerCode` | string | read-only | Your customer code (a numerical value used for identification when contacting support via phone call) | | `email` | string | read-only | | | `fax` | string | | | | `firstname` | string | | | | `italianSDI` | string | | | | `language` | nichandle.LanguageEnum | | Languages a nichandle can choose — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `legalform` | nichandle.LegalFormEnum | | Legal forms a nichandle can be registered as — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `name` | string | | | | `nationalIdentificationNumber` | string | | | | `nichandle` | string | read-only | | | `organisation` | string | | | | `ovhCompany` | nichandle.OvhCompanyEnum | read-only | OVH companies — one of `kimsufi`, `ovh`, `soyoustart` | | `ovhSubsidiary` | nichandle.OvhSubsidiaryEnum | read-only | OVH subsidiaries — one of `ASIA`, `AU`, `CA`, `CZ`, `DE`, `ES`, `EU`, `FI`, `FR`, `GB`, `IE`, `IN`, … | | `phone` | string | | | | `phoneCountry` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `sex` | nichandle.GenderEnum | | All genders a person can choose — one of `female`, `male` | | `spareEmail` | string | | | | `state` | nichandle.StateEnum | read-only | States a nichandle can be in — one of `complete`, `incomplete` | | `vat` | string | | | | `zip` | string | | | ```json { "address": "string", "area": "string", "birthCity": "string", "birthDay": "string", "city": "string", "companyNationalIdentificationNumber": "string", "corporationType": "string", "country": "AC", "fax": "string", "firstname": "string", "italianSDI": "string", "language": "cs_CZ", "legalform": "administration", "name": "string", "nationalIdentificationNumber": "string", "organisation": "string", "phone": "string", "phoneCountry": "AC", "sex": "female", "spareEmail": "string", "vat": "string", "zip": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.Nichandle result = client.put("/me", address = None, # (type: string, nullable) area = None, # (type: string, nullable) birthCity = None, # (type: string, nullable) birthDay = None, # (type: string, nullable) city = None, # (type: string, nullable) companyNationalIdentificationNumber = None, # (type: string, nullable) corporationType = None, # (type: string, nullable) country = None, # (type: ) fax = None, # (type: string, nullable) firstname = None, # (type: string, nullable) italianSDI = None, # (type: string, nullable) language = None, # (type: nichandle.LanguageEnum, nullable) legalform = None, # (type: ) name = None, # (type: string, nullable) nationalIdentificationNumber = None, # (type: string, nullable) organisation = None, # (type: string, nullable) phone = None, # (type: string, nullable) phoneCountry = None, # (type: nichandle.CountryEnum, nullable) sex = None, # (type: nichandle.GenderEnum, nullable) spareEmail = None, # (type: string, nullable) vat = None, # (type: string, nullable) zip = None, # (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me", array( address => null, // (type: string, nullable) area => null, // (type: string, nullable) birthCity => null, // (type: string, nullable) birthDay => null, // (type: string, nullable) city => null, // (type: string, nullable) companyNationalIdentificationNumber => null, // (type: string, nullable) corporationType => null, // (type: string, nullable) country => null, // (type: ) fax => null, // (type: string, nullable) firstname => null, // (type: string, nullable) italianSDI => null, // (type: string, nullable) language => null, // (type: nichandle.LanguageEnum, nullable) legalform => null, // (type: ) name => null, // (type: string, nullable) nationalIdentificationNumber => null, // (type: string, nullable) organisation => null, // (type: string, nullable) phone => null, // (type: string, nullable) phoneCountry => null, // (type: nichandle.CountryEnum, nullable) sex => null, // (type: nichandle.GenderEnum, nullable) spareEmail => null, // (type: string, nullable) vat => null, // (type: string, nullable) zip => null, // (type: string, nullable) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/accessRestriction/backupCode` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-backupcode **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.SOTPAccount | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `lastUsedDate` | string (date-time) | read-only | Last used date | | `remaining` | integer | read-only | Number of remaining codes | | `status` | nichandle.accessRestriction.SOTPStatusEnum | read-only | Status of this account — one of `disabled`, `enabled`, `needCodeValidation`, `needEmailValidation` | ```json { "creationDate": "2024-01-01T12:00:00Z", "lastUsedDate": "2024-01-01T12:00:00Z", "remaining": 0, "status": "disabled" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/backupCode" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/backupCode") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/backupCode"); print_r($result); ?> ``` ## Add a SOTP access restriction `POST /1.0/me/accessRestriction/backupCode` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-backupcode **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.SOTPSecret | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `codes` | string[] | | | ```json { "codes": [ "string" ] } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/backupCode" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/accessRestriction/backupCode") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/backupCode"); print_r($result); ?> ``` ## Delete this Two-Factor `DELETE /1.0/me/accessRestriction/backupCode` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-accessrestriction-backupcode **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/backupCode" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/accessRestriction/backupCode") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/accessRestriction/backupCode"); print_r($result); ?> ``` ## Disable this SOTP account `POST /1.0/me/accessRestriction/backupCode/disable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-backupcode-disable **Status:** Stable production version ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | OTP code given by the application | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/backupCode/disable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/backupCode/disable", code = None, # OTP code given by the application (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/backupCode/disable", array( code => null, // OTP code given by the application (type: password) )); print_r($result); ?> ``` ## Enable this SOTP account `POST /1.0/me/accessRestriction/backupCode/enable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-backupcode-enable **Status:** Stable production version ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | OTP code given by the application | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/backupCode/enable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/backupCode/enable", code = None, # OTP code given by the application (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/backupCode/enable", array( code => null, // OTP code given by the application (type: password) )); print_r($result); ?> ``` ## Validate your SOTP account `POST /1.0/me/accessRestriction/backupCode/validate` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-backupcode-validate **Status:** Stable production version ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | OTP code given by the application | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.SOTPValidate | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `remainingCodes` | integer | | | ```json { "remainingCodes": 0 } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/backupCode/validate" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/backupCode/validate", code = None, # OTP code given by the application (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/backupCode/validate", array( code => null, // OTP code given by the application (type: password) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/accessRestriction/developerMode` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-developermode **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/developerMode/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.DeveloperModeRestriction | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `enabled` | boolean | | Allow login on your account on a development version of the Manager | ```json { "enabled": true } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/developerMode" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/developerMode") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/developerMode"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/accessRestriction/developerMode` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-accessrestriction-developermode **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/developerMode/edit` ### Request body (required) Type: `nichandle.DeveloperModeRestriction` | Field | Type | Required | Description | | --- | --- | --- | --- | | `enabled` | boolean | | Allow login on your account on a development version of the Manager | ```json { "enabled": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/developerMode" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.DeveloperModeRestriction result = client.put("/me/accessRestriction/developerMode", enabled = None, # Allow login on your account on a development version of the Manager (type: boolean) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/accessRestriction/developerMode", array( enabled => null, // Allow login on your account on a development version of the Manager (type: boolean) )); print_r($result); ?> ``` ## List of IP restrictions `GET /1.0/me/accessRestriction/ip` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-ip **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/ip/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/ip" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/ip") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/ip"); print_r($result); ?> ``` ## Add an IP access restriction `POST /1.0/me/accessRestriction/ip` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-ip **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/ip/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `ip` | ipBlock | yes | An IP range where we will apply the rule | | `rule` | nichandle.accessRestriction.IpRestrictionRuleEnum | yes | Accept or deny IP access — one of `accept`, `deny` | | `warning` | boolean | yes | Send an email if someone try to access with this IP address | ```json { "ip": "192.0.2.0/24", "rule": "accept", "warning": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/ip" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: boolean result = client.post("/me/accessRestriction/ip", ip = None, # An IP range where we will apply the rule (type: ipBlock) rule = None, # Accept or deny IP access (type: nichandle.accessRestriction.IpRestrictionRuleEnum) warning = None, # Send an email if someone try to access with this IP address (type: boolean) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/ip", array( ip => null, // An IP range where we will apply the rule (type: ipBlock) rule => null, // Accept or deny IP access (type: nichandle.accessRestriction.IpRestrictionRuleEnum) warning => null, // Send an email if someone try to access with this IP address (type: boolean) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/accessRestriction/ip/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-ip-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/ip/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.IpRestriction | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer | read-only | The Id of the restriction | | `ip` | ipBlock | read-only | An IP range where we will apply the rule | | `rule` | nichandle.accessRestriction.IpRestrictionRuleEnum | | Accept or deny IP access — one of `accept`, `deny` | | `warning` | boolean | | Send an email if someone try to access with this IP address | ```json { "id": 0, "ip": "192.0.2.0/24", "rule": "accept", "warning": true } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/ip/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/ip/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/ip/{id}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/accessRestriction/ip/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-accessrestriction-ip-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/ip/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `nichandle.IpRestriction` | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer | read-only | The Id of the restriction | | `ip` | ipBlock | read-only | An IP range where we will apply the rule | | `rule` | nichandle.accessRestriction.IpRestrictionRuleEnum | | Accept or deny IP access — one of `accept`, `deny` | | `warning` | boolean | | Send an email if someone try to access with this IP address | ```json { "rule": "accept", "warning": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/ip/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.IpRestriction result = client.put("/me/accessRestriction/ip/{id}", rule = None, # Accept or deny IP access (type: nichandle.accessRestriction.IpRestrictionRuleEnum) warning = None, # Send an email if someone try to access with this IP address (type: boolean) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/accessRestriction/ip/{id}", array( rule => null, // Accept or deny IP access (type: nichandle.accessRestriction.IpRestrictionRuleEnum) warning => null, // Send an email if someone try to access with this IP address (type: boolean) )); print_r($result); ?> ``` ## Delete this restriction rule `DELETE /1.0/me/accessRestriction/ip/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-accessrestriction-ip-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/ip/delete` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/ip/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/accessRestriction/ip/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/accessRestriction/ip/{id}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/accessRestriction/ipDefaultRule` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-ipdefaultrule **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/ipDefaultRule/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.IpRestrictionDefaultRule | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `rule` | nichandle.accessRestriction.IpRestrictionRuleEnum | | Accept or deny access — one of `accept`, `deny` | | `warning` | boolean | | Send an email if someone try to access | ```json { "rule": "accept", "warning": true } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/ipDefaultRule" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/ipDefaultRule") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/ipDefaultRule"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/accessRestriction/ipDefaultRule` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-accessrestriction-ipdefaultrule **Status:** Stable production version **IAM actions:** `account:apiovh:me/accessRestriction/ipDefaultRule/edit` ### Request body (required) Type: `nichandle.IpRestrictionDefaultRule` | Field | Type | Required | Description | | --- | --- | --- | --- | | `rule` | nichandle.accessRestriction.IpRestrictionRuleEnum | | Accept or deny access — one of `accept`, `deny` | | `warning` | boolean | | Send an email if someone try to access | ```json { "rule": "accept", "warning": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/ipDefaultRule" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.IpRestrictionDefaultRule result = client.put("/me/accessRestriction/ipDefaultRule", rule = None, # Accept or deny access (type: nichandle.accessRestriction.IpRestrictionRuleEnum) warning = None, # Send an email if someone try to access (type: boolean) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/accessRestriction/ipDefaultRule", array( rule => null, // Accept or deny access (type: nichandle.accessRestriction.IpRestrictionRuleEnum) warning => null, // Send an email if someone try to access (type: boolean) )); print_r($result); ?> ``` ## List of Sms accounts `GET /1.0/me/accessRestriction/sms` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-sms **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/sms") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/sms"); print_r($result); ?> ``` ## Add a SMS access restriction `POST /1.0/me/accessRestriction/sms` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-sms **Status:** Stable production version ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `phone` | string | yes | Cell phone number to register | ```json { "phone": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.SmsSecret | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer | | | | `remainingTry` | integer | | | ```json { "id": 0, "remainingTry": 0 } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/accessRestriction/sms", phone = None, # Cell phone number to register (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/sms", array( phone => null, // Cell phone number to register (type: string) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/accessRestriction/sms/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-sms-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.SmsAccount | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | Description of this phone | | `id` | integer | read-only | The Id of the restriction | | `lastUsedDate` | string (date-time) | read-only | Last used date | | `phoneNumber` | string | read-only | Associated phone number | | `status` | nichandle.accessRestriction.SmsStatusEnum | read-only | Status of this account — one of `disabled`, `enabled`, `needCodeValidation`, `needEmailValidation` | ```json { "creationDate": "2024-01-01T12:00:00Z", "description": "string", "id": 0, "lastUsedDate": "2024-01-01T12:00:00Z", "phoneNumber": "string", "status": "disabled" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/sms/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/sms/{id}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/accessRestriction/sms/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-accessrestriction-sms-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `nichandle.accessRestriction.SmsAccount` | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | Description of this phone | | `id` | integer | read-only | The Id of the restriction | | `lastUsedDate` | string (date-time) | read-only | Last used date | | `phoneNumber` | string | read-only | Associated phone number | | `status` | nichandle.accessRestriction.SmsStatusEnum | read-only | Status of this account — one of `disabled`, `enabled`, `needCodeValidation`, `needEmailValidation` | ```json { "description": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.accessRestriction.SmsAccount result = client.put("/me/accessRestriction/sms/{id}", description = None, # Description of this phone (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/accessRestriction/sms/{id}", array( description => null, // Description of this phone (type: string) )); print_r($result); ?> ``` ## Delete this Two-Factor `DELETE /1.0/me/accessRestriction/sms/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-accessrestriction-sms-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/accessRestriction/sms/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/accessRestriction/sms/{id}"); print_r($result); ?> ``` ## Disable this SMS account `POST /1.0/me/accessRestriction/sms/{id}/disable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-sms-id-disable **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | SMS code send by a cellphone | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms/{id}/disable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/sms/{id}/disable", code = None, # SMS code send by a cellphone (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/sms/{id}/disable", array( code => null, // SMS code send by a cellphone (type: password) )); print_r($result); ?> ``` ## Enable this SMS account `POST /1.0/me/accessRestriction/sms/{id}/enable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-sms-id-enable **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | SMS code send by a cellphone | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms/{id}/enable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/sms/{id}/enable", code = None, # SMS code send by a cellphone (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/sms/{id}/enable", array( code => null, // SMS code send by a cellphone (type: password) )); print_r($result); ?> ``` ## Send a SMS to this account `POST /1.0/me/accessRestriction/sms/{id}/sendCode` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-sms-id-sendcode **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.SmsCode | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `challenge` | string | | | ```json { "challenge": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms/{id}/sendCode" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/accessRestriction/sms/{id}/sendCode") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/sms/{id}/sendCode"); print_r($result); ?> ``` ## Validate your SMS account `POST /1.0/me/accessRestriction/sms/{id}/validate` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-sms-id-validate **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | SMS code send to a cellphone | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/sms/{id}/validate" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/sms/{id}/validate", code = None, # SMS code send to a cellphone (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/sms/{id}/validate", array( code => null, // SMS code send to a cellphone (type: password) )); print_r($result); ?> ``` ## List of TOTP accounts `GET /1.0/me/accessRestriction/totp` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-totp **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/totp") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/totp"); print_r($result); ?> ``` ## Add a TOTP access restriction `POST /1.0/me/accessRestriction/totp` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-totp **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.TOTPSecret | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer | | | | `qrcodeHelper` | string (password) | | | | `secret` | string (password) | | | ```json { "id": 0, "qrcodeHelper": "string", "secret": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/accessRestriction/totp") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/totp"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/accessRestriction/totp/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-totp-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.TOTPAccount | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | Description of this TOTP | | `id` | integer | read-only | The Id of the restriction | | `lastUsedDate` | string (date-time) | read-only | Last used date | | `status` | nichandle.accessRestriction.TOTPStatusEnum | read-only | Status of this account — one of `disabled`, `enabled`, `needCodeValidation`, `needEmailValidation` | ```json { "creationDate": "2024-01-01T12:00:00Z", "description": "string", "id": 0, "lastUsedDate": "2024-01-01T12:00:00Z", "status": "disabled" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/totp/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/totp/{id}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/accessRestriction/totp/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-accessrestriction-totp-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `nichandle.accessRestriction.TOTPAccount` | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | Description of this TOTP | | `id` | integer | read-only | The Id of the restriction | | `lastUsedDate` | string (date-time) | read-only | Last used date | | `status` | nichandle.accessRestriction.TOTPStatusEnum | read-only | Status of this account — one of `disabled`, `enabled`, `needCodeValidation`, `needEmailValidation` | ```json { "description": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.accessRestriction.TOTPAccount result = client.put("/me/accessRestriction/totp/{id}", description = None, # Description of this TOTP (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/accessRestriction/totp/{id}", array( description => null, // Description of this TOTP (type: string) )); print_r($result); ?> ``` ## Delete this Two-Factor `DELETE /1.0/me/accessRestriction/totp/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-accessrestriction-totp-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/accessRestriction/totp/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/accessRestriction/totp/{id}"); print_r($result); ?> ``` ## Disable this TOTP account `POST /1.0/me/accessRestriction/totp/{id}/disable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-totp-id-disable **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | OTP code given by the application | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp/{id}/disable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/totp/{id}/disable", code = None, # OTP code given by the application (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/totp/{id}/disable", array( code => null, // OTP code given by the application (type: password) )); print_r($result); ?> ``` ## Enable this TOTP account `POST /1.0/me/accessRestriction/totp/{id}/enable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-totp-id-enable **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | OTP code given by the application | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp/{id}/enable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/totp/{id}/enable", code = None, # OTP code given by the application (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/totp/{id}/enable", array( code => null, // OTP code given by the application (type: password) )); print_r($result); ?> ``` ## Validate your TOTP account `POST /1.0/me/accessRestriction/totp/{id}/validate` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-totp-id-validate **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `code` | string (password) | yes | OTP code given by the application | ```json { "code": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/totp/{id}/validate" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: password result = client.post("/me/accessRestriction/totp/{id}/validate", code = None, # OTP code given by the application (type: password) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/totp/{id}/validate", array( code => null, // OTP code given by the application (type: password) )); print_r($result); ?> ``` ## List of U2F accounts `GET /1.0/me/accessRestriction/u2f` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-u2f **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/u2f") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/u2f"); print_r($result); ?> ``` ## Add a U2F access restriction `POST /1.0/me/accessRestriction/u2f` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-u2f **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.U2FRegisterChallenge | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `challenge` | string | | | | `id` | integer | | | | `rpId` | string | | | | `rpName` | string | | | | `userDisplayName` | string | | | | `userId` | string | | | | `userName` | string | | | ```json { "challenge": "string", "id": 0, "rpId": "string", "rpName": "string", "userDisplayName": "string", "userId": "string", "userName": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/accessRestriction/u2f") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/u2f"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/accessRestriction/u2f/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-accessrestriction-u2f-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.accessRestriction.U2FAccount | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | Description of this U2F key | | `id` | integer | read-only | The Id of the restriction | | `lastUsedDate` | string (date-time) | read-only | Last used date | | `status` | nichandle.accessRestriction.U2FStatusEnum | read-only | Status of this account — one of `disabled`, `enabled`, `needCodeValidation` | ```json { "creationDate": "2024-01-01T12:00:00Z", "description": "string", "id": 0, "lastUsedDate": "2024-01-01T12:00:00Z", "status": "disabled" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/accessRestriction/u2f/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/accessRestriction/u2f/{id}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/accessRestriction/u2f/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-accessrestriction-u2f-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `nichandle.accessRestriction.U2FAccount` | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | Description of this U2F key | | `id` | integer | read-only | The Id of the restriction | | `lastUsedDate` | string (date-time) | read-only | Last used date | | `status` | nichandle.accessRestriction.U2FStatusEnum | read-only | Status of this account — one of `disabled`, `enabled`, `needCodeValidation` | ```json { "description": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.accessRestriction.U2FAccount result = client.put("/me/accessRestriction/u2f/{id}", description = None, # Description of this U2F key (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/accessRestriction/u2f/{id}", array( description => null, // Description of this U2F key (type: string) )); print_r($result); ?> ``` ## Delete this Two-Factor `DELETE /1.0/me/accessRestriction/u2f/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-accessrestriction-u2f-id **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/accessRestriction/u2f/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/accessRestriction/u2f/{id}"); print_r($result); ?> ``` ## Disable this U2F account `POST /1.0/me/accessRestriction/u2f/{id}/disable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-u2f-id-disable **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f/{id}/disable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/accessRestriction/u2f/{id}/disable") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/u2f/{id}/disable"); print_r($result); ?> ``` ## Enable this U2F account `POST /1.0/me/accessRestriction/u2f/{id}/enable` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-u2f-id-enable **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f/{id}/enable" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/accessRestriction/u2f/{id}/enable") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/u2f/{id}/enable"); print_r($result); ?> ``` ## Validate your U2F account `POST /1.0/me/accessRestriction/u2f/{id}/validate` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-accessrestriction-u2f-id-validate **Status:** Stable production version ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | The Id of the restriction | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `attestationObject` | string | yes | | | `clientDataJSON` | string | yes | | | `rawId` | string | yes | | ```json { "attestationObject": "string", "clientDataJSON": "string", "rawId": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/accessRestriction/u2f/{id}/validate" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/accessRestriction/u2f/{id}/validate", attestationObject = None, # (type: string) clientDataJSON = None, # (type: string) rawId = None, # (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/accessRestriction/u2f/{id}/validate", array( attestationObject => null, // (type: string) clientDataJSON => null, // (type: string) rawId => null, // (type: string) )); print_r($result); ?> ``` ## Create a new account whose billing will be linked to your current account's billing `POST /1.0/me/account` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-account **Status:** Alpha version **IAM actions:** `account:apiovh:me/account/create` ### Request body (required) Type: `reseller.Nichandle` | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | string | | Address of nichandle | | `area` | string | | Area of nichandle | | `billingAccount` | string | | Billing account to link to the new nic | | `birthCity` | string | | City of birth | | `birthDay` | string | | Birth date | | `city` | string | | City of nichandle | | `companyNationalIdentificationNumber` | string | | Company National Identification Number | | `complementaryAddress` | string | | Complementary Address | | `corporationType` | string | | Corporation type | | `country` | nichandle.CountryEnum | | Customer country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `currency` | nichandle.Currency | read-only | Customer currency | | `currency.code` | string | | Currency code | | `currency.symbol` | string | | Currency symbol | | `customerCode` | string | read-only | Your customer code (a numerical value used for identification when contacting support via phone call) | | `einvoicingBillingAddress` | string | | Default e-invoicing billing address | | `email` | string | | Email address | | `fax` | string | | Fax number | | `firstname` | string | | First name | | `italianSDI` | string | | Italian SDI | | `kycValidated` | boolean | read-only | KYC validation state | | `language` | nichandle.LanguageEnum | | Language — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `legalform` | nichandle.LegalFormEnum | | Customer legal form — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `name` | string | | Customer name | | `nationalIdentificationNumber` | string | | National Identification Number | | `nichandle` | string | read-only | Customer identifier | | `organisation` | string | | Name of organisation | | `ovhCompany` | nichandle.OvhCompanyEnum | read-only | OVH company — one of `kimsufi`, `ovh`, `soyoustart` | | `ovhSubsidiary` | nichandle.OvhSubsidiaryEnum | read-only | OVH subsidiary — one of `ASIA`, `AU`, `CA`, `CZ`, `DE`, `ES`, `EU`, `FI`, `FR`, `GB`, `IE`, `IN`, … | | `phone` | string | | Phone number | | `phoneCountry` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `phoneType` | nichandle.PhoneTypeEnum | | Type of phone(mobile, landline) — one of `landline`, `mobile` | | `purposeOfPurchase` | string | | Customer purpose of purchase | | `sex` | nichandle.GenderEnum | | Gender — one of `female`, `male` | | `spareEmail` | string | | Spare email | | `state` | nichandle.StateEnum | read-only | Nichandle state — one of `complete`, `incomplete` | | `vat` | string | | VAT number | | `zip` | string | | Zipcode | ```json { "address": "string", "area": "string", "billingAccount": "string", "birthCity": "string", "birthDay": "string", "city": "string", "companyNationalIdentificationNumber": "string", "complementaryAddress": "string", "corporationType": "string", "country": "AC", "einvoicingBillingAddress": "string", "email": "string", "fax": "string", "firstname": "string", "italianSDI": "string", "language": "cs_CZ", "legalform": "administration", "name": "string", "nationalIdentificationNumber": "string", "organisation": "string", "phone": "string", "phoneCountry": "AC", "phoneType": "landline", "purposeOfPurchase": "string", "sex": "female", "spareEmail": "string", "vat": "string", "zip": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.Nichandle | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | string | | | | `area` | string | | | | `birthCity` | string | | | | `birthDay` | string | | | | `city` | string | | | | `companyNationalIdentificationNumber` | string | | | | `corporationType` | string | | | | `country` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `currency` | nichandle.Currency | read-only | Customer currency | | `currency.code` | string | | Currency code | | `currency.symbol` | string | | Currency symbol | | `customerCode` | string | read-only | Your customer code (a numerical value used for identification when contacting support via phone call) | | `email` | string | read-only | | | `fax` | string | | | | `firstname` | string | | | | `italianSDI` | string | | | | `language` | nichandle.LanguageEnum | | Languages a nichandle can choose — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `legalform` | nichandle.LegalFormEnum | | Legal forms a nichandle can be registered as — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `name` | string | | | | `nationalIdentificationNumber` | string | | | | `nichandle` | string | read-only | | | `organisation` | string | | | | `ovhCompany` | nichandle.OvhCompanyEnum | read-only | OVH companies — one of `kimsufi`, `ovh`, `soyoustart` | | `ovhSubsidiary` | nichandle.OvhSubsidiaryEnum | read-only | OVH subsidiaries — one of `ASIA`, `AU`, `CA`, `CZ`, `DE`, `ES`, `EU`, `FI`, `FR`, `GB`, `IE`, `IN`, … | | `phone` | string | | | | `phoneCountry` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `sex` | nichandle.GenderEnum | | All genders a person can choose — one of `female`, `male` | | `spareEmail` | string | | | | `state` | nichandle.StateEnum | read-only | States a nichandle can be in — one of `complete`, `incomplete` | | `vat` | string | | | | `zip` | string | | | ```json { "address": "string", "area": "string", "birthCity": "string", "birthDay": "string", "city": "string", "companyNationalIdentificationNumber": "string", "corporationType": "string", "country": "AC", "currency": { "code": "string", "symbol": "string" }, "customerCode": "string", "email": "string", "fax": "string", "firstname": "string", "italianSDI": "string", "language": "cs_CZ", "legalform": "administration", "name": "string", "nationalIdentificationNumber": "string", "nichandle": "string", "organisation": "string", "ovhCompany": "kimsufi", "ovhSubsidiary": "ASIA", "phone": "string", "phoneCountry": "AC", "sex": "female", "spareEmail": "string", "state": "complete", "vat": "string", "zip": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/account" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: reseller.Nichandle result = client.post("/me/account", address = None, # Address of nichandle (type: string, nullable) area = None, # Area of nichandle (type: string, nullable) billingAccount = None, # Billing account to link to the new nic (type: string, nullable) birthCity = None, # City of birth (type: string, nullable) birthDay = None, # Birth date (type: string, nullable) city = None, # City of nichandle (type: string, nullable) companyNationalIdentificationNumber = None, # Company National Identification Number (type: string, nullable) complementaryAddress = None, # Complementary Address (type: string, nullable) corporationType = None, # Corporation type (type: string, nullable) country = None, # Customer country (type: nichandle.CountryEnum) einvoicingBillingAddress = None, # Default e-invoicing billing address (type: string, nullable) email = None, # Email address (type: string, nullable) fax = None, # Fax number (type: string, nullable) firstname = None, # First name (type: string, nullable) italianSDI = None, # Italian SDI (type: string, nullable) language = None, # Language (type: nichandle.LanguageEnum, nullable) legalform = None, # Customer legal form (type: nichandle.LegalFormEnum) name = None, # Customer name (type: string, nullable) nationalIdentificationNumber = None, # National Identification Number (type: string, nullable) organisation = None, # Name of organisation (type: string, nullable) phone = None, # Phone number (type: string, nullable) phoneCountry = None, # (type: nichandle.CountryEnum, nullable) phoneType = None, # Type of phone(mobile, landline) (type: nichandle.PhoneTypeEnum, nullable) purposeOfPurchase = None, # Customer purpose of purchase (type: string, nullable) sex = None, # Gender (type: nichandle.GenderEnum, nullable) spareEmail = None, # Spare email (type: string, nullable) vat = None, # VAT number (type: string, nullable) zip = None, # Zipcode (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/account", array( address => null, // Address of nichandle (type: string, nullable) area => null, // Area of nichandle (type: string, nullable) billingAccount => null, // Billing account to link to the new nic (type: string, nullable) birthCity => null, // City of birth (type: string, nullable) birthDay => null, // Birth date (type: string, nullable) city => null, // City of nichandle (type: string, nullable) companyNationalIdentificationNumber => null, // Company National Identification Number (type: string, nullable) complementaryAddress => null, // Complementary Address (type: string, nullable) corporationType => null, // Corporation type (type: string, nullable) country => null, // Customer country (type: nichandle.CountryEnum) einvoicingBillingAddress => null, // Default e-invoicing billing address (type: string, nullable) email => null, // Email address (type: string, nullable) fax => null, // Fax number (type: string, nullable) firstname => null, // First name (type: string, nullable) italianSDI => null, // Italian SDI (type: string, nullable) language => null, // Language (type: nichandle.LanguageEnum, nullable) legalform => null, // Customer legal form (type: nichandle.LegalFormEnum) name => null, // Customer name (type: string, nullable) nationalIdentificationNumber => null, // National Identification Number (type: string, nullable) organisation => null, // Name of organisation (type: string, nullable) phone => null, // Phone number (type: string, nullable) phoneCountry => null, // (type: nichandle.CountryEnum, nullable) phoneType => null, // Type of phone(mobile, landline) (type: nichandle.PhoneTypeEnum, nullable) purposeOfPurchase => null, // Customer purpose of purchase (type: string, nullable) sex => null, // Gender (type: nichandle.GenderEnum, nullable) spareEmail => null, // Spare email (type: string, nullable) vat => null, // VAT number (type: string, nullable) zip => null, // Zipcode (type: string, nullable) )); print_r($result); ?> ``` ## List of your Api Credentials `GET /1.0/me/api/credential` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-api-credential **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/credential/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `applicationId` | query | integer | | Filter the value of applicationId property (like) | | `status` | query | auth.CredentialStateEnum | | Filter the value of status property (=) — one of `expired`, `pendingValidation`, `refused`, `validated` | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/api/credential" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/api/credential") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/api/credential"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/api/credential/{credentialId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-api-credential-credentialid **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/credential/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `credentialId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | api.Credential | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `allowedIPs` | ipBlock[] | | If defined, list of ip blocks which are allowed to call API with this credential | | `applicationId` | integer | read-only | | | `creation` | string (date-time) | read-only | | | `credentialId` | integer | read-only | | | `expiration` | string (date-time) | read-only | | | `lastUse` | string (date-time) | read-only | | | `ovhSupport` | boolean | read-only | States whether this credential has been created by yourself or by the OVH support team | | `rules` | auth.AccessRule[] | read-only | | | `rules[].method` | http.MethodEnum | | All HTTP methods available — one of `DELETE`, `GET`, `POST`, `PUT` | | `rules[].path` | string | | | | `status` | auth.CredentialStateEnum | read-only | All states a Credential can be in — one of `expired`, `pendingValidation`, `refused`, `validated` | ```json { "allowedIPs": [ "192.0.2.0/24" ], "applicationId": 0, "creation": "2024-01-01T12:00:00Z", "credentialId": 0, "expiration": "2024-01-01T12:00:00Z", "lastUse": "2024-01-01T12:00:00Z", "ovhSupport": true, "rules": [ { "method": "DELETE", "path": "string" } ], "status": "expired" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/api/credential/{credentialId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/api/credential/{credentialId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/api/credential/{credentialId}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/api/credential/{credentialId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-api-credential-credentialid **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/credential/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `credentialId` | path | integer | yes | | ### Request body (required) Type: `api.Credential` | Field | Type | Required | Description | | --- | --- | --- | --- | | `allowedIPs` | ipBlock[] | | If defined, list of ip blocks which are allowed to call API with this credential | | `applicationId` | integer | read-only | | | `creation` | string (date-time) | read-only | | | `credentialId` | integer | read-only | | | `expiration` | string (date-time) | read-only | | | `lastUse` | string (date-time) | read-only | | | `ovhSupport` | boolean | read-only | States whether this credential has been created by yourself or by the OVH support team | | `rules` | auth.AccessRule[] | read-only | | | `rules[].method` | http.MethodEnum | | All HTTP methods available — one of `DELETE`, `GET`, `POST`, `PUT` | | `rules[].path` | string | | | | `status` | auth.CredentialStateEnum | read-only | All states a Credential can be in — one of `expired`, `pendingValidation`, `refused`, `validated` | ```json { "allowedIPs": [ "192.0.2.0/24" ] } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/api/credential/{credentialId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: api.Credential result = client.put("/me/api/credential/{credentialId}", allowedIPs = None, # If defined, list of ip blocks which are allowed to call API with this credential (type: array, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/api/credential/{credentialId}", array( allowedIPs => null, // If defined, list of ip blocks which are allowed to call API with this credential (type: array, nullable) )); print_r($result); ?> ``` ## Remove this credential `DELETE /1.0/me/api/credential/{credentialId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-api-credential-credentialid **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/credential/delete` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `credentialId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/api/credential/{credentialId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/api/credential/{credentialId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/api/credential/{credentialId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/api/credential/{credentialId}/application` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-api-credential-credentialid-application **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/credential/application/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `credentialId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | api.Application | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `applicationId` | integer | read-only | | | `applicationKey` | string | read-only | | | `description` | string | read-only | | | `name` | string | read-only | | | `status` | api.ApplicationStatusEnum | read-only | List of state of an Api Application — one of `active`, `blocked`, `inactive`, `trusted` | ```json { "applicationId": 0, "applicationKey": "string", "description": "string", "name": "string", "status": "active" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/api/credential/{credentialId}/application" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/api/credential/{credentialId}/application") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/api/credential/{credentialId}/application"); print_r($result); ?> ``` ## List of Api calls done with your account `GET /1.0/me/api/logs/self` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-api-logs-self **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/logs/self/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/api/logs/self" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/api/logs/self") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/api/logs/self"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/api/logs/self/{logId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-api-logs-self-logid **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/logs/self/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `logId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | api.Log | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `account` | string | read-only | Account which did the Request | | `date` | string (date-time) | read-only | Date of the request | | `ip` | ip | read-only | Source IP of the request | | `logId` | integer | read-only | | | `method` | http.MethodEnum | read-only | HTTP Method of the request — one of `DELETE`, `GET`, `POST`, `PUT` | | `path` | string | read-only | HTTP URI of the request | | `route` | string | read-only | API Route called | ```json { "account": "string", "date": "2024-01-01T12:00:00Z", "ip": "192.0.2.0", "logId": 0, "method": "DELETE", "path": "string", "route": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/api/logs/self/{logId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/api/logs/self/{logId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/api/logs/self/{logId}"); print_r($result); ?> ``` ## List of Api calls done on services you have access to `GET /1.0/me/api/logs/services` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-api-logs-services **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/logs/services/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/api/logs/services" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/api/logs/services") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/api/logs/services"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/api/logs/services/{logId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-api-logs-services-logid **Status:** Stable production version **IAM actions:** `account:apiovh:me/api/logs/services/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `logId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | api.Log | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `account` | string | read-only | Account which did the Request | | `date` | string (date-time) | read-only | Date of the request | | `ip` | ip | read-only | Source IP of the request | | `logId` | integer | read-only | | | `method` | http.MethodEnum | read-only | HTTP Method of the request — one of `DELETE`, `GET`, `POST`, `PUT` | | `path` | string | read-only | HTTP URI of the request | | `route` | string | read-only | API Route called | ```json { "account": "string", "date": "2024-01-01T12:00:00Z", "ip": "192.0.2.0", "logId": 0, "method": "DELETE", "path": "string", "route": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/api/logs/services/{logId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/api/logs/services/{logId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/api/logs/services/{logId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/autorenew` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-autorenew **Status:** Stable production version **IAM actions:** `account:apiovh:me/autorenew/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.NicAutorenewInfos | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `active` | boolean | | Renewal active or not | | `lastRenew` | string (date-time) | read-only | give the last renew | | `renewDay` | integer | | give the renewal day | ```json { "active": true, "lastRenew": "2024-01-01T12:00:00Z", "renewDay": 0 } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/autorenew" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/autorenew") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/autorenew"); print_r($result); ?> ``` ## Activate auto renew for this nic `POST /1.0/me/autorenew` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-autorenew **Status:** Stable production version **IAM actions:** `account:apiovh:me/autorenew/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `renewDay` | integer | yes | Day of autorenew | ```json { "renewDay": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/autorenew" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: long result = client.post("/me/autorenew", renewDay = None, # Day of autorenew (type: long) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/autorenew", array( renewDay => null, // Day of autorenew (type: long) )); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/autorenew` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-autorenew **Status:** Stable production version **IAM actions:** `account:apiovh:me/autorenew/edit` ### Request body (required) Type: `nichandle.NicAutorenewInfos` | Field | Type | Required | Description | | --- | --- | --- | --- | | `active` | boolean | | Renewal active or not | | `lastRenew` | string (date-time) | read-only | give the last renew | | `renewDay` | integer | | give the renewal day | ```json { "active": true, "renewDay": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/autorenew" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.NicAutorenewInfos result = client.put("/me/autorenew", active = None, # Renewal active or not (type: boolean) renewDay = None, # give the renewal day (type: integer) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/autorenew", array( active => null, // Renewal active or not (type: boolean) renewDay => null, // give the renewal day (type: integer) )); print_r($result); ?> ``` ## List available payment methods in this Nic's country `GET /1.0/me/availableAutomaticPaymentMeans` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-availableautomaticpaymentmeans **Status:** Stable production version **IAM actions:** `account:apiovh:me/availableAutomaticPaymentMeans/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.AutomaticPaymentMean | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `bankAccount` | boolean | | Bank Account | | `creditCard` | boolean | | Credit Card | | `deferredPaymentAccount` | boolean | | Deferred invoice payment account for authorized customers | | `paypal` | boolean | | Paypal account | ```json { "bankAccount": true, "creditCard": true, "deferredPaymentAccount": true, "paypal": true } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/availableAutomaticPaymentMeans" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/availableAutomaticPaymentMeans") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/availableAutomaticPaymentMeans"); print_r($result); ?> ``` ## List of all the bills the logged account has `GET /1.0/me/bill` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `category` | query | billing.CategoryEnum | | Filter the value of category property (=) — one of `autorenew`, `earlyrenewal`, `purchase`, `purchase-cloud`, `purchase-servers`, `purchase-telecom`, `purchase-web` | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `orderId` | query | integer | | Filter the value of orderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill"); print_r($result); ?> ``` ## Exports a bundle of invoices `POST /1.0/me/bill/export` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-bill-export **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/export` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `archiveType` | billing.ArchiveTypeEnum | yes | The file type of the archive — one of `csv`, `zip` | | `endDate` | string (date-time) | | End interval of the export | | `ids` | string[] | | A list of ids to export | | `startDate` | string (date-time) | | Start interval of the export | ```json { "archiveType": "csv", "endDate": "2024-01-01T12:00:00Z", "ids": [ "string" ], "startDate": "2024-01-01T12:00:00Z" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/bill/export" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/bill/export", archiveType = None, # The file type of the archive (type: billing.ArchiveTypeEnum) endDate = None, # End interval of the export (type: datetime, nullable) ids = None, # A list of ids to export (type: string[], nullable) startDate = None, # Start interval of the export (type: datetime, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/bill/export", array( archiveType => null, // The file type of the archive (type: billing.ArchiveTypeEnum) endDate => null, // End interval of the export (type: datetime, nullable) ids => null, // A list of ids to export (type: string[], nullable) startDate => null, // Start interval of the export (type: datetime, nullable) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/bill/{billId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Bill | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `billId` | string | read-only | | | `category` | billing.CategoryEnum | read-only | Types of plans — one of `autorenew`, `earlyrenewal`, `purchase`, `purchase-cloud`, `purchase-servers`, `purchase-telecom`, `purchase-web` | | `date` | string (date-time) | read-only | | | `eInvoicingId` | string | read-only | | | `eInvoicingStatus` | billing.EInvoicingStatusEnum | read-only | List of available eInvoicing Status types — one of `accepted`, `error`, `ignored`, `invalid`, `new`, `ok`, `processing`, `readyToSubmit`, `rejected`, `submitted` | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "billId": "string", "category": "autorenew", "date": "2024-01-01T12:00:00Z", "eInvoicingId": "string", "eInvoicingStatus": "accepted", "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/bill/{billId}/debt` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid-debt **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/debt/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Debt | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Original amount of the debt | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the debt was created on | | `debtId` | integer | read-only | | | `dueAmount` | order.Price | read-only | Amount you still owe for that debt | | `dueAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `dueAmount.text` | string | | | | `dueAmount.value` | number | | | | `dueDate` | string (date-time) | read-only | If specified, the debt will not be recovered before that date | | `orderId` | integer | read-only | The order the debt relates to | | `pendingAmount` | order.Price | read-only | Amount currently being processed | | `pendingAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `pendingAmount.text` | string | | | | `pendingAmount.value` | number | | | | `status` | debt.entry.StatusDebtOrderEnum | read-only | Status of a debt — one of `PAID`, `REFUNDED`, `TO_BE_PAID`, `UNMATURED`, `UNPAID`, `WRITE_OFF` | | `todoAmount` | order.Price | read-only | Reserved amount awaiting payment | | `todoAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `todoAmount.text` | string | | | | `todoAmount.value` | number | | | | `unmaturedAmount` | order.Price | read-only | Unmatured amount for deferred payment term | | `unmaturedAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unmaturedAmount.text` | string | | | | `unmaturedAmount.value` | number | | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "debtId": 0, "dueAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "dueDate": "2024-01-01T12:00:00Z", "orderId": 0, "pendingAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "status": "PAID", "todoAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unmaturedAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/debt" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}/debt") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}/debt"); print_r($result); ?> ``` ## All operations related to these debts `GET /1.0/me/bill/{billId}/debt/operation` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid-debt-operation **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositOrderId` | query | integer | | Filter the value of depositOrderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/debt/operation" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}/debt/operation") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}/debt/operation"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/bill/{billId}/debt/operation/{operationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid-debt-operation-operationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Operation | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Amount of the operation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the operation took place on | | `depositOrderId` | integer | read-only | Order id associated to the deposit | | `operationId` | integer | read-only | | | `status` | debt.entry.StatusEnum | read-only | Status of the operation — one of `CANCELLED`, `DONE`, `FAILED`, `PAID`, `PENDING`, `TODO` | | `type` | debt.entry.OperationEnum | read-only | Type of movement this operation represents — one of `BANK_TRANSFER_MANUAL`, `CANCEL`, `CASH_MANUAL`, `CHECK_MANUAL`, `CREDITCARD`, `CREDITCARD_AUTOMATIC`, `CREDITCARD_MANUAL`, `CREDIT_ACCOUNT_AUTOMATIC`, `CREDIT_CARD_AUTOMATIC`, `CREDIT_CARD_MANUAL`, `CURRENT_ACCOUNT_AUTOMATIC`, `CURRENT_ACCOUNT_MANUAL`, … | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "depositOrderId": 0, "operationId": 0, "status": "CANCELLED", "type": "BANK_TRANSFER_MANUAL" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/debt/operation/{operationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}/debt/operation/{operationId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}/debt/operation/{operationId}"); print_r($result); ?> ``` ## Return main data about the object related to this debt operation `GET /1.0/me/bill/{billId}/debt/operation/{operationId}/associatedObject` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid-debt-operation-operationid-associatedobject **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/debt/operation/associatedObject/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.entry.AssociatedObject | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | | | | `paymentInfo` | debt.associatedObject.PaymentInfo | | The payment infos linked to this debt entry | | `paymentInfo.description` | string | | Optional customer description | | `paymentInfo.paymentType` | billing.PaymentMeanEnum | | Payment mean used for this debt operation — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | | `paymentInfo.publicLabel` | string | | Public payment mean label | | `subId` | string | | | | `type` | debt.associatedObject.TypeEnum | | Type of objects an order can be linked to — one of `Bill`, `DebtOperation`, `Deposit`, `Order`, `OvhAccountMovement`, `Refund`, `Withdrawal` | ```json { "id": "string", "paymentInfo": { "description": "string", "paymentType": "cash", "publicLabel": "string" }, "subId": "string", "type": "Bill" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/debt/operation/{operationId}/associatedObject" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}/debt/operation/{operationId}/associatedObject") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}/debt/operation/{operationId}/associatedObject"); print_r($result); ?> ``` ## Create an order in order to pay this order's debt `POST /1.0/me/bill/{billId}/debt/pay` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-bill-billid-debt-pay **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/debt/pay` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/debt/pay" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/bill/{billId}/debt/pay") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/bill/{billId}/debt/pay"); print_r($result); ?> ``` ## Give access to all entries of the bill `GET /1.0/me/bill/{billId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/bill/{billId}/details/{billDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid-details-billdetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billDetailId` | path | string | yes | | | `billId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.BillDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `billDetailId` | string | read-only | | | `description` | string | read-only | | | `domain` | string | read-only | | | `periodEnd` | string (date) | read-only | | | `periodStart` | string (date) | read-only | | | `quantity` | string | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.LongPrice | read-only | LongPrice with all digits and its currency and a textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | ```json { "billDetailId": "string", "description": "string", "domain": "string", "periodEnd": "2024-01-01", "periodStart": "2024-01-01", "quantity": "string", "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/details/{billDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}/details/{billDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}/details/{billDetailId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/bill/{billId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bill-billid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/bill/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bill/{billId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bill/{billId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bill/{billId}/payment"); print_r($result); ?> ``` ## Send invoices through postal mail `GET /1.0/me/billing/invoicesByPostalMail` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-billing-invoicesbypostalmail **Status:** Beta version **IAM actions:** `account:apiovh:me/billing/invoicesByPostalMail/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | boolean | successful operation | ```json true ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/billing/invoicesByPostalMail" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/billing/invoicesByPostalMail") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/billing/invoicesByPostalMail"); print_r($result); ?> ``` ## Enable or disable invoices by postal mail `POST /1.0/me/billing/invoicesByPostalMail` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-billing-invoicesbypostalmail **Status:** Beta version **IAM actions:** `account:apiovh:me/billing/invoicesByPostalMail/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `enable` | boolean | yes | Send invoices through postal mail | ```json { "enable": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/billing/invoicesByPostalMail" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: boolean result = client.post("/me/billing/invoicesByPostalMail", enable = None, # Send invoices through postal mail (type: boolean) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/billing/invoicesByPostalMail", array( enable => null, // Send invoices through postal mail (type: boolean) )); print_r($result); ?> ``` ## Get your Bring your own IP token `GET /1.0/me/bringYourOwnIp/token` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-bringyourownip-token **Status:** Beta version **IAM actions:** `account:apiovh:me/bringYourOwnIp/token/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `campus` | query | ip.CampusEnum | yes | Campus where you plan to bring your own IP range in. See /ip/campus to get more details. — one of `BHS`, `ERI`, `GRA`, `HIL`, `LIM`, `MIL`, `PAR`, `RBX`, `SBG`, `SGP`, `SYD`, `VIN`, … | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string | successful operation | ```json "string" ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/bringYourOwnIp/token" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/bringYourOwnIp/token") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/bringYourOwnIp/token"); print_r($result); ?> ``` ## Get all certificates of the account `GET /1.0/me/certificates` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#getCertificates **Status:** Alpha version **IAM actions:** `account:apiovh:me/certificates/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `name` | query | string | | Certificate definition name | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/certificates" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/certificates") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/certificates"); print_r($result); ?> ``` ## Initiate an email change procedure `POST /1.0/me/changeEmail` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-changeemail **Status:** Stable production version **IAM actions:** `account:apiovh:me/changeEmail` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `newEmail` | string | yes | New email to associate to your account | ```json { "newEmail": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.emailChange.Task | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `dateDone` | string (date-time) | read-only | End date of that request | | `dateRequest` | string (date-time) | read-only | Creation date of that request | | `id` | integer | read-only | | | `newEmail` | string | read-only | The email address to change for | | `state` | nichandle.changeEmail.TaskStateEnum | read-only | Current state of the request — one of `aborted`, `done`, `refused`, `todo` | ```json { "dateDone": "2024-01-01T12:00:00Z", "dateRequest": "2024-01-01T12:00:00Z", "id": 0, "newEmail": "string", "state": "aborted" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/changeEmail" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/changeEmail", newEmail = None, # New email to associate to your account (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/changeEmail", array( newEmail => null, // New email to associate to your account (type: string) )); print_r($result); ?> ``` ## Initiate a password change procedure `POST /1.0/me/changePassword` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-changepassword **Status:** Stable production version ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/changePassword" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/changePassword") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/changePassword"); print_r($result); ?> ``` ## List all consent campaign available `GET /1.0/me/consent` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-consent **Status:** Stable production version **IAM actions:** `account:apiovh:me/consent/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.consent.Campaign[] | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | read-only | Campaign description | | `name` | string | read-only | Campaign name | | `type` | me.consent.CampaignTypeEnum | read-only | Campaign type — one of `OPTIN`, `OPTOUT` | ```json [ { "description": "string", "name": "string", "type": "OPTIN" } ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/consent" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/consent") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/consent"); print_r($result); ?> ``` ## Retrieve information about a consent campaign `GET /1.0/me/consent/{campaignName}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-consent-campaignname **Status:** Stable production version **IAM actions:** `account:apiovh:me/consent/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `campaignName` | path | string | yes | Campaign name | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.consent.Campaign | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | read-only | Campaign description | | `name` | string | read-only | Campaign name | | `type` | me.consent.CampaignTypeEnum | read-only | Campaign type — one of `OPTIN`, `OPTOUT` | ```json { "description": "string", "name": "string", "type": "OPTIN" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/consent/{campaignName}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/consent/{campaignName}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/consent/{campaignName}"); print_r($result); ?> ``` ## Get decision value for a consent campaign `GET /1.0/me/consent/{campaignName}/decision` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-consent-campaignname-decision **Status:** Stable production version **IAM actions:** `account:apiovh:me/consent/decision/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `campaignName` | path | string | yes | Campaign name | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.consent.Consent | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `campaign` | string | read-only | Campaign name | | `history` | me.consent.Decision[] | read-only | Consent decisions history for this campaign | | `history[].pixel` | me.consent.PixelUpdate | | Optional pixel tracking consent update | | `history[].pixel.value` | boolean | yes | Pixel tracking consent value | | `history[].timestamp` | string (date-time) | read-only | Consent decision datetime | | `history[].value` | boolean | | Consent decision value | | `pixel` | me.consent.Pixel | read-only | Optional pixel tracking consent | | `pixel.history` | me.consent.Decision[] | read-only | Pixel tracking consent decisions history | | `pixel.history[].pixel` | me.consent.PixelUpdate | | Optional pixel tracking consent update | | `pixel.history[].timestamp` | string (date-time) | read-only | Consent decision datetime | | `pixel.history[].value` | boolean | | Consent decision value | | `pixel.value` | boolean | read-only | Current pixel tracking consent value | | `type` | me.consent.CampaignTypeEnum | read-only | Campaign type — one of `OPTIN`, `OPTOUT` | | `value` | boolean | read-only | Current email consent value | ```json { "campaign": "string", "history": [ { "pixel": { "value": true }, "timestamp": "2024-01-01T12:00:00Z", "value": true } ], "pixel": { "history": [ { "pixel": { "value": true }, "timestamp": "2024-01-01T12:00:00Z", "value": true } ], "value": true }, "type": "OPTIN", "value": true } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/consent/{campaignName}/decision" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/consent/{campaignName}/decision") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/consent/{campaignName}/decision"); print_r($result); ?> ``` ## Update decision of a consent campaign `PUT /1.0/me/consent/{campaignName}/decision` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-consent-campaignname-decision **Status:** Stable production version **IAM actions:** `account:apiovh:me/consent/decision/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `campaignName` | path | string | yes | Campaign name | ### Request body (required) Type: `me.consent.Decision` | Field | Type | Required | Description | | --- | --- | --- | --- | | `pixel` | me.consent.PixelUpdate | | Optional pixel tracking consent update | | `pixel.value` | boolean | yes | Pixel tracking consent value | | `timestamp` | string (date-time) | read-only | Consent decision datetime | | `value` | boolean | | Consent decision value | ```json { "pixel": { "value": true }, "value": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/consent/{campaignName}/decision" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: me.consent.Decision result = client.put("/me/consent/{campaignName}/decision", pixel = None, # Optional pixel tracking consent update (type: me.consent.PixelUpdate) value = None, # Consent decision value (type: boolean) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/consent/{campaignName}/decision", array( pixel => null, // Optional pixel tracking consent update (type: me.consent.PixelUpdate) value => null, // Consent decision value (type: boolean) )); print_r($result); ?> ``` ## Retrieve every contact your created `GET /1.0/me/contact` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-contact **Status:** Stable production version **IAM actions:** `account:apiovh:me/contact/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/contact" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/contact") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/contact"); print_r($result); ?> ``` ## Create a new contact `POST /1.0/me/contact` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-contact **Status:** Stable production version **IAM actions:** `account:apiovh:me/contact/create` ### Request body (required) Type: `me.contact.Contact` | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | me.contact.Address | | Address for this contact | | `address.city` | string | | City | | `address.country` | nichandle.CountryEnum | | Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `address.line1` | string | | First line of the address | | `address.line2` | string | | Second line of the address | | `address.line3` | string | | Third line of the address | | `address.otherDetails` | string | | Other details | | `address.province` | string | | Province name | | `address.zip` | string | | Zipcode | | `birthCity` | string | | Birth city | | `birthCountry` | nichandle.CountryEnum | | Birth Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `birthDay` | string (date) | | Birth date | | `birthZip` | string | | Birth Zipcode | | `cellPhone` | phoneNumber | | Cellphone number | | `companyNationalIdentificationNumber` | string | | National identification number of your company | | `email` | string | | Email address | | `fax` | phoneNumber | | Fax number | | `firstName` | string | | First name | | `gender` | nichandle.GenderEnum | | Gender — one of `female`, `male` | | `id` | integer | read-only | Contact Identifier | | `language` | nichandle.LanguageEnum | | Language — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `lastName` | string | | Last name | | `legalForm` | nichandle.LegalFormEnum | | Legal form of the contact — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `nationalIdentificationNumber` | string | | National identification number of the contact | | `nationality` | nichandle.CountryEnum | | Nationality — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `organisationName` | string | | Organisation name | | `organisationType` | string | | Organisation type | | `phone` | phoneNumber | | Telephone number | | `spareEmail` | string | | Spare email address | | `vat` | string | | VAT number | ```json { "address": { "city": "string", "country": "AC", "line1": "string", "line2": "string", "line3": "string", "otherDetails": "string", "province": "string", "zip": "string" }, "birthCity": "string", "birthCountry": "AC", "birthDay": "2024-01-01", "birthZip": "string", "cellPhone": "string", "companyNationalIdentificationNumber": "string", "email": "string", "fax": "string", "firstName": "string", "gender": "female", "language": "cs_CZ", "lastName": "string", "legalForm": "administration", "nationalIdentificationNumber": "string", "nationality": "AC", "organisationName": "string", "organisationType": "string", "phone": "string", "spareEmail": "string", "vat": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.contact.Contact | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | me.contact.Address | | Address for this contact | | `address.city` | string | | City | | `address.country` | nichandle.CountryEnum | | Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `address.line1` | string | | First line of the address | | `address.line2` | string | | Second line of the address | | `address.line3` | string | | Third line of the address | | `address.otherDetails` | string | | Other details | | `address.province` | string | | Province name | | `address.zip` | string | | Zipcode | | `birthCity` | string | | Birth city | | `birthCountry` | nichandle.CountryEnum | | Birth Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `birthDay` | string (date) | | Birth date | | `birthZip` | string | | Birth Zipcode | | `cellPhone` | phoneNumber | | Cellphone number | | `companyNationalIdentificationNumber` | string | | National identification number of your company | | `email` | string | | Email address | | `fax` | phoneNumber | | Fax number | | `firstName` | string | | First name | | `gender` | nichandle.GenderEnum | | Gender — one of `female`, `male` | | `id` | integer | read-only | Contact Identifier | | `language` | nichandle.LanguageEnum | | Language — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `lastName` | string | | Last name | | `legalForm` | nichandle.LegalFormEnum | | Legal form of the contact — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `nationalIdentificationNumber` | string | | National identification number of the contact | | `nationality` | nichandle.CountryEnum | | Nationality — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `organisationName` | string | | Organisation name | | `organisationType` | string | | Organisation type | | `phone` | phoneNumber | | Telephone number | | `spareEmail` | string | | Spare email address | | `vat` | string | | VAT number | ```json { "address": { "city": "string", "country": "AC", "line1": "string", "line2": "string", "line3": "string", "otherDetails": "string", "province": "string", "zip": "string" }, "birthCity": "string", "birthCountry": "AC", "birthDay": "2024-01-01", "birthZip": "string", "cellPhone": "string", "companyNationalIdentificationNumber": "string", "email": "string", "fax": "string", "firstName": "string", "gender": "female", "id": 0, "language": "cs_CZ", "lastName": "string", "legalForm": "administration", "nationalIdentificationNumber": "string", "nationality": "AC", "organisationName": "string", "organisationType": "string", "phone": "string", "spareEmail": "string", "vat": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/contact" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: me.contact.Contact result = client.post("/me/contact", address = None, # Address for this contact (type: me.contact.Address) birthCity = None, # Birth city (type: string, nullable) birthCountry = None, # Birth Country (type: nichandle.CountryEnum, nullable) birthDay = None, # Birth date (type: string, nullable) birthZip = None, # Birth Zipcode (type: string, nullable) cellPhone = None, # Cellphone number (type: phoneNumber, nullable) companyNationalIdentificationNumber = None, # National identification number of your company (type: string, nullable) email = None, # Email address (type: string) fax = None, # Fax number (type: phoneNumber, nullable) firstName = None, # First name (type: string) gender = None, # Gender (type: nichandle.GenderEnum, nullable) language = None, # Language (type: nichandle.LanguageEnum) lastName = None, # Last name (type: string) legalForm = None, # Legal form of the contact (type: nichandle.LegalFormEnum) nationalIdentificationNumber = None, # National identification number of the contact (type: string, nullable) nationality = None, # Nationality (type: nichandle.CountryEnum, nullable) organisationName = None, # Organisation name (type: string, nullable) organisationType = None, # Organisation type (type: string, nullable) phone = None, # Telephone number (type: phoneNumber, nullable) spareEmail = None, # Spare email address (type: string, nullable) vat = None, # VAT number (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/contact", array( address => null, // Address for this contact (type: me.contact.Address) birthCity => null, // Birth city (type: string, nullable) birthCountry => null, // Birth Country (type: nichandle.CountryEnum, nullable) birthDay => null, // Birth date (type: string, nullable) birthZip => null, // Birth Zipcode (type: string, nullable) cellPhone => null, // Cellphone number (type: phoneNumber, nullable) companyNationalIdentificationNumber => null, // National identification number of your company (type: string, nullable) email => null, // Email address (type: string) fax => null, // Fax number (type: phoneNumber, nullable) firstName => null, // First name (type: string) gender => null, // Gender (type: nichandle.GenderEnum, nullable) language => null, // Language (type: nichandle.LanguageEnum) lastName => null, // Last name (type: string) legalForm => null, // Legal form of the contact (type: nichandle.LegalFormEnum) nationalIdentificationNumber => null, // National identification number of the contact (type: string, nullable) nationality => null, // Nationality (type: nichandle.CountryEnum, nullable) organisationName => null, // Organisation name (type: string, nullable) organisationType => null, // Organisation type (type: string, nullable) phone => null, // Telephone number (type: phoneNumber, nullable) spareEmail => null, // Spare email address (type: string, nullable) vat => null, // VAT number (type: string, nullable) )); print_r($result); ?> ``` ## Retrieve information about a contact `GET /1.0/me/contact/{contactId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-contact-contactid **Status:** Stable production version **IAM actions:** `account:apiovh:me/contact/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `contactId` | path | integer | yes | Contact ID | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.contact.Contact | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | me.contact.Address | | Address for this contact | | `address.city` | string | | City | | `address.country` | nichandle.CountryEnum | | Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `address.line1` | string | | First line of the address | | `address.line2` | string | | Second line of the address | | `address.line3` | string | | Third line of the address | | `address.otherDetails` | string | | Other details | | `address.province` | string | | Province name | | `address.zip` | string | | Zipcode | | `birthCity` | string | | Birth city | | `birthCountry` | nichandle.CountryEnum | | Birth Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `birthDay` | string (date) | | Birth date | | `birthZip` | string | | Birth Zipcode | | `cellPhone` | phoneNumber | | Cellphone number | | `companyNationalIdentificationNumber` | string | | National identification number of your company | | `email` | string | | Email address | | `fax` | phoneNumber | | Fax number | | `firstName` | string | | First name | | `gender` | nichandle.GenderEnum | | Gender — one of `female`, `male` | | `id` | integer | read-only | Contact Identifier | | `language` | nichandle.LanguageEnum | | Language — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `lastName` | string | | Last name | | `legalForm` | nichandle.LegalFormEnum | | Legal form of the contact — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `nationalIdentificationNumber` | string | | National identification number of the contact | | `nationality` | nichandle.CountryEnum | | Nationality — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `organisationName` | string | | Organisation name | | `organisationType` | string | | Organisation type | | `phone` | phoneNumber | | Telephone number | | `spareEmail` | string | | Spare email address | | `vat` | string | | VAT number | ```json { "address": { "city": "string", "country": "AC", "line1": "string", "line2": "string", "line3": "string", "otherDetails": "string", "province": "string", "zip": "string" }, "birthCity": "string", "birthCountry": "AC", "birthDay": "2024-01-01", "birthZip": "string", "cellPhone": "string", "companyNationalIdentificationNumber": "string", "email": "string", "fax": "string", "firstName": "string", "gender": "female", "id": 0, "language": "cs_CZ", "lastName": "string", "legalForm": "administration", "nationalIdentificationNumber": "string", "nationality": "AC", "organisationName": "string", "organisationType": "string", "phone": "string", "spareEmail": "string", "vat": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/contact/{contactId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/contact/{contactId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/contact/{contactId}"); print_r($result); ?> ``` ## Update an existing contact `PUT /1.0/me/contact/{contactId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-contact-contactid **Status:** Stable production version **IAM actions:** `account:apiovh:me/contact/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `contactId` | path | integer | yes | Contact ID | ### Request body (required) Type: `me.contact.Contact` | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | me.contact.Address | | Address for this contact | | `address.city` | string | | City | | `address.country` | nichandle.CountryEnum | | Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `address.line1` | string | | First line of the address | | `address.line2` | string | | Second line of the address | | `address.line3` | string | | Third line of the address | | `address.otherDetails` | string | | Other details | | `address.province` | string | | Province name | | `address.zip` | string | | Zipcode | | `birthCity` | string | | Birth city | | `birthCountry` | nichandle.CountryEnum | | Birth Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `birthDay` | string (date) | | Birth date | | `birthZip` | string | | Birth Zipcode | | `cellPhone` | phoneNumber | | Cellphone number | | `companyNationalIdentificationNumber` | string | | National identification number of your company | | `email` | string | | Email address | | `fax` | phoneNumber | | Fax number | | `firstName` | string | | First name | | `gender` | nichandle.GenderEnum | | Gender — one of `female`, `male` | | `id` | integer | read-only | Contact Identifier | | `language` | nichandle.LanguageEnum | | Language — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `lastName` | string | | Last name | | `legalForm` | nichandle.LegalFormEnum | | Legal form of the contact — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `nationalIdentificationNumber` | string | | National identification number of the contact | | `nationality` | nichandle.CountryEnum | | Nationality — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `organisationName` | string | | Organisation name | | `organisationType` | string | | Organisation type | | `phone` | phoneNumber | | Telephone number | | `spareEmail` | string | | Spare email address | | `vat` | string | | VAT number | ```json { "address": { "city": "string", "country": "AC", "line1": "string", "line2": "string", "line3": "string", "otherDetails": "string", "province": "string", "zip": "string" }, "birthCity": "string", "birthCountry": "AC", "birthDay": "2024-01-01", "birthZip": "string", "cellPhone": "string", "companyNationalIdentificationNumber": "string", "email": "string", "fax": "string", "firstName": "string", "gender": "female", "language": "cs_CZ", "lastName": "string", "legalForm": "administration", "nationalIdentificationNumber": "string", "nationality": "AC", "organisationName": "string", "organisationType": "string", "phone": "string", "spareEmail": "string", "vat": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.contact.Contact | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `address` | me.contact.Address | | Address for this contact | | `address.city` | string | | City | | `address.country` | nichandle.CountryEnum | | Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `address.line1` | string | | First line of the address | | `address.line2` | string | | Second line of the address | | `address.line3` | string | | Third line of the address | | `address.otherDetails` | string | | Other details | | `address.province` | string | | Province name | | `address.zip` | string | | Zipcode | | `birthCity` | string | | Birth city | | `birthCountry` | nichandle.CountryEnum | | Birth Country — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `birthDay` | string (date) | | Birth date | | `birthZip` | string | | Birth Zipcode | | `cellPhone` | phoneNumber | | Cellphone number | | `companyNationalIdentificationNumber` | string | | National identification number of your company | | `email` | string | | Email address | | `fax` | phoneNumber | | Fax number | | `firstName` | string | | First name | | `gender` | nichandle.GenderEnum | | Gender — one of `female`, `male` | | `id` | integer | read-only | Contact Identifier | | `language` | nichandle.LanguageEnum | | Language — one of `cs_CZ`, `de_DE`, `en_AU`, `en_CA`, `en_GB`, `en_IE`, `en_US`, `es_ES`, `fi_FI`, `fr_CA`, `fr_FR`, `fr_MA`, … | | `lastName` | string | | Last name | | `legalForm` | nichandle.LegalFormEnum | | Legal form of the contact — one of `administration`, `association`, `corporation`, `individual`, `other`, `personalcorporation` | | `nationalIdentificationNumber` | string | | National identification number of the contact | | `nationality` | nichandle.CountryEnum | | Nationality — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `organisationName` | string | | Organisation name | | `organisationType` | string | | Organisation type | | `phone` | phoneNumber | | Telephone number | | `spareEmail` | string | | Spare email address | | `vat` | string | | VAT number | ```json { "address": { "city": "string", "country": "AC", "line1": "string", "line2": "string", "line3": "string", "otherDetails": "string", "province": "string", "zip": "string" }, "birthCity": "string", "birthCountry": "AC", "birthDay": "2024-01-01", "birthZip": "string", "cellPhone": "string", "companyNationalIdentificationNumber": "string", "email": "string", "fax": "string", "firstName": "string", "gender": "female", "id": 0, "language": "cs_CZ", "lastName": "string", "legalForm": "administration", "nationalIdentificationNumber": "string", "nationality": "AC", "organisationName": "string", "organisationType": "string", "phone": "string", "spareEmail": "string", "vat": "string" } ``` ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/contact/{contactId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: me.contact.Contact result = client.put("/me/contact/{contactId}", address = None, # Address for this contact (type: me.contact.Address) birthCity = None, # Birth city (type: string, nullable) birthCountry = None, # Birth Country (type: nichandle.CountryEnum, nullable) birthDay = None, # Birth date (type: string, nullable) birthZip = None, # Birth Zipcode (type: string, nullable) cellPhone = None, # Cellphone number (type: phoneNumber, nullable) companyNationalIdentificationNumber = None, # National identification number of your company (type: string, nullable) email = None, # Email address (type: string) fax = None, # Fax number (type: phoneNumber, nullable) firstName = None, # First name (type: string) gender = None, # Gender (type: nichandle.GenderEnum, nullable) language = None, # Language (type: nichandle.LanguageEnum) lastName = None, # Last name (type: string) legalForm = None, # Legal form of the contact (type: nichandle.LegalFormEnum) nationalIdentificationNumber = None, # National identification number of the contact (type: string, nullable) nationality = None, # Nationality (type: nichandle.CountryEnum, nullable) organisationName = None, # Organisation name (type: string, nullable) organisationType = None, # Organisation type (type: string, nullable) phone = None, # Telephone number (type: phoneNumber, nullable) spareEmail = None, # Spare email address (type: string, nullable) vat = None, # VAT number (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/contact/{contactId}", array( address => null, // Address for this contact (type: me.contact.Address) birthCity => null, // Birth city (type: string, nullable) birthCountry => null, // Birth Country (type: nichandle.CountryEnum, nullable) birthDay => null, // Birth date (type: string, nullable) birthZip => null, // Birth Zipcode (type: string, nullable) cellPhone => null, // Cellphone number (type: phoneNumber, nullable) companyNationalIdentificationNumber => null, // National identification number of your company (type: string, nullable) email => null, // Email address (type: string) fax => null, // Fax number (type: phoneNumber, nullable) firstName => null, // First name (type: string) gender => null, // Gender (type: nichandle.GenderEnum, nullable) language => null, // Language (type: nichandle.LanguageEnum) lastName => null, // Last name (type: string) legalForm => null, // Legal form of the contact (type: nichandle.LegalFormEnum) nationalIdentificationNumber => null, // National identification number of the contact (type: string, nullable) nationality => null, // Nationality (type: nichandle.CountryEnum, nullable) organisationName => null, // Organisation name (type: string, nullable) organisationType => null, // Organisation type (type: string, nullable) phone => null, // Telephone number (type: phoneNumber, nullable) spareEmail => null, // Spare email address (type: string, nullable) vat => null, // VAT number (type: string, nullable) )); print_r($result); ?> ``` ## Get mandatory/read-only information about the fields of a contact `GET /1.0/me/contact/{contactId}/fields` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-contact-contactid-fields **Status:** Stable production version **IAM actions:** `account:apiovh:me/contact/fields/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `contactId` | path | integer | yes | Contact ID | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.contact.FieldInformation[] | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `fieldName` | string | read-only | Name of the field concerned by restrictions | | `mandatory` | boolean | read-only | Indicates if the field is mandatory when editing | | `readOnly` | boolean | read-only | Indicates if the field can't be edited | ```json [ { "fieldName": "string", "mandatory": true, "readOnly": true } ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/contact/{contactId}/fields" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/contact/{contactId}/fields") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/contact/{contactId}/fields"); print_r($result); ?> ``` ## List of all the correctiveInvoice the logged account has `GET /1.0/me/correctiveInvoice` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `category` | query | billing.CategoryEnum | | Filter the value of category property (=) — one of `autorenew`, `earlyrenewal`, `purchase`, `purchase-cloud`, `purchase-servers`, `purchase-telecom`, `purchase-web` | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `orderId` | query | integer | | Filter the value of orderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.CorrectiveInvoice | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `category` | billing.CategoryEnum | read-only | Types of plans — one of `autorenew`, `earlyrenewal`, `purchase`, `purchase-cloud`, `purchase-servers`, `purchase-telecom`, `purchase-web` | | `correctedInvoiceId` | string | read-only | | | `correctiveInvoiceId` | string | read-only | | | `date` | string (date-time) | read-only | | | `eInvoicingId` | string | read-only | | | `eInvoicingStatus` | billing.EInvoicingStatusEnum | read-only | List of available eInvoicing Status types — one of `accepted`, `error`, `ignored`, `invalid`, `new`, `ok`, `processing`, `readyToSubmit`, `rejected`, `submitted` | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "category": "autorenew", "correctedInvoiceId": "string", "correctiveInvoiceId": "string", "date": "2024-01-01T12:00:00Z", "eInvoicingId": "string", "eInvoicingStatus": "accepted", "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid-debt **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/debt/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Debt | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Original amount of the debt | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the debt was created on | | `debtId` | integer | read-only | | | `dueAmount` | order.Price | read-only | Amount you still owe for that debt | | `dueAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `dueAmount.text` | string | | | | `dueAmount.value` | number | | | | `dueDate` | string (date-time) | read-only | If specified, the debt will not be recovered before that date | | `orderId` | integer | read-only | The order the debt relates to | | `pendingAmount` | order.Price | read-only | Amount currently being processed | | `pendingAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `pendingAmount.text` | string | | | | `pendingAmount.value` | number | | | | `status` | debt.entry.StatusDebtOrderEnum | read-only | Status of a debt — one of `PAID`, `REFUNDED`, `TO_BE_PAID`, `UNMATURED`, `UNPAID`, `WRITE_OFF` | | `todoAmount` | order.Price | read-only | Reserved amount awaiting payment | | `todoAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `todoAmount.text` | string | | | | `todoAmount.value` | number | | | | `unmaturedAmount` | order.Price | read-only | Unmatured amount for deferred payment term | | `unmaturedAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unmaturedAmount.text` | string | | | | `unmaturedAmount.value` | number | | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "debtId": 0, "dueAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "dueDate": "2024-01-01T12:00:00Z", "orderId": 0, "pendingAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "status": "PAID", "todoAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unmaturedAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}/debt") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}/debt"); print_r($result); ?> ``` ## All operations related to these debts `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid-debt-operation **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | | `depositOrderId` | query | integer | | Filter the value of depositOrderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid-debt-operation-operationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Operation | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Amount of the operation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the operation took place on | | `depositOrderId` | integer | read-only | Order id associated to the deposit | | `operationId` | integer | read-only | | | `status` | debt.entry.StatusEnum | read-only | Status of the operation — one of `CANCELLED`, `DONE`, `FAILED`, `PAID`, `PENDING`, `TODO` | | `type` | debt.entry.OperationEnum | read-only | Type of movement this operation represents — one of `BANK_TRANSFER_MANUAL`, `CANCEL`, `CASH_MANUAL`, `CHECK_MANUAL`, `CREDITCARD`, `CREDITCARD_AUTOMATIC`, `CREDITCARD_MANUAL`, `CREDIT_ACCOUNT_AUTOMATIC`, `CREDIT_CARD_AUTOMATIC`, `CREDIT_CARD_MANUAL`, `CURRENT_ACCOUNT_AUTOMATIC`, `CURRENT_ACCOUNT_MANUAL`, … | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "depositOrderId": 0, "operationId": 0, "status": "CANCELLED", "type": "BANK_TRANSFER_MANUAL" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}"); print_r($result); ?> ``` ## Return main data about the object related to this debt operation `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}/associatedObject` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid-debt-operation-operationid-associatedobject **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/debt/operation/associatedObject/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.entry.AssociatedObject | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | | | | `paymentInfo` | debt.associatedObject.PaymentInfo | | The payment infos linked to this debt entry | | `paymentInfo.description` | string | | Optional customer description | | `paymentInfo.paymentType` | billing.PaymentMeanEnum | | Payment mean used for this debt operation — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | | `paymentInfo.publicLabel` | string | | Public payment mean label | | `subId` | string | | | | `type` | debt.associatedObject.TypeEnum | | Type of objects an order can be linked to — one of `Bill`, `DebtOperation`, `Deposit`, `Order`, `OvhAccountMovement`, `Refund`, `Withdrawal` | ```json { "id": "string", "paymentInfo": { "description": "string", "paymentType": "cash", "publicLabel": "string" }, "subId": "string", "type": "Bill" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}/associatedObject" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}/associatedObject") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}/debt/operation/{operationId}/associatedObject"); print_r($result); ?> ``` ## Create an order in order to pay this order's debt `POST /1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/pay` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-correctiveinvoice-correctiveinvoiceid-debt-pay **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/debt/pay` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/debt/pay" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/correctiveInvoice/{correctiveInvoiceId}/debt/pay") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/correctiveInvoice/{correctiveInvoiceId}/debt/pay"); print_r($result); ?> ``` ## Give access to all entries of the CorrectiveInvoice `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}/details/{correctiveInvoiceDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid-details-correctiveinvoicedetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceDetailId` | path | string | yes | | | `correctiveInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.CorrectiveInvoiceDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `correctiveInvoiceDetailId` | string | read-only | | | `description` | string | read-only | | | `domain` | string | read-only | | | `periodEnd` | string (date) | read-only | | | `periodStart` | string (date) | read-only | | | `quantity` | integer | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.LongPrice | read-only | LongPrice with all digits and its currency and a textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | ```json { "correctiveInvoiceDetailId": "string", "description": "string", "domain": "string", "periodEnd": "2024-01-01", "periodStart": "2024-01-01", "quantity": 0, "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/details/{correctiveInvoiceDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}/details/{correctiveInvoiceDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}/details/{correctiveInvoiceDetailId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/correctiveInvoice/{correctiveInvoiceId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-correctiveinvoice-correctiveinvoiceid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/correctiveInvoice/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `correctiveInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/correctiveInvoice/{correctiveInvoiceId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/correctiveInvoice/{correctiveInvoiceId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/correctiveInvoice/{correctiveInvoiceId}/payment"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/debtAccount` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-debtaccount **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Balance | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `active` | boolean | read-only | | | `dueAmount` | order.Price | read-only | Amount of debts the account has | | `dueAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `dueAmount.text` | string | | | | `dueAmount.value` | number | | | | `pendingAmount` | order.Price | read-only | Amount currently being processed | | `pendingAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `pendingAmount.text` | string | | | | `pendingAmount.value` | number | | | | `todoAmount` | order.Price | read-only | Reserved amount awaiting payment | | `todoAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `todoAmount.text` | string | | | | `todoAmount.value` | number | | | | `unmaturedAmount` | order.Price | read-only | Unmatured amount for deferred payment term | | `unmaturedAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unmaturedAmount.text` | string | | | | `unmaturedAmount.value` | number | | | ```json { "active": true, "dueAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "pendingAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "todoAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unmaturedAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/debtAccount") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/debtAccount"); print_r($result); ?> ``` ## All debts related to your account `GET /1.0/me/debtAccount/debt` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-debtaccount-debt **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/debt/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount/debt" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/debtAccount/debt") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/debtAccount/debt"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/debtAccount/debt/{debtId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-debtaccount-debt-debtid **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/debt/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `debtId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Debt | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Original amount of the debt | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the debt was created on | | `debtId` | integer | read-only | | | `dueAmount` | order.Price | read-only | Amount you still owe for that debt | | `dueAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `dueAmount.text` | string | | | | `dueAmount.value` | number | | | | `dueDate` | string (date-time) | read-only | If specified, the debt will not be recovered before that date | | `orderId` | integer | read-only | The order the debt relates to | | `pendingAmount` | order.Price | read-only | Amount currently being processed | | `pendingAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `pendingAmount.text` | string | | | | `pendingAmount.value` | number | | | | `status` | debt.entry.StatusDebtOrderEnum | read-only | Status of a debt — one of `PAID`, `REFUNDED`, `TO_BE_PAID`, `UNMATURED`, `UNPAID`, `WRITE_OFF` | | `todoAmount` | order.Price | read-only | Reserved amount awaiting payment | | `todoAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `todoAmount.text` | string | | | | `todoAmount.value` | number | | | | `unmaturedAmount` | order.Price | read-only | Unmatured amount for deferred payment term | | `unmaturedAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unmaturedAmount.text` | string | | | | `unmaturedAmount.value` | number | | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "debtId": 0, "dueAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "dueDate": "2024-01-01T12:00:00Z", "orderId": 0, "pendingAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "status": "PAID", "todoAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unmaturedAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount/debt/{debtId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/debtAccount/debt/{debtId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/debtAccount/debt/{debtId}"); print_r($result); ?> ``` ## All operations related to these debts `GET /1.0/me/debtAccount/debt/{debtId}/operation` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-debtaccount-debt-debtid-operation **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `debtId` | path | integer | yes | | | `depositOrderId` | query | integer | | Filter the value of depositOrderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount/debt/{debtId}/operation" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/debtAccount/debt/{debtId}/operation") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/debtAccount/debt/{debtId}/operation"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/debtAccount/debt/{debtId}/operation/{operationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-debtaccount-debt-debtid-operation-operationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `debtId` | path | integer | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Operation | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Amount of the operation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the operation took place on | | `depositOrderId` | integer | read-only | Order id associated to the deposit | | `operationId` | integer | read-only | | | `status` | debt.entry.StatusEnum | read-only | Status of the operation — one of `CANCELLED`, `DONE`, `FAILED`, `PAID`, `PENDING`, `TODO` | | `type` | debt.entry.OperationEnum | read-only | Type of movement this operation represents — one of `BANK_TRANSFER_MANUAL`, `CANCEL`, `CASH_MANUAL`, `CHECK_MANUAL`, `CREDITCARD`, `CREDITCARD_AUTOMATIC`, `CREDITCARD_MANUAL`, `CREDIT_ACCOUNT_AUTOMATIC`, `CREDIT_CARD_AUTOMATIC`, `CREDIT_CARD_MANUAL`, `CURRENT_ACCOUNT_AUTOMATIC`, `CURRENT_ACCOUNT_MANUAL`, … | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "depositOrderId": 0, "operationId": 0, "status": "CANCELLED", "type": "BANK_TRANSFER_MANUAL" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount/debt/{debtId}/operation/{operationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/debtAccount/debt/{debtId}/operation/{operationId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/debtAccount/debt/{debtId}/operation/{operationId}"); print_r($result); ?> ``` ## Return main data about the object related to this debt operation `GET /1.0/me/debtAccount/debt/{debtId}/operation/{operationId}/associatedObject` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-debtaccount-debt-debtid-operation-operationid-associatedobject **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/debt/operation/associatedObject/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `debtId` | path | integer | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.entry.AssociatedObject | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | | | | `paymentInfo` | debt.associatedObject.PaymentInfo | | The payment infos linked to this debt entry | | `paymentInfo.description` | string | | Optional customer description | | `paymentInfo.paymentType` | billing.PaymentMeanEnum | | Payment mean used for this debt operation — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | | `paymentInfo.publicLabel` | string | | Public payment mean label | | `subId` | string | | | | `type` | debt.associatedObject.TypeEnum | | Type of objects an order can be linked to — one of `Bill`, `DebtOperation`, `Deposit`, `Order`, `OvhAccountMovement`, `Refund`, `Withdrawal` | ```json { "id": "string", "paymentInfo": { "description": "string", "paymentType": "cash", "publicLabel": "string" }, "subId": "string", "type": "Bill" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount/debt/{debtId}/operation/{operationId}/associatedObject" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/debtAccount/debt/{debtId}/operation/{operationId}/associatedObject") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/debtAccount/debt/{debtId}/operation/{operationId}/associatedObject"); print_r($result); ?> ``` ## Create an order in order to pay this order's debt `POST /1.0/me/debtAccount/debt/{debtId}/pay` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-debtaccount-debt-debtid-pay **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/debt/pay` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `debtId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount/debt/{debtId}/pay" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/debtAccount/debt/{debtId}/pay") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/debtAccount/debt/{debtId}/pay"); print_r($result); ?> ``` ## Create an order in order to pay all your due debts `POST /1.0/me/debtAccount/pay` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-debtaccount-pay **Status:** Stable production version **IAM actions:** `account:apiovh:me/debtAccount/pay` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/debtAccount/pay" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/debtAccount/pay") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/debtAccount/pay"); print_r($result); ?> ``` ## List of all the deposits made to your prepaid account or debt account `GET /1.0/me/deposit` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `orderId` | query | integer | | Filter the value of orderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Deposit | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Price with it's currency and textual representation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | | | `depositId` | string | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `paymentInfo` | debt.associatedObject.PaymentInfo | read-only | The payment infos linked to this debt entry | | `paymentInfo.description` | string | | Optional customer description | | `paymentInfo.paymentType` | billing.PaymentMeanEnum | | Payment mean used for this debt operation — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | | `paymentInfo.publicLabel` | string | | Public payment mean label | | `pdfUrl` | string | read-only | | | `url` | string | read-only | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "depositId": "string", "orderId": 0, "password": "string", "paymentInfo": { "description": "string", "paymentType": "cash", "publicLabel": "string" }, "pdfUrl": "string", "url": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}"); print_r($result); ?> ``` ## Give access to all entries of this deposit `GET /1.0/me/deposit/{depositId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}/details/{depositDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-details-depositdetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `depositDetailId` | path | string | yes | | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.DepositDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `depositDetailId` | string | read-only | | | `description` | string | read-only | | | `domain` | string | read-only | | | `quantity` | string | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.Price | read-only | Price with it's currency and textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | ```json { "depositDetailId": "string", "description": "string", "domain": "string", "quantity": "string", "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/details/{depositDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/details/{depositDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/details/{depositDetailId}"); print_r($result); ?> ``` ## Get invoices paid by this deposit `GET /1.0/me/deposit/{depositId}/paidBills` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}/paidBills/{billId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Bill | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `billId` | string | read-only | | | `category` | billing.CategoryEnum | read-only | Types of plans — one of `autorenew`, `earlyrenewal`, `purchase`, `purchase-cloud`, `purchase-servers`, `purchase-telecom`, `purchase-web` | | `date` | string (date-time) | read-only | | | `eInvoicingId` | string | read-only | | | `eInvoicingStatus` | billing.EInvoicingStatusEnum | read-only | List of available eInvoicing Status types — one of `accepted`, `error`, `ignored`, `invalid`, `new`, `ok`, `processing`, `readyToSubmit`, `rejected`, `submitted` | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "billId": "string", "category": "autorenew", "date": "2024-01-01T12:00:00Z", "eInvoicingId": "string", "eInvoicingStatus": "accepted", "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}/paidBills/{billId}/debt` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid-debt **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/debt/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Debt | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Original amount of the debt | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the debt was created on | | `debtId` | integer | read-only | | | `dueAmount` | order.Price | read-only | Amount you still owe for that debt | | `dueAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `dueAmount.text` | string | | | | `dueAmount.value` | number | | | | `dueDate` | string (date-time) | read-only | If specified, the debt will not be recovered before that date | | `orderId` | integer | read-only | The order the debt relates to | | `pendingAmount` | order.Price | read-only | Amount currently being processed | | `pendingAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `pendingAmount.text` | string | | | | `pendingAmount.value` | number | | | | `status` | debt.entry.StatusDebtOrderEnum | read-only | Status of a debt — one of `PAID`, `REFUNDED`, `TO_BE_PAID`, `UNMATURED`, `UNPAID`, `WRITE_OFF` | | `todoAmount` | order.Price | read-only | Reserved amount awaiting payment | | `todoAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `todoAmount.text` | string | | | | `todoAmount.value` | number | | | | `unmaturedAmount` | order.Price | read-only | Unmatured amount for deferred payment term | | `unmaturedAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unmaturedAmount.text` | string | | | | `unmaturedAmount.value` | number | | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "debtId": 0, "dueAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "dueDate": "2024-01-01T12:00:00Z", "orderId": 0, "pendingAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "status": "PAID", "todoAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unmaturedAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/debt" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}/debt") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}/debt"); print_r($result); ?> ``` ## All operations related to these debts `GET /1.0/me/deposit/{depositId}/paidBills/{billId}/debt/operation` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid-debt-operation **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | | `depositOrderId` | query | integer | | Filter the value of depositOrderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/debt/operation" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}/debt/operation") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}/debt/operation"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid-debt-operation-operationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Operation | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Amount of the operation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the operation took place on | | `depositOrderId` | integer | read-only | Order id associated to the deposit | | `operationId` | integer | read-only | | | `status` | debt.entry.StatusEnum | read-only | Status of the operation — one of `CANCELLED`, `DONE`, `FAILED`, `PAID`, `PENDING`, `TODO` | | `type` | debt.entry.OperationEnum | read-only | Type of movement this operation represents — one of `BANK_TRANSFER_MANUAL`, `CANCEL`, `CASH_MANUAL`, `CHECK_MANUAL`, `CREDITCARD`, `CREDITCARD_AUTOMATIC`, `CREDITCARD_MANUAL`, `CREDIT_ACCOUNT_AUTOMATIC`, `CREDIT_CARD_AUTOMATIC`, `CREDIT_CARD_MANUAL`, `CURRENT_ACCOUNT_AUTOMATIC`, `CURRENT_ACCOUNT_MANUAL`, … | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "depositOrderId": 0, "operationId": 0, "status": "CANCELLED", "type": "BANK_TRANSFER_MANUAL" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}"); print_r($result); ?> ``` ## Return main data about the object related to this debt operation `GET /1.0/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}/associatedObject` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid-debt-operation-operationid-associatedobject **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/debt/operation/associatedObject/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.entry.AssociatedObject | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | | | | `paymentInfo` | debt.associatedObject.PaymentInfo | | The payment infos linked to this debt entry | | `paymentInfo.description` | string | | Optional customer description | | `paymentInfo.paymentType` | billing.PaymentMeanEnum | | Payment mean used for this debt operation — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | | `paymentInfo.publicLabel` | string | | Public payment mean label | | `subId` | string | | | | `type` | debt.associatedObject.TypeEnum | | Type of objects an order can be linked to — one of `Bill`, `DebtOperation`, `Deposit`, `Order`, `OvhAccountMovement`, `Refund`, `Withdrawal` | ```json { "id": "string", "paymentInfo": { "description": "string", "paymentType": "cash", "publicLabel": "string" }, "subId": "string", "type": "Bill" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}/associatedObject" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}/associatedObject") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}/debt/operation/{operationId}/associatedObject"); print_r($result); ?> ``` ## Create an order in order to pay this order's debt `POST /1.0/me/deposit/{depositId}/paidBills/{billId}/debt/pay` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-deposit-depositid-paidbills-billid-debt-pay **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/debt/pay` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/debt/pay" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/deposit/{depositId}/paidBills/{billId}/debt/pay") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/deposit/{depositId}/paidBills/{billId}/debt/pay"); print_r($result); ?> ``` ## Give access to all entries of the bill `GET /1.0/me/deposit/{depositId}/paidBills/{billId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}/paidBills/{billId}/details/{billDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid-details-billdetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billDetailId` | path | string | yes | | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.BillDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `billDetailId` | string | read-only | | | `description` | string | read-only | | | `domain` | string | read-only | | | `periodEnd` | string (date) | read-only | | | `periodStart` | string (date) | read-only | | | `quantity` | string | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.LongPrice | read-only | LongPrice with all digits and its currency and a textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | ```json { "billDetailId": "string", "description": "string", "domain": "string", "periodEnd": "2024-01-01", "periodStart": "2024-01-01", "quantity": "string", "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/details/{billDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}/details/{billDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}/details/{billDetailId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}/paidBills/{billId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-paidbills-billid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/paidBills/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `billId` | path | string | yes | | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/paidBills/{billId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/paidBills/{billId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/paidBills/{billId}/payment"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/deposit/{depositId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-deposit-depositid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/deposit/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `depositId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/deposit/{depositId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/deposit/{depositId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/deposit/{depositId}/payment"); print_r($result); ?> ``` ## List of documents added in your account `GET /1.0/me/document` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-document **Status:** Stable production version **IAM actions:** `account:apiovh:me/document/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string (uuid)[] | successful operation | ```json [ "00000000-0000-0000-0000-000000000000" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/document" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/document") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/document"); print_r($result); ?> ``` ## Create new document `POST /1.0/me/document` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-document **Status:** Stable production version **IAM actions:** `account:apiovh:me/document/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `name` | string | yes | File name | | `tags` | complexType.SafeKeyValue_string[] | | File tags | | `tags[].key` | string | | | | `tags[].value` | string | | | ```json { "name": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.document.Document | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Document creation | | `expirationDate` | string (date-time) | | Document expiration | | `getUrl` | string | read-only | URL used to get document | | `id` | string (uuid) | read-only | Document id | | `name` | string | read-only | Document name | | `putUrl` | string | read-only | URL used to put document | | `size` | integer | read-only | Document size (in bytes) | | `tags` | complexType.SafeKeyValue_string[] | read-only | Document tags | | `tags[].key` | string | | | | `tags[].value` | string | | | | `validationDate` | string (date-time) | read-only | Document validation | ```json { "creationDate": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "getUrl": "string", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "putUrl": "string", "size": 0, "tags": [ { "key": "string", "value": "string" } ], "validationDate": "2024-01-01T12:00:00Z" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/document" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/document", name = None, # File name (type: string) tags = None, # File tags (type: complexType.SafeKeyValue[], nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/document", array( name => null, // File name (type: string) tags => null, // File tags (type: complexType.SafeKeyValue[], nullable) )); print_r($result); ?> ``` ## Add CORS support on your container `POST /1.0/me/document/cors` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-document-cors **Status:** Stable production version **IAM actions:** `account:apiovh:me/document/cors/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `origin` | string | yes | Allow this origin | ```json { "origin": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/document/cors" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/document/cors", origin = None, # Allow this origin (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/document/cors", array( origin => null, // Allow this origin (type: string) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/document/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-document-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/document/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | string (uuid) | yes | Document id | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.document.Document | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Document creation | | `expirationDate` | string (date-time) | | Document expiration | | `getUrl` | string | read-only | URL used to get document | | `id` | string (uuid) | read-only | Document id | | `name` | string | read-only | Document name | | `putUrl` | string | read-only | URL used to put document | | `size` | integer | read-only | Document size (in bytes) | | `tags` | complexType.SafeKeyValue_string[] | read-only | Document tags | | `tags[].key` | string | | | | `tags[].value` | string | | | | `validationDate` | string (date-time) | read-only | Document validation | ```json { "creationDate": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "getUrl": "string", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "putUrl": "string", "size": 0, "tags": [ { "key": "string", "value": "string" } ], "validationDate": "2024-01-01T12:00:00Z" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/document/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/document/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/document/{id}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/document/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-document-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/document/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | string (uuid) | yes | Document id | ### Request body (required) Type: `nichandle.document.Document` | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Document creation | | `expirationDate` | string (date-time) | | Document expiration | | `getUrl` | string | read-only | URL used to get document | | `id` | string (uuid) | read-only | Document id | | `name` | string | read-only | Document name | | `putUrl` | string | read-only | URL used to put document | | `size` | integer | read-only | Document size (in bytes) | | `tags` | complexType.SafeKeyValue_string[] | read-only | Document tags | | `tags[].key` | string | | | | `tags[].value` | string | | | | `validationDate` | string (date-time) | read-only | Document validation | ```json { "expirationDate": "2024-01-01T12:00:00Z" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/document/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.document.Document result = client.put("/me/document/{id}", expirationDate = None, # Document expiration (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/document/{id}", array( expirationDate => null, // Document expiration (type: string, nullable) )); print_r($result); ?> ``` ## Delete a document `DELETE /1.0/me/document/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-document-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/document/delete` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | string (uuid) | yes | Document id | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/document/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/document/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/document/{id}"); print_r($result); ?> ``` ## List of all the downPaymentInvoice the logged account has `GET /1.0/me/downPaymentInvoice` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `category` | query | billing.CategoryEnum | | Filter the value of category property (=) — one of `autorenew`, `earlyrenewal`, `purchase`, `purchase-cloud`, `purchase-servers`, `purchase-telecom`, `purchase-web` | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `orderId` | query | integer | | Filter the value of orderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.DownPaymentInvoice | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `category` | billing.CategoryEnum | read-only | Types of plans — one of `autorenew`, `earlyrenewal`, `purchase`, `purchase-cloud`, `purchase-servers`, `purchase-telecom`, `purchase-web` | | `date` | string (date-time) | read-only | | | `downPaymentInvoiceId` | string | read-only | | | `eInvoicingId` | string | read-only | | | `eInvoicingStatus` | billing.EInvoicingStatusEnum | read-only | List of available eInvoicing Status types — one of `accepted`, `error`, `ignored`, `invalid`, `new`, `ok`, `processing`, `readyToSubmit`, `rejected`, `submitted` | | `orderId` | integer | read-only | | | `password` | string (password) | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "category": "autorenew", "date": "2024-01-01T12:00:00Z", "downPaymentInvoiceId": "string", "eInvoicingId": "string", "eInvoicingStatus": "accepted", "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid-debt **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/debt/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Debt | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Original amount of the debt | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the debt was created on | | `debtId` | integer | read-only | | | `dueAmount` | order.Price | read-only | Amount you still owe for that debt | | `dueAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `dueAmount.text` | string | | | | `dueAmount.value` | number | | | | `dueDate` | string (date-time) | read-only | If specified, the debt will not be recovered before that date | | `orderId` | integer | read-only | The order the debt relates to | | `pendingAmount` | order.Price | read-only | Amount currently being processed | | `pendingAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `pendingAmount.text` | string | | | | `pendingAmount.value` | number | | | | `status` | debt.entry.StatusDebtOrderEnum | read-only | Status of a debt — one of `PAID`, `REFUNDED`, `TO_BE_PAID`, `UNMATURED`, `UNPAID`, `WRITE_OFF` | | `todoAmount` | order.Price | read-only | Reserved amount awaiting payment | | `todoAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `todoAmount.text` | string | | | | `todoAmount.value` | number | | | | `unmaturedAmount` | order.Price | read-only | Unmatured amount for deferred payment term | | `unmaturedAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unmaturedAmount.text` | string | | | | `unmaturedAmount.value` | number | | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "debtId": 0, "dueAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "dueDate": "2024-01-01T12:00:00Z", "orderId": 0, "pendingAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "status": "PAID", "todoAmount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unmaturedAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt"); print_r($result); ?> ``` ## All operations related to these debts `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid-debt-operation **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `depositOrderId` | query | integer | | Filter the value of depositOrderId property (=) | | `downPaymentInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid-debt-operation-operationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/debt/operation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.Operation | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Amount of the operation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `date` | string (date-time) | read-only | Date the operation took place on | | `depositOrderId` | integer | read-only | Order id associated to the deposit | | `operationId` | integer | read-only | | | `status` | debt.entry.StatusEnum | read-only | Status of the operation — one of `CANCELLED`, `DONE`, `FAILED`, `PAID`, `PENDING`, `TODO` | | `type` | debt.entry.OperationEnum | read-only | Type of movement this operation represents — one of `BANK_TRANSFER_MANUAL`, `CANCEL`, `CASH_MANUAL`, `CHECK_MANUAL`, `CREDITCARD`, `CREDITCARD_AUTOMATIC`, `CREDITCARD_MANUAL`, `CREDIT_ACCOUNT_AUTOMATIC`, `CREDIT_CARD_AUTOMATIC`, `CREDIT_CARD_MANUAL`, `CURRENT_ACCOUNT_AUTOMATIC`, `CURRENT_ACCOUNT_MANUAL`, … | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "depositOrderId": 0, "operationId": 0, "status": "CANCELLED", "type": "BANK_TRANSFER_MANUAL" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}"); print_r($result); ?> ``` ## Return main data about the object related to this debt operation `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}/associatedObject` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid-debt-operation-operationid-associatedobject **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/debt/operation/associatedObject/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceId` | path | string | yes | | | `operationId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | debt.entry.AssociatedObject | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | | | | `paymentInfo` | debt.associatedObject.PaymentInfo | | The payment infos linked to this debt entry | | `paymentInfo.description` | string | | Optional customer description | | `paymentInfo.paymentType` | billing.PaymentMeanEnum | | Payment mean used for this debt operation — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | | `paymentInfo.publicLabel` | string | | Public payment mean label | | `subId` | string | | | | `type` | debt.associatedObject.TypeEnum | | Type of objects an order can be linked to — one of `Bill`, `DebtOperation`, `Deposit`, `Order`, `OvhAccountMovement`, `Refund`, `Withdrawal` | ```json { "id": "string", "paymentInfo": { "description": "string", "paymentType": "cash", "publicLabel": "string" }, "subId": "string", "type": "Bill" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}/associatedObject" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}/associatedObject") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/operation/{operationId}/associatedObject"); print_r($result); ?> ``` ## Create an order in order to pay this order's debt `POST /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/pay` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-downpaymentinvoice-downpaymentinvoiceid-debt-pay **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/debt/pay` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/pay" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/pay") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/downPaymentInvoice/{downPaymentInvoiceId}/debt/pay"); print_r($result); ?> ``` ## Give access to all entries of the DownPaymentInvoice `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/details/{downPaymentInvoiceDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid-details-downpaymentinvoicedetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceDetailId` | path | string | yes | | | `downPaymentInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.DownPaymentInvoiceDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | read-only | | | `domain` | string | read-only | | | `downPaymentInvoiceDetailId` | string | read-only | | | `periodEnd` | string (date) | read-only | | | `periodStart` | string (date) | read-only | | | `quantity` | integer | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.LongPrice | read-only | LongPrice with all digits and its currency and a textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | ```json { "description": "string", "domain": "string", "downPaymentInvoiceDetailId": "string", "periodEnd": "2024-01-01", "periodStart": "2024-01-01", "quantity": 0, "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/details/{downPaymentInvoiceDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}/details/{downPaymentInvoiceDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}/details/{downPaymentInvoiceDetailId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-downpaymentinvoice-downpaymentinvoiceid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/downPaymentInvoice/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `downPaymentInvoiceId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/downPaymentInvoice/{downPaymentInvoiceId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/downPaymentInvoice/{downPaymentInvoiceId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/downPaymentInvoice/{downPaymentInvoiceId}/payment"); print_r($result); ?> ``` ## Get the fax custom domains linked to the customer account `GET /1.0/me/fax/customDomains` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-fax-customdomains **Status:** Stable production version **IAM actions:** `account:apiovh:me/fax/customDomains/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/fax/customDomains" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/fax/customDomains") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/fax/customDomains"); print_r($result); ?> ``` ## Create a custom domain for your fax services `POST /1.0/me/fax/customDomains` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-fax-customdomains **Status:** Stable production version **IAM actions:** `account:apiovh:me/fax/customDomains/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `domain` | string | yes | The custom domain of your fax services | ```json { "domain": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | telephony.MailDomain2Service | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `domain` | string | read-only | The custom domain of your fax services | | `id` | integer | read-only | | ```json { "domain": "string", "id": 0 } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/fax/customDomains" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/fax/customDomains", domain = None, # The custom domain of your fax services (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/fax/customDomains", array( domain => null, // The custom domain of your fax services (type: string) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/fax/customDomains/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-fax-customdomains-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/fax/customDomains/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | telephony.MailDomain2Service | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `domain` | string | read-only | The custom domain of your fax services | | `id` | integer | read-only | | ```json { "domain": "string", "id": 0 } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/fax/customDomains/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/fax/customDomains/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/fax/customDomains/{id}"); print_r($result); ?> ``` ## Delete a custom domain of your fax services `DELETE /1.0/me/fax/customDomains/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-fax-customdomains-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/fax/customDomains/delete` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/fax/customDomains/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/fax/customDomains/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/fax/customDomains/{id}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/fidelityAccount` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-fidelityaccount **Status:** Stable production version **IAM actions:** `account:apiovh:me/fidelityAccount/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.FidelityAccount | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `alertThreshold` | integer | | | | `balance` | integer | read-only | | | `canBeCredited` | boolean | read-only | | | `lastUpdate` | string (date-time) | read-only | | | `openDate` | string (date-time) | read-only | | ```json { "alertThreshold": 0, "balance": 0, "canBeCredited": true, "lastUpdate": "2024-01-01T12:00:00Z", "openDate": "2024-01-01T12:00:00Z" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/fidelityAccount" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/fidelityAccount") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/fidelityAccount"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/fidelityAccount` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-fidelityaccount **Status:** Stable production version **IAM actions:** `account:apiovh:me/fidelityAccount/edit` ### Request body (required) Type: `billing.FidelityAccount` | Field | Type | Required | Description | | --- | --- | --- | --- | | `alertThreshold` | integer | | | | `balance` | integer | read-only | | | `canBeCredited` | boolean | read-only | | | `lastUpdate` | string (date-time) | read-only | | | `openDate` | string (date-time) | read-only | | ```json { "alertThreshold": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/fidelityAccount" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: billing.FidelityAccount result = client.put("/me/fidelityAccount", alertThreshold = None, # (type: integer, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/fidelityAccount", array( alertThreshold => null, // (type: integer, nullable) )); print_r($result); ?> ``` ## Generate an order that can be paid in order to credit the fidelity account `POST /1.0/me/fidelityAccount/creditOrder` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-fidelityaccount-creditorder **Status:** Stable production version **IAM actions:** `account:apiovh:me/fidelityAccount/creditOrder` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | integer | yes | The amount of points you want to credit your fidelity account of | ```json { "amount": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/fidelityAccount/creditOrder" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: long result = client.post("/me/fidelityAccount/creditOrder", amount = None, # The amount of points you want to credit your fidelity account of (type: long) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/fidelityAccount/creditOrder", array( amount => null, // The amount of points you want to credit your fidelity account of (type: long) )); print_r($result); ?> ``` ## List of entries of the fidelity account `GET /1.0/me/fidelityAccount/movements` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-fidelityaccount-movements **Status:** Stable production version **IAM actions:** `account:apiovh:me/fidelityAccount/movements/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/fidelityAccount/movements" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/fidelityAccount/movements") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/fidelityAccount/movements"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/fidelityAccount/movements/{movementId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-fidelityaccount-movements-movementid **Status:** Stable production version **IAM actions:** `account:apiovh:me/fidelityAccount/movements/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `movementId` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.FidelityMovement | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | integer | read-only | | | `balance` | integer | read-only | | | `date` | string (date-time) | read-only | | | `description` | string | read-only | | | `movementId` | integer | read-only | | | `operation` | billing.fidelityAccount.OperationEnum | read-only | Operations a fidelity account movement can represent — one of `bonus`, `cancel-bonus`, `cancel-credit`, `cancel-debit`, `cancel-pre-debit`, `credit`, `debit`, `pre-credit`, `pre-debit` | | `order` | integer | read-only | | | `previousBalance` | integer | read-only | | ```json { "amount": 0, "balance": 0, "date": "2024-01-01T12:00:00Z", "description": "string", "movementId": 0, "operation": "bonus", "order": 0, "previousBalance": 0 } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/fidelityAccount/movements/{movementId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/fidelityAccount/movements/{movementId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/fidelityAccount/movements/{movementId}"); print_r($result); ?> ``` ## Get your insight access token `GET /1.0/me/insight` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-insight **Status:** Deprecated, will be removed **Deprecated** since 2026-10-17, removed on 2026-12-17. **IAM actions:** `account:apiovh:me/insight/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | me.insight.Access | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `access` | string (password) | read-only | Access token | | `createdAt` | string (date-time) | read-only | Token creation date | | `expireAt` | string (date-time) | read-only | Token expiration date | ```json { "access": "string", "createdAt": "2024-01-01T12:00:00Z", "expireAt": "2024-01-01T12:00:00Z" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/insight" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/insight") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/insight"); print_r($result); ?> ``` ## List of organisations `GET /1.0/me/ipOrganisation` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-iporganisation **Status:** Stable production version **IAM actions:** `account:apiovh:me/ipOrganisation/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/ipOrganisation" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/ipOrganisation") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/ipOrganisation"); print_r($result); ?> ``` ## Add an organisation `POST /1.0/me/ipOrganisation` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-iporganisation **Status:** Stable production version **IAM actions:** `account:apiovh:me/ipOrganisation/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `abuse_mailbox` | string | yes | | | `address` | string | yes | | | `city` | string | yes | | | `country` | nichandle.CountryEnum | yes | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `firstname` | string | yes | | | `lastname` | string | yes | | | `phone` | phoneNumber | yes | Phone number | | `registry` | nichandle.IpRegistryEnum | yes | Ip registries — one of `ARIN`, `RIPE` | | `state` | string | | | | `zip` | string | | | ```json { "abuse_mailbox": "string", "address": "string", "city": "string", "country": "AC", "firstname": "string", "lastname": "string", "phone": "string", "registry": "ARIN", "state": "string", "zip": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/ipOrganisation" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/ipOrganisation", abuse_mailbox = None, # (type: string) address = None, # (type: string) city = None, # (type: string) country = None, # (type: nichandle.CountryEnum) firstname = None, # (type: string) lastname = None, # (type: string) phone = None, # (type: phoneNumber) registry = None, # (type: nichandle.IpRegistryEnum) state = None, # (type: string, nullable) zip = None, # (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/ipOrganisation", array( abuse_mailbox => null, // (type: string) address => null, // (type: string) city => null, // (type: string) country => null, // (type: nichandle.CountryEnum) firstname => null, // (type: string) lastname => null, // (type: string) phone => null, // (type: phoneNumber) registry => null, // (type: nichandle.IpRegistryEnum) state => null, // (type: string, nullable) zip => null, // (type: string, nullable) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/ipOrganisation/{organisationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-iporganisation-organisationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/ipOrganisation/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `organisationId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.Ipv4Org | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `abuse_mailbox` | string | | | | `address` | string | | | | `city` | string | | | | `country` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `firstname` | string | | | | `lastname` | string | | | | `organisationId` | string | read-only | | | `phone` | phoneNumber | | Phone number | | `registry` | nichandle.IpRegistryEnum | read-only | Ip registries — one of `ARIN`, `RIPE` | | `state` | string | | | | `zip` | string | | | ```json { "abuse_mailbox": "string", "address": "string", "city": "string", "country": "AC", "firstname": "string", "lastname": "string", "organisationId": "string", "phone": "string", "registry": "ARIN", "state": "string", "zip": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/ipOrganisation/{organisationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/ipOrganisation/{organisationId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/ipOrganisation/{organisationId}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/ipOrganisation/{organisationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-iporganisation-organisationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/ipOrganisation/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `organisationId` | path | string | yes | | ### Request body (required) Type: `nichandle.Ipv4Org` | Field | Type | Required | Description | | --- | --- | --- | --- | | `abuse_mailbox` | string | | | | `address` | string | | | | `city` | string | | | | `country` | nichandle.CountryEnum | | Countries a nichandle can choose — one of `AC`, `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, … | | `firstname` | string | | | | `lastname` | string | | | | `organisationId` | string | read-only | | | `phone` | phoneNumber | | Phone number | | `registry` | nichandle.IpRegistryEnum | read-only | Ip registries — one of `ARIN`, `RIPE` | | `state` | string | | | | `zip` | string | | | ```json { "abuse_mailbox": "string", "address": "string", "city": "string", "country": "AC", "firstname": "string", "lastname": "string", "phone": "string", "state": "string", "zip": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/ipOrganisation/{organisationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.Ipv4Org result = client.put("/me/ipOrganisation/{organisationId}", abuse_mailbox = None, # (type: string) address = None, # (type: string) city = None, # (type: string) country = None, # (type: ) firstname = None, # (type: string) lastname = None, # (type: string) phone = None, # (type: ) state = None, # (type: string, nullable) zip = None, # (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/ipOrganisation/{organisationId}", array( abuse_mailbox => null, // (type: string) address => null, // (type: string) city => null, // (type: string) country => null, // (type: ) firstname => null, // (type: string) lastname => null, // (type: string) phone => null, // (type: ) state => null, // (type: string, nullable) zip => null, // (type: string, nullable) )); print_r($result); ?> ``` ## Delete this organisation `DELETE /1.0/me/ipOrganisation/{organisationId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-iporganisation-organisationid **Status:** Stable production version **IAM actions:** `account:apiovh:me/ipOrganisation/delete` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `organisationId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/ipOrganisation/{organisationId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/ipOrganisation/{organisationId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/ipOrganisation/{organisationId}"); print_r($result); ?> ``` ## List of mailing list you can subscribe `GET /1.0/me/mailingList/availableLists` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-mailinglist-availablelists **Status:** Stable production version **IAM actions:** `account:apiovh:me/mailingList/availableLists/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/mailingList/availableLists" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/mailingList/availableLists") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/mailingList/availableLists"); print_r($result); ?> ``` ## Subscribe an email to a restricted mailing list `POST /1.0/me/mailingList/subscribe` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-mailinglist-subscribe **Status:** Stable production version **IAM actions:** `account:apiovh:me/mailingList/subscribe` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `email` | string | yes | Email you want to subscribe to | | `mailingList` | string | yes | Mailing list | ```json { "email": "string", "mailingList": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/mailingList/subscribe" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/mailingList/subscribe", email = None, # Email you want to subscribe to (type: string) mailingList = None, # Mailing list (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/mailingList/subscribe", array( email => null, // Email you want to subscribe to (type: string) mailingList => null, // Mailing list (type: string) )); print_r($result); ?> ``` ## List of all your email notifications `GET /1.0/me/notification/email/history` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-notification-email-history **Status:** Stable production version **IAM actions:** `account:apiovh:me/notification/email/history/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/notification/email/history" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/notification/email/history") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/notification/email/history"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/notification/email/history/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-notification-email-history-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/notification/email/history/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.emailNotification | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `body` | string | read-only | This email body | | `date` | string (date-time) | read-only | This email date | | `id` | integer | read-only | This email Id | | `subject` | string | read-only | This email subject | ```json { "body": "string", "date": "2024-01-01T12:00:00Z", "id": 0, "subject": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/notification/email/history/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/notification/email/history/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/notification/email/history/{id}"); print_r($result); ?> ``` ## List of OVH accounts the logged account has `GET /1.0/me/ovhAccount` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-ovhaccount **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/ovhAccount") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/ovhAccount"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/ovhAccount/{ovhAccountId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-ovhaccount-ovhaccountid **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `ovhAccountId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.OvhAccount | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `alertThreshold` | integer | | | | `availableAfterCredit` | order.Price | read-only | Price with it's currency and textual representation | | `availableAfterCredit.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `availableAfterCredit.text` | string | | | | `availableAfterCredit.value` | number | | | | `balance` | order.Price | read-only | Price with it's currency and textual representation | | `balance.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `balance.text` | string | | | | `balance.value` | number | | | | `canBeCredited` | boolean | read-only | | | `isActive` | boolean | read-only | | | `lastUpdate` | string (date-time) | read-only | | | `openDate` | string (date-time) | read-only | | | `ovhAccountId` | string | read-only | | | `retrievableAmount` | order.Price | read-only | Price with it's currency and textual representation | | `retrievableAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `retrievableAmount.text` | string | | | | `retrievableAmount.value` | number | | | ```json { "alertThreshold": 0, "availableAfterCredit": { "currencyCode": "AUD", "text": "string", "value": 0 }, "balance": { "currencyCode": "AUD", "text": "string", "value": 0 }, "canBeCredited": true, "isActive": true, "lastUpdate": "2024-01-01T12:00:00Z", "openDate": "2024-01-01T12:00:00Z", "ovhAccountId": "string", "retrievableAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount/{ovhAccountId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/ovhAccount/{ovhAccountId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/ovhAccount/{ovhAccountId}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/ovhAccount/{ovhAccountId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-ovhaccount-ovhaccountid **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `ovhAccountId` | path | string | yes | | ### Request body (required) Type: `billing.OvhAccount` | Field | Type | Required | Description | | --- | --- | --- | --- | | `alertThreshold` | integer | | | | `availableAfterCredit` | order.Price | read-only | Price with it's currency and textual representation | | `availableAfterCredit.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `availableAfterCredit.text` | string | | | | `availableAfterCredit.value` | number | | | | `balance` | order.Price | read-only | Price with it's currency and textual representation | | `balance.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `balance.text` | string | | | | `balance.value` | number | | | | `canBeCredited` | boolean | read-only | | | `isActive` | boolean | read-only | | | `lastUpdate` | string (date-time) | read-only | | | `openDate` | string (date-time) | read-only | | | `ovhAccountId` | string | read-only | | | `retrievableAmount` | order.Price | read-only | Price with it's currency and textual representation | | `retrievableAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `retrievableAmount.text` | string | | | | `retrievableAmount.value` | number | | | ```json { "alertThreshold": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount/{ovhAccountId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: billing.OvhAccount result = client.put("/me/ovhAccount/{ovhAccountId}", alertThreshold = None, # (type: integer, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/ovhAccount/{ovhAccountId}", array( alertThreshold => null, // (type: integer, nullable) )); print_r($result); ?> ``` ## Generate an order that can be paid in order to credit the OVH account `POST /1.0/me/ovhAccount/{ovhAccountId}/creditOrder` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-ovhaccount-ovhaccountid-creditorder **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/creditOrder/create` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `ovhAccountId` | path | string | yes | | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | integer | yes | The amount in cents you want to credit your account of | ```json { "amount": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount/{ovhAccountId}/creditOrder" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: long result = client.post("/me/ovhAccount/{ovhAccountId}/creditOrder", amount = None, # The amount in cents you want to credit your account of (type: long) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/ovhAccount/{ovhAccountId}/creditOrder", array( amount => null, // The amount in cents you want to credit your account of (type: long) )); print_r($result); ?> ``` ## Details about an entry of the OVH account `GET /1.0/me/ovhAccount/{ovhAccountId}/movements` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-ovhaccount-ovhaccountid-movements **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/movements/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `ovhAccountId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount/{ovhAccountId}/movements" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/ovhAccount/{ovhAccountId}/movements") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/ovhAccount/{ovhAccountId}/movements"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/ovhAccount/{ovhAccountId}/movements/{movementId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-ovhaccount-ovhaccountid-movements-movementid **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/movements/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `movementId` | path | integer | yes | | | `ovhAccountId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Movement | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Price with it's currency and textual representation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `balance` | order.Price | read-only | Price with it's currency and textual representation | | `balance.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `balance.text` | string | | | | `balance.value` | number | | | | `date` | string (date-time) | read-only | | | `description` | string | read-only | | | `movementId` | integer | read-only | | | `operation` | billing.ovhAccount.OperationEnum | read-only | Operations an OVH account movement can represent — one of `cancel-credit`, `cancel-debit`, `cancel-pre-debit`, `credit`, `debit`, `pre-credit`, `pre-debit` | | `order` | integer | read-only | | | `previousBalance` | order.Price | read-only | Price with it's currency and textual representation | | `previousBalance.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `previousBalance.text` | string | | | | `previousBalance.value` | number | | | | `retrievableAmount` | order.Price | read-only | Price with it's currency and textual representation | | `retrievableAmount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `retrievableAmount.text` | string | | | | `retrievableAmount.value` | number | | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "balance": { "currencyCode": "AUD", "text": "string", "value": 0 }, "date": "2024-01-01T12:00:00Z", "description": "string", "movementId": 0, "operation": "cancel-credit", "order": 0, "previousBalance": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retrievableAmount": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount/{ovhAccountId}/movements/{movementId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/ovhAccount/{ovhAccountId}/movements/{movementId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/ovhAccount/{ovhAccountId}/movements/{movementId}"); print_r($result); ?> ``` ## request a refund of this credit note to your original payment method `POST /1.0/me/ovhAccount/{ovhAccountId}/movements/{movementId}/requestRefund` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-ovhaccount-ovhaccountid-movements-movementid-requestrefund **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/movements/requestRefund` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `movementId` | path | integer | yes | | | `ovhAccountId` | path | string | yes | | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | integer | yes | The amount in cents you want to retrieve | ```json { "amount": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount/{ovhAccountId}/movements/{movementId}/requestRefund" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: long result = client.post("/me/ovhAccount/{ovhAccountId}/movements/{movementId}/requestRefund", amount = None, # The amount in cents you want to retrieve (type: long) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/ovhAccount/{ovhAccountId}/movements/{movementId}/requestRefund", array( amount => null, // The amount in cents you want to retrieve (type: long) )); print_r($result); ?> ``` ## Transfer money from ovhAccount to your bank account `POST /1.0/me/ovhAccount/{ovhAccountId}/retrieveMoney` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-ovhaccount-ovhaccountid-retrievemoney **Status:** Stable production version **IAM actions:** `account:apiovh:me/ovhAccount/retrieveMoney` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `ovhAccountId` | path | string | yes | | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | integer | yes | The amount in cents you want to transfer | | `bankAccountId` | integer | yes | A valid bank account | ```json { "amount": 0, "bankAccountId": 0 } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Order | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `expirationDate` | string (date-time) | read-only | | | `metadatas` | string[] | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `retractionDate` | string (date-time) | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "expirationDate": "2024-01-01T12:00:00Z", "metadatas": [ "string" ], "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "retractionDate": "2024-01-01T12:00:00Z", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/ovhAccount/{ovhAccountId}/retrieveMoney" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/ovhAccount/{ovhAccountId}/retrieveMoney", amount = None, # The amount in cents you want to transfer (type: long) bankAccountId = None, # A valid bank account (type: long) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/ovhAccount/{ovhAccountId}/retrieveMoney", array( amount => null, // The amount in cents you want to transfer (type: long) bankAccountId => null, // A valid bank account (type: long) )); print_r($result); ?> ``` ## Request a password recover `POST /1.0/me/passwordRecover` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-passwordrecover **Status:** Stable production version **Authentication:** none (public operation) ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `ovhCompany` | nichandle.OvhCompanyEnum | yes | Company of your OVH Account Id — one of `kimsufi`, `ovh`, `soyoustart` | | `ovhId` | string | yes | Your OVH Account Id | ```json { "ovhCompany": "kimsufi", "ovhId": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/passwordRecover" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/passwordRecover", ovhCompany = None, # Company of your OVH Account Id (type: nichandle.OvhCompanyEnum) ovhId = None, # Your OVH Account Id (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/passwordRecover", array( ovhCompany => null, // Company of your OVH Account Id (type: nichandle.OvhCompanyEnum) ovhId => null, // Your OVH Account Id (type: string) )); print_r($result); ?> ``` ## List of all the refunds the logged account has `GET /1.0/me/refund` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-refund **Status:** Stable production version **IAM actions:** `account:apiovh:me/refund/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `orderId` | query | integer | | Filter the value of orderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/refund" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/refund") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/refund"); print_r($result); ?> ``` ## Exports a bundle of refunds `POST /1.0/me/refund/export` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-refund-export **Status:** Stable production version **IAM actions:** `account:apiovh:me/refund/export` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `archiveType` | billing.ArchiveTypeEnum | yes | The file type of the archive — one of `csv`, `zip` | | `endDate` | string (date-time) | | End interval of the export | | `ids` | string[] | | A list of ids to export | | `startDate` | string (date-time) | | Start interval of the export | ```json { "archiveType": "csv", "endDate": "2024-01-01T12:00:00Z", "ids": [ "string" ], "startDate": "2024-01-01T12:00:00Z" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/refund/export" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/refund/export", archiveType = None, # The file type of the archive (type: billing.ArchiveTypeEnum) endDate = None, # End interval of the export (type: datetime, nullable) ids = None, # A list of ids to export (type: string[], nullable) startDate = None, # Start interval of the export (type: datetime, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/refund/export", array( archiveType => null, // The file type of the archive (type: billing.ArchiveTypeEnum) endDate => null, // End interval of the export (type: datetime, nullable) ids => null, // A list of ids to export (type: string[], nullable) startDate => null, // Start interval of the export (type: datetime, nullable) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/refund/{refundId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-refund-refundid **Status:** Stable production version **IAM actions:** `account:apiovh:me/refund/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `refundId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Refund | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `orderId` | integer | read-only | | | `originalBillId` | string | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `refundId` | string | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "orderId": 0, "originalBillId": "string", "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "refundId": "string", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/refund/{refundId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/refund/{refundId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/refund/{refundId}"); print_r($result); ?> ``` ## Give access to all entries of the refund `GET /1.0/me/refund/{refundId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-refund-refundid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/refund/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `refundId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/refund/{refundId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/refund/{refundId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/refund/{refundId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/refund/{refundId}/details/{refundDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-refund-refundid-details-refunddetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/refund/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `refundDetailId` | path | string | yes | | | `refundId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.RefundDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | read-only | | | `domain` | string | read-only | | | `quantity` | string | read-only | | | `reference` | string | read-only | | | `refundDetailId` | string | read-only | | | `refundId` | string | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.Price | read-only | Price with it's currency and textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | ```json { "description": "string", "domain": "string", "quantity": "string", "reference": "string", "refundDetailId": "string", "refundId": "string", "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/refund/{refundId}/details/{refundDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/refund/{refundId}/details/{refundDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/refund/{refundId}/details/{refundDetailId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/refund/{refundId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-refund-refundid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/refund/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `refundId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/refund/{refundId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/refund/{refundId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/refund/{refundId}/payment"); print_r($result); ?> ``` ## List all the bills sent by the current account `GET /1.0/me/reverseBill` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-reversebill **Status:** Stable production version **IAM actions:** `account:apiovh:me/reverseBill/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `orderId` | query | integer | | Filter the value of orderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/reverseBill" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/reverseBill") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/reverseBill"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/reverseBill/{reverseBillId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-reversebill-reversebillid **Status:** Stable production version **IAM actions:** `account:apiovh:me/reverseBill/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `reverseBillId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.ReverseBill | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | | | `orderId` | integer | read-only | | | `password` | string (password) | read-only | | | `pdfUrl` | string | read-only | | | `priceWithTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithTax.text` | string | | | | `priceWithTax.value` | number | | | | `priceWithoutTax` | order.Price | read-only | Price with it's currency and textual representation | | `priceWithoutTax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `priceWithoutTax.text` | string | | | | `priceWithoutTax.value` | number | | | | `reverseBillId` | string | read-only | | | `tax` | order.Price | read-only | Price with it's currency and textual representation | | `tax.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `tax.text` | string | | | | `tax.value` | number | | | | `url` | string | read-only | | ```json { "date": "2024-01-01T12:00:00Z", "orderId": 0, "password": "string", "pdfUrl": "string", "priceWithTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "priceWithoutTax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "reverseBillId": "string", "tax": { "currencyCode": "AUD", "text": "string", "value": 0 }, "url": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/reverseBill/{reverseBillId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/reverseBill/{reverseBillId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/reverseBill/{reverseBillId}"); print_r($result); ?> ``` ## Give access to all entries of this withdrawal `GET /1.0/me/reverseBill/{reverseBillId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-reversebill-reversebillid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/reverseBill/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `reverseBillId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/reverseBill/{reverseBillId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/reverseBill/{reverseBillId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/reverseBill/{reverseBillId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/reverseBill/{reverseBillId}/details/{reverseBillDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-reversebill-reversebillid-details-reversebilldetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/reverseBill/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `reverseBillDetailId` | path | string | yes | | | `reverseBillId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.ReversableBillDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | read-only | | | `domain` | string | read-only | | | `quantity` | string | read-only | | | `reference` | string | read-only | | | `reverseBillDetailId` | string | read-only | | | `reverseBillId` | string | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.Price | read-only | Price with it's currency and textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | ```json { "description": "string", "domain": "string", "quantity": "string", "reference": "string", "reverseBillDetailId": "string", "reverseBillId": "string", "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/reverseBill/{reverseBillId}/details/{reverseBillDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/reverseBill/{reverseBillId}/details/{reverseBillDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/reverseBill/{reverseBillId}/details/{reverseBillDetailId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/reverseBill/{reverseBillId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-reversebill-reversebillid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/reverseBill/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `reverseBillId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/reverseBill/{reverseBillId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/reverseBill/{reverseBillId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/reverseBill/{reverseBillId}/payment"); print_r($result); ?> ``` ## List active SLA `GET /1.0/me/sla` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-sla **Status:** Stable production version **IAM actions:** `account:apiovh:me/sla/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/sla" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/sla") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/sla"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/sla/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-sla-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/sla/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.SlaOperation | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `date` | string (date-time) | read-only | Date of the event that led to SLA | | `description` | string | read-only | Description of the SLA operation for this incident | | `endDate` | string (date-time) | read-only | Date of the end of the SLA | | `id` | integer | read-only | SLA identifier | | `name` | string | read-only | Sla operation name | | `startDate` | string (date-time) | read-only | Date of the start of the SLA | ```json { "date": "2024-01-01T12:00:00Z", "description": "string", "endDate": "2024-01-01T12:00:00Z", "id": 0, "name": "string", "startDate": "2024-01-01T12:00:00Z" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/sla/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/sla/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/sla/{id}"); print_r($result); ?> ``` ## Ask for SLA application `POST /1.0/me/sla/{id}/apply` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-sla-id-apply **Status:** Stable production version **IAM actions:** `account:apiovh:me/sla/apply` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/sla/{id}/apply" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/sla/{id}/apply") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/sla/{id}/apply"); print_r($result); ?> ``` ## Check whether this SLA can be applied on your services `GET /1.0/me/sla/{id}/canBeApplied` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-sla-id-canbeapplied **Status:** Stable production version **IAM actions:** `account:apiovh:me/sla/canBeApplied/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | boolean | successful operation | ```json true ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/sla/{id}/canBeApplied" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/sla/{id}/canBeApplied") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/sla/{id}/canBeApplied"); print_r($result); ?> ``` ## Get services impacted by this SLA `GET /1.0/me/sla/{id}/services` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-sla-id-services **Status:** Stable production version **IAM actions:** `account:apiovh:me/sla/services/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.SlaOperationService[] | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | | Service description | | `serviceName` | string | | Impacted service name | | `slaApplication` | string | | SLA plan application | | `slaPlan` | string | | SLA plan description | ```json [ { "description": "string", "serviceName": "string", "slaApplication": "string", "slaPlan": "string" } ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/sla/{id}/services" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/sla/{id}/services") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/sla/{id}/services"); print_r($result); ?> ``` ## Get the status request of this SLA `GET /1.0/me/sla/{id}/status` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-sla-id-status **Status:** Stable production version **IAM actions:** `account:apiovh:me/sla/status/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string | successful operation | ```json "string" ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/sla/{id}/status" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/sla/{id}/status") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/sla/{id}/status"); print_r($result); ?> ``` ## List of sub-accounts `GET /1.0/me/subAccount` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-subaccount **Status:** Stable production version **IAM actions:** `account:apiovh:me/subAccount/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/subAccount" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/subAccount") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/subAccount"); print_r($result); ?> ``` ## Create a new sub-account `POST /1.0/me/subAccount` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-subaccount **Status:** Stable production version **IAM actions:** `account:apiovh:me/subAccount/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | | Description of the new sub-account | ```json { "description": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer | successful operation | ```json 0 ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/subAccount" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/subAccount", description = None, # Description of the new sub-account (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/subAccount", array( description => null, // Description of the new sub-account (type: string, nullable) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/subAccount/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-subaccount-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/subAccount/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.SubAccount | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | This sub-account description | | `id` | integer | read-only | This sub-account id | ```json { "creationDate": "2024-01-01T12:00:00Z", "description": "string", "id": 0 } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/subAccount/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/subAccount/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/subAccount/{id}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/subAccount/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-subaccount-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/subAccount/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Request body (required) Type: `nichandle.SubAccount` | Field | Type | Required | Description | | --- | --- | --- | --- | | `creationDate` | string (date-time) | read-only | Creation date | | `description` | string | | This sub-account description | | `id` | integer | read-only | This sub-account id | ```json { "description": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/subAccount/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.SubAccount result = client.put("/me/subAccount/{id}", description = None, # This sub-account description (type: string, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/subAccount/{id}", array( description => null, // This sub-account description (type: string, nullable) )); print_r($result); ?> ``` ## Create a consumer key for the current application `POST /1.0/me/subAccount/{id}/createConsumerKey` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-subaccount-id-createconsumerkey **Status:** Stable production version **IAM actions:** `account:apiovh:me/subAccount/createConsumerKey` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | Id of the object | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.SubAccountConsumerKey | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `consumerKey` | string | | The consumer key | ```json { "consumerKey": "string" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/subAccount/{id}/createConsumerKey" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/subAccount/{id}/createConsumerKey") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/subAccount/{id}/createConsumerKey"); print_r($result); ?> ``` ## List of all OVH things you can subscribe to `GET /1.0/me/subscription` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-subscription **Status:** Deprecated, will be removed **Deprecated** since 2023-06-15, removed on 2023-07-15. **IAM actions:** `account:apiovh:me/subscription/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/subscription" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/subscription") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/subscription"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/subscription/{subscriptionType}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-subscription-subscriptiontype **Status:** Deprecated, will be removed **Deprecated** since 2023-06-15, removed on 2023-07-15. **IAM actions:** `account:apiovh:me/subscription/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `subscriptionType` | path | string | yes | The type of subscription | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.Subscription | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `registered` | boolean | | Determine whether you are registered or not | | `type` | string | read-only | The type of subscription | ```json { "registered": true, "type": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/subscription/{subscriptionType}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/subscription/{subscriptionType}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/subscription/{subscriptionType}"); print_r($result); ?> ``` ## Alter this object properties `PUT /1.0/me/subscription/{subscriptionType}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-me-subscription-subscriptiontype **Status:** Deprecated, will be removed **Deprecated** since 2023-06-15, removed on 2023-07-15. **IAM actions:** `account:apiovh:me/subscription/edit` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `subscriptionType` | path | string | yes | The type of subscription | ### Request body (required) Type: `nichandle.Subscription` | Field | Type | Required | Description | | --- | --- | --- | --- | | `registered` | boolean | | Determine whether you are registered or not | | `type` | string | read-only | The type of subscription | ```json { "registered": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/1.0/me/subscription/{subscriptionType}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: nichandle.Subscription result = client.put("/me/subscription/{subscriptionType}", registered = None, # Determine whether you are registered or not (type: boolean, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/me/subscription/{subscriptionType}", array( registered => null, // Determine whether you are registered or not (type: boolean, nullable) )); print_r($result); ?> ``` ## List of service contact change tasks you are involved in `GET /1.0/me/task/contactChange` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-task-contactchange **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/contactChange/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `askingAccount` | query | string | | Filter the value of askingAccount property (like) | | `state` | query | nichandle.changeContact.TaskStateEnum | | Filter the value of state property (like) — one of `aborted`, `checkValidity`, `doing`, `done`, `error`, `expired`, `refused`, `todo`, `validatingByCustomers` | | `toAccount` | query | string | | Filter the value of toAccount property (like) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/task/contactChange" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/task/contactChange") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/task/contactChange"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/task/contactChange/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-task-contactchange-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/contactChange/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.contactChange.Task | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `askingAccount` | string | read-only | Account who asked the contact change | | `contactTypes` | nichandle.changeContact.ContactTypeEnum[] | read-only | Contacts to be changed | | `dateDone` | string (date-time) | read-only | Date at which the contact change has been finished | | `dateRequest` | string (date-time) | read-only | Date at which the request has been made | | `fromAccount` | string | read-only | Account to change contact from | | `id` | integer | read-only | | | `serviceDomain` | string | read-only | The service on which the task runs | | `state` | nichandle.changeContact.TaskStateEnum | read-only | Current state of the request — one of `aborted`, `checkValidity`, `doing`, `done`, `error`, `expired`, `refused`, `todo`, `validatingByCustomers` | | `toAccount` | string | read-only | Account to change contact to | ```json { "askingAccount": "string", "contactTypes": [ "contactAdmin" ], "dateDone": "2024-01-01T12:00:00Z", "dateRequest": "2024-01-01T12:00:00Z", "fromAccount": "string", "id": 0, "serviceDomain": "string", "state": "aborted", "toAccount": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/task/contactChange/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/task/contactChange/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/task/contactChange/{id}"); print_r($result); ?> ``` ## Accept this change request `POST /1.0/me/task/contactChange/{id}/accept` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-task-contactchange-id-accept **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/contactChange/accept` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | yes | The token you received by email for this request | ```json { "token": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/task/contactChange/{id}/accept" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/task/contactChange/{id}/accept", token = None, # The token you received by email for this request (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/task/contactChange/{id}/accept", array( token => null, // The token you received by email for this request (type: string) )); print_r($result); ?> ``` ## Refuse this change request `POST /1.0/me/task/contactChange/{id}/refuse` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-task-contactchange-id-refuse **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/contactChange/refuse` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | yes | The token you received by email for this request | ```json { "token": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/task/contactChange/{id}/refuse" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/task/contactChange/{id}/refuse", token = None, # The token you received by email for this request (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/task/contactChange/{id}/refuse", array( token => null, // The token you received by email for this request (type: string) )); print_r($result); ?> ``` ## This call will send you a new email, containing a new token `POST /1.0/me/task/contactChange/{id}/resendEmail` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-task-contactchange-id-resendemail **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/contactChange/resendEmail` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/task/contactChange/{id}/resendEmail" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/task/contactChange/{id}/resendEmail") # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/task/contactChange/{id}/resendEmail"); print_r($result); ?> ``` ## List of email change tasks you are involved in `GET /1.0/me/task/emailChange` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-task-emailchange **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/emailChange/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `state` | query | nichandle.changeEmail.TaskStateEnum | | Filter the value of state property (like) — one of `aborted`, `done`, `refused`, `todo` | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/task/emailChange" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/task/emailChange") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/task/emailChange"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/task/emailChange/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-task-emailchange-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/emailChange/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.emailChange.Task | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `dateDone` | string (date-time) | read-only | End date of that request | | `dateRequest` | string (date-time) | read-only | Creation date of that request | | `id` | integer | read-only | | | `newEmail` | string | read-only | The email address to change for | | `state` | nichandle.changeEmail.TaskStateEnum | read-only | Current state of the request — one of `aborted`, `done`, `refused`, `todo` | ```json { "dateDone": "2024-01-01T12:00:00Z", "dateRequest": "2024-01-01T12:00:00Z", "id": 0, "newEmail": "string", "state": "aborted" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/task/emailChange/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/task/emailChange/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/task/emailChange/{id}"); print_r($result); ?> ``` ## Accept this change request `POST /1.0/me/task/emailChange/{id}/accept` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-task-emailchange-id-accept **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/emailChange/accept` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | yes | The token you received by email for this request | ```json { "token": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/task/emailChange/{id}/accept" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/task/emailChange/{id}/accept", token = None, # The token you received by email for this request (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/task/emailChange/{id}/accept", array( token => null, // The token you received by email for this request (type: string) )); print_r($result); ?> ``` ## Refuse this change request `POST /1.0/me/task/emailChange/{id}/refuse` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-task-emailchange-id-refuse **Status:** Stable production version **IAM actions:** `account:apiovh:me/task/emailChange/refuse` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | yes | The token you received by email for this request | ```json { "token": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/task/emailChange/{id}/refuse" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/task/emailChange/{id}/refuse", token = None, # The token you received by email for this request (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/task/emailChange/{id}/refuse", array( token => null, // The token you received by email for this request (type: string) )); print_r($result); ?> ``` ## The default SIP IP restictions for your future VoIP lines `GET /1.0/me/telephony/defaultIpRestriction` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-telephony-defaultiprestriction **Status:** Stable production version **IAM actions:** `account:apiovh:me/telephony/defaultIpRestriction/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | integer[] | successful operation | ```json [ 0 ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/telephony/defaultIpRestriction" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/telephony/defaultIpRestriction") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/telephony/defaultIpRestriction"); print_r($result); ?> ``` ## Create a default IP restriction for your future VoIP lines `POST /1.0/me/telephony/defaultIpRestriction` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-telephony-defaultiprestriction **Status:** Stable production version **IAM actions:** `account:apiovh:me/telephony/defaultIpRestriction/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `subnet` | ipv4Block | yes | The IPv4 subnet you want to allow | | `type` | telephony.ProtocolEnum | yes | The protocol you want to restrict (sip/mgcp) — one of `mgcp`, `sip` | ```json { "subnet": "192.0.2.0/24", "type": "mgcp" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | telephony.DefaultIpRestriction | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer | read-only | | | `subnet` | ipv4Block | read-only | The IPv4 subnet you want to allow | | `type` | telephony.ProtocolEnum | read-only | The protocol you want to restrict (sip/mgcp) — one of `mgcp`, `sip` | ```json { "id": 0, "subnet": "192.0.2.0/24", "type": "mgcp" } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/telephony/defaultIpRestriction" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/telephony/defaultIpRestriction", subnet = None, # The IPv4 subnet you want to allow (type: ipv4Block) type = None, # The protocol you want to restrict (sip/mgcp) (type: telephony.ProtocolEnum) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/telephony/defaultIpRestriction", array( subnet => null, // The IPv4 subnet you want to allow (type: ipv4Block) type => null, // The protocol you want to restrict (sip/mgcp) (type: telephony.ProtocolEnum) )); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/telephony/defaultIpRestriction/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-telephony-defaultiprestriction-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/telephony/defaultIpRestriction/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | telephony.DefaultIpRestriction | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer | read-only | | | `subnet` | ipv4Block | read-only | The IPv4 subnet you want to allow | | `type` | telephony.ProtocolEnum | read-only | The protocol you want to restrict (sip/mgcp) — one of `mgcp`, `sip` | ```json { "id": 0, "subnet": "192.0.2.0/24", "type": "mgcp" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/telephony/defaultIpRestriction/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/telephony/defaultIpRestriction/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/telephony/defaultIpRestriction/{id}"); print_r($result); ?> ``` ## Delete a default IP restriction for your future VoIP lines `DELETE /1.0/me/telephony/defaultIpRestriction/{id}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#delete-me-telephony-defaultiprestriction-id **Status:** Stable production version **IAM actions:** `account:apiovh:me/telephony/defaultIpRestriction/delete` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | integer | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X DELETE \ "https://api.eu.ovhcloud.com/1.0/me/telephony/defaultIpRestriction/{id}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.delete("/me/telephony/defaultIpRestriction/{id}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php delete("/me/telephony/defaultIpRestriction/{id}"); print_r($result); ?> ``` ## Get the telephony settings linked to the customer account `GET /1.0/me/telephony/settings` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-telephony-settings **Status:** Stable production version **IAM actions:** `account:apiovh:me/telephony/settings/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | telephony.Settings | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `billingPolicies` | telephony.BillingSettings | | Billing policies settings | | `billingPolicies.renewByBillingContact` | boolean | | Renew is done by billing contact instead of billing account | | `lineDescriptionPolicies` | telephony.LineDescriptionSettings | | Line description policies settings | | `lineDescriptionPolicies.displayOnBill` | boolean | | Line's description is displayed on bills | | `lineDescriptionPolicies.displayOnIncomingCall` | boolean | | Line's description is displayed on incoming calls | ```json { "billingPolicies": { "renewByBillingContact": true }, "lineDescriptionPolicies": { "displayOnBill": true, "displayOnIncomingCall": true } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/telephony/settings" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/telephony/settings") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/telephony/settings"); print_r($result); ?> ``` ## Change the telephony settings linked to the customer account `POST /1.0/me/telephony/settings` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-telephony-settings **Status:** Stable production version **IAM actions:** `account:apiovh:me/telephony/settings/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `settings` | telephony.Settings | yes | Settings to be changed | | `settings.billingPolicies` | telephony.BillingSettings | | Billing policies settings | | `settings.billingPolicies.renewByBillingContact` | boolean | | Renew is done by billing contact instead of billing account | | `settings.lineDescriptionPolicies` | telephony.LineDescriptionSettings | | Line description policies settings | | `settings.lineDescriptionPolicies.displayOnBill` | boolean | | Line's description is displayed on bills | | `settings.lineDescriptionPolicies.displayOnIncomingCall` | boolean | | Line's description is displayed on incoming calls | ```json { "settings": { "billingPolicies": { "renewByBillingContact": true }, "lineDescriptionPolicies": { "displayOnBill": true, "displayOnIncomingCall": true } } } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/telephony/settings" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: telephony.Settings result = client.post("/me/telephony/settings", settings = None, # Settings to be changed (type: telephony.Settings) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/telephony/settings", array( settings => null, // Settings to be changed (type: telephony.Settings) )); print_r($result); ?> ``` ## VIP Status of this account `GET /1.0/me/vipStatus` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-vipstatus **Status:** Stable production version **IAM actions:** `account:apiovh:me/vipStatus/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.VipStatus | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `cloud` | boolean | | Is account VIP for Cloud Universe | | `dedicated` | boolean | | Is account VIP for Dedicated Universe | | `telecom` | boolean | | Is account VIP for Telecom Universe | | `web` | boolean | | Is account VIP for Web Universe | ```json { "cloud": true, "dedicated": true, "telecom": true, "web": true } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/vipStatus" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/vipStatus") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/vipStatus"); print_r($result); ?> ``` ## Verify existing voucher `POST /1.0/me/voucher/checkValidity` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-voucher-checkvalidity **Status:** Stable production version **IAM actions:** `account:apiovh:me/voucher/checkValidity` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `voucher` | string | yes | Voucher value | ```json { "voucher": "string" } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | nichandle.VoucherStatus | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `validity` | boolean | | Is voucher valid | ```json { "validity": true } ``` ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/voucher/checkValidity" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: string result = client.post("/me/voucher/checkValidity", voucher = None, # Voucher value (type: string) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/voucher/checkValidity", array( voucher => null, // Voucher value (type: string) )); print_r($result); ?> ``` ## List of all the withdrawals made from your prepaid account `GET /1.0/me/withdrawal` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-withdrawal **Status:** Stable production version **IAM actions:** `account:apiovh:me/withdrawal/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `date.from` | query | string (date-time) | | Filter the value of date property (>=) | | `date.to` | query | string (date-time) | | Filter the value of date property (<=) | | `orderId` | query | integer | | Filter the value of orderId property (=) | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/withdrawal" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/withdrawal") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/withdrawal"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/withdrawal/{withdrawalId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-withdrawal-withdrawalid **Status:** Stable production version **IAM actions:** `account:apiovh:me/withdrawal/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `withdrawalId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Withdrawal | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `amount` | order.Price | read-only | Price with it's currency and textual representation | | `amount.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `amount.text` | string | | | | `amount.value` | number | | | | `country` | string | read-only | | | `date` | string (date-time) | read-only | | | `orderId` | integer | read-only | | | `password` | string | read-only | | | `pdfUrl` | string | read-only | | | `url` | string | read-only | | | `withdrawalId` | string | read-only | | ```json { "amount": { "currencyCode": "AUD", "text": "string", "value": 0 }, "country": "string", "date": "2024-01-01T12:00:00Z", "orderId": 0, "password": "string", "pdfUrl": "string", "url": "string", "withdrawalId": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/withdrawal/{withdrawalId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/withdrawal/{withdrawalId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/withdrawal/{withdrawalId}"); print_r($result); ?> ``` ## Give access to all entries of this withdrawal `GET /1.0/me/withdrawal/{withdrawalId}/details` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-withdrawal-withdrawalid-details **Status:** Stable production version **IAM actions:** `account:apiovh:me/withdrawal/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `withdrawalId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | string[] | successful operation | ```json [ "string" ] ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/withdrawal/{withdrawalId}/details" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/withdrawal/{withdrawalId}/details") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/withdrawal/{withdrawalId}/details"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/withdrawal/{withdrawalId}/details/{withdrawalDetailId}` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-withdrawal-withdrawalid-details-withdrawaldetailid **Status:** Stable production version **IAM actions:** `account:apiovh:me/withdrawal/details/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `withdrawalDetailId` | path | string | yes | | | `withdrawalId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.WithdrawalDetail | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `description` | string | read-only | | | `domain` | string | read-only | | | `quantity` | string | read-only | | | `totalPrice` | order.Price | read-only | Price with it's currency and textual representation | | `totalPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `totalPrice.text` | string | | | | `totalPrice.value` | number | | | | `unitPrice` | order.Price | read-only | Price with it's currency and textual representation | | `unitPrice.currencyCode` | order.CurrencyCodeEnum | | one of `AUD`, `CAD`, `CZK`, `EUR`, `GBP`, `INR`, `LTL`, `MAD`, `N/A`, `PLN`, `SGD`, `TND`, … | | `unitPrice.text` | string | | | | `unitPrice.value` | number | | | | `withdrawalDetailId` | string | read-only | | ```json { "description": "string", "domain": "string", "quantity": "string", "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "withdrawalDetailId": "string" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/withdrawal/{withdrawalId}/details/{withdrawalDetailId}" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/withdrawal/{withdrawalId}/details/{withdrawalDetailId}") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/withdrawal/{withdrawalId}/details/{withdrawalDetailId}"); print_r($result); ?> ``` ## Get this object properties `GET /1.0/me/withdrawal/{withdrawalId}/payment` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-withdrawal-withdrawalid-payment **Status:** Stable production version **IAM actions:** `account:apiovh:me/withdrawal/payment/get` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `withdrawalId` | path | string | yes | | ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | billing.Payment | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `paymentDate` | string (date-time) | read-only | | | `paymentIdentifier` | string | read-only | | | `paymentType` | billing.PaymentMeanEnum | read-only | All payment means you might have use on an OVH order — one of `cash`, `chargeback`, `check`, `cheque`, `creditAccount`, `creditCard`, `debtAccount`, `deposit`, `digitalLaunchPad`, `edinar`, `fidelityPoints`, `free`, … | ```json { "paymentDate": "2024-01-01T12:00:00Z", "paymentIdentifier": "string", "paymentType": "cash" } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/withdrawal/{withdrawalId}/payment" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/withdrawal/{withdrawalId}/payment") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/withdrawal/{withdrawalId}/payment"); print_r($result); ?> ``` ## Get xdsl settings linked to the nichandle `GET /1.0/me/xdsl/setting` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-me-xdsl-setting **Status:** Stable production version **IAM actions:** `account:apiovh:me/xdsl/setting/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | xdsl.Setting | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `ispPartnerOrderCollectChoice` | boolean | | Enable the partner collect choice in the order funnel | | `resellerFastModemShipping` | boolean | | Send the modem as soon as possible, do not wait the xdsl line to be active | | `resellerModemBasicConfig` | boolean | | Let the modem with vendor configuration. It prevent to apply the config managed by ovh manager | ```json { "ispPartnerOrderCollectChoice": true, "resellerFastModemShipping": true, "resellerModemBasicConfig": true } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/1.0/me/xdsl/setting" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/me/xdsl/setting") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/me/xdsl/setting"); print_r($result); ?> ``` ## Change xdsl settings linked to the nichandle `POST /1.0/me/xdsl/setting` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#post-me-xdsl-setting **Status:** Stable production version **IAM actions:** `account:apiovh:me/xdsl/setting/create` ### Request body (required) Type: `object` | Field | Type | Required | Description | | --- | --- | --- | --- | | `resellerFastModemShipping` | boolean | | Send the modem as soon as possible, do not wait the xdsl line to be active | | `resellerModemBasicConfig` | boolean | | Let the modem with vendor configuration. It prevent to apply the config managed by ovh manager | ```json { "resellerFastModemShipping": true, "resellerModemBasicConfig": true } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | — | successful operation | ### Example ```bash curl -X POST \ "https://api.eu.ovhcloud.com/1.0/me/xdsl/setting" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.post("/me/xdsl/setting", resellerFastModemShipping = None, # Send the modem as soon as possible, do not wait the xdsl line to be active (type: boolean, nullable) resellerModemBasicConfig = None, # Let the modem with vendor configuration. It prevent to apply the config managed by ovh manager (type: boolean, nullable) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php post("/me/xdsl/setting", array( resellerFastModemShipping => null, // Send the modem as soon as possible, do not wait the xdsl line to be active (type: boolean, nullable) resellerModemBasicConfig => null, // Let the modem with vendor configuration. It prevent to apply the config managed by ovh manager (type: boolean, nullable) )); print_r($result); ?> ``` ## Get the current and available API revisions `GET /v2/account/api/revision` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#get-account-api-revision **Status:** Alpha version **IAM actions:** `account:apiovh:revision/get` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | revisions.revision.AccountRevision | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `availableRevisions` | string[] | read-only | Available API revisions to transition to | | `currentState` | revisions.revision.AccountRevisionCurrentState | read-only | Current state of the API revision | | `currentState.revision` | string | read-only | Currently active API revision | | `targetSpec` | revisions.revision.AccountRevisionTargetSpec | read-only | Target specification for the API revision | | `targetSpec.revision` | string | yes | API revision to set as active | ```json { "availableRevisions": [ "string" ], "currentState": { "revision": "string" }, "targetSpec": { "revision": "string" } } ``` ### Example ```bash curl -X GET \ "https://api.eu.ovhcloud.com/v2/account/api/revision" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) result = client.get("/v2/account/api/revision") # Pretty print print(json.dumps(result, indent=4)) ``` ```php get("/v2/account/api/revision"); print_r($result); ?> ``` ## Update the current API revision `PUT /v2/account/api/revision` Link: https://developers.eu.ovhcloud.com/reference/account/profile/#put-account-api-revision **Status:** Alpha version **IAM actions:** `account:apiovh:revision/edit` ### Request body (required) Type: `revisions.revision.AccountRevisionInput` | Field | Type | Required | Description | | --- | --- | --- | --- | | `targetSpec` | revisions.revision.AccountRevisionTargetSpec | yes | Requested target specification | | `targetSpec.revision` | string | yes | API revision to set as active | ```json { "targetSpec": { "revision": "string" } } ``` ### Responses | Status | Type | Description | | --- | --- | --- | | 200 | revisions.revision.AccountRevision | successful operation | | Field | Type | Required | Description | | --- | --- | --- | --- | | `availableRevisions` | string[] | read-only | Available API revisions to transition to | | `currentState` | revisions.revision.AccountRevisionCurrentState | read-only | Current state of the API revision | | `currentState.revision` | string | read-only | Currently active API revision | | `targetSpec` | revisions.revision.AccountRevisionTargetSpec | read-only | Target specification for the API revision | | `targetSpec.revision` | string | yes | API revision to set as active | ```json { "availableRevisions": [ "string" ], "currentState": { "revision": "string" }, "targetSpec": { "revision": "string" } } ``` ### Example ```bash curl -X PUT \ "https://api.eu.ovhcloud.com/v2/account/api/revision" \ -H "accept: application/json" \ -H "authorization: Bearer $OVH_TOKEN" \ -H "content-type: application/json" \ -d '{ }' ``` ```python ''' First, install the latest release of Python wrapper: $ pip install ovh ''' import json import ovh # Instantiate an OVH Client. # You can generate new credentials with full access to your account on # the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*) client = ovh.Client( endpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application) application_key='xxxxxxxxxx', # Application Key application_secret='xxxxxxxxxx', # Application Secret consumer_key='xxxxxxxxxx', # Consumer Key ) # Request body type: revisions.revision.AccountRevisionInput result = client.put("/v2/account/api/revision", targetSpec = None, # Requested target specification (type: revisions.revision.AccountRevisionTargetSpec) ) # Pretty print print(json.dumps(result, indent=4)) ``` ```php put("/v2/account/api/revision", array( targetSpec => null, // Requested target specification (type: revisions.revision.AccountRevisionTargetSpec) )); print_r($result); ?> ```