{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"email.exchange.Domain":{"type":"object","description":"Exchange domain","properties":{"cnameToCheck":{"type":"string","description":"Cname that will be checked to prove the domain ownership","nullable":true,"readOnly":true},"dkimDiagnostics":{"allOf":[{"$ref":"#/components/schemas/email.exchange.DomainDkimDiagnostics"}],"description":"DKIM diagnostics on this domain","readOnly":true},"domainAliases":{"type":"array","description":"List of aliases for this domain","items":{"type":"string"},"readOnly":true},"domainValidated":{"type":"boolean","description":"Domain validation status","readOnly":true},"expectedAutodiscoverSRV":{"type":"string","description":"Expected SRV record on this domain","readOnly":true},"expectedMX":{"type":"array","description":"Expected MX record(s) on this domain","items":{"type":"string"},"readOnly":true},"expectedSPF":{"type":"string","description":"Expected SPF record on this domain","readOnly":true},"isAliasDomain":{"type":"boolean","description":"Indicate if this domain is an alias for another domain","readOnly":true},"main":{"type":"boolean","description":"If true this is an organization (Exchange 2010 only)","nullable":true,"readOnly":true},"mxIsValid":{"type":"boolean","description":"If true your dns mx configuration is valid","readOnly":true},"mxRecord":{"type":"array","description":"Domain MX record configured in DNS","nullable":true,"items":{"type":"string"},"readOnly":true},"mxRelay":{"type":"string","description":"If specified, emails to not existing address will be redirected to that domain","nullable":true},"name":{"type":"string","description":"Domain name","readOnly":true},"organization2010":{"type":"string","description":"If specified, indicates to which organization this domain belongs (Exchange 2010 only)","nullable":true,"readOnly":true},"sbrDefault":{"type":"string","description":"Relay domain address that will be used to all newly created accounts","nullable":true,"readOnly":true},"sendConnectorIdDefault":{"type":"integer","description":"Send connector id that will be used to all newly created accounts","nullable":true,"readOnly":true},"spfIsValid":{"type":"boolean","description":"Wether your SPF record is valid","readOnly":true},"spfRecord":{"type":"array","description":"Domain's SPF record configured in the DNS","nullable":true,"items":{"type":"string"},"readOnly":true},"srvIsValid":{"type":"boolean","description":"If true your dns srv record is valid","readOnly":true},"srvRecord":{"type":"array","description":"Domain SRV record configured in DNS","nullable":true,"items":{"type":"string"},"readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/email.exchange.ObjectStateEnum"}],"description":"Domain state","readOnly":true},"taskPendingId":{"type":"integer","description":"Pending taks id","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/email.exchange.DomainTypeEnum"}],"description":"Domain type"}}},"email.exchange.DomainDkimDiagnostics":{"type":"object","description":"DKIM diagnostics information for domain","properties":{"errorCode":{"type":"integer","nullable":true},"message":{"type":"string","nullable":true},"state":{"$ref":"#/components/schemas/email.exchange.DomainDkimDiagnosticsStateEnum"}}},"email.exchange.DomainDkimDiagnosticsStateEnum":{"type":"string","description":"Domain DKIM state","enum":["active","disabled","error","inProgress","toConfigure"]},"email.exchange.DomainTypeEnum":{"type":"string","description":"Domain type","enum":["authoritative","nonAuthoritative"]},"email.exchange.ObjectStateEnum":{"type":"string","description":"Current object state","enum":["creating","deleting","internalMigration","ok","reopening","suspended","suspending"]},"email.exchange.Task":{"type":"object","description":"Exchange task details","properties":{"finishDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/email.exchange.TaskFunctionEnum"}],"description":"Function name","readOnly":true},"id":{"type":"integer","description":"Task id","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/email.exchange.TaskStatusEnum"}],"description":"Task status","readOnly":true},"todoDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true}}},"email.exchange.TaskFunctionEnum":{"type":"string","description":"function enumeration for exchange task","enum":["activateSharepoint","addAccount","addAccountArchive","addAccountImpersonation","addActiveSyncMailNotification","addAlias","addDistributionGroup","addDistributionGroupManager","addDistributionGroupMember","addDistributionGroupSendAs","addDistributionGroupSendOnBehalfTo","addDomain","addDomainDisclaimer","addExchangeCustomIsolation","addExchangeDomainDKIM","addExchangeRemoteMailbox","addExchangeServiceAuthorizedIp","addExportPstRequest","addExternalContact","addFullAccess","addOutlookLicense","addPublicFolder","addPublicFolderPermission","addResourceAccount","addResourceDelegate","addSendAs","addSendConnector","addSendOnBehalfTo","addSharedAccount","addSharedAccountFullAccess","addSharedAccountSendAs","addSharedAccountSendOnBehalfTo","changeHostname","changePassword","clearDataOnDevice","cloneTemplateExchangePrivate","configureExchangeCustomer","configureExchangeOwaMfa","copyMailbox","createExternalAntiSpamReceiveConnector","deleteAccount","deleteAccountArchive","deleteAccountImpersonation","deleteActiveSyncMailNotification","deleteAlias","deleteDistributionGroup","deleteDistributionGroupManager","deleteDistributionGroupMember","deleteDistributionGroupSendAs","deleteDistributionGroupSendOnBehalfTo","deleteDomain","deleteDomainDisclaimer","deleteExchangeCustomIsolation","deleteExchangeDomainDKIM","deleteExchangeRemoteMailbox","deleteExchangeService","deleteExchangeServiceAuthorizedIp","deleteExportPstRequest","deleteExternalAntiSpamReceiveConnector","deleteExternalContact","deleteFullAccess","deleteOutlookLicense","deletePublicFolder","deletePublicFolderPermission","deleteResourceAccount","deleteResourceDelegate","deleteSendAs","deleteSendConnector","deleteSendOnBehalfTo","deleteSharedAccount","deleteSharedAccountFullAccess","deleteSharedAccountSendAs","deleteSharedAccountSendOnBehalfTo","destroyPrivateVm","diagnoseAccount","disableExchangeDKIM","enableExchangeDKIM","expandDrive","generateOutlookUrl","generatePstUrl","installExchange","installSSL","maintenance","migrationAccount","migrationDisclaimer","migrationExternalContact","migrationHistory","migrationMailingList","migrationResourceAccount","migrationService","reOpenHostedAccount","reOpenOutlookLicense","reOpenPrivateAccount","reOpenPrivateVm","setAccount","setAccountArchive","setAlias","setDistributionGroup","setDns","setDomain","setDomainDisclaimer","setExchangeAccountProtocol","setExchangeRemoteMailbox","setExchangeServiceDevice","setExternalAntiSpamReceiveConnector","setExternalContact","setPublicFolder","setPublicFolderPermission","setResourceAccount","setSendConnector","setService","setSharedAccount","suspendAccount","suspendExchangeService","suspendHostedAccount","suspendOutlookLicense","suspendPrivateAccount","suspendPrivateVm","unsuspendAccount","unsuspendExchangeService","unsuspendHostedAccount","updateExchangeServiceDevice","upgrade2016"]},"email.exchange.TaskStatusEnum":{"type":"string","description":"Exchange task status","enum":["cancelled","doing","done","error","todo"]},"email.exchange.dkim":{"type":"object","description":"DKIM for a domain","properties":{"cnameIsValid":{"type":"boolean","description":"If true your dns cname configuration is valid","readOnly":true},"customerRecord":{"type":"string","description":"customer dns record","readOnly":true},"header":{"type":"string","description":"header used for dkim signature","readOnly":true},"lastUpdate":{"type":"string","description":"Last update date","nullable":true,"format":"date-time","readOnly":true},"recordType":{"type":"string","description":"Record type of the customer record","readOnly":true},"selectorName":{"type":"string","description":"selectorName","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/email.exchange.dkimStatusEnum"}],"description":"dkim status","readOnly":true},"targetRecord":{"type":"string","description":"Target of the customer record","nullable":true,"readOnly":true},"taskPendingId":{"type":"integer","description":"Pending task for this DKIM","nullable":true,"readOnly":true}}},"email.exchange.dkimStatusEnum":{"type":"string","description":"dkim status","enum":["deleting","disabling","enabling","inProduction","ready","todo","waitingRecord"]},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"msServices.Task":{"type":"object","description":"Active Directory task details","properties":{"finishDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/msServices.TaskFunctionEnum"}],"description":"Function name","readOnly":true},"id":{"type":"integer","description":"Task id","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/msServices.TaskStatusEnum"}],"description":"Task status","readOnly":true},"todoDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true}}},"msServices.TaskFunctionEnum":{"type":"string","description":"function enumeration for Active Directory task","enum":["activateADSync","activateSharepoint","addADAccount","addADOU","addADSyncAccount","addADUPNSuffix","alterMfaOnAllUsers","changeADPassword","changeADSyncPassword","deactivateADSync","delADOU","deleteADAccount","deleteADSyncAccount","deleteADUPNSuffix","disableADAccountMfa","disableADAccountMfaTemporary","enableADAccountMfa","enableADSyncAccount","generateADSyncClientUrl","resetADAccountMfa","setADAccount","setPasswordPolicy"]},"msServices.TaskStatusEnum":{"type":"string","description":"ActiveDirectory task status","enum":["cancelled","doing","done","error","todo"]},"msServices.UPNStateEnum":{"type":"string","description":"Active Directory UPN Suffix State","enum":["creating","deleting","ok"]},"msServices.upnSuffix":{"type":"object","description":"Active Directory UPN Suffix","properties":{"cnameToCheck":{"type":"string","description":"Cname record used for UPN suffix verification","nullable":true,"readOnly":true},"ownershipValidated":{"type":"boolean","description":"Ownership for upn suffix confirmed","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/msServices.UPNStateEnum"}],"description":"UPN suffix state","readOnly":true},"suffix":{"type":"string","description":"UPN suffix","readOnly":true},"taskPendingId":{"type":"integer","description":"Pending task for this upnSuffix","readOnly":true}}},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/email/exchange/{organizationName}/service/{exchangeService}/domain":{"get":{"summary":"List domains","description":"List domains. Returns the names of the domains of the service. Filter them by `state`, or set `main` to get the main domain only.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"query","name":"main","description":"Filter the value of main property (like)","schema":{"type":"boolean"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"query","name":"state","description":"Filter the value of state property (=)","schema":{"$ref":"#/components/schemas/email.exchange.ObjectStateEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@10"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@10"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/get","required":true}],"x-expanded-response":"EmailExchangeDomain"},"post":{"summary":"Add a domain","description":"Add a domain. Adds an authoritative or non-authoritative domain to the service and returns the task. For a domain hosted by OVHcloud, the MX, SPF, autodiscover and DKIM records can be configured automatically.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoEnableDKIM":{"type":"boolean","description":"Enable DKIM automatically after DKIM configuration"},"configureAutodiscover":{"type":"boolean","description":"If you host domain in OVH we can configure autodiscover record automatically"},"configureDKIM":{"type":"boolean","description":"Launch configuration of DKIM automatically for the domain"},"configureMx":{"type":"boolean","description":"If you host domain in OVH we can configure mx record automatically"},"configureSPF":{"type":"boolean","description":"Enable automatic SPF record (only for domains hosted by OVHcloud)"},"main":{"type":"boolean","description":"This newly created domain will be an organization (Exchange 2010 only)"},"mxRelay":{"type":"string","description":"If specified, emails to not existing address will be redirected to that domain"},"name":{"type":"string","description":"Domain to install on server"},"organization2010":{"type":"string","description":"If specified, indicates which organization this newly created domain will be part of (Exchange 2010 only)"},"sbrDefault":{"type":"string","description":"Default Sender base routing destination domain applied on all new created accounts"},"sendConnectorIdDefault":{"type":"integer","description":"Default Sender Connector id applied on all new created accounts"},"type":{"description":"Type of domain that You want to install","$ref":"#/components/schemas/email.exchange.DomainTypeEnum"}},"required":["name","type"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@30"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@30"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain\",\n\tautoEnableDKIM = None, # Enable DKIM automatically after DKIM configuration (type: boolean, nullable)\n\tconfigureAutodiscover = None, # If you host domain in OVH we can configure autodiscover record automatically (type: boolean, nullable)\n\tconfigureDKIM = None, # Launch configuration of DKIM automatically for the domain (type: boolean, nullable)\n\tconfigureMx = None, # If you host domain in OVH we can configure mx record automatically (type: boolean, nullable)\n\tconfigureSPF = None, # Enable automatic SPF record (only for domains hosted by OVHcloud) (type: boolean, nullable)\n\tmain = None, # This newly created domain will be an organization (Exchange 2010 only) (type: boolean, nullable)\n\tmxRelay = None, # If specified, emails to not existing address will be redirected to that domain (type: string, nullable)\n\tname = None, # Domain to install on server (type: string)\n\torganization2010 = None, # If specified, indicates which organization this newly created domain will be part of (Exchange 2010 only) (type: string, nullable)\n\tsbrDefault = None, # Default Sender base routing destination domain applied on all new created accounts (type: string, nullable)\n\tsendConnectorIdDefault = None, # Default Sender Connector id applied on all new created accounts (type: long, nullable)\n\ttype = None, # Type of domain that You want to install (type: email.exchange.DomainTypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain\", array(\n\tautoEnableDKIM => null, // Enable DKIM automatically after DKIM configuration (type: boolean, nullable)\n\tconfigureAutodiscover => null, // If you host domain in OVH we can configure autodiscover record automatically (type: boolean, nullable)\n\tconfigureDKIM => null, // Launch configuration of DKIM automatically for the domain (type: boolean, nullable)\n\tconfigureMx => null, // If you host domain in OVH we can configure mx record automatically (type: boolean, nullable)\n\tconfigureSPF => null, // Enable automatic SPF record (only for domains hosted by OVHcloud) (type: boolean, nullable)\n\tmain => null, // This newly created domain will be an organization (Exchange 2010 only) (type: boolean, nullable)\n\tmxRelay => null, // If specified, emails to not existing address will be redirected to that domain (type: string, nullable)\n\tname => null, // Domain to install on server (type: string)\n\torganization2010 => null, // If specified, indicates which organization this newly created domain will be part of (Exchange 2010 only) (type: string, nullable)\n\tsbrDefault => null, // Default Sender base routing destination domain applied on all new created accounts (type: string, nullable)\n\tsendConnectorIdDefault => null, // Default Sender Connector id applied on all new created accounts (type: long, nullable)\n\ttype => null, // Type of domain that You want to install (type: email.exchange.DomainTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/create","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}":{"delete":{"summary":"Remove a domain","description":"Remove a domain. Detaches the domain from the Exchange service, which no longer serves email addresses on it, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@40"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@40"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/delete","required":true}]},"get":{"summary":"Get a domain","description":"Get a domain. Returns the type, state and validation status of the domain, its expected and configured MX, SPF and SRV records, and its DKIM diagnostics.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Domain"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@20"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@20"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/get","required":true}]},"put":{"summary":"Update a domain","description":"Update a domain. Updates the type of the domain and `mxRelay`, the domain that receives the emails sent to addresses that do not exist.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Domain"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@50"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@50"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: email.exchange.Domain\nresult = client.put(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}\",\n\tmxRelay = None, # If specified, emails to not existing address will be redirected to that domain (type: string, nullable)\n\ttype = None, # Domain type (type: email.exchange.DomainTypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: email.exchange.Domain\n$result = $ovh->put(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}\", array(\n\tmxRelay => null, // If specified, emails to not existing address will be redirected to that domain (type: string, nullable)\n\ttype => null, // Domain type (type: email.exchange.DomainTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/edit","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/changeDefaultSBR":{"put":{"summary":"Change the default sender-based routing","description":"Change the default sender-based routing. Sets the destination domain (`sbrDefault`) and the send connector (`sendConnectorIdDefault`) applied to all new accounts of the domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sbrDefault":{"type":"string","description":"Default Sender base routing destination domain applied on all new created accounts"},"sendConnectorIdDefault":{"type":"integer","description":"Default Sender Connector id applied on all new created accounts"}}}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@60"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@60"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@60"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.put(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/changeDefaultSBR\",\n\tsbrDefault = None, # Default Sender base routing destination domain applied on all new created accounts (type: string, nullable)\n\tsendConnectorIdDefault = None, # Default Sender Connector id applied on all new created accounts (type: long, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->put(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/changeDefaultSBR\", array(\n\tsbrDefault => null, // Default Sender base routing destination domain applied on all new created accounts (type: string, nullable)\n\tsendConnectorIdDefault => null, // Default Sender Connector id applied on all new created accounts (type: long, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/changeDefaultSBR","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim":{"get":{"summary":"List DKIM selectors","description":"List DKIM selectors. Returns the names of the DKIM selectors of the domain. Get one to read its DNS record and its status.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@70"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@70"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/dkim/get","required":true}],"x-expanded-response":"EmailExchangeDkim"},"post":{"summary":"Create a DKIM selector","description":"Create a DKIM selector. Creates a DKIM selector on the domain and returns the task. For a domain hosted by OVHcloud, `configureDkim` creates the DNS record and `autoEnableDKIM` enables the selector once configured.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoEnableDKIM":{"type":"boolean","description":"Enable DKIM automatically after DKIM configuration"},"configureDkim":{"type":"boolean","description":"If you host domain in OVH we can configure dkim dns record automatically"},"selectorName":{"type":"string","description":"selector name for DKIM"}},"required":["selectorName"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@90"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@90"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim\",\n\tautoEnableDKIM = None, # Enable DKIM automatically after DKIM configuration (type: boolean, nullable)\n\tconfigureDkim = None, # If you host domain in OVH we can configure dkim dns record automatically (type: boolean, nullable)\n\tselectorName = None, # selector name for DKIM (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim\", array(\n\tautoEnableDKIM => null, // Enable DKIM automatically after DKIM configuration (type: boolean, nullable)\n\tconfigureDkim => null, // If you host domain in OVH we can configure dkim dns record automatically (type: boolean, nullable)\n\tselectorName => null, // selector name for DKIM (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/dkim/create","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}":{"delete":{"summary":"Delete a DKIM selector","description":"Delete a DKIM selector. Removes the DKIM selector and its key from the domain of the Exchange service, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"selectorName","description":"selectorName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@100"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@100"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/dkim/delete","required":true}]},"get":{"summary":"Get a DKIM selector","description":"Get a DKIM selector. Returns the status of the DKIM selector, the DNS record to create (name, type and target) and whether the CNAME record is valid.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"selectorName","description":"selectorName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.dkim"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@80"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@80"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/dkim/get","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}/disable":{"post":{"summary":"Disable DKIM signing","description":"Disable DKIM signing. Stops signing the emails of the domain with this DKIM selector, and returns the task. The selector is kept.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"selectorName","description":"selectorName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@110"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@110"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}/disable\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}/disable\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/dkim/disable","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}/enable":{"post":{"summary":"Enable DKIM signing","description":"Enable DKIM signing. Enables DKIM signing with the selector, or switches the selector in use to this one, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"selectorName","description":"selectorName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@120"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@120"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}/enable\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkim/{selectorName}/enable\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/dkim/enable","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkimSelector":{"get":{"summary":"List available DKIM selectors","description":"List available DKIM selectors. Returns the selector names that can be used to create a DKIM selector on the domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@130"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@130"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@130"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkimSelector\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/dkimSelector\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/domain/dkimSelector/get","required":true}]}},"/msServices/{serviceName}/upnSuffix":{"get":{"summary":"List UPN suffixes","description":"List UPN suffixes. Returns the UPN suffixes of the Active Directory service. Get one to read its state and the CNAME to check.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your Active Directory organization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@140"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@140"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@140"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/msServices/{serviceName}/upnSuffix\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/msServices/{serviceName}/upnSuffix\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"microsoftServices:apiovh:upnSuffix/get","required":true}],"x-expanded-response":"MsServicesUpnSuffix"},"post":{"summary":"Create a UPN suffix","description":"Create a UPN suffix. Adds a UPN suffix to the Active Directory service and returns the task. Its ownership is verified with the CNAME record given in `cnameToCheck`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your Active Directory organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"suffix":{"type":"string","description":"UPN suffix to create"}},"required":["suffix"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/msServices.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@160"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@160"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/msServices/{serviceName}/upnSuffix\",\n\tsuffix = None, # UPN suffix to create (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/msServices/{serviceName}/upnSuffix\", array(\n\tsuffix => null, // UPN suffix to create (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"microsoftServices:apiovh:upnSuffix/create","required":true}]}},"/msServices/{serviceName}/upnSuffix/{suffix}":{"delete":{"summary":"Delete a UPN suffix","description":"Delete a UPN suffix. Removes the UPN suffix from the Active Directory service, so that user names can no longer use it, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your Active Directory organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"suffix","description":"UPN suffix","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/msServices.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@170"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@170"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@170"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/msServices/{serviceName}/upnSuffix/{suffix}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/msServices/{serviceName}/upnSuffix/{suffix}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"microsoftServices:apiovh:upnSuffix/delete","required":true}]},"get":{"summary":"Get a UPN suffix","description":"Get a UPN suffix. Returns the state of the UPN suffix, the CNAME record used to verify it and whether its ownership is validated.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your Active Directory organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"suffix","description":"UPN suffix","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/msServices.upnSuffix"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Hosted Exchange","Domains@@@150"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Domains@@@150"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Domains@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/msServices/{serviceName}/upnSuffix/{suffix}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/msServices/{serviceName}/upnSuffix/{suffix}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"microsoftServices:apiovh:upnSuffix/get","required":true}]}}}}