{"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 !"},"complexType.UnitAndValue_double":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"value":{"type":"number"}}},"complexType.UnitAndValue_string":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"value":{"type":"string"}}},"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"},"hosting.web.ModuleList":{"type":"object","description":"A module specifically packaged by OVH","properties":{"active":{"type":"boolean","description":"Is the module available?","readOnly":true},"adminNameType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.module.AdminNameTypeEnum"}],"description":"The type of the admin name","readOnly":true},"author":{"type":"string","description":"The packager of this module for OVH","readOnly":true},"branch":{"allOf":[{"$ref":"#/components/schemas/hosting.web.module.BranchEnum"}],"description":"The branch of the module","readOnly":true},"id":{"type":"integer","description":"The ID of the module","readOnly":true},"keywords":{"type":"array","description":"The keywords for this module","items":{"type":"string"},"readOnly":true},"language":{"type":"array","description":"All available languages for this module","items":{"$ref":"#/components/schemas/hosting.web.module.LanguageEnum"},"readOnly":true},"languageRequirement":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_string"}],"description":"Minimal language version required to run this module","readOnly":true},"latest":{"type":"boolean","description":"Is this the latest version available?","readOnly":true},"name":{"type":"string","description":"The name of the module","readOnly":true},"size":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Size of the module","readOnly":true},"upgradeFrom":{"type":"array","description":"The IDs of the module you can upgrade to","items":{"type":"integer"},"readOnly":true},"version":{"type":"string","description":"The version of the module","readOnly":true}}},"hosting.web.module":{"type":"object","description":"Hosting modules installed","properties":{"adminFolder":{"type":"string","description":"The admin folder, relative to the module's installation path","readOnly":true},"adminName":{"type":"string","description":"Login for the admin account","readOnly":true},"creationDate":{"type":"string","description":"Date of the installation of the module","format":"date-time","readOnly":true},"dependencies":{"type":"array","description":"The dependencies to which the module has access. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example","items":{"$ref":"#/components/schemas/hosting.web.module.DependencyType"},"readOnly":true},"id":{"type":"integer","description":"Installation ID","readOnly":true},"language":{"allOf":[{"$ref":"#/components/schemas/hosting.web.module.LanguageEnum"}],"description":"The language of the module","readOnly":true},"lastUpdate":{"type":"string","description":"Date of the last module's upgrade","format":"date-time","readOnly":true},"moduleId":{"type":"integer","description":"ID of the module associated with this installation","readOnly":true},"path":{"type":"string","description":"Where the module is installed, relative to your home directory","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.module.StatusEnum"}],"description":"The module status","readOnly":true},"targetUrl":{"type":"string","description":"The URL from where your module can be reached","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this module","nullable":true,"readOnly":true}}},"hosting.web.module.AdminNameTypeEnum":{"type":"string","description":"The type of the admin name","enum":["email","string"]},"hosting.web.module.BranchEnum":{"type":"string","description":"Branch enum","enum":["old","stable","testing"]},"hosting.web.module.DependencyType":{"type":"object","description":"Dependency parameters. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example","properties":{"name":{"type":"string","description":"The name of this dependency","nullable":true},"password":{"type":"string","description":"The password associated with the user","nullable":true,"format":"password"},"port":{"type":"integer","description":"The port on where to contact this dependency","nullable":true},"prefix":{"type":"string","description":"The prefix to set to the data to distinguish between the data from the module and the rest","nullable":true},"server":{"type":"string","description":"The server on where your dependency is hosted","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.module.DependencyTypeEnum"}],"description":"Type"},"user":{"type":"string","description":"The user to use to connect to this dependency","nullable":true}}},"hosting.web.module.DependencyTypeEnum":{"type":"string","description":"The type of the dependency. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example","enum":["mysql"]},"hosting.web.module.LanguageEnum":{"type":"string","description":"Install language","enum":["cz","de","en","es","fi","fr","it","lt","nl","pl","pt"]},"hosting.web.module.StatusEnum":{"type":"string","description":"Module status","enum":["created","creating","deleting","updating"]},"hosting.web.task":{"type":"object","description":"Tasks","properties":{"doneDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"type":"string","description":"Function name","readOnly":true},"id":{"type":"integer","description":"the id of the task","readOnly":true},"lastUpdate":{"type":"string","description":"last update","nullable":true,"format":"date-time","readOnly":true},"objectId":{"type":"string","description":"Task related object ID","nullable":true,"readOnly":true},"objectType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.ObjectTypeEnum"}],"description":"Task object type","nullable":true,"readOnly":true},"startDate":{"type":"string","description":"Task Creation date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.StatusEnum"}],"description":"Task status","readOnly":true}}},"hosting.web.task.ObjectTypeEnum":{"type":"string","description":"Task object type listing","enum":["Abuse","AttachedDomain","BlockedIp","Cdn","Cron","Database","Dump","EnvVar","Filerz","Hostedssl","Hosting","Indy","Infra","Minor","Module","Other","OvhConfig","OvhOrg","OwnLogs","Runtime","Scan","Sqlperso","User","UserLogs","Web","Webd"]},"hosting.web.task.StatusEnum":{"type":"string","description":"Task's status","enum":["cancelled","doing","done","error","init","todo"]},"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":{"/hosting/web/moduleList":{"get":{"summary":"List available modules","description":"List available modules. Returns the IDs of the modules that can be installed. Filter them by active, branch or latest.","parameters":[{"in":"query","name":"active","description":"Filter the value of active property (=)","schema":{"type":"boolean"}},{"in":"query","name":"branch","description":"Filter the value of branch property (=)","schema":{"$ref":"#/components/schemas/hosting.web.module.BranchEnum"}},{"in":"query","name":"latest","description":"Filter the value of latest property (=)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Modules@@@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(\"/hosting/web/moduleList\")\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(\"/hosting/web/moduleList\");\n\nprint_r($result);\n?>"}],"x-expanded-response":"HostingWebModuleList"}},"/hosting/web/moduleList/{id}":{"get":{"summary":"Get an available module","description":"Get an available module. Returns the name, version, branch, languages and requirements of the module, and the modules it can be upgraded to.","parameters":[{"in":"path","name":"id","description":"The ID of the module","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.ModuleList"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Modules@@@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(\"/hosting/web/moduleList/{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(\"/hosting/web/moduleList/{id}\");\n\nprint_r($result);\n?>"}]}},"/hosting/web/{serviceName}/module":{"get":{"summary":"List installed modules","description":"List installed modules. Returns the installation IDs of the modules installed on the hosting. Get the details of one with its installation ID.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Modules@@@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(\"/hosting/web/{serviceName}/module\")\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(\"/hosting/web/{serviceName}/module\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:module/get","required":true}],"x-expanded-response":"HostingWebModule"},"post":{"summary":"Install a module","description":"Install a module. Installs a module from the available modules in a folder of the hosting, with its admin account and dependencies, and returns the task. The admin password needs at least 8 characters.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"adminName":{"type":"string","description":"The login for the admin account (may be a standard string or your email)"},"adminPassword":{"type":"string","description":"The password for the admin account (at least 8 characters)","format":"password"},"dependencies":{"type":"array","description":"The dependencies that we have to configure on your module. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example","items":{"$ref":"#/components/schemas/hosting.web.module.DependencyType"}},"domain":{"type":"string","description":"On which domain the module has to be available (it can be a multidomain or a subdomain) - if not set, the module will be available on your serviceName domain"},"language":{"description":"The language to set to your module","$ref":"#/components/schemas/hosting.web.module.LanguageEnum"},"moduleId":{"type":"integer","description":"ID of the module you want to install"},"path":{"type":"string","description":"Where to install the module, relative to your home directory"}},"required":["moduleId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Modules@@@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\n# Request body type: string\nresult = client.post(\"/hosting/web/{serviceName}/module\",\n\tadminName = None, # The login for the admin account (may be a standard string or your email) (type: string, nullable)\n\tadminPassword = None, # The password for the admin account (at least 8 characters) (type: password, nullable)\n\tdependencies = None, # The dependencies that we have to configure on your module. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example (type: hosting.web.module.DependencyType[], nullable)\n\tdomain = None, # On which domain the module has to be available (it can be a multidomain or a subdomain) - if not set, the module will be available on your serviceName domain (type: string, nullable)\n\tlanguage = None, # The language to set to your module (type: hosting.web.module.LanguageEnum, nullable)\n\tmoduleId = None, # ID of the module you want to install (type: long)\n\tpath = None, # Where to install the module, relative to your home directory (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: string\n$result = $ovh->post(\"/hosting/web/{serviceName}/module\", array(\n\tadminName => null, // The login for the admin account (may be a standard string or your email) (type: string, nullable)\n\tadminPassword => null, // The password for the admin account (at least 8 characters) (type: password, nullable)\n\tdependencies => null, // The dependencies that we have to configure on your module. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example (type: hosting.web.module.DependencyType[], nullable)\n\tdomain => null, // On which domain the module has to be available (it can be a multidomain or a subdomain) - if not set, the module will be available on your serviceName domain (type: string, nullable)\n\tlanguage => null, // The language to set to your module (type: hosting.web.module.LanguageEnum, nullable)\n\tmoduleId => null, // ID of the module you want to install (type: long)\n\tpath => null, // Where to install the module, relative to your home directory (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:module/create","required":true}]}},"/hosting/web/{serviceName}/module/{id}":{"delete":{"summary":"Delete an installed module","description":"Delete an installed module. Deletes the module installation and returns the task. Use the installation ID, not the module ID.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Installation ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Modules@@@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(\"/hosting/web/{serviceName}/module/{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(\"/hosting/web/{serviceName}/module/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:module/delete","required":true}]},"get":{"summary":"Get an installed module","description":"Get an installed module. Returns the path, URL, admin login, language, dependencies and status of the installed module.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Installation ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.module"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Modules@@@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(\"/hosting/web/{serviceName}/module/{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(\"/hosting/web/{serviceName}/module/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:module/get","required":true}]}}}}