{"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/v2"}],"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"},"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"},"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"},"zimbra.CName":{"type":"object","description":"Object representing a DNS CName entry","properties":{"name":{"type":"string","description":"Name of the CName entry on customer DNS","readOnly":true},"value":{"type":"string","description":"Value of the CName entry on customer DNS","readOnly":true}}},"zimbra.DKIMSelectors":{"type":"object","description":"Object representing a DKIM selector objet which is a CName entry","properties":{"cnames":{"type":"array","description":"List of CName to configure for DKIM","items":{"$ref":"#/components/schemas/zimbra.CName"},"readOnly":true}}},"zimbra.DNSOwnership":{"type":"object","description":"Object representing a DNS configuration that should be applied to verify ownership","properties":{"cname":{"type":"string","description":"Identifier on zone of domain for verification","nullable":true,"readOnly":true}}},"zimbra.DomainDiagnosisError":{"type":"object","description":"Errors of failed diagnostic","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisErrorCodeEnum"}],"description":"Status of performed diagnostic process for given domain","readOnly":true},"message":{"type":"string","description":"Diagnosis message","readOnly":true}}},"zimbra.DomainDiagnosisErrorCodeEnum":{"type":"string","description":"Status of performed diagnostic process for given domain","enum":["BAD_CONFIGURATION","DOMAIN_IN_TRANSIENT_STATE","DOMAIN_NOT_FOUND","DOMAIN_NOT_VALIDATED","INTERNAL_ERROR"]},"zimbra.DomainDiagnosisPostPayload":{"type":"object","description":"Payload for diagnosing domains","properties":{"domains":{"type":"array","description":"List of domains to diagnose","items":{"type":"string","format":"uuid"}}},"required":["domains"]},"zimbra.DomainDiagnosisRecommendations":{"type":"object","description":"Recommendations on how to configure a domain","properties":{"expectedDNSConfig":{"allOf":[{"$ref":"#/components/schemas/zimbra.ExpectedDNSConfig"}],"description":"Expected configuration of a domain","readOnly":true}}},"zimbra.DomainDiagnosisResponse":{"type":"object","description":"Object representing domain","properties":{"domainId":{"type":"string","description":"Identifier of the domain","format":"uuid","readOnly":true},"domainName":{"type":"string","description":"Name of the domain","nullable":true,"readOnly":true},"error":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisError"}],"description":"List of errors when doing diagnostics","nullable":true,"readOnly":true},"isExternal":{"type":"boolean","description":"Whether domain is not managed by OVHcloud, it allows autoconfiguration of the domain","nullable":true,"readOnly":true},"recommendations":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisRecommendations"}],"description":"Recommendations on how to configure a domain","nullable":true,"readOnly":true},"result":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisResult"}],"description":"Result of the diagnosis","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisStatusEnum"}],"description":"Status of the diagnosis","readOnly":true}}},"zimbra.DomainDiagnosisResult":{"type":"object","description":"The result of the diagnosis","properties":{"autodiscover":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestAutodiscoverResult"}],"description":"The result of the Autodiscover diagnosis","readOnly":true},"dkim":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestDKIMResult"}],"description":"The result of the DKIM diagnosis","readOnly":true},"mx":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestMXResult"}],"description":"The result of the MX diagnosis","readOnly":true},"spf":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestSPFResult"}],"description":"The result of the SPF diagnosis","readOnly":true}}},"zimbra.DomainDiagnosisStatusEnum":{"type":"string","description":"Status of performed diagnostic process for given domain","enum":["ERROR","OK","PARTIAL"]},"zimbra.DomainDiagnosisTestAutodiscoverError":{"type":"object","description":"Details on the Autodiscover error diagnosis error","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestAutodiscoverErrorCodeEnum"}],"description":"The error code for the Autodiscover error","readOnly":true},"message":{"type":"string","description":"The error message for the Autodiscover error","readOnly":true}}},"zimbra.DomainDiagnosisTestAutodiscoverErrorCodeEnum":{"type":"string","description":"Error code of Autodiscover Diagnosis","enum":["INCORRECT_SRV_RECORD","INTERNAL_ERROR","MULTIPLE_SRV_RECORDS","NO_SRV_RECORD","TASK_FAILED","TASK_RUNNING"]},"zimbra.DomainDiagnosisTestAutodiscoverResult":{"type":"object","description":"Autodiscover Diagnosis test result","properties":{"errors":{"type":"array","description":"List of errors during Autodiscover diagnosis","items":{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestAutodiscoverError"},"readOnly":true},"recordsFound":{"type":"array","description":"Found Autodiscover record","items":{"type":"string"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestStatusEnum"}],"description":"Status of performed diagnostic process for Autodiscover test","readOnly":true}}},"zimbra.DomainDiagnosisTestDKIMError":{"type":"object","description":"Details on the DKIM error diagnosis error","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestDKIMErrorCodeEnum"}],"description":"The error code for the DKIM error","readOnly":true},"message":{"type":"string","description":"The error message for the DKIM error","readOnly":true}}},"zimbra.DomainDiagnosisTestDKIMErrorCodeEnum":{"type":"string","description":"Error code of DKIM Diagnosis","enum":["DKIM_DISABLED","INCORRECT_CNAME_RECORD","INTERNAL_ERROR","MISSING_ONE_SELECTOR","OVH_NOT_INCLUDED","TASK_FAILED","TASK_RUNNING"]},"zimbra.DomainDiagnosisTestDKIMResult":{"type":"object","description":"DKIM Diagnosis test result","properties":{"errors":{"type":"array","description":"List of error during DKIM diagnosis","items":{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestDKIMError"},"readOnly":true},"recordsFound":{"type":"array","description":"Found DKIM records","items":{"$ref":"#/components/schemas/zimbra.CName"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestStatusEnum"}],"description":"Status of performed diagnostic process for DKIM test","readOnly":true}}},"zimbra.DomainDiagnosisTestMXError":{"type":"object","description":"Details on the MX error diagnosis error","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestMXErrorCodeEnum"}],"description":"The error code for the MX error","readOnly":true},"message":{"type":"string","description":"The error message for the MX error","readOnly":true}}},"zimbra.DomainDiagnosisTestMXErrorCodeEnum":{"type":"string","description":"Error code of the MX diagnosis","enum":["EXTERNAL_MX_RECORD","INTERNAL_ERROR","MISSING_OVH_SERVER","NO_MX_RECORD","OVH_MX_LOW_PRIORITY"]},"zimbra.DomainDiagnosisTestMXResult":{"type":"object","description":"MX Diagnosis test result","properties":{"errors":{"type":"array","description":"List of errors during MX diagnosis","items":{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestMXError"},"readOnly":true},"recordsFound":{"type":"array","description":"Found MX records","items":{"$ref":"#/components/schemas/zimbra.MXRecord"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestStatusEnum"}],"description":"Status of performed diagnostic process for MX test","readOnly":true}}},"zimbra.DomainDiagnosisTestSPFError":{"type":"object","description":"Details on the SPF error diagnosis error","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestSPFErrorCodeEnum"}],"description":"The error code for the SPF error","readOnly":true},"message":{"type":"string","description":"The error message for the SPF error","readOnly":true}}},"zimbra.DomainDiagnosisTestSPFErrorCodeEnum":{"type":"string","description":"Error code of the SPF diagnosis","enum":["DANGEROUS_SPF_POLICY","INTERNAL_ERROR","INVALID_SPF_RECORD","MISSING_OVH_SERVER","MISSING_SPF_POLICY","MULTIPLE_SPF_RECORDS","NOT_RECOMMENDED_SPF_POLICY","NO_SPF_RECORD"]},"zimbra.DomainDiagnosisTestSPFResult":{"type":"object","description":"SPF Diagnosis test result","properties":{"errors":{"type":"array","description":"List of errors during SPF diagnosis","items":{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestSPFError"},"readOnly":true},"recordsFound":{"type":"array","description":"Found SPF record","items":{"type":"string"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/zimbra.DomainDiagnosisTestStatusEnum"}],"description":"Status of performed diagnostic process for SPF test","readOnly":true}}},"zimbra.DomainDiagnosisTestStatusEnum":{"type":"string","description":"Status of performed diagnostic process for given test","enum":["ERROR","OK","WARNING"]},"zimbra.ExpectedDNSConfig":{"type":"object","description":"Object representing a DNS configuration that should be applied","properties":{"autodiscover":{"type":"string","description":"Recommended autodiscover value","readOnly":true},"dkim":{"allOf":[{"$ref":"#/components/schemas/zimbra.DKIMSelectors"}],"description":"Recommended DKIM selectors","readOnly":true},"mx":{"type":"array","description":"Recommended MX records for efficient mail delivery","items":{"$ref":"#/components/schemas/zimbra.MXRecord"},"readOnly":true},"ownership":{"allOf":[{"$ref":"#/components/schemas/zimbra.DNSOwnership"}],"description":"DNS configuration to apply to verify ownership","readOnly":true},"spf":{"type":"string","description":"Recommended SPF value","readOnly":true}}},"zimbra.MXRecord":{"type":"object","description":"Object representing an MX record","properties":{"priority":{"type":"integer","description":"Priority for that target server","readOnly":true},"target":{"type":"string","description":"Target server","readOnly":true}}}},"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":{"/zimbra/platform/{platformId}/diagnostic/domain":{"post":{"operationId":"diagnoseZimbraDomains","summary":"Diagnose domains","description":"Checks the MX, SPF, DKIM and autodiscover DNS records of the domains listed in `domains`. Returns, for each domain, the status and errors of each test, the records found and the expected DNS configuration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"platformId","description":"Platform ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zimbra.DomainDiagnosisPostPayload"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/zimbra.DomainDiagnosisResponse"}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::PlatformNotFound":{"value":{"class":"Client::NotFound::PlatformNotFound","message":"The platform was not found"}}}}}}},"tags":["Domain"],"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Zimbra","Diagnostics@@@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\n# Request body type: zimbra.DomainDiagnosisPostPayload\nresult = client.post(\"/v2/zimbra/platform/{platformId}/diagnostic/domain\",\n\tdomains = None, # List of domains to diagnose (type: array)\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: zimbra.DomainDiagnosisPostPayload\n$result = $ovh->post(\"/v2/zimbra/platform/{platformId}/diagnostic/domain\", array(\n\tdomains => null, // List of domains to diagnose (type: array)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"zimbra:apiovh:platform/diagnostic/domain/get","required":true}]}}},"tags":[{"name":"Domain","x-tag-expanded":false,"description":"Missing description"}]}