{"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"},"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"},"me.partnerLevel.Level":{"type":"object","description":"Partner level of an account","properties":{"level":{"allOf":[{"$ref":"#/components/schemas/me.partnerLevel.LevelTypeEnum"}],"description":"Level of partner","readOnly":true},"msa":{"type":"boolean","description":"Contains an MSA certificate","readOnly":true},"requirement":{"allOf":[{"$ref":"#/components/schemas/me.partnerLevel.RequirementLoSEnum"}],"description":"Level of Support required","readOnly":true}}},"me.partnerLevel.LevelTypeEnum":{"type":"string","description":"Type of level","enum":["advanced","none","standard","strategic"]},"me.partnerLevel.RequirementLoSEnum":{"type":"string","description":"Level of Support required","enum":["none","premium","premium-accredited"]},"nichandle.CountryEnum":{"type":"string","description":"Countries a nichandle can choose","enum":["AC","AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","UNKNOWN","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"partner2.AcceptanceStatusEnum":{"type":"string","description":"Acceptance status","enum":["Advanced","AdvancedHandOperated","AdvancedQualified","Open","Registered","RegisteredQualified","Rejected"]},"partner2.Account":{"type":"object","description":"Account Entity","properties":{"city":{"type":"string","description":"DEPRECATED - Account City","nullable":true},"companyTurnover":{"type":"number","description":"Company turnover (in euros)","nullable":true},"country":{"allOf":[{"$ref":"#/components/schemas/nichandle.CountryEnum"}],"description":"DEPRECATED - Account Country","nullable":true},"name":{"type":"string","description":"Account Name"},"numberOfEmployees":{"allOf":[{"$ref":"#/components/schemas/partner2.employeesNumberEnum"}],"description":"Number of employees","nullable":true},"partnerType":{"allOf":[{"$ref":"#/components/schemas/partner2.partnerTypeEnum"}],"description":"Partner Type","nullable":true},"yearEstablished":{"type":"string","description":"In what year was your company established?","nullable":true,"format":"date"}},"required":["name"]},"partner2.AreaOfExpertiseEnum":{"type":"string","description":"Area of expertise","enum":["BigData","Connectivity","DC","DomainName","EmailMsSolution","HPC","Nutanix","Orchestration","PC","PCIDSS","SecurityCertif","VPS","VoIP","WH"]},"partner2.Contact":{"type":"object","description":"Contact Entity","properties":{"email":{"type":"string","description":"Contact Email"},"firstName":{"type":"string","description":"Contact First Name"},"jobTitle":{"type":"string","description":"Contact Job Title","nullable":true},"lastName":{"type":"string","description":"Contact Last Name"},"phone":{"type":"string","description":"Contact Phone"},"position":{"allOf":[{"$ref":"#/components/schemas/partner2.PositionEnum"}],"description":"Contact Position"}},"required":["email","firstName","lastName","phone","position"]},"partner2.Partner":{"type":"object","description":"Partner Entity","properties":{"acceptanceStatus":{"allOf":[{"$ref":"#/components/schemas/partner2.AcceptanceStatusEnum"}],"description":"Acceptance Status","nullable":true,"readOnly":true},"account":{"allOf":[{"$ref":"#/components/schemas/partner2.Account"}],"description":"Account"},"areaOfExpertise":{"type":"array","description":"DEPRECATED - Area of Expertise","nullable":true,"items":{"$ref":"#/components/schemas/partner2.AreaOfExpertiseEnum"}},"contact":{"allOf":[{"$ref":"#/components/schemas/partner2.Contact"}],"description":"Contact","nullable":true},"partnersProgramReason":{"type":"string","description":"DEPRECATED - Why you want to take part in OVH's Partners Program","nullable":true},"partnership":{"allOf":[{"$ref":"#/components/schemas/partner2.PartnerShip"}],"description":" How the PartnerShip will Growth"},"salesProjection":{"type":"number","description":"DEPRECATED - Sales Projection (in euros) ","nullable":true}},"required":["account"]},"partner2.PartnerShip":{"type":"object","description":"Partner ship evolution","properties":{"areaOfExpertise":{"type":"array","description":"Area of Expertise","nullable":true,"items":{"$ref":"#/components/schemas/partner2.AreaOfExpertiseEnum"}},"emailCommunication":{"type":"boolean","description":"GDPR - email/communication opt in"},"partnersProgramReason":{"type":"string","description":"Why you want to take part in OVH's Partners Program","nullable":true},"salesGrowthOpportunities":{"type":"string","description":"OVHcloud sales growth opportunities","nullable":true},"salesProjection":{"type":"number","description":"Sales projection (in euros)"},"supportAgreementStatement":{"type":"boolean","description":"Support agreement statement"}}},"partner2.PositionEnum":{"type":"string","description":"Job positions","enum":["AF","BusinessOwner","HR","ITDevops","ITOther","ITSysAdmin","LC","Marketing","Other","PreSales","Production","Purchasing","RD","Sales"]},"partner2.employeesNumberEnum":{"type":"string","description":"employeesNumber","enum":["1000to1999","100To199","10To19","1Or2","2000to4999","200To249","20To49","250To499","3To5","5000to9999","500to999","50To99","6To9","over10000"]},"partner2.partnerTypeEnum":{"type":"string","description":"partner type","enum":["consultingCompany","iaasProvider","managedServiceProvider","other","softwareEditor","strategicConsulting","systemsIntegrator","telecomOperators","trainingCompany","valueAddedReseller","webAgency"]},"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":{"/me/partnerLevel":{"get":{"summary":"Fetch the partner level of the account","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/me.partnerLevel.Level"}}}}},"x-developer-hub-navigation":[["Misc","Partner"]],"x-badges":[{"color":"blue","label":"Beta 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(\"/me/partnerLevel\")\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(\"/me/partnerLevel\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/partnerLevel/get","required":true}]}},"/partner":{"get":{"summary":"Get partner status","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/partner2.Partner"}}}},"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::PartnerNotFound":{"value":{"class":"Client::NotFound::PartnerNotFound","message":"Partner not found"}}}}}},"500":{"description":"Error 500 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":{"Server::InternalServerError::PartnerError":{"value":{"class":"Server::InternalServerError::PartnerError","message":"Internal Server Error"}}}}}}},"x-developer-hub-navigation":[["Misc","Partner"]],"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(\"/partner\")\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(\"/partner\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:partner/get","required":true}]},"post":{"summary":"Register as a partner","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/partner2.Partner"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Misc","Partner"]],"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: partner2.Partner\nresult = client.post(\"/partner\",\n\taccount = None, # Account (type: partner2.Account)\n\tareaOfExpertise = None, # DEPRECATED - Area of Expertise (type: array, nullable)\n\tcontact = None, # Contact (type: partner2.Contact, nullable)\n\tpartnersProgramReason = None, # DEPRECATED - Why you want to take part in OVH's Partners Program (type: string, nullable)\n\tpartnership = None, #  How the PartnerShip will Growth (type: partner2.PartnerShip)\n\tsalesProjection = None, # DEPRECATED - Sales Projection (in euros)  (type: number, 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: partner2.Partner\n$result = $ovh->post(\"/partner\", array(\n\taccount => null, // Account (type: partner2.Account)\n\tareaOfExpertise => null, // DEPRECATED - Area of Expertise (type: array, nullable)\n\tcontact => null, // Contact (type: partner2.Contact, nullable)\n\tpartnersProgramReason => null, // DEPRECATED - Why you want to take part in OVH's Partners Program (type: string, nullable)\n\tpartnership => null, //  How the PartnerShip will Growth (type: partner2.PartnerShip)\n\tsalesProjection => null, // DEPRECATED - Sales Projection (in euros)  (type: number, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:partner/create","required":true}]}}}}