SQL Server

PreviousRedis NextHardwares

Last updated 4 months ago

get SQLServer instance by its id

get

Authorizations

Path parameters

idinteger · int64Required

id, example: 123

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/databases/sqlserver/{id} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "agOptions": {
    "agListener": "text",
    "agListenerIp": "text",
    "agName": "text",
    "agWitness": "text"
  },
  "allowMonitoringDisplay": true,
  "area": {
    "availabilityZones": [
      {
        "availabilityZoneGroup": "text",
        "datacenterId": "text",
        "defaultZone": true,
        "id": "text",
        "location": "text",
        "routable": true
      }
    ],
    "defaultArea": true,
    "id": "text",
    "location": "text",
    "regulation": "text"
  },
  "availabilityZone": {
    "availabilityZoneGroup": "text",
    "datacenterId": "text",
    "defaultZone": true,
    "id": "text",
    "location": "text",
    "routable": true
  },
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2025-05-08T20:45:28.807Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2025-05-08T20:45:28.807Z",
        "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",
  "cpu": 1,
  "creationTime": "text",
  "creationUser": "text",
  "endOfSalesAt": "2025-05-08T20:45:28.807Z",
  "endOfSupportAt": "2025-05-08T20:45:28.807Z",
  "environment": "text",
  "extendedSupportAt": "2025-05-08T20:45:28.807Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "label": "text",
  "metrologyUrl": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "monitoringOnCallEnabled": true,
  "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
  },
  "nodeCount": 1,
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-05-08T20:45:28.807Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-05-08T20:45:28.807Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "ram": 1,
  "region": {
    "areas": [
      {
        "availabilityZones": [
          {
            "availabilityZoneGroup": "text",
            "datacenterId": "text",
            "defaultZone": true,
            "id": "text",
            "location": "text",
            "routable": true
          }
        ],
        "defaultArea": true,
        "id": "text",
        "location": "text",
        "regulation": "text"
      }
    ],
    "dataCenter": "text",
    "id": "text",
    "location": "text"
  },
  "releasedAt": "2025-05-08T20:45:28.807Z",
  "replicationStatus": true,
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "sizing": "text",
  "status": "text",
  "supportPhase": "text",
  "technology": "text",
  "topology": "text",
  "type": "text",
  "version": "text"
}

Verify the existence of a FARM_MSSQL by FARM_AG_LISTENER.

head

Authorizations

Path parameters

namestringRequired

Query parameters

propertystring · enumOptionalDefault: NAMEPossible values:

Responses

200

400

Bad Request

*/*

head

HEAD /itcare/databases/sqlserver/{name} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

No content

Get a SQLServer node informations

get

Authorizations

Path parameters

idinteger · int64Required

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/databases/sqlserver/{id}/nodes HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

[
  {
    "area": {
      "availabilityZones": [
        {
          "availabilityZoneGroup": "text",
          "datacenterId": "text",
          "defaultZone": true,
          "id": "text",
          "location": "text",
          "routable": true
        }
      ],
      "defaultArea": true,
      "id": "text",
      "location": "text",
      "regulation": "text"
    },
    "authenticationDomain": "text",
    "availabilityZone": {
      "availabilityZoneGroup": "text",
      "datacenterId": "text",
      "defaultZone": true,
      "id": "text",
      "location": "text",
      "routable": true
    },
    "backup": {
      "backupSystem": "text",
      "filesNb": 1,
      "lastDate": "2025-05-08T20:45:28.807Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T20:45:28.807Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T20:45:28.807Z",
          "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",
    "cpu": 1,
    "creationTime": "text",
    "creationUser": "text",
    "endOfSalesAt": "2025-05-08T20:45:28.807Z",
    "endOfSupportAt": "2025-05-08T20:45:28.807Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T20:45:28.807Z",
    "family": "text",
    "id": 1,
    "imageCode": "text",
    "internalResourceId": 1,
    "internalType": "text",
    "ipAddress": "text",
    "isExternalIngressNode": true,
    "isInternalIngressNode": true,
    "isMemberOFLoadBalancer": true,
    "label": "text",
    "labelArea": "text",
    "labelAvailabilityZone": "text",
    "labelDataCenter": "text",
    "labelRegion": "text",
    "loadbalancers": [
      {
        "id": 1,
        "memberCount": 1,
        "monitoringEnabled": true,
        "name": "text",
        "serviceId": 1,
        "status": "text"
      }
    ],
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "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
    },
    "osName": "text",
    "osType": "text",
    "parentResourceType": "text",
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T20:45:28.807Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T20:45:28.807Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "ram": 1,
    "region": {
      "areas": [
        {
          "availabilityZones": [
            {
              "availabilityZoneGroup": "text",
              "datacenterId": "text",
              "defaultZone": true,
              "id": "text",
              "location": "text",
              "routable": true
            }
          ],
          "defaultArea": true,
          "id": "text",
          "location": "text",
          "regulation": "text"
        }
      ],
      "dataCenter": "text",
      "id": "text",
      "location": "text"
    },
    "releasedAt": "2025-05-08T20:45:28.807Z",
    "replication": {
      "noStoRplExplanation": "text",
      "storageClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": true,
      "storageMoveTicket": "text",
      "storageReplicationClass": "text"
    },
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "snapshot": {
      "changeReference": "text",
      "createdAt": "2025-05-08T20:45:28.807Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2025-05-08T20:45:28.807Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2025-05-08T20:45:28.807Z",
      "snapshotSize": 1
    },
    "status": "text",
    "storage": 1,
    "storageInformation": {
      "fileSystems": [
        {
          "free": 1,
          "mountingPoint": "text",
          "sizeOf": 1,
          "type": "text"
        }
      ],
      "totalSizeDisks": 1,
      "totalSizeFileSystems": 1
    },
    "storageMoveInProgress": true,
    "supportPhase": "text",
    "technology": "text",
    "type": "text"
  }
]

Get a SQLServer network informations

get

Authorizations

Path parameters

idinteger · int64Required

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/databases/sqlserver/{id}/networks HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

[
  {
    "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
  }
]

List SQLServer

get

Authorizations

Query parameters

servicesinteger · int64[]Optional

namesstring[]Optional

Names, example: resource01,!resource02,resource42

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Status, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

cloudsintegerOptional

pagestringOptional

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

sizestringOptional

Number of records per page.

sortanyOptional

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

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/databases/sqlserver HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "content": [
    {
      "agOptions": {
        "agListener": "text",
        "agListenerIp": "text",
        "agName": "text",
        "agWitness": "text"
      },
      "allowMonitoringDisplay": true,
      "area": {
        "availabilityZones": [
          {
            "availabilityZoneGroup": "text",
            "datacenterId": "text",
            "defaultZone": true,
            "id": "text",
            "location": "text",
            "routable": true
          }
        ],
        "defaultArea": true,
        "id": "text",
        "location": "text",
        "regulation": "text"
      },
      "availabilityZone": {
        "availabilityZoneGroup": "text",
        "datacenterId": "text",
        "defaultZone": true,
        "id": "text",
        "location": "text",
        "routable": true
      },
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-05-08T20:45:28.807Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-05-08T20:45:28.807Z",
            "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",
      "cpu": 1,
      "creationTime": "text",
      "creationUser": "text",
      "endOfSalesAt": "2025-05-08T20:45:28.807Z",
      "endOfSupportAt": "2025-05-08T20:45:28.807Z",
      "environment": "text",
      "extendedSupportAt": "2025-05-08T20:45:28.807Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "label": "text",
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "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
      },
      "nodeCount": 1,
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-05-08T20:45:28.807Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-05-08T20:45:28.807Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "ram": 1,
      "region": {
        "areas": [
          {
            "availabilityZones": [
              {
                "availabilityZoneGroup": "text",
                "datacenterId": "text",
                "defaultZone": true,
                "id": "text",
                "location": "text",
                "routable": true
              }
            ],
            "defaultArea": true,
            "id": "text",
            "location": "text",
            "regulation": "text"
          }
        ],
        "dataCenter": "text",
        "id": "text",
        "location": "text"
      },
      "releasedAt": "2025-05-08T20:45:28.807Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "sizing": "text",
      "status": "text",
      "supportPhase": "text",
      "technology": "text",
      "topology": "text",
      "type": "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
}

Create a SQL server instance

post

This method allows to create a SQL Server 2022 platform.

You will have to know at the minimum :

name of the SQL server (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
storage needed on each disk of the SQL server (volumes attribute). Initially, 5 disks are allocated and you can create one more. The first disk with id disk0 represents the "C: System", its maximum possible value is 70 and minimum is 1 (representing GB). disk1 represents "D: Root Instance", disk2 represents "E: User Databases", disk 3 represents "F: User Log" and disk4 represents "G: TempDB". The maximum possible value for these disks is 4096 and the minimum is 10 (representing GB).
password to connect to the server (customerPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 8.
On which service the SQL server belongs to (serviceId attribute).
network ID of the cluster (networkId attribute).
the area where you want to host your cluster (area attribute).
the database collation you want to use (collation attribute).
the SQL server edition (edition attribute) whether it's "STD" or "ENT"

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

optional fields:

Availability zone of the SQL server (az attribute) default az of area will be used if not provided
Authentication domain (authenticationDomainId attribute)
Whether SQL server is cluster AlwaysOn or standalone (alwaysOn attribute) default is false
Installing SQL Server Integration Services (SSIS) (ssis attribute) default is false
Installing SQL Server Reporting Services (SSRS) (ssrs attribute) default is false
Installing SQL Server Analysis Services (SSAS) (ssas attribute) default is false
Modelisation type (asServerModeStd attribute) which will be considered only if ssas is true
Collation for Analysis Services (asCollation attribute) which will be considered only if ssas is true
Whether Full-Text search is enabled or not (fullText attribute) default is false
Availability mode when sql server is cluster AlwaysOn (availabilityMode attribute)
Failover mode when sql server is cluster AlwaysOn (failoverMode attribute)
Readable secondary when sql server is cluster AlwaysOn (readableSecondary attribute)
Witness when sql server is cluster AlwaysOn (witness attribute)
Listener name when sql server is cluster AlwaysOn (listenerName attribute)

POST /sqlserver
{
   "name":"RSQL22",
   "nodeSizing":"2cpu8gb",
   "volumes":[
      {
         "id":"disk3",
         "sizeGb":10
      },
      {
         "id":"disk4",
         "sizeGb":10
      },
      {
         "id":"disk2",
         "sizeGb":30
      },
      {
         "id":"disk1",
         "sizeGb":30
      },
      {
         "id":"disk0",
         "sizeGb":70
      }
   ],
   "area":"EB-QA",
   "customerPassword":"P@ssw0rd",
   "collation":"French_BIN",
   "edition":"STD",
   "serviceId":2423,
   "networkId":5000802
}

Authorizations

Body

alwaysOnbooleanOptional

Cluster/Basic Always On, example: true

areastringRequired

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

asCollactionstringOptional

Collation for Analysis Services

asServerModeEntstringOptional

Modelisation type

asServerModeStdstringOptional

Modelisation type, example: TABULAR

authenticationDomainIdstringOptional

authentication domain id, example: CGDM-EMEA

availabilityModestringOptional

Cluster availability mode, example: Synchronous_commit

azstringRequired

Availability zone of SQL Server

backupEnabledbooleanOptional

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

cloudIdinteger · int64Optional

collationstringRequired

Database Collation, example: French_BIN

customerPasswordstringRequired

Customer Password

dbBackupPolicyIdstringOptional

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

editionstringRequired

SQL Server edition, example: ENT

failoverModestringOptional

Cluster failover mode, example: Read-intent_only

fullTextbooleanOptional

Whether Full-Text search is enabled or not

listenerNamestringOptional

Cluster listener name, example: rhusqllsnr01

monitoringAlertingbooleanOptional

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

monitoringEnabledbooleanOptional

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 SQL Server

networkIdinteger · int64Required

The network Id of the ELS cluster

noBackupProdReasonstringOptional

Indicates why a production resource is not under backup.

noMonitoringProdReasonstringOptional

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstringOptional

Indicates why a production resource is not replicated.

nodeCountinteger · int32Optional

cluster nodes number, example: 3

nodeSizingstringRequired

Node sizing for cluster

onCallSupervisionbooleanOptional

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

platformstringRequired

Product platform of the cluster

prefixstringOptional

Prefix name of SQL Server

readableSecondarystringOptional

Cluster readable secondary, example: YES, NO, READ_ONLY

regionstringRequired

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

regulationstringOptional

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

replicationEnabledbooleanOptional

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

serverBackupPolicyIdstringOptional

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.

specificRequeststringOptional

specific request to be done by an administrator. Can differ delivery of instance up to 24h., example: Could you please install .NET framework 4.5 on instance ? Thanks.

ssasbooleanOptional

SQL Server Analysis Services (SSAS)

ssisbooleanOptional

SQL Server Integration Services (SSIS)

ssrsbooleanOptional

SQL Server Reporting Services (SSRS)

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

post

POST /itcare/databases/sqlserver HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 958

{
  "alwaysOn": true,
  "area": "text",
  "asCollaction": "text",
  "asServerModeEnt": "text",
  "asServerModeStd": "text",
  "authenticationDomainId": "text",
  "availabilityMode": "text",
  "az": "text",
  "backupEnabled": true,
  "cloudId": 1,
  "collation": "text",
  "customerPassword": "text",
  "dbBackupPolicyId": "text",
  "edition": "text",
  "failoverMode": "text",
  "fullText": true,
  "listenerName": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "name": "text",
  "networkId": 1,
  "noBackupProdReason": "text",
  "noMonitoringProdReason": "text",
  "noReplicationProdReason": "text",
  "nodeCount": 1,
  "nodeSizing": "text",
  "onCallSupervision": true,
  "platform": "text",
  "prefix": "text",
  "readableSecondary": "text",
  "region": "text",
  "regulation": "text",
  "replicationEnabled": true,
  "serverBackupPolicyId": "text",
  "serviceId": 1,
  "specificRequest": "text",
  "ssas": true,
  "ssis": true,
  "ssrs": true,
  "volumes": [
    {
      "description": "text",
      "editable": 1,
      "exclFromSnap": 1,
      "id": "data",
      "mandatory": true,
      "max": 1,
      "min": 1,
      "order": 1,
      "sizeGb": 1,
      "system": true
    }
  ]
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:45:28.807Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Delete an existing SQL Server instance

delete

This method allows to delete a SQL Server instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

by id

DELETE /compute/databases/sqlserver/1234

by id and changeReference (RFC)

DELETE /compute/databases/sqlserver/1234
{
	"changeReference": "56789"
}

Authorizations

Path parameters

idinteger · int64Required

id, example: 123

Body

Parameters when deleting a resource

changeReferencestring · max: 10Optional

Optional reference for change

Responses

202

Accepted

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

delete

DELETE /itcare/databases/sqlserver/{id} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "changeReference": "text"
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:45:28.807Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Performs update actions to an existing SQLServer instance

patch

This method allows to update a SQL Server Farm.

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 SQL Server Farm

Use the start operation to start the SQL Server Farm.

This method is synchronous (status code 202).

Example :

PATCH /compute/databases/sqlserver/1234
{
    "operation": "start"
}

Stop SQL Server Farm

Use the stop operation to stop the SQL Server Farm.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

by SQL Server id

PATCH /compute/databases/sqlserver/1234
{
	"operation": "stop"
}

by sql server id and changeReference number (RFC)

PATCH /compute/databases/sqlserver/1234
{
	"operation": "stop",
	"options": {
	    "changeReference": "56789"
	}
}

Reset SQLServer Farm

Use the reset operation to reset the SQL Server Farm.

This method is synchronous (status code 202).

Example :

PATCH /compute/databases/sqlserver/1234
{
    "operation": "reset"
}

Resize SQLServer instance

Use the resize operation to resize the nodes of the SQLServer instance and the instance itself.

This operation cannot be undone afterwards.

This method is asynchronous (status code 202).

PATCH /compute/databases/sqlserver/1234
{
	"operation":"resize",
	"options": {
        "sizing": "2cpu4gb"
    }
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the SQL Server.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the SQLServer.

Use the excluded option to turn on/off patch party.
Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

Include from patch party body:

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

Exclude from patch party body:

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

Authorizations

Path parameters

idinteger · int64Required

id, example: 123

Body

Object describing a partial modification of an object to perform. Please refer to documentation to get list of operations available and their specific payload.

operationstringRequired

Operation to perform on target object, example: operation_name

Responses

202

Accepted

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

patch

PATCH /itcare/databases/sqlserver/{id} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:45:28.807Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}