{"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 !"},"dedicatedCloud.sap":{"type":"object","description":"This schema provides detailed information about the pre-installation tasks related to SAP deployments.","properties":{"applicationType":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.applicationTypeEnum"}],"description":"Describes the type of SAP application that is being installed as part of the pre-installation tasks.","readOnly":true},"applicationVersion":{"type":"string","description":"Describes the specific version of the SAP application that is being installed during the pre-installation process.","readOnly":true},"cleanStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current status of the clean-up operations performed as part of the pre-installation tasks.","readOnly":true},"deploymentType":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.deploymentTypeEnum"}],"description":"Describes the type of deployment strategy being used for the SAP installation during the pre-installation process.","readOnly":true},"endTime":{"type":"string","description":"Records the date and time when the pre-installation tasks were finished.","nullable":true,"readOnly":true},"errorMessage":{"type":"string","description":"Contains a detailed error message if any issues or failures occurred during the execution of the pre-installation tasks.","nullable":true,"readOnly":true},"gatewayStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of the Gateway component during the pre-installation process.","readOnly":true},"sapHanaInstallationStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of the SAP HANA installation during the pre-installation process.","readOnly":true},"sapHanaSid":{"type":"string","description":"Describes the System ID (SID) assigned to the SAP HANA instance being installed as part of the pre-installation tasks.","readOnly":true},"sapSid":{"type":"string","description":"Describes the System ID (SID) assigned to the SAP system being installed as part of the pre-installation tasks.","readOnly":true},"sapSystemInstallationStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of the SAP system installation during the pre-installation process.","readOnly":true},"startTime":{"type":"string","description":"Records the date and time when the pre-installation tasks were initiated.","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides an overview of the current overall status of the pre-installation tasks.","readOnly":true},"taskId":{"type":"string","description":"Uniquely identifies each set of pre-installation tasks.","format":"uuid","readOnly":true},"vmDeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of virtual machines deployment during the pre-installation process.","readOnly":true}}},"dedicatedCloud.sap.applicationServers":{"type":"object","description":"This section contains the configuration details for setting up the SAP Application servers.","properties":{"datastoreName":{"type":"string","description":"Defines the name of the datastore where the SAP Application server's virtual machine will be stored."},"gateway":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Defines the IPv4 address of the default gateway that the SAP Application server will use to access external networks."},"instanceNumber":{"type":"string","description":"Represents the unique instance number assigned to the SAP Application server within the SAP system landscape."},"ipAddress":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Defines the static IPv4 address for the SAP Application server, which must be unique within the specified network."},"memory":{"type":"integer","description":"Allocates the amount of RAM (in gigabytes) to be assigned to the SAP Application server for optimal performance."},"name":{"type":"string","description":"Defines the hostname of the SAP Application server's virtual machine, which should be unique."},"netmask":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Defines the netmask for the SAP Application server, which defines the network range it belongs to."},"network":{"type":"string","description":"Defines the network name to which the SAP Application server will be connected."},"ovaTemplate":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.ovaTemplatesEnum"}],"description":"Selects the OVA template that will be used to deploy the SAP Application server."},"role":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.rolesEnum"}],"description":"Assigns a specific role to the SAP Application server, based on its intended function within the SAP environment."},"rootPassword":{"type":"string","description":"Defines the password for the root user account of the SAP Application server's virtual machine.","format":"password"},"vcpus":{"type":"integer","description":"Defines the number of virtual CPUs (vCPUs) that will be allocated to the SAP Application server."}},"required":["datastoreName","gateway","instanceNumber","ipAddress","memory","name","netmask","network","ovaTemplate","role","rootPassword","vcpus"]},"dedicatedCloud.sap.applicationTypeEnum":{"type":"string","description":"This enumeration specifies the type of SAP application.","enum":["ABAP","JAVA"]},"dedicatedCloud.sap.applicationVersionEnum":{"type":"string","description":"This enumeration specifies the version of the SAP application.","enum":["NetWeaver 7.50","S/4HANA 2021","S/4HANA 2022","S/4HANA 2023"]},"dedicatedCloud.sap.bucket":{"type":"object","description":"This schema defines the configuration details required for a bucket, including authentication and endpoint information.","properties":{"accessKey":{"type":"string","description":"A unique alphanumeric string used as part of the authentication process to access the bucket."},"endpoint":{"type":"string","description":"The URL where the bucket can be accessed over the internet."},"id":{"type":"string","description":"A unique identifier assigned to the bucket."},"secretKey":{"type":"string","description":"Confidential string used with access key for bucket authentication.","format":"password"}},"required":["accessKey","endpoint","id","secretKey"]},"dedicatedCloud.sap.deploymentTypeEnum":{"type":"string","description":"This enumeration specifies the type of deployment for the SAP system.","enum":["Distributed","High-Availability","Standard"]},"dedicatedCloud.sap.firewall":{"type":"object","description":"This configuration allows you to manage and control the firewall settings specifically for SAP Central Services, SAP Application servers, and SAP HANA databases at the operating system level. By enabling or disabling the firewall for each component, you can enhance the security of your SAP environment while ensuring that necessary communication channels remain open.","properties":{"applicationServers":{"type":"boolean","description":"Controls the firewall status for the SAP Application servers at the operating system level. Set to 'true' to enable the firewall, or 'false' to disable it."},"centralServices":{"type":"boolean","description":"Controls the firewall status for the SAP Central Services server at the operating system level. Set to 'true' to enable the firewall, or 'false' to disable it."},"hanaDatabase":{"type":"boolean","description":"Controls the firewall status for the SAP HANA servers at the operating system level. Set to 'true' to enable the firewall, or 'false' to disable it."}},"required":["applicationServers","centralServices","hanaDatabase"]},"dedicatedCloud.sap.hanaServers":{"type":"object","description":"This section contains the configuration details required for setting up and managing SAP HANA servers.","properties":{"datastoreName":{"type":"string","description":"Defines the name of the datastore where the SAP HANA server's virtual machine will be stored."},"gateway":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Defines the IPv4 address of the default gateway that the SAP HANA server will use to access external networks."},"instanceNumber":{"type":"string","description":"Represents the unique instance number assigned to the SAP HANA server within the SAP system landscape."},"ipAddress":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Defines the IPv4 address that will be assigned to the SAP HANA server's virtual machine."},"memory":{"type":"integer","description":"Allocates the amount of RAM (in gigabytes) to be assigned to the SAP HANA server for optimal performance."},"name":{"type":"string","description":"Defines the hostname that will be assigned to the SAP HANA server's virtual machine."},"netmask":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Defines the netmask for the SAP HANA server, which defines the network range it belongs to."},"network":{"type":"string","description":"Defines the network name to which the SAP HANA server will be connected."},"ovaTemplate":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.ovaTemplatesEnum"}],"description":"Selects the OVA template that will be used to deploy the SAP HANA server."},"rootPassword":{"type":"string","description":"Defines the password for the root user account of the SAP HANA server's virtual machine.","format":"password"},"thickDatastorePolicy":{"type":"string","description":"Defines the thick provisioning policy that will be applied to the SAP HANA server's storage allocation."},"vcpus":{"type":"integer","description":"Defines the number of virtual CPUs (vCPUs) that will be allocated to the SAP HANA server."}},"required":["datastoreName","gateway","instanceNumber","ipAddress","memory","name","netmask","network","ovaTemplate","rootPassword","thickDatastorePolicy","vcpus"]},"dedicatedCloud.sap.ldp":{"type":"object","description":"This schema defines the necessary configuration parameters for integrating with the SAP Logs Data Platform, including authentication and endpoint details.","properties":{"certificate":{"type":"string","description":"A certificate to authenticate and establish a trusted connection with the entrypoint of the SAP Logs Data Platform.","format":"password"},"entrypoint":{"type":"string","description":"The specific URL endpoint provided by Logs Data Platform for pushing logs."}},"required":["certificate","entrypoint"]},"dedicatedCloud.sap.ovaTemplatesEnum":{"type":"string","description":"This enumeration represents the available OVA templates specifically designed for deploying SAP servers.","enum":["SLES SLE-15-SP4-Full-x86_64 (BYOL)","SLES SLE-15-SP5-Full-x86_64 (BYOL)","SLES SLE-15-SP6-Full-x86_64 (BYOL)","SLES SLE-15-SP7-Full-x86_64 (BYOL)","SLES for SAP SLE-15-SP4-Full-x86_64 (BYOL)","SLES for SAP SLE-15-SP5-Full-x86_64 (BYOL)","SLES for SAP SLE-15-SP6-Full-x86_64 (BYOL)","SLES for SAP SLE-15-SP7-Full-x86_64 (BYOL)"]},"dedicatedCloud.sap.params":{"type":"object","description":"This object defines the parameters required to initiate a pre-installation task for an SAP environment.","properties":{"applicationServers":{"type":"array","description":"An array containing the configuration details for each SAP Application Server (such as SCS, ERS, PAS, AAS) virtual machine that will be deployed.","items":{"$ref":"#/components/schemas/dedicatedCloud.sap.applicationServers"}},"applicationType":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.applicationTypeEnum"}],"description":"Selects the type of SAP application that will be installed, such as NetWeaver 7.50 or S/4HANA."},"applicationVersion":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.applicationVersionEnum"}],"description":"Selects the specific version of the SAP application that will be deployed."},"bucketBackint":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.bucket"}],"description":"Configuration settings for the storage bucket used by the OVHcloud Backint Agent to store SAP HANA backup files."},"bucketSources":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.bucket"}],"description":"Configuration settings for the storage bucket that contains the necessary SAP installation sources."},"clusterName":{"type":"string","description":"A user-defined name for the cluster that will host the SAP environment, usually 'Cluster1'."},"datacenterId":{"type":"integer","description":"The unique identifier for the datacenter where the SAP environment will be deployed."},"deploymentType":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.deploymentTypeEnum"}],"description":"Selects the type of SAP deployment, such as Standard, Distributed or High-Availability."},"domainName":{"type":"string","description":"The fully qualified domain name (FQDN) that will be used for the SAP environment."},"firewall":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.firewall"}],"description":"Configuration settings for the firewall to protect the SAP environment."},"hanaServers":{"type":"array","description":"An array containing the configuration details for each SAP HANA virtual machine that will be deployed.","items":{"$ref":"#/components/schemas/dedicatedCloud.sap.hanaServers"}},"logsDataPlatform":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.ldp"}],"description":"Configuration settings for the Logs Data Platform that will be used to collect and externalize operating system and SAP logs."},"osLicense":{"type":"string","description":"The license key or identifier for the operating system that will be used for the SAP environment."},"osUpdate":{"type":"boolean","description":"A boolean value indicating whether the operating system should be updated during the pre-installation process."},"passwords":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.passwords"}],"description":"Configuration settings for the various passwords required for the SAP environment, including database, administrator, and service accounts."},"serviceName":{"type":"string","description":"The name of the Hosted Private Cloud service. This field is primarily used by the OVHcloud Manager during the import process."},"sids":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.sids"}],"description":"Configuration settings for the System IDs (SIDs) that will be used for the SAP environment."},"systemUsage":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.systemUsageEnum"}],"description":"Selects the intended usage of the SAP system, such as custom, development, production or test."}},"required":["applicationServers","applicationType","applicationVersion","bucketSources","clusterName","datacenterId","deploymentType","domainName","firewall","hanaServers","osUpdate","passwords","sids","systemUsage"]},"dedicatedCloud.sap.passwords":{"type":"object","description":"This schema defines the required passwords for various SAP accounts.","properties":{"masterSap":{"type":"string","description":"The password for the SAP master account, which is used for installation tasks related to the SAP system.","format":"password"},"masterSapHana":{"type":"string","description":"The password for the SAP HANA master account, which is used for installation tasks related to the SAP HANA database.","format":"password"},"sidadm":{"type":"string","description":"The password for the sidadm account, which is the system administrator account for the SAP installation.","format":"password"},"system":{"type":"string","description":"The password for the SAP HANA SYSTEM account, which is a privileged user account used for managing the SAP HANA database.","format":"password"}},"required":["masterSap","masterSapHana","sidadm","system"]},"dedicatedCloud.sap.rolesEnum":{"type":"string","description":"This enumeration defines the possible roles that can be assigned to SAP servers.","enum":["CI","DI","ERS","SCS"]},"dedicatedCloud.sap.sids":{"type":"object","description":"This schema defines the System Identifiers (SIDs) used for SAP and SAP HANA systems.","properties":{"sapHanaSid":{"type":"string","description":"A unique alphanumeric identifier assigned to the SAP HANA system."},"sapSid":{"type":"string","description":"A unique alphanumeric identifier assigned to the SAP system."}},"required":["sapHanaSid","sapSid"]},"dedicatedCloud.sap.statusEnum":{"type":"string","description":"This enumeration represents the possible statuses of a step.","enum":["FAILURE","PENDING","RETRY","REVOKED","STARTED","SUCCESS"]},"dedicatedCloud.sap.systemUsageEnum":{"type":"string","description":"This enumeration specifies the intended usage of the SAP system.","enum":["custom","development","production","test"]},"dedicatedCloud.sapWithIAM":{"type":"object","description":"This schema provides detailed information about the pre-installation tasks related to SAP deployments.","properties":{"applicationType":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.applicationTypeEnum"}],"description":"Describes the type of SAP application that is being installed as part of the pre-installation tasks.","readOnly":true},"applicationVersion":{"type":"string","description":"Describes the specific version of the SAP application that is being installed during the pre-installation process.","readOnly":true},"cleanStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current status of the clean-up operations performed as part of the pre-installation tasks.","readOnly":true},"deploymentType":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.deploymentTypeEnum"}],"description":"Describes the type of deployment strategy being used for the SAP installation during the pre-installation process.","readOnly":true},"endTime":{"type":"string","description":"Records the date and time when the pre-installation tasks were finished.","nullable":true,"readOnly":true},"errorMessage":{"type":"string","description":"Contains a detailed error message if any issues or failures occurred during the execution of the pre-installation tasks.","nullable":true,"readOnly":true},"gatewayStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of the Gateway component during the pre-installation process.","readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"sapHanaInstallationStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of the SAP HANA installation during the pre-installation process.","readOnly":true},"sapHanaSid":{"type":"string","description":"Describes the System ID (SID) assigned to the SAP HANA instance being installed as part of the pre-installation tasks.","readOnly":true},"sapSid":{"type":"string","description":"Describes the System ID (SID) assigned to the SAP system being installed as part of the pre-installation tasks.","readOnly":true},"sapSystemInstallationStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of the SAP system installation during the pre-installation process.","readOnly":true},"startTime":{"type":"string","description":"Records the date and time when the pre-installation tasks were initiated.","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides an overview of the current overall status of the pre-installation tasks.","readOnly":true},"taskId":{"type":"string","description":"Uniquely identifies each set of pre-installation tasks.","format":"uuid","readOnly":true},"vmDeploymentStatus":{"allOf":[{"$ref":"#/components/schemas/dedicatedCloud.sap.statusEnum"}],"description":"Provides the current operational state of virtual machines deployment during the pre-installation process.","readOnly":true}}},"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"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"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":{"/dedicatedCloud/{serviceName}/sap":{"get":{"summary":"List pre-installation tasks","description":"Returns the pre-installation tasks of the service and their status.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}},{"in":"path","name":"serviceName","description":"Domain of the service","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicatedCloud.sapWithIAM"}}}}}},"x-developer-hub-navigation":[["Private Cloud","SAP Features Hub@@@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(\"/dedicatedCloud/{serviceName}/sap\")\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(\"/dedicatedCloud/{serviceName}/sap\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"pccVMware:apiovh:sap/get","required":true}],"x-expanded-response":"DedicatedCloudSapWithIAM"},"post":{"summary":"Create a pre-installation task","description":"Starts a task that deploys the SAP HANA and application server virtual machines in a datacenter of the service, then installs SAP HANA and the SAP system. Only one task can run at a time on the service. To check the parameters without starting a task, use the validate endpoint.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Domain of the service","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicatedCloud.sap.params"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Error 400 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::BadRequest::BucketParameterInvalid":{"value":{"class":"Client::BadRequest::BucketParameterInvalid","message":"The provided {{.key}} is invalid."}}}}}},"403":{"description":"Error 403 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::Forbidden::BucketAccessDenied":{"value":{"class":"Client::Forbidden::BucketAccessDenied","message":"The provided credentials do not have permission to read from the {{.id}} bucket."}},"Client::Forbidden::BucketAccessDeniedVersioning":{"value":{"class":"Client::Forbidden::BucketAccessDeniedVersioning","message":"The provided credentials do not have the necessary administrator permissions to check the versioning status of the {{.id}} bucket."}}}}}},"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::BucketMissingFiles":{"value":{"class":"Client::NotFound::BucketMissingFiles","message":"The following files are missing from the bucket: {{.files}}"}},"Client::NotFound::BucketNotFound":{"value":{"class":"Client::NotFound::BucketNotFound","message":"The specified bucket does not exist in the selected region."}},"Client::NotFound::PccDatacenterNotFound":{"value":{"class":"Client::NotFound::PccDatacenterNotFound","message":"The requested datacenter ID {{.datacenterId}} has not been found in your PCC service {{.serviceName}}."}}}}}},"409":{"description":"Error 409 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::Conflict::InstallationInProgress":{"value":{"class":"Client::Conflict::InstallationInProgress","message":"The installation task {{.taskId}} is still in progress."}}}}}}},"x-developer-hub-navigation":[["Private Cloud","SAP Features Hub@@@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\n# Request body type: dedicatedCloud.sap.params\nresult = client.post(\"/dedicatedCloud/{serviceName}/sap\",\n\tapplicationServers = None, # An array containing the configuration details for each SAP Application Server (such as SCS, ERS, PAS, AAS) virtual machine that will be deployed. (type: array)\n\tapplicationType = None, # Selects the type of SAP application that will be installed, such as NetWeaver 7.50 or S/4HANA. (type: dedicatedCloud.sap.applicationTypeEnum)\n\tapplicationVersion = None, # Selects the specific version of the SAP application that will be deployed. (type: dedicatedCloud.sap.applicationVersionEnum)\n\tbucketBackint = None, # Configuration settings for the storage bucket used by the OVHcloud Backint Agent to store SAP HANA backup files. (type: dedicatedCloud.sap.bucket)\n\tbucketSources = None, # Configuration settings for the storage bucket that contains the necessary SAP installation sources. (type: dedicatedCloud.sap.bucket)\n\tclusterName = None, # A user-defined name for the cluster that will host the SAP environment, usually 'Cluster1'. (type: string)\n\tdatacenterId = None, # The unique identifier for the datacenter where the SAP environment will be deployed. (type: integer)\n\tdeploymentType = None, # Selects the type of SAP deployment, such as Standard, Distributed or High-Availability. (type: dedicatedCloud.sap.deploymentTypeEnum)\n\tdomainName = None, # The fully qualified domain name (FQDN) that will be used for the SAP environment. (type: string)\n\tfirewall = None, # Configuration settings for the firewall to protect the SAP environment. (type: dedicatedCloud.sap.firewall)\n\thanaServers = None, # An array containing the configuration details for each SAP HANA virtual machine that will be deployed. (type: array)\n\tlogsDataPlatform = None, # Configuration settings for the Logs Data Platform that will be used to collect and externalize operating system and SAP logs. (type: dedicatedCloud.sap.ldp)\n\tosLicense = None, # The license key or identifier for the operating system that will be used for the SAP environment. (type: string)\n\tosUpdate = None, # A boolean value indicating whether the operating system should be updated during the pre-installation process. (type: boolean)\n\tpasswords = None, # Configuration settings for the various passwords required for the SAP environment, including database, administrator, and service accounts. (type: dedicatedCloud.sap.passwords)\n\tserviceName = None, # The name of the Hosted Private Cloud service. This field is primarily used by the OVHcloud Manager during the import process. (type: string)\n\tsids = None, # Configuration settings for the System IDs (SIDs) that will be used for the SAP environment. (type: dedicatedCloud.sap.sids)\n\tsystemUsage = None, # Selects the intended usage of the SAP system, such as custom, development, production or test. (type: dedicatedCloud.sap.systemUsageEnum)\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: dedicatedCloud.sap.params\n$result = $ovh->post(\"/dedicatedCloud/{serviceName}/sap\", array(\n\tapplicationServers => null, // An array containing the configuration details for each SAP Application Server (such as SCS, ERS, PAS, AAS) virtual machine that will be deployed. (type: array)\n\tapplicationType => null, // Selects the type of SAP application that will be installed, such as NetWeaver 7.50 or S/4HANA. (type: dedicatedCloud.sap.applicationTypeEnum)\n\tapplicationVersion => null, // Selects the specific version of the SAP application that will be deployed. (type: dedicatedCloud.sap.applicationVersionEnum)\n\tbucketBackint => null, // Configuration settings for the storage bucket used by the OVHcloud Backint Agent to store SAP HANA backup files. (type: dedicatedCloud.sap.bucket)\n\tbucketSources => null, // Configuration settings for the storage bucket that contains the necessary SAP installation sources. (type: dedicatedCloud.sap.bucket)\n\tclusterName => null, // A user-defined name for the cluster that will host the SAP environment, usually 'Cluster1'. (type: string)\n\tdatacenterId => null, // The unique identifier for the datacenter where the SAP environment will be deployed. (type: integer)\n\tdeploymentType => null, // Selects the type of SAP deployment, such as Standard, Distributed or High-Availability. (type: dedicatedCloud.sap.deploymentTypeEnum)\n\tdomainName => null, // The fully qualified domain name (FQDN) that will be used for the SAP environment. (type: string)\n\tfirewall => null, // Configuration settings for the firewall to protect the SAP environment. (type: dedicatedCloud.sap.firewall)\n\thanaServers => null, // An array containing the configuration details for each SAP HANA virtual machine that will be deployed. (type: array)\n\tlogsDataPlatform => null, // Configuration settings for the Logs Data Platform that will be used to collect and externalize operating system and SAP logs. (type: dedicatedCloud.sap.ldp)\n\tosLicense => null, // The license key or identifier for the operating system that will be used for the SAP environment. (type: string)\n\tosUpdate => null, // A boolean value indicating whether the operating system should be updated during the pre-installation process. (type: boolean)\n\tpasswords => null, // Configuration settings for the various passwords required for the SAP environment, including database, administrator, and service accounts. (type: dedicatedCloud.sap.passwords)\n\tserviceName => null, // The name of the Hosted Private Cloud service. This field is primarily used by the OVHcloud Manager during the import process. (type: string)\n\tsids => null, // Configuration settings for the System IDs (SIDs) that will be used for the SAP environment. (type: dedicatedCloud.sap.sids)\n\tsystemUsage => null, // Selects the intended usage of the SAP system, such as custom, development, production or test. (type: dedicatedCloud.sap.systemUsageEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"pccVMware:apiovh:sap/create","required":true}]}},"/dedicatedCloud/{serviceName}/sap/{taskId}":{"delete":{"summary":"Delete a pre-installation task","description":"Deletes the task. The virtual machines it deployed are kept.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Domain of the service","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Private Cloud","SAP Features Hub@@@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\nresult = client.delete(\"/dedicatedCloud/{serviceName}/sap/{taskId}\")\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(\"/dedicatedCloud/{serviceName}/sap/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"pccVMware:apiovh:sap/delete","required":true}]},"get":{"summary":"Get a pre-installation task","description":"Returns the status of the task and of each step, from virtual machine deployment to SAP installation, with an error message if a step fails.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Domain of the service","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicatedCloud.sapWithIAM"}}}}},"x-developer-hub-navigation":[["Private Cloud","SAP Features Hub@@@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(\"/dedicatedCloud/{serviceName}/sap/{taskId}\")\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(\"/dedicatedCloud/{serviceName}/sap/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"pccVMware:apiovh:sap/get","required":true}]}}}}