{"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 !"},"domain.DomainSpecialAccountActionEnum":{"type":"string","description":"Possible values for pop action task","enum":["add","change","delete"]},"domain.DomainSpecialAccountTypeEnum":{"type":"string","description":"Possible type task","enum":["25g","alias","delete","filter","forward","responder"]},"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.domain.Responder":{"type":"object","description":"Responder","properties":{"account":{"type":"string","description":"Name of account","readOnly":true},"content":{"type":"string","description":"Content of responder"},"copy":{"type":"boolean","description":"If false, emails will be dropped. If true and copyTo field is empty, emails will be delivered to your mailbox. If true and copyTo is set with an address, emails will be delivered to this address","readOnly":true},"copyTo":{"type":"string","description":"Account where copy emails","nullable":true,"readOnly":true},"from":{"type":"string","description":"Date of start responder","nullable":true,"format":"date-time"},"to":{"type":"string","description":"Date of end responder","nullable":true,"format":"date-time"}}},"email.domain.TaskSpecialAccount":{"type":"object","description":"Task special account List","properties":{"account":{"type":"string","description":"Account name of task","readOnly":true},"action":{"allOf":[{"$ref":"#/components/schemas/domain.DomainSpecialAccountActionEnum"}],"description":"Action of task","readOnly":true},"date":{"type":"string","description":"Creation date of task","format":"date-time","readOnly":true},"domain":{"type":"string","description":"Domain name of task","readOnly":true},"id":{"type":"integer","description":"Id of task","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/domain.DomainSpecialAccountTypeEnum"}],"description":"Type of action filter","readOnly":true}}},"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"}},"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/domain/{domain}/responder":{"get":{"summary":"List responders","description":"List responders. Returns the account names of the responders of the domain. Filter them by `account`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"account","description":"Responder name","schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","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","MX Plan","Roundcube platform","Responders@@@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/domain/{domain}/responder\")\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/domain/{domain}/responder\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:responder/get","required":true}],"x-expanded-response":"EmailDomainResponder"},"post":{"summary":"Create a responder","description":"Create a responder. Creates an automatic reply for an account with its content and optional start and end dates, and returns the task. With `copy` false, emails are dropped; with `copy` true, they go to the mailbox, or to `copyTo` when set.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"string","description":"Account of domain"},"content":{"type":"string","description":"Content of responder"},"copy":{"type":"boolean","description":"If false, emails will be dropped. If true and copyTo field is empty, emails will be delivered to your mailbox. If true and copyTo is set with an address, emails will be delivered to this address"},"copyTo":{"type":"string","description":"Account where copy emails"},"from":{"type":"string","description":"Date of start responder","format":"date-time"},"to":{"type":"string","description":"Date of end responder","format":"date-time"}},"required":["account","content","copy"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskSpecialAccount"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Responders@@@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/domain/{domain}/responder\",\n\taccount = None, # Account of domain (type: string)\n\tcontent = None, # Content of responder (type: string)\n\tcopy = None, # If false, emails will be dropped. If true and copyTo field is empty, emails will be delivered to your mailbox. If true and copyTo is set with an address, emails will be delivered to this address (type: boolean)\n\tcopyTo = None, # Account where copy emails (type: string, nullable)\n\tfrom = None, # Date of start responder (type: datetime, nullable)\n\tto = None, # Date of end responder (type: datetime, 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->post(\"/email/domain/{domain}/responder\", array(\n\taccount => null, // Account of domain (type: string)\n\tcontent => null, // Content of responder (type: string)\n\tcopy => null, // If false, emails will be dropped. If true and copyTo field is empty, emails will be delivered to your mailbox. If true and copyTo is set with an address, emails will be delivered to this address (type: boolean)\n\tcopyTo => null, // Account where copy emails (type: string, nullable)\n\tfrom => null, // Date of start responder (type: datetime, nullable)\n\tto => null, // Date of end responder (type: datetime, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:responder/create","required":true}]}},"/email/domain/{domain}/responder/{account}":{"delete":{"summary":"Delete a responder","description":"Delete a responder. Removes the automatic reply of the email account and returns the task. Follow it under `task/responder/{id}`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"account","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.TaskSpecialAccount"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Responders@@@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/domain/{domain}/responder/{account}\")\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/domain/{domain}/responder/{account}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:responder/delete","required":true}]},"get":{"summary":"Get a responder","description":"Get a responder. Returns the account, content, start and end dates and copy settings of the responder.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"account","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.Responder"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Responders@@@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/domain/{domain}/responder/{account}\")\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/domain/{domain}/responder/{account}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:responder/get","required":true}]},"put":{"summary":"Update a responder","description":"Update a responder. Changes the `content` of the automatic reply and the dates it is active (`from`, `to`) for the email account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"account","description":"Name of account","required":true,"schema":{"type":"string"}},{"in":"path","name":"domain","description":"Name of your domain name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.domain.Responder"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","MX Plan","Roundcube platform","Responders@@@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.domain.Responder\nresult = client.put(\"/email/domain/{domain}/responder/{account}\",\n\tcontent = None, # Content of responder (type: string)\n\tfrom = None, # Date of start responder (type: string, nullable)\n\tto = None, # Date of end responder (type: string, 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// Request body type: email.domain.Responder\n$result = $ovh->put(\"/email/domain/{domain}/responder/{account}\", array(\n\tcontent => null, // Content of responder (type: string)\n\tfrom => null, // Date of start responder (type: string, nullable)\n\tto => null, // Date of end responder (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailDomain:apiovh:responder/edit","required":true}]}}}}