Skip to content

SAP Features Hub

All operations require authentication.

4 operationsv1/dedicatedCloud/{serviceName}
Agent setup

List pre-installation tasksProduction

GET
/1.0/dedicatedCloud/{serviceName}/sap

Returns the pre-installation tasks of the service and their status.

Path parameters

serviceName
required
string

Domain of the service

Query parameters

iamTags
object

Filter resources on IAM tags

Response

200sapWithIAM[]successful operation
applicationType
read-only
applicationTypeEnum

Describes the type of SAP application that is being installed as part of the pre-installation tasks.

ValuesABAPJAVA
applicationVersion
read-only
string

Describes the specific version of the SAP application that is being installed during the pre-installation process.

cleanStatus
read-only
statusEnum

Provides the current status of the clean-up operations performed as part of the pre-installation tasks.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
deploymentType
read-only
deploymentTypeEnum

Describes the type of deployment strategy being used for the SAP installation during the pre-installation process.

ValuesDistributedHigh-AvailabilityStandard
endTime
read-only
string

Records the date and time when the pre-installation tasks were finished.

errorMessage
read-only
string

Contains a detailed error message if any issues or failures occurred during the execution of the pre-installation tasks.

gatewayStatus
read-only
statusEnum

Provides the current operational state of the Gateway component during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
iam
read-only
ResourceMetadata

IAM resource metadata

sapHanaInstallationStatus
read-only
statusEnum

Provides the current operational state of the SAP HANA installation during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
sapHanaSid
read-only
string

Describes the System ID (SID) assigned to the SAP HANA instance being installed as part of the pre-installation tasks.

sapSid
read-only
string

Describes the System ID (SID) assigned to the SAP system being installed as part of the pre-installation tasks.

sapSystemInstallationStatus
read-only
statusEnum

Provides the current operational state of the SAP system installation during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
startTime
read-only
string

Records the date and time when the pre-installation tasks were initiated.

status
read-only
statusEnum

Provides an overview of the current overall status of the pre-installation tasks.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
taskId
read-only
stringuuid

Uniquely identifies each set of pre-installation tasks.

vmDeploymentStatus
read-only
statusEnum

Provides the current operational state of virtual machines deployment during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/sap \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "applicationType": "ABAP", "applicationVersion": "string", "cleanStatus": "FAILURE", "deploymentType": "Distributed", "endTime": "string", "errorMessage": "string", "gatewayStatus": "FAILURE", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "sapHanaInstallationStatus": "FAILURE", "sapHanaSid": "string", "sapSid": "string", "sapSystemInstallationStatus": "FAILURE", "startTime": "string", "status": "FAILURE", "taskId": "00000000-0000-0000-0000-000000000000", "vmDeploymentStatus": "FAILURE" }]

Get a pre-installation taskProduction

GET
/1.0/dedicatedCloud/{serviceName}/sap/{taskId}

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.

Path parameters

serviceName
required
string

Domain of the service

taskId
required
stringuuid

Task ID

Response

200sapWithIAMsuccessful operation
applicationType
read-only
applicationTypeEnum

Describes the type of SAP application that is being installed as part of the pre-installation tasks.

ValuesABAPJAVA
applicationVersion
read-only
string

Describes the specific version of the SAP application that is being installed during the pre-installation process.

cleanStatus
read-only
statusEnum

Provides the current status of the clean-up operations performed as part of the pre-installation tasks.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
deploymentType
read-only
deploymentTypeEnum

Describes the type of deployment strategy being used for the SAP installation during the pre-installation process.

ValuesDistributedHigh-AvailabilityStandard
endTime
read-only
string

Records the date and time when the pre-installation tasks were finished.

errorMessage
read-only
string

Contains a detailed error message if any issues or failures occurred during the execution of the pre-installation tasks.

gatewayStatus
read-only
statusEnum

Provides the current operational state of the Gateway component during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
iam
read-only
ResourceMetadata

IAM resource metadata

sapHanaInstallationStatus
read-only
statusEnum

Provides the current operational state of the SAP HANA installation during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
sapHanaSid
read-only
string

Describes the System ID (SID) assigned to the SAP HANA instance being installed as part of the pre-installation tasks.

sapSid
read-only
string

Describes the System ID (SID) assigned to the SAP system being installed as part of the pre-installation tasks.

sapSystemInstallationStatus
read-only
statusEnum

Provides the current operational state of the SAP system installation during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
startTime
read-only
string

Records the date and time when the pre-installation tasks were initiated.

status
read-only
statusEnum

Provides an overview of the current overall status of the pre-installation tasks.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS
taskId
read-only
stringuuid

Uniquely identifies each set of pre-installation tasks.

vmDeploymentStatus
read-only
statusEnum

Provides the current operational state of virtual machines deployment during the pre-installation process.

ValuesFAILUREPENDINGRETRYREVOKEDSTARTEDSUCCESS

Example uses serviceName = string, taskId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/sap/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "applicationType": "ABAP", "applicationVersion": "string", "cleanStatus": "FAILURE", "deploymentType": "Distributed", "endTime": "string", "errorMessage": "string", "gatewayStatus": "FAILURE", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "sapHanaInstallationStatus": "FAILURE", "sapHanaSid": "string", "sapSid": "string", "sapSystemInstallationStatus": "FAILURE", "startTime": "string", "status": "FAILURE", "taskId": "00000000-0000-0000-0000-000000000000", "vmDeploymentStatus": "FAILURE"}

Create a pre-installation taskProduction

POST
/1.0/dedicatedCloud/{serviceName}/sap

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.

Path parameters

serviceName
required
string

Domain of the service

Request body (required)

applicationServers
required
applicationServers[]

An array containing the configuration details for each SAP Application Server (such as SCS, ERS, PAS, AAS) virtual machine that will be deployed.

applicationType
required
applicationTypeEnum

Selects the type of SAP application that will be installed, such as NetWeaver 7.50 or S/4HANA.

ValuesABAPJAVA
applicationVersion
required
applicationVersionEnum

Selects the specific version of the SAP application that will be deployed.

ValuesNetWeaver 7.50S/4HANA 2021S/4HANA 2022S/4HANA 2023
bucketBackint
bucket

Configuration settings for the storage bucket used by the OVHcloud Backint Agent to store SAP HANA backup files.

bucketSources
required
bucket

Configuration settings for the storage bucket that contains the necessary SAP installation sources.

clusterName
required
string

A user-defined name for the cluster that will host the SAP environment, usually 'Cluster1'.

datacenterId
required
integer

The unique identifier for the datacenter where the SAP environment will be deployed.

deploymentType
required
deploymentTypeEnum

Selects the type of SAP deployment, such as Standard, Distributed or High-Availability.

ValuesDistributedHigh-AvailabilityStandard
domainName
required
string

The fully qualified domain name (FQDN) that will be used for the SAP environment.

firewall
required
firewall

Configuration settings for the firewall to protect the SAP environment.

hanaServers
required
hanaServers[]

An array containing the configuration details for each SAP HANA virtual machine that will be deployed.

logsDataPlatform
ldp

Configuration settings for the Logs Data Platform that will be used to collect and externalize operating system and SAP logs.

osLicense
string

The license key or identifier for the operating system that will be used for the SAP environment.

osUpdate
required
boolean

A boolean value indicating whether the operating system should be updated during the pre-installation process.

passwords
required
passwords

Configuration settings for the various passwords required for the SAP environment, including database, administrator, and service accounts.

serviceName
string

The name of the Hosted Private Cloud service. This field is primarily used by the OVHcloud Manager during the import process.

sids
required
sids

Configuration settings for the System IDs (SIDs) that will be used for the SAP environment.

systemUsage
required
systemUsageEnum

Selects the intended usage of the SAP system, such as custom, development, production or test.

Valuescustomdevelopmentproductiontest

Response

200stringsuccessful operation
400objectError 400 response
403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/sap \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"00000000-0000-0000-0000-000000000000"

Delete a pre-installation taskProduction

DELETE
/1.0/dedicatedCloud/{serviceName}/sap/{taskId}

Deletes the task. The virtual machines it deployed are kept.

Path parameters

serviceName
required
string

Domain of the service

taskId
required
stringuuid

Task ID

Response

200—successful operation

Example uses serviceName = string, taskId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/sap/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"