Overdrive

List OverDrive Instances

get

/storage/overdrive

Authorizations

Query parameters

namesstring[]

Names, example: overdrive1

cloudsinteger

pagestring

Results page you want to retrieve (0..N)

sizestring

Number of records per page.

sortany

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/storage/overdrive'

200

400

200

{
  "content": [
    {
      "actionsInProgress": [
        {
          "family": "text",
          "id": 1,
          "internalId": 1,
          "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
          "message": "text",
          "process": "text",
          "resourceName": "text",
          "resourceType": "text",
          "status": "SUCCESS,IN_PROGRESS,ERROR"
        }
      ],
      "availableActions": [
        {
          "available": true,
          "operation": "text",
          "unavailabilityCauses": [
            "text"
          ]
        }
      ],
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-03-09T14:22:10.133Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-03-09T14:22:10.133Z",
            "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-03-09T14:22:10.133Z",
      "endOfSupportAt": "2025-03-09T14:22:10.133Z",
      "environment": "text",
      "extendedSupportAt": "2025-03-09T14:22:10.133Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "label": "text",
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-03-09T14:22:10.133Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-03-09T14:22:10.133Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "releasedAt": "2025-03-09T14:22:10.133Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "sizing": "text",
      "status": "text",
      "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
}

OK

Create an OverDrive instance

This method allows to create an OverDrive instance.

You will have to know at the minimum :

• where you want to host your instance (region attribute)
• name of instance (name attribute)
• sizing of the instance (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)
• how to connect to the instance (password attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
• On which service the OverDrive instance belongs to (serviceId attribute).
• Define the Drive URL to be configured in your service (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"
	
}

post

/storage/overdrive

Authorizations

Body

backupEnabledboolean

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

cloudIdinteger · int64

dbBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

driveSiteUristringrequired

Define the Drive URL to be configured in OverDrive

monitoringAlertingboolean

Indicates if alerting should be activated. If absent, set to false.

monitoringEnabledboolean

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

namestringrequired

Name of OverDrive Instance

Pattern: [a-z0-9\-]{4,60}$

noBackupProdReasonstring

Indicates why a production resource is not under backup.

noMonitoringProdReasonstring

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstring

Indicates why a production resource is not replicated.

onCallSupervisionboolean

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

passwordstringrequired

Password to connect to the OverDrive instance.

regionstringrequired

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

regulationstring

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

replicationEnabledboolean

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

serverBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

serviceIdinteger · int64required

id of service to put instance in.

sizingstringrequired

Sizing. L, XL , XS, S, M. Sizing for OverDrive instances

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.cegedim.cloud/itcare/storage/overdrive' \
  --header 'Content-Type: application/vnd.cegedim-it.v1+json' \
  --data '{
    "backupEnabled": true,
    "cloudId": 1,
    "dbBackupPolicyId": "text",
    "driveSiteUri": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "name": "text",
    "noBackupProdReason": "text",
    "noMonitoringProdReason": "text",
    "noReplicationProdReason": "text",
    "onCallSupervision": true,
    "password": "text",
    "region": "text",
    "regulation": "text",
    "replicationEnabled": true,
    "serverBackupPolicyId": "text",
    "serviceId": 1,
    "sizing": "text"
  }'

200

400

200

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

OK

Delete an OverDrive instance

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

delete

/storage/overdrive/{id}

Authorizations

Path parameters

idinteger · int64required

id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.cegedim.cloud/itcare/storage/overdrive/{id}'

200

400

200

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

OK

Get an OverDrive Instance

get

/storage/overdrive/{id}

Authorizations

Path parameters

idinteger · int64required

id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/storage/overdrive/{id}'

200

400

200

{
  "actionsInProgress": [
    {
      "family": "text",
      "id": 1,
      "internalId": 1,
      "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
      "message": "text",
      "process": "text",
      "resourceName": "text",
      "resourceType": "text",
      "status": "SUCCESS,IN_PROGRESS,ERROR"
    }
  ],
  "availableActions": [
    {
      "available": true,
      "operation": "text",
      "unavailabilityCauses": [
        "text"
      ]
    }
  ],
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2025-03-09T14:22:10.133Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2025-03-09T14:22:10.133Z",
        "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-03-09T14:22:10.133Z",
  "endOfSupportAt": "2025-03-09T14:22:10.133Z",
  "environment": "text",
  "extendedSupportAt": "2025-03-09T14:22:10.133Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "label": "text",
  "metrologyUrl": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "name": "text",
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-03-09T14:22:10.133Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-03-09T14:22:10.133Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "releasedAt": "2025-03-09T14:22:10.133Z",
  "replicationStatus": true,
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "sizing": "text",
  "status": "text",
  "supportPhase": "text",
  "technology": "text",
  "type": "text",
  "url": "text",
  "version": "text"
}

OK

Update an OverDrive instance

This method allows to update an Overdrive instance.

Structure of payload is generic and describes :

• operation you want to be performed
• options 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"
}

patch

/storage/overdrive/{id}

Authorizations

Path parameters

idinteger · int64required

id, example: 123

Body

application/jsonapplication/vnd.cegedim-it.v1+json

operationstring

optionsobject

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.cegedim.cloud/itcare/storage/overdrive/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "operation": "text",
    "options": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }'

200

400

200

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

OK