{"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"},"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"},"ipLoadbalancing.Ssl.Ssl":{"type":"object","description":"Ssl","properties":{"displayName":{"type":"string","description":"Human readable name for your ssl certificate, this field is for you","nullable":true},"expireDate":{"type":"string","description":"Expire date of your SSL certificate","format":"date-time","readOnly":true},"fingerprint":{"type":"string","description":"Fingerprint of your SSL certificate","readOnly":true},"id":{"type":"integer","description":"Id of your SSL certificate","readOnly":true},"san":{"type":"array","description":"Subject Alternative Name of your SSL certificate","items":{"type":"string"},"readOnly":true},"serial":{"type":"string","description":"Serial of your SSL certificate (Deprecated, use fingerprint instead !)","readOnly":true},"subject":{"type":"string","description":"Subject of your SSL certificate","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.SslTypeEnum"}],"description":"Type of your SSL certificate.\n'built' for SSL certificates managed by the IP Load Balancing. 'custom' for user manager certificates.","nullable":true,"readOnly":true}}},"ipLoadbalancing.SslTypeEnum":{"type":"string","description":"Possible values for ssl type","enum":["built","built_not_routed","custom"]},"ipLoadbalancing.Task.Task":{"type":"object","description":"IP Load Balancing Operations","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.TaskActionEnum"}],"description":"Operation type","readOnly":true},"creationDate":{"type":"string","description":"Creation date of your operation","format":"date-time","readOnly":true},"doneDate":{"type":"string","description":"Done date of your operation","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"integer","description":"Id of the operation","readOnly":true},"progress":{"type":"integer","description":"Operation progress percentage","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.TaskStatusEnum"}],"description":"Current status of your operation","readOnly":true},"zones":{"type":"array","description":"Zone of your Load Balancer which are updated by current Task","items":{"type":"string"},"readOnly":true}}},"ipLoadbalancing.TaskActionEnum":{"type":"string","description":"Possible task action","enum":["deleteIplb","deployIplb","install","installIplb","installZone","orderFreeCertificate","orderPaidCertificate","orderSsl","refreshIplb","releaseIplb","releaseIplbZone","reopenIplb","suspendIplb","suspendZone","switchToIplbNextGenerationApi","vrackAttach","vrackDetach"]},"ipLoadbalancing.TaskStatusEnum":{"type":"string","description":"Possible task status","enum":["blocked","cancelled","doing","done","error","todo"]},"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":{"/ipLoadbalancing/{serviceName}/freeCertificate":{"post":{"summary":"Order a free certificate","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fqdn":{"type":"array","description":"The FQDN for which you want a free certificate. A DCV (Domain Control Validation) http request will be made to http://your_domain.abc, make sure this domain exists and resolves to your iplb ip before ordering","items":{"type":"string"}}},"required":["fqdn"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.Task.Task"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","SSL@@@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\n# Request body type: string[]\nresult = client.post(\"/ipLoadbalancing/{serviceName}/freeCertificate\",\n\tfqdn = None, # The FQDN for which you want a free certificate. A DCV (Domain Control Validation) http request will be made to http://your_domain.abc, make sure this domain exists and resolves to your iplb ip before ordering (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(\"/ipLoadbalancing/{serviceName}/freeCertificate\", array(\n\tfqdn => null, // The FQDN for which you want a free certificate. A DCV (Domain Control Validation) http request will be made to http://your_domain.abc, make sure this domain exists and resolves to your iplb ip before ordering (type: string[])\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:freeCertificate/order","required":true}]}},"/ipLoadbalancing/{serviceName}/ssl":{"get":{"summary":"List SSL certificates","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"expireDate","description":"Filter the value of expireDate property (<)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"fingerprint","description":"Filter the value of fingerprint property (like)","schema":{"type":"string"}},{"in":"query","name":"serial","description":"Filter the value of serial property (like)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Filter the value of type property (=)","schema":{"$ref":"#/components/schemas/ipLoadbalancing.SslTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","SSL@@@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(\"/ipLoadbalancing/{serviceName}/ssl\")\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(\"/ipLoadbalancing/{serviceName}/ssl\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:ssl/get","required":true}],"x-expanded-response":"IpLoadbalancingSslSsl"},"post":{"summary":"Create a custom SSL certificate","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"Certificate"},"chain":{"type":"string","description":"Certificate chain"},"displayName":{"type":"string","description":"Human readable name for your ssl certificate, this field is for you"},"key":{"type":"string","description":"Certificate key"}},"required":["certificate","key"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.Ssl.Ssl"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","SSL@@@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.post(\"/ipLoadbalancing/{serviceName}/ssl\",\n\tcertificate = None, # Certificate (type: text)\n\tchain = None, # Certificate chain (type: text, nullable)\n\tdisplayName = None, # Human readable name for your ssl certificate, this field is for you (type: string, nullable)\n\tkey = None, # Certificate key (type: text)\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(\"/ipLoadbalancing/{serviceName}/ssl\", array(\n\tcertificate => null, // Certificate (type: text)\n\tchain => null, // Certificate chain (type: text, nullable)\n\tdisplayName => null, // Human readable name for your ssl certificate, this field is for you (type: string, nullable)\n\tkey => null, // Certificate key (type: text)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:ssl/create","required":true}]}},"/ipLoadbalancing/{serviceName}/ssl/{id}":{"delete":{"summary":"Delete an SSL certificate","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of your SSL certificate","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","SSL@@@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(\"/ipLoadbalancing/{serviceName}/ssl/{id}\")\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(\"/ipLoadbalancing/{serviceName}/ssl/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:ssl/delete","required":true}]},"get":{"summary":"Get an SSL certificate","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of your SSL certificate","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.Ssl.Ssl"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","SSL@@@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.get(\"/ipLoadbalancing/{serviceName}/ssl/{id}\")\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(\"/ipLoadbalancing/{serviceName}/ssl/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:ssl/get","required":true}]},"put":{"summary":"Update an SSL certificate","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of your SSL certificate","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.Ssl.Ssl"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","SSL@@@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: ipLoadbalancing.Ssl.Ssl\nresult = client.put(\"/ipLoadbalancing/{serviceName}/ssl/{id}\",\n\tdisplayName = None, # Human readable name for your ssl certificate, this field is for you (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: ipLoadbalancing.Ssl.Ssl\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}/ssl/{id}\", array(\n\tdisplayName => null, // Human readable name for your ssl certificate, this field is for you (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:ssl/edit","required":true}]}}}}