Services

Get a list of the resources excluded from Patch Party

This method allows to update the partch party informations related to the given service.

Structure of payload is generic and describes :

• an array containing the patch party configuration to apply for each resource of the given service
• If the resource is to be excluded from the patch parties, an explanation must be given.
• If the resource is to be included to the patch parties, an patchGroup should be given unless the resource is part of a cluster.

Update Patch Party Statuses

PATCH /services/1234/patch-policies
[
    {
        "resourceId": 500079802,
        "excluded": false,
        "exclusionReason": "I don't want to include this resource"
    },
    {
        "resourceId": 500079545,
        "excluded": true,
        "patchGroup": "2"
    },
    {
        "resourceId": 500057033,
        "excluded": false,
        "exclusionReason": "Wrong patch group is set",
        "patchGroup": "1c"
    },
    {
        "resourceId": 500057055,
        "excluded": false,
        "patchGroup": "1"
    }
]

• The response will give the status of all the submitted resources, for example :

[
    {
        "status": "FAILED",
        "message": "The patch group is only allowed when the farm has one member",
        "id": -1,
        "internalId": 500057055
    },
    {
        "status": "IN_PROGRESS",
        "message": "Include PatchParty SQLServer rhutsql20",
        "process": "INCLUDE_PATCHPARTY",
        "id": 500079545,
        "lastUpdatedAt": "2023-11-16T11:53:42.888+00:00"
    },
    {
        "status": "FAILED",
        "message": "Wrong patch party group set",
        "id": -1,
        "internalId": 500057033
    },
    {
        "id": 202
    }
]

There are 3 groups available defining the sequence on which the instance should be updated: 1 (First Group), 2 (Second Group) or 3 (Third Group).

If no group is set, it means that you have no preference while defining the sequences.

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/patch-policies

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

excluded*boolean

Tells if the resource is excluded or not from patch party

exclusionReasonstring

Raison why the resource should be excluded from patch party.

patchGroupstring

Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference

patchDatestring (date-time)

Date of the last System Upgrade.

patchTagstring

Tag to reference the last patch party

namestring

Name of the resource under patch party or not

idinteger (int64)

Id of the resource under patch party or not

excludedBystring

User who performed the exclusion from patch party action

exclusionDatestring (date-time)

Date on which the exclusion from patch party was performed

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/patch-policies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "excluded": false,
    "exclusionReason": "text",
    "patchGroup": "text",
    "patchDate": "2025-01-03T03:44:48.117Z",
    "patchTag": "text",
    "name": "text",
    "id": 0,
    "excludedBy": "text",
    "exclusionDate": "2025-01-03T03:44:48.117Z"
  }
]

Update patch party configuration for resources for a service

PATCHhttps://api.cegedim.cloud/itcare/compute/services/{id}/patch-policies

Path parameters

id*integer (int64)

Service Id, example: 44411

Body

application/vnd.cegedim-it.v1+json

resourceId*integer (int64)

excludedboolean

exclusionReasonstring

patchGroupstring

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/patch-policies', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify([
      {
        "resourceId": 0
      }
    ]),
});
const data = await response.json();

Response

200

[
  {
    "process": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR",
    "message": "text",
    "id": 0,
    "internalId": 0,
    "resourceName": "text",
    "resourceType": "text",
    "family": "text",
    "lastUpdatedAt": "2025-01-03T03:44:48.117Z"
  }
]

List Compute Resources

GEThttps://api.cegedim.cloud/itcare/compute/services

Query parameters

Response

200400

OK

Body

*/*

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of ServiceV1 (object)

numberinteger (int32)

sortarray of SortObject (object)

pageablePageableObject (object)

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "totalElements": 0,
  "totalPages": 0,
  "first": false,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "text",
      "status": "ACTIVE,PREPARATION",
      "environment": "text",
      "key": "text",
      "comment": "text",
      "cloud": "text",
      "cloudId": 0,
      "smsSubscribed": false,
      "advancedMonitoringAllowed": false,
      "relations": {
        "dependencies": [],
        "impacts": []
      }
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": false,
      "property": "text",
      "ignoreCase": false
    }
  ],
  "pageable": {
    "offset": 0,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": false,
        "property": "text",
        "ignoreCase": false
      }
    ],
    "pageSize": 0,
    "pageNumber": 0,
    "paged": false,
    "unpaged": false
  },
  "numberOfElements": 0,
  "last": false,
  "empty": false
}

List the action history of a service. Retrieves all operations / events that occurs on a resource : start, stop, monitoring operations ...

GEThttps://api.cegedim.cloud/itcare/compute/services/{serviceId}/history

Path parameters

serviceId*integer (int64)

Service Id, example: 500063721

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int64)

submittedAtstring (date-time)

completedAtstring (date-time)

lastUpdatedAtstring (date-time)

submittedBystring

resourceTypestring

resourceNamestring

familystring

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{serviceId}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "process": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR",
    "message": "text",
    "id": 0,
    "submittedAt": "2025-01-03T03:44:48.117Z",
    "completedAt": "2025-01-03T03:44:48.117Z",
    "lastUpdatedAt": "2025-01-03T03:44:48.117Z",
    "submittedBy": "text",
    "resourceType": "text",
    "resourceName": "text",
    "family": "text"
  }
]

Get detailed information of a service by its Id

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}

Path parameters

id*integer (int64)

Service Id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

Id of service

namestring

Name of service

statusenum

Status of service. Use List Statuses API method to list possible values.

ACTIVE,PREPARATION

environmentstring

Environment of service. Use List Statuses API method to list possible values.

keystring

Internal key of service

commentstring

Short comment of service

cloudstring

Cloud Name of the service

cloudIdinteger (int64)

Cloud Name of the service

smsSubscribedboolean

Tells If the service has subscribed to cegedim.cloud sms service

advancedMonitoringAllowedboolean

Tells If the service accepts advanced monitoring

relationsServicesRelationsV1 (object)

Holds dependencies of a Service : dependencies (other services that are required for a service to be fully functional) and impacts (other services that depends on current service)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 0,
  "name": "text",
  "status": "ACTIVE,PREPARATION",
  "environment": "text",
  "key": "text",
  "comment": "text",
  "cloud": "text",
  "cloudId": 0,
  "smsSubscribed": false,
  "advancedMonitoringAllowed": false,
  "relations": {
    "dependencies": [],
    "impacts": []
  }
}

Get Resources related to Storage (e.g : Glusterfs ...) of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/storage

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

sizingstring

virtualIpstring

versionstring

nodeCountstring

volumeCountstring

topologystring

cpuinteger (int64)

raminteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/storage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "sizing": "text",
    "virtualIp": "text",
    "version": "text",
    "nodeCount": "text",
    "volumeCount": "text",
    "topology": "text",
    "cpu": 0,
    "ram": 0
  }
]

Get service statistics such as number of Computable items linked to the service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/stats

Path parameters

id*integer (int64)

Service Id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

Other propertiesinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/stats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get a service Resources List. It is possible to filter by category : See the '/resource-types' endpoint for all available options

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/resources

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/resources', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    }
  }
]

Get Relations of a service : dependencies and impacts

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/relations

Path parameters

id*integer (int64)

Service Id, example: 44411

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

dependenciesarray of ServiceV1 (object)

Services that are required for current service to be fully functional

impactsarray of ServiceV1 (object)

Services that requires current service to be fully functional

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/relations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "dependencies": [
    {
      "id": 0,
      "name": "text",
      "status": "ACTIVE,PREPARATION",
      "environment": "text",
      "key": "text",
      "comment": "text",
      "cloud": "text",
      "cloudId": 0,
      "smsSubscribed": false,
      "advancedMonitoringAllowed": false
    }
  ],
  "impacts": [
    {
      "id": 0,
      "name": "text",
      "status": "ACTIVE,PREPARATION",
      "environment": "text",
      "key": "text",
      "comment": "text",
      "cloud": "text",
      "cloudId": 0,
      "smsSubscribed": false,
      "advancedMonitoringAllowed": false
    }
  ]
}

Get a service Relations Stats: counts of dependencies and impacts of service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/relations/stats

Path parameters

id*integer (int64)

Service Id, example: 44411

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

dependenciesinteger (int32)

Number of services that are required for current service to be fully functional

impactsinteger (int32)

Number of services that requires current service to be fully functional

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/relations/stats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "dependencies": 0,
  "impacts": 0
}

Get NetworkCluster list of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/network-clusters

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

versionstring

allowMonitoringDisplayboolean

sizingstring

ipAddressstring

cpuinteger (int64)

raminteger (int64)

nodeCountinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/network-clusters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "version": "text",
    "allowMonitoringDisplay": false,
    "sizing": "text",
    "ipAddress": "text",
    "cpu": 0,
    "ram": 0,
    "nodeCount": 0
  }
]

Get Managed DataBases of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/managed-databases

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

nodeCountinteger (int64)

versionstring

backupSystemstring

drpClassstring

sizingstring

topologystring

cpuinteger (int64)

raminteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/managed-databases', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "nodeCount": 0,
    "version": "text",
    "backupSystem": "text",
    "drpClass": "text",
    "sizing": "text",
    "topology": "text",
    "cpu": 0,
    "ram": 0
  }
]

Get LOADBALANCERS of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/loadbalancers

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

ipAddressstring

nodeCountinteger (int64)

networkNetworkV1 (object)

urlsarray of URL (object)

urls of the load balancer

membersarray of InstanceV1 (object)

Instances that are load balanced by this loadbalancer

protocolsarray of Protocol (object)

Protocols on which this loadbalancer expose a virtual service

irulesarray of Irule (object)

iRules configured for this loadbalancer

healthChecksarray of HealthCheckV1 (object)

Healthchecks configured for this loadbalancer

certificateCertificateV1 (object)

defaultPersistencestring

Advanced property such as default persistence

fallbackPersistencestring

Advanced property such as fallback persistence

loadBalancingModestring

Advanced property such as load balancing mode

botDefenseEnabledboolean

Bot Defense state

botDefenseUpdatingboolean

Bot Defense is updating

securityProfileSecurityProfileV1 (object)

snatAutomapboolean

Source addresse translation automap enabled

parentResourceServiceResourceBaseV1 (object)

Holds common properties to all Resources managed in ITCare available on a Service

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/loadbalancers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "ipAddress": "text",
    "nodeCount": 0,
    "network": {
      "id": 0,
      "technicalId": "text",
      "cidr": "text",
      "description": "text",
      "scope": "text",
      "defaultNetwork": false,
      "usedPercent": 0,
      "ipFreeNumber": 0,
      "ipAddress": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "mask": "text",
      "networkShortDescription": "text",
      "isIpRangePublic": false,
      "cloud": "text",
      "environment": "text",
      "shortDescription": "text",
      "gateway": "text",
      "region": "text",
      "area": "text"
    },
    "urls": [
      {
        "id": 0,
        "name": "text",
        "type": "text",
        "serviceId": 0,
        "serviceName": "text",
        "serviceKey": "text",
        "environment": "text",
        "creationUser": "text",
        "creationTime": "text",
        "description": "text",
        "comment": "text",
        "releasedAt": "2025-01-03T03:44:48.117Z",
        "endOfSalesAt": "2025-01-03T03:44:48.117Z",
        "extendedSupportAt": "2025-01-03T03:44:48.117Z",
        "endOfSupportAt": "2025-01-03T03:44:48.117Z",
        "supportPhase": "text",
        "tags": [
          {
            "tagKey": "text",
            "tagValue": "text"
          }
        ],
        "status": "text",
        "monitoringEnabled": false,
        "monitoringAlerting": false,
        "monitoringOnCallEnabled": false,
        "monitoringMode": "text",
        "specificChecks": [
          {
            "name": "text",
            "parameter": {
              "path": "text",
              "prefix": "text",
              "authentification": {
                "user": "text",
                "password": "text"
              },
              "protocol": "text",
              "port": 0,
              "method": "text",
              "criticalStatus": "text",
              "warningContent": "text",
              "criticalContent": "text",
              "expectedContent": "text",
              "parameters": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "headers": [
                {
                  "key": "text",
                  "value": "text"
                }
              ]
            }
          }
        ]
      }
    ],
    "members": [
      {
        "id": 0,
        "name": "text",
        "type": "text",
        "internalType": "text",
        "status": "text",
        "category": "text",
        "technology": "text",
        "family": "text",
        "label": "text",
        "comment": "text",
        "productCode": "text",
        "productName": "text",
        "productVersion": "text",
        "cloudId": 0,
        "cloudName": "text",
        "serviceId": 0,
        "serviceName": "text",
        "serviceKey": "text",
        "environment": "text",
        "endOfSupportAt": "2025-01-03T03:44:48.117Z",
        "supportPhase": "text",
        "creationUser": "text",
        "creationTime": "text",
        "releasedAt": "2025-01-03T03:44:48.117Z",
        "endOfSalesAt": "2025-01-03T03:44:48.117Z",
        "extendedSupportAt": "2025-01-03T03:44:48.117Z",
        "monitoringEnabled": false,
        "monitoringAlerting": false,
        "monitoringOnCallEnabled": false,
        "monitoringRequested": false,
        "replicationStatus": false,
        "backupStatus": false,
        "patchParty": {
          "excluded": false,
          "exclusionReason": "text",
          "patchGroup": "text",
          "patchDate": "2025-01-03T03:44:48.117Z",
          "patchTag": "text",
          "name": "text",
          "id": 0,
          "excludedBy": "text",
          "exclusionDate": "2025-01-03T03:44:48.117Z"
        },
        "metrologyUrl": "text",
        "path": "text",
        "resourceType": "text",
        "internalResourceId": 0,
        "backupPolicyDetails": {
          "backups": [
            {
              "id": 0,
              "type": "text",
              "backupSize": 0,
              "backupLastDate": "2025-01-03T03:44:48.117Z"
            }
          ],
          "policies": [
            {
              "name": "text",
              "label": "text",
              "scope": "text",
              "type": "text",
              "replication": false,
              "durationInHours": 0,
              "startTime": "text",
              "timezone": "text",
              "policyId": "text",
              "backupLastDate": "2025-01-03T03:44:48.117Z",
              "backupSize": 0
            }
          ]
        },
        "ipAddress": "text",
        "network": {
          "id": 0,
          "technicalId": "text",
          "cidr": "text",
          "description": "text",
          "scope": "text",
          "defaultNetwork": false,
          "usedPercent": 0,
          "ipFreeNumber": 0,
          "ipAddress": "text",
          "dns": [
            {
              "alias": "text",
              "domain": "text"
            }
          ],
          "mask": "text",
          "networkShortDescription": "text",
          "isIpRangePublic": false,
          "cloud": "text",
          "environment": "text",
          "shortDescription": "text",
          "gateway": "text",
          "region": "text",
          "area": "text"
        },
        "storageInformation": {
          "totalSizeDisks": 0,
          "fileSystems": [
            {
              "mountingPoint": "text",
              "type": "text",
              "sizeOf": 0,
              "free": 0
            }
          ],
          "totalSizeFileSystems": 0
        },
        "availabilityZone": {
          "id": "text",
          "location": "text",
          "routable": false,
          "defaultZone": false,
          "datacenterId": "text",
          "availabilityZoneGroup": "text"
        },
        "area": {
          "id": "text",
          "location": "text",
          "regulation": "text",
          "defaultArea": false,
          "availabilityZones": [
            {
              "id": "text",
              "location": "text",
              "routable": false,
              "defaultZone": false,
              "datacenterId": "text",
              "availabilityZoneGroup": "text"
            }
          ]
        },
        "region": {
          "id": "text",
          "location": "text",
          "areas": [
            {
              "id": "text",
              "location": "text",
              "regulation": "text",
              "defaultArea": false,
              "availabilityZones": [
                {
                  "id": "text",
                  "location": "text",
                  "routable": false,
                  "defaultZone": false,
                  "datacenterId": "text",
                  "availabilityZoneGroup": "text"
                }
              ]
            }
          ],
          "dataCenter": "text"
        },
        "backup": {
          "backupSystem": "text",
          "size": 0,
          "type": "text",
          "filesNb": 0,
          "lastDate": "2025-01-03T03:44:48.117Z"
        },
        "replication": {
          "storageClass": "text",
          "storageReplicationClass": "text",
          "storageClassOverride": "text",
          "storageMoveInProgress": false,
          "storageMoveTicket": "text",
          "noStoRplExplanation": "text"
        },
        "snapshot": {
          "id": "text",
          "label": "text",
          "createdBy": "text",
          "createdAt": "2025-01-03T03:44:48.117Z",
          "recoveredAt": "2025-01-03T03:44:48.117Z",
          "expiresAt": "2025-01-03T03:44:48.117Z",
          "description": "text",
          "changeReference": "text",
          "snapshotSize": 0
        },
        "labelRegion": "text",
        "labelDataCenter": "text",
        "labelArea": "text",
        "labelAvailabilityZone": "text",
        "totalSizeDisks": "text",
        "cpu": 0,
        "ram": 0,
        "storage": 0,
        "isMemberOFLoadBalancer": false,
        "loadbalancers": [
          {
            "id": 0,
            "name": "text",
            "status": "text",
            "monitoringEnabled": false,
            "memberCount": 0,
            "serviceId": 0
          }
        ],
        "imageCode": "text",
        "osName": "text",
        "osType": "text",
        "isExternalIngressNode": false,
        "isInternalIngressNode": false,
        "storageMoveInProgress": false,
        "authenticationDomain": "text",
        "parentResourceType": "text"
      }
    ],
    "protocols": [
      {
        "protocol": "text",
        "port": 0,
        "name": "text",
        "comment": "text",
        "isCertificateRequired": false,
        "persistence": false,
        "redirectToHttps": false,
        "profilePersistenceOnly": "text",
        "profileNoPersistenceOnly": "text",
        "profilePersistenceRedirect": "text",
        "profileNoPersistenceNoRedirect": "text",
        "profilePersistenceNoRedirect": "text",
        "profileNoPersistenceRedirect": "text",
        "order": 0
      }
    ],
    "irules": [
      {
        "name": "text",
        "description": "text"
      }
    ],
    "healthChecks": [
      {
        "id": 0,
        "name": "text",
        "description": "text",
        "comment": "text"
      }
    ],
    "certificate": {
      "id": 0,
      "certificateName": "text",
      "commonName": "text",
      "description": "text",
      "expirationDate": "text"
    },
    "defaultPersistence": "text",
    "fallbackPersistence": "text",
    "loadBalancingMode": "text",
    "botDefenseEnabled": false,
    "botDefenseUpdating": false,
    "securityProfile": {
      "id": "text",
      "name": "text",
      "description": "text",
      "profile": "text",
      "enforcement": "text",
      "comment": "text",
      "whiteList": [
        {
          "ip": "text",
          "url": "text",
          "comment": "text"
        }
      ],
      "template": "text"
    },
    "snatAutomap": false,
    "parentResource": {
      "id": 0,
      "name": "text",
      "type": "text",
      "internalType": "text",
      "status": "text",
      "category": "text",
      "technology": "text",
      "family": "text",
      "label": "text",
      "comment": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "cloudId": 0,
      "cloudName": "text",
      "serviceId": 0,
      "serviceName": "text",
      "serviceKey": "text",
      "environment": "text",
      "endOfSupportAt": "2025-01-03T03:44:48.117Z",
      "supportPhase": "text",
      "creationUser": "text",
      "creationTime": "text",
      "releasedAt": "2025-01-03T03:44:48.117Z",
      "endOfSalesAt": "2025-01-03T03:44:48.117Z",
      "extendedSupportAt": "2025-01-03T03:44:48.117Z",
      "monitoringEnabled": false,
      "monitoringAlerting": false,
      "monitoringOnCallEnabled": false,
      "monitoringRequested": false,
      "replicationStatus": false,
      "backupStatus": false,
      "patchParty": {
        "excluded": false,
        "exclusionReason": "text",
        "patchGroup": "text",
        "patchDate": "2025-01-03T03:44:48.117Z",
        "patchTag": "text",
        "name": "text",
        "id": 0,
        "excludedBy": "text",
        "exclusionDate": "2025-01-03T03:44:48.117Z"
      },
      "metrologyUrl": "text",
      "path": "text",
      "resourceType": "text",
      "internalResourceId": 0,
      "backupPolicyDetails": {
        "backups": [
          {
            "id": 0,
            "type": "text",
            "backupSize": 0,
            "backupLastDate": "2025-01-03T03:44:48.117Z"
          }
        ],
        "policies": [
          {
            "name": "text",
            "label": "text",
            "scope": "text",
            "type": "text",
            "replication": false,
            "durationInHours": 0,
            "startTime": "text",
            "timezone": "text",
            "policyId": "text",
            "backupLastDate": "2025-01-03T03:44:48.117Z",
            "backupSize": 0
          }
        ]
      }
    }
  }
]

Get K8sContainers of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/kubernetes

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

Storage Replication Enabled - The farm has replicated storage

backupStatusboolean

Indicates backup is active on the host

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

nodeCountinteger (int64)

Number of Nodes of the K8s Cluster

topologystring

High availability mode status

versionstring

Version of the K8S Cluster

versionDetailedstring

Version of the K8S Cluster

managementUrlstring

Management host of the K8S Cluster

technicalIdstring

Technical ID of the K8S Cluster

labelAreaListarray of string

A list of Area name

labelRegionstring

Region pretty name

availableAZsarray of string

availableDCsarray of string

supportsHAModeboolean

allowMonitoringDisplayboolean

ingressProviderenum

Kubernetes Container Ingress Providers

NGINXISTIOTRAEFIKNGINX,ISTIO,TRAEFIK

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/kubernetes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "nodeCount": 0,
    "topology": "text",
    "version": "text",
    "versionDetailed": "text",
    "managementUrl": "text",
    "technicalId": "text",
    "labelAreaList": [
      "text"
    ],
    "labelRegion": "text",
    "availableAZs": [
      "text"
    ],
    "availableDCs": [
      "text"
    ],
    "supportsHAMode": false,
    "allowMonitoringDisplay": false,
    "ingressProvider": "NGINX"
  }
]

Get INSTANCES of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/instances

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

ipAddressstring

networkNetworkV1 (object)

storageInformationStorageInformationV1 (object)

Information about a Storage of an Instance

availabilityZoneAvailabilityZoneV1 (object)

areaAreaV1 (object)

regionRegionV1 (object)

backupBackupV1 (object)

Backup information on an instance

replicationReplicationV1 (object)

Replication information on an instance

snapshotSnapshotV1 (object)

Snapshot of an instance

labelRegionstring

Region pretty name

labelDataCenterstring

DataCenter pretty name

labelAreastring

Area pretty name

labelAvailabilityZonestring

Availability Zone pretty name

totalSizeDisksstring

Total Disk size of the resource

cpuinteger (int64)

CPU of the resource

raminteger (int64)

RAM of the resource

storagenumber

Storage after disks format in GB of the resource

isMemberOFLoadBalancerboolean

Instance is member of load balancer

loadbalancersarray of LoadbalancerInfoV1 (object)

imageCodestring

Internal Image linked to this instance

osNamestring

OS name of this instance

osTypestring

OS type of this instance

isExternalIngressNodeboolean

This instance is ingress external node

isInternalIngressNodeboolean

This instance is ingress internal node

storageMoveInProgressboolean

Information about storage replication in Progress

authenticationDomainstring

parentResourceTypestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/instances', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "ipAddress": "text",
    "network": {
      "id": 0,
      "technicalId": "text",
      "cidr": "text",
      "description": "text",
      "scope": "text",
      "defaultNetwork": false,
      "usedPercent": 0,
      "ipFreeNumber": 0,
      "ipAddress": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "mask": "text",
      "networkShortDescription": "text",
      "isIpRangePublic": false,
      "cloud": "text",
      "environment": "text",
      "shortDescription": "text",
      "gateway": "text",
      "region": "text",
      "area": "text"
    },
    "storageInformation": {
      "totalSizeDisks": 0,
      "fileSystems": [
        {
          "mountingPoint": "text",
          "type": "text",
          "sizeOf": 0,
          "free": 0
        }
      ],
      "totalSizeFileSystems": 0
    },
    "availabilityZone": {
      "id": "text",
      "location": "text",
      "routable": false,
      "defaultZone": false,
      "datacenterId": "text",
      "availabilityZoneGroup": "text"
    },
    "area": {
      "id": "text",
      "location": "text",
      "regulation": "text",
      "defaultArea": false,
      "availabilityZones": [
        {
          "id": "text",
          "location": "text",
          "routable": false,
          "defaultZone": false,
          "datacenterId": "text",
          "availabilityZoneGroup": "text"
        }
      ]
    },
    "region": {
      "id": "text",
      "location": "text",
      "areas": [
        {
          "id": "text",
          "location": "text",
          "regulation": "text",
          "defaultArea": false,
          "availabilityZones": [
            {
              "id": "text",
              "location": "text",
              "routable": false,
              "defaultZone": false,
              "datacenterId": "text",
              "availabilityZoneGroup": "text"
            }
          ]
        }
      ],
      "dataCenter": "text"
    },
    "backup": {
      "backupSystem": "text",
      "size": 0,
      "type": "text",
      "filesNb": 0,
      "lastDate": "2025-01-03T03:44:48.117Z"
    },
    "replication": {
      "storageClass": "text",
      "storageReplicationClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": false,
      "storageMoveTicket": "text",
      "noStoRplExplanation": "text"
    },
    "snapshot": {
      "id": "text",
      "label": "text",
      "createdBy": "text",
      "createdAt": "2025-01-03T03:44:48.117Z",
      "recoveredAt": "2025-01-03T03:44:48.117Z",
      "expiresAt": "2025-01-03T03:44:48.117Z",
      "description": "text",
      "changeReference": "text",
      "snapshotSize": 0
    },
    "labelRegion": "text",
    "labelDataCenter": "text",
    "labelArea": "text",
    "labelAvailabilityZone": "text",
    "totalSizeDisks": "text",
    "cpu": 0,
    "ram": 0,
    "storage": 0,
    "isMemberOFLoadBalancer": false,
    "loadbalancers": [
      {
        "id": 0,
        "name": "text",
        "status": "text",
        "monitoringEnabled": false,
        "memberCount": 0,
        "serviceId": 0
      }
    ],
    "imageCode": "text",
    "osName": "text",
    "osType": "text",
    "isExternalIngressNode": false,
    "isInternalIngressNode": false,
    "storageMoveInProgress": false,
    "authenticationDomain": "text",
    "parentResourceType": "text"
  }
]

Get Hardware list of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/hardwares

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

dcstring

regionstring

modelstring

serialstring

ipstring

stickerstring

locationstring

rackstring

maintenanceTypestring

endOfCoverDatestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/hardwares', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "dc": "text",
    "region": "text",
    "model": "text",
    "serial": "text",
    "ip": "text",
    "sticker": "text",
    "location": "text",
    "rack": "text",
    "maintenanceType": "text",
    "endOfCoverDate": "text"
  }
]

Get MessageBrokers of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/brokers

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

versionstring

sizingstring

nodeCountinteger (int64)

topologystring

cpuinteger (int64)

raminteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/brokers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "version": "text",
    "sizing": "text",
    "nodeCount": 0,
    "topology": "text",
    "cpu": 0,
    "ram": 0
  }
]

Get Application servers of a service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/application-servers

Path parameters

id*integer (int64)

Service Id, example: 44411

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

ipAddressstring

networkNetworkV1 (object)

storageInformationStorageInformationV1 (object)

Information about a Storage of an Instance

availabilityZoneAvailabilityZoneV1 (object)

areaAreaV1 (object)

regionRegionV1 (object)

backupBackupV1 (object)

Backup information on an instance

replicationReplicationV1 (object)

Replication information on an instance

snapshotSnapshotV1 (object)

Snapshot of an instance

labelRegionstring

Region pretty name

labelDataCenterstring

DataCenter pretty name

labelAreastring

Area pretty name

labelAvailabilityZonestring

Availability Zone pretty name

totalSizeDisksstring

Total Disk size of the resource

cpuinteger (int64)

CPU of the resource

raminteger (int64)

RAM of the resource

storagenumber

Storage after disks format in GB of the resource

isMemberOFLoadBalancerboolean

Instance is member of load balancer

loadbalancersarray of LoadbalancerInfoV1 (object)

imageCodestring

Internal Image linked to this instance

osNamestring

OS name of this instance

osTypestring

OS type of this instance

isExternalIngressNodeboolean

This instance is ingress external node

isInternalIngressNodeboolean

This instance is ingress internal node

storageMoveInProgressboolean

Information about storage replication in Progress

authenticationDomainstring

parentResourceTypestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/application-servers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-03T03:44:48.117Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-03T03:44:48.117Z",
    "endOfSalesAt": "2025-01-03T03:44:48.117Z",
    "extendedSupportAt": "2025-01-03T03:44:48.117Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-03T03:44:48.117Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-03T03:44:48.117Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-03T03:44:48.117Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-03T03:44:48.117Z",
          "backupSize": 0
        }
      ]
    },
    "ipAddress": "text",
    "network": {
      "id": 0,
      "technicalId": "text",
      "cidr": "text",
      "description": "text",
      "scope": "text",
      "defaultNetwork": false,
      "usedPercent": 0,
      "ipFreeNumber": 0,
      "ipAddress": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "mask": "text",
      "networkShortDescription": "text",
      "isIpRangePublic": false,
      "cloud": "text",
      "environment": "text",
      "shortDescription": "text",
      "gateway": "text",
      "region": "text",
      "area": "text"
    },
    "storageInformation": {
      "totalSizeDisks": 0,
      "fileSystems": [
        {
          "mountingPoint": "text",
          "type": "text",
          "sizeOf": 0,
          "free": 0
        }
      ],
      "totalSizeFileSystems": 0
    },
    "availabilityZone": {
      "id": "text",
      "location": "text",
      "routable": false,
      "defaultZone": false,
      "datacenterId": "text",
      "availabilityZoneGroup": "text"
    },
    "area": {
      "id": "text",
      "location": "text",
      "regulation": "text",
      "defaultArea": false,
      "availabilityZones": [
        {
          "id": "text",
          "location": "text",
          "routable": false,
          "defaultZone": false,
          "datacenterId": "text",
          "availabilityZoneGroup": "text"
        }
      ]
    },
    "region": {
      "id": "text",
      "location": "text",
      "areas": [
        {
          "id": "text",
          "location": "text",
          "regulation": "text",
          "defaultArea": false,
          "availabilityZones": [
            {
              "id": "text",
              "location": "text",
              "routable": false,
              "defaultZone": false,
              "datacenterId": "text",
              "availabilityZoneGroup": "text"
            }
          ]
        }
      ],
      "dataCenter": "text"
    },
    "backup": {
      "backupSystem": "text",
      "size": 0,
      "type": "text",
      "filesNb": 0,
      "lastDate": "2025-01-03T03:44:48.117Z"
    },
    "replication": {
      "storageClass": "text",
      "storageReplicationClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": false,
      "storageMoveTicket": "text",
      "noStoRplExplanation": "text"
    },
    "snapshot": {
      "id": "text",
      "label": "text",
      "createdBy": "text",
      "createdAt": "2025-01-03T03:44:48.117Z",
      "recoveredAt": "2025-01-03T03:44:48.117Z",
      "expiresAt": "2025-01-03T03:44:48.117Z",
      "description": "text",
      "changeReference": "text",
      "snapshotSize": 0
    },
    "labelRegion": "text",
    "labelDataCenter": "text",
    "labelArea": "text",
    "labelAvailabilityZone": "text",
    "totalSizeDisks": "text",
    "cpu": 0,
    "ram": 0,
    "storage": 0,
    "isMemberOFLoadBalancer": false,
    "loadbalancers": [
      {
        "id": 0,
        "name": "text",
        "status": "text",
        "monitoringEnabled": false,
        "memberCount": 0,
        "serviceId": 0
      }
    ],
    "imageCode": "text",
    "osName": "text",
    "osType": "text",
    "isExternalIngressNode": false,
    "isInternalIngressNode": false,
    "storageMoveInProgress": false,
    "authenticationDomain": "text",
    "parentResourceType": "text"
  }
]

List actions in progress for a list of resources of a service by category. No category means all resources of the service

GEThttps://api.cegedim.cloud/itcare/compute/services/{id}/actions-in-progress

Path parameters

id*integer (int64)

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/services/{id}/actions-in-progress', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "process": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR",
    "message": "text",
    "id": 0,
    "internalId": 0,
    "resourceName": "text",
    "resourceType": "text",
    "family": "text",
    "lastUpdatedAt": "2025-01-03T03:44:48.117Z"
  }
]