OAuth2 flow
Names, example: overdrive1
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
OK
Bad Request
This method allows to create an OverDrive instance.
You will have to know at the minimum :
region attribute)name attribute)sizing attribute). The possible values are : XS (Up to 50 users total), S(Up to 1M ppm), M(Up to 10M ppm), L(Up to 100M ppm), XL(More than 100M ppm)password attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.serviceId attribute).driveSiteUri).This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
POST /storage/overdrive
{
"name": "poverdrive01",
"region": "EB",
"sizing":"XS",
"serviceId":"123",
"password": "Password!!??",
"driveSiteUri": "demo.mydrive.cegedim.cloud"
}
OAuth2 flow
This method allows to delete an Overdrive instance.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
DELETE /storage/overdrive/123
OAuth2 flow
id, example: 123
OK
Bad Request
This method allows to update an Overdrive instance.
Structure of payload is generic and describes :
operation you want to be performedoptions data relative to the operation performed - see details - optional.Below are different operations currently implemented.
Start Overdrive instance
Use the start operation to start an Overdrive instance.
Starts overdrive instance.
This method is synchronous (status code 202).
Example :
PATCH /storage/overdrive/1234
{
"operation": "start"
}
Stop Overdrive instance
Use the stop operation to stop the nodes of the Overdrive instance and the instance itself.
This operation cannot be undone afterwards.
This method is synchronous (status code 202).
PATCH /storage/overdrive/1234
{
"operation":"stop"
}
OAuth2 flow
id, example: 123
OK
Bad Request
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
Define the Drive URL to be configured in OverDrive
Name of OverDrive Instance
[a-z0-9\-]{4,60}$Indicates why a production resource is not under backup.
Indicates why a production resource is not under monitoring.
Indicates why a production resource is not replicated.
Password to connect to the OverDrive instance.
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
id of service to put instance in.
Sizing. L, XL , XS, S, M. Sizing for OverDrive instances
Indicates monitoring and support level, if absent then we use boolean variables to describe which level
OK
Bad Request
{
"content": [
{
"actionsInProgress": [
{
"family": "text",
"id": 1,
"internalId": 1,
"lastUpdatedAt": "2025-12-14T15:59:23.776Z",
"message": "text",
"process": "text",
"resourceName": "text",
"resourceType": "text",
"status": "SUCCESS,IN_PROGRESS,ERROR"
}
],
"availableActions": [
{
"available": true,
"operation": "text",
"unavailabilityCauses": [
"text"
]
}
],
"backupPolicyDetails": {
"backups": [
{
"backupLastDate": "2025-12-14T15:59:23.776Z",
"backupSize": 1,
"id": 1,
"type": "text"
}
],
"policies": [
{
"backupLastDate": "2025-12-14T15:59:23.776Z",
"backupSize": 1,
"durationInHours": 1,
"frequencies": {},
"label": "text",
"name": "text",
"policyId": "text",
"replication": true,
"scope": "text",
"startTime": "text",
"timezone": "text",
"type": "text"
}
]
},
"backupStatus": true,
"category": "text",
"cloudId": 1,
"cloudName": "text",
"comment": "text",
"creationTime": "text",
"creationUser": "text",
"endOfSalesAt": "2025-12-14T15:59:23.776Z",
"endOfSupportAt": "2025-12-14T15:59:23.776Z",
"environment": "text",
"extendedSupportAt": "2025-12-14T15:59:23.776Z",
"family": "text",
"id": 1,
"internalResourceId": 1,
"internalType": "text",
"ipAddress": "text",
"label": "text",
"labelArea": "text",
"labelAvailabilityZone": "text",
"labelDataCenter": "text",
"labelRegion": "text",
"metrologyUrl": "text",
"monitoringRequested": true,
"name": "text",
"network": {
"area": "text",
"cidr": "text",
"cloud": "text",
"defaultNetwork": true,
"description": "text",
"dns": [
{
"alias": "text",
"domain": "text"
}
],
"environment": "text",
"gateway": "text",
"id": 1,
"ipAddress": "text",
"ipFreeNumber": 1,
"isIpRangePublic": true,
"mask": "text",
"networkShortDescription": "text",
"region": "text",
"scope": "text",
"shortDescription": "text",
"technicalId": "text",
"usedPercent": 1
},
"patchParty": {
"excluded": true,
"excludedBy": "text",
"exclusionDate": "2025-12-14T15:59:23.776Z",
"exclusionReason": "text",
"id": 1,
"name": "text",
"patchDate": "2025-12-14T15:59:23.776Z",
"patchGroup": "text",
"patchTag": "text"
},
"path": "text",
"prettyLabel": "text",
"productCode": "text",
"productName": "text",
"productVersion": "text",
"releasedAt": "2025-12-14T15:59:23.776Z",
"replicationStatus": true,
"resourceType": "text",
"serviceId": 1,
"serviceKey": "text",
"serviceName": "text",
"sizing": "text",
"status": "text",
"supportLevel": "NO_MONITORING_NO_SUPPORT",
"supportPhase": "text",
"technology": "text",
"type": "text",
"url": "text",
"version": "text"
}
],
"empty": true,
"first": true,
"last": true,
"number": 1,
"numberOfElements": 1,
"pageable": {
"offset": 1,
"pageNumber": 1,
"pageSize": 1,
"paged": true,
"sort": [
{
"ascending": true,
"direction": "text",
"ignoreCase": true,
"nullHandling": "text",
"property": "text"
}
],
"unpaged": true
},
"size": 1,
"sort": [
{
"ascending": true,
"direction": "text",
"ignoreCase": true,
"nullHandling": "text",
"property": "text"
}
],
"totalElements": 1,
"totalPages": 1
}{
"family": "text",
"id": 1,
"internalId": 1,
"lastUpdatedAt": "2025-12-14T15:59:23.776Z",
"message": "text",
"process": "text",
"resourceName": "text",
"resourceType": "text",
"status": "SUCCESS,IN_PROGRESS,ERROR"
}{
"family": "text",
"id": 1,
"internalId": 1,
"lastUpdatedAt": "2025-12-14T15:59:23.776Z",
"message": "text",
"process": "text",
"resourceName": "text",
"resourceType": "text",
"status": "SUCCESS,IN_PROGRESS,ERROR"
}{
"family": "text",
"id": 1,
"internalId": 1,
"lastUpdatedAt": "2025-12-14T15:59:23.776Z",
"message": "text",
"process": "text",
"resourceName": "text",
"resourceType": "text",
"status": "SUCCESS,IN_PROGRESS,ERROR"
}GET /itcare/storage/overdrive HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
DELETE /itcare/storage/overdrive/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
GET /itcare/storage/overdrive/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"actionsInProgress": [
{
"family": "text",
"id": 1,
"internalId": 1,
"lastUpdatedAt": "2025-12-14T15:59:23.776Z",
"message": "text",
"process": "text",
"resourceName": "text",
"resourceType": "text",
"status": "SUCCESS,IN_PROGRESS,ERROR"
}
],
"availableActions": [
{
"available": true,
"operation": "text",
"unavailabilityCauses": [
"text"
]
}
],
"backupPolicyDetails": {
"backups": [
{
"backupLastDate": "2025-12-14T15:59:23.776Z",
"backupSize": 1,
"id": 1,
"type": "text"
}
],
"policies": [
{
"backupLastDate": "2025-12-14T15:59:23.776Z",
"backupSize": 1,
"durationInHours": 1,
"frequencies": {},
"label": "text",
"name": "text",
"policyId": "text",
"replication": true,
"scope": "text",
"startTime": "text",
"timezone": "text",
"type": "text"
}
]
},
"backupStatus": true,
"category": "text",
"cloudId": 1,
"cloudName": "text",
"comment": "text",
"creationTime": "text",
"creationUser": "text",
"endOfSalesAt": "2025-12-14T15:59:23.776Z",
"endOfSupportAt": "2025-12-14T15:59:23.776Z",
"environment": "text",
"extendedSupportAt": "2025-12-14T15:59:23.776Z",
"family": "text",
"id": 1,
"internalResourceId": 1,
"internalType": "text",
"ipAddress": "text",
"label": "text",
"labelArea": "text",
"labelAvailabilityZone": "text",
"labelDataCenter": "text",
"labelRegion": "text",
"metrologyUrl": "text",
"monitoringRequested": true,
"name": "text",
"network": {
"area": "text",
"cidr": "text",
"cloud": "text",
"defaultNetwork": true,
"description": "text",
"dns": [
{
"alias": "text",
"domain": "text"
}
],
"environment": "text",
"gateway": "text",
"id": 1,
"ipAddress": "text",
"ipFreeNumber": 1,
"isIpRangePublic": true,
"mask": "text",
"networkShortDescription": "text",
"region": "text",
"scope": "text",
"shortDescription": "text",
"technicalId": "text",
"usedPercent": 1
},
"patchParty": {
"excluded": true,
"excludedBy": "text",
"exclusionDate": "2025-12-14T15:59:23.776Z",
"exclusionReason": "text",
"id": 1,
"name": "text",
"patchDate": "2025-12-14T15:59:23.776Z",
"patchGroup": "text",
"patchTag": "text"
},
"path": "text",
"prettyLabel": "text",
"productCode": "text",
"productName": "text",
"productVersion": "text",
"releasedAt": "2025-12-14T15:59:23.776Z",
"replicationStatus": true,
"resourceType": "text",
"serviceId": 1,
"serviceKey": "text",
"serviceName": "text",
"sizing": "text",
"status": "text",
"supportLevel": "NO_MONITORING_NO_SUPPORT",
"supportPhase": "text",
"technology": "text",
"type": "text",
"url": "text",
"version": "text"
}PATCH /itcare/storage/overdrive/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"operation": "text",
"options": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}POST /itcare/storage/overdrive HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 1880
{
"backupEnabled": true,
"cloudId": 1,
"dbBackupPolicyId": "text",
"driveSiteUri": "text",
"name": "text",
"noBackupProdReason": "text",
"noMonitoringProdReason": "text",
"noReplicationProdReason": "text",
"password": "text",
"product": {
"BACKUP_POLICY_TYPE": "text",
"CATEGORY_WEIGHT": 1,
"CODE": "text",
"COMMENT": "text",
"DOCUMENTATION": "text",
"EDITION": "text",
"END_OF_SALES_AT": "2025-12-14T15:59:23.776Z",
"END_OF_SUPPORT_AT": "2025-12-14T15:59:23.776Z",
"ENFORCED_AUTH_DOMAIN": true,
"EXTENDED_SUPPORT_AT": "2025-12-14T15:59:23.776Z",
"FAMILY_WEIGHT": 1,
"ID": "text",
"IMG": "text",
"LABEL": "text",
"NAME": "text",
"PLATFORM": "text",
"PRODUCT_CATEGORY": "text",
"PRODUCT_DISPLAYABLE": true,
"PRODUCT_IS_DISABLED": true,
"PRODUCT_IS_IN_BETA_MODE": true,
"PRODUCT_MAGIC_FORMS": "text",
"PRODUCT_SKIP_TECHNOLOGY": true,
"PRODUCT_TECHNOLOGY": "text",
"PRODUCT_VERSION": "text",
"RELEASED_AT": "2025-12-14T15:59:23.776Z",
"STATUS": "text",
"SUPPORT_FORM_AVAILABLE": true,
"SUPPORT_FORM_ID": "text",
"SUPPORT_PHASE": "text",
"TECH_FORMONLY": true,
"TECH_WEIGHT": 1,
"TYPE": "text",
"VERSION": "text",
"configuration": {
"topologies": [
{
"alwaysOn": "text",
"cluster": "text",
"galera": "text",
"ha": "text",
"replica": "text",
"sentinel": "text",
"single": "text",
"standalone": "text"
}
]
},
"properties": [
{
"defaultValue": "text",
"description": "text",
"displayed": true,
"editable": true,
"key": "text",
"mandatory": true,
"value": "text"
}
],
"resources": [
{
"available": true,
"id": "text",
"optionDescrEn": "text",
"optionDescrFr": "text",
"optionName": "text",
"optionOrder": "text",
"ram": 1,
"vcpus": 1
}
],
"storage": {
"maxVolumes": 1,
"minVolumeSize": 1,
"totalSizeAuthorized": 1,
"totalVolumesSize": 1,
"volumes": [
{
"description": "text",
"editable": 1,
"exclFromSnap": 1,
"id": "data",
"mandatory": true,
"max": 1,
"min": 1,
"order": 1,
"sizeGb": 1,
"system": true
}
]
}
},
"region": "text",
"regulation": "text",
"replicationEnabled": true,
"serverBackupPolicyId": "text",
"serviceId": 1,
"sizing": "text",
"supportLevel": "NO_MONITORING_NO_SUPPORT"
}