LogoLogo
cegedim.cloudITCareAPIPrivacy
Français
Français
  • Documentation
  • ITCare
    • ITCare, c'est quoi ?
      • Débuter avec ITCare
      • Démos
    • Enercare
      • Empreinte carbone
    • Notes de mise à jour
  • ITCare API
    • Aperçu
    • Authentication
    • Erreurs
    • Pagination
    • Reference API
      • Démarrage rapide
      • Analytics
        • Matomo
      • Changes
        • Changes
      • Compute
        • Application Servers
        • Backup Policies
        • Containers
        • Environments
        • Instances
        • Platform
        • Resource Filters
        • Resource Types
        • Resources
        • Services
        • Statuses
        • Tag Keys
        • Tag Values
        • Types
      • Databases
        • Databases
        • MariaDB
        • OpenSearch
        • PostgreSQL
        • Redis
        • SQL Server
      • Hardwares
        • Hardwares
      • Messaging
        • Apache Kafka
        • Message Brokers
        • RabbitMQ
      • Networking
        • Domains
        • Load Balancers
        • Network Clusters
        • Networks
      • Operations
        • Actions
        • Operations
      • Storage
        • Glusterfs
        • Overdrive
      • Topology
        • Topology
  • Services
    • Produits
    • Politique de support
    • Politique de patch
    • RACI
  • Analytique
    • Matomo
      • Matomo - Architecture
      • Matomo - Didacticiels
  • Calcul
    • Instances virtuelles
      • Instances virtuelles - Architectures
        • Linux - Renforcement
      • Instances virtuelles - Didacticiels
    • Conteneurs (K8s)
      • K8s - Architecture
        • Hardening
        • Stockage Persistant
      • K8s - Didacticiels
        • Haute Disponibilité
  • Bases de données
    • MariaDB
      • MariaDB - Architecture
      • MariaDB - Didacticiels
    • OpenSearch
      • OpenSearch - Architecture
        • v2 - Changements
      • OpenSearch - Didacticiels
    • PostgreSQL
      • PostgreSQL - Architecture
      • PostgreSQL - Didacticiels
      • PostgreSQL - Mise à jour
    • Redis
      • Redis - Architecture
      • Redis - Didacticiels
      • Redis - Mise à jour
    • SQL Server
      • SQL Server - Architecture
      • SQL Server - Didacticiels
  • Message
    • Apache Kafka
      • Apache Kafka - Architecture
      • Apache Kafka - Didacticiels
      • Apache Kafka - Mise à jour
    • RabbitMQ
      • RabbitMQ - Architecture
      • RabbitMQ - Didacticiels
    • SMS
      • SMS - Didacticiels
  • Securité
    • Advanced Vulnerability Assessment
    • Bot Defense
      • Bot Defense - Architecture
    • Campagne de Phishing
    • Data Masking
      • Data Masking - Didacticiels
  • Surveillance
    • ExtraHop
  • Stockage
    • GlusterFS
      • GlusterFS - Architecture
      • GlusterFS - Didacticiels
    • OverDrive
      • OverDrive - Architecture
    • Stockage Objet
      • Stockage Objet - Architecture
        • Compatibilité API S3
        • Limitation et bonnes pratiques
        • URL pré-signée
        • Politiques de Buckets
        • Configuration de cycle de vie
        • Object Lock
      • Stockage Objet - Didacticiels
        • Gérer des Objects Users
        • Gérer des versions dans un Bucket
        • Gérer l'accès à un Bucket
Powered by GitBook
On this page
Export as PDF
  1. ITCare API
  2. Reference API
  3. Compute

Services

PreviousResourcesNextStatuses

Last updated 4 months ago

List Compute Resources

get
Authorizations
Query parameters
namesstring[]Optional

Names, example: resource01,!resource02,resource42

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

sortanyOptional

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

directionstringOptional
cloudsintegerOptional
pagestringOptional

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

sizestringOptional

Number of records per page.

Responses
200
OK
*/*
400
Bad Request
*/*
get
GET /itcare/compute/services HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "content": [
    {
      "advancedMonitoringAllowed": true,
      "cloud": "text",
      "cloudId": 1,
      "comment": "text",
      "environment": "text",
      "id": 1,
      "key": "text",
      "name": "text",
      "relations": {
        "dependencies": [
          {
            "advancedMonitoringAllowed": true,
            "cloud": "text",
            "cloudId": 1,
            "comment": "text",
            "environment": "text",
            "id": 1,
            "key": "text",
            "name": "text",
            "relations": "[Circular Reference]",
            "smsSubscribed": true,
            "status": "ACTIVE,PREPARATION"
          }
        ],
        "impacts": [
          {
            "advancedMonitoringAllowed": true,
            "cloud": "text",
            "cloudId": 1,
            "comment": "text",
            "environment": "text",
            "id": 1,
            "key": "text",
            "name": "text",
            "relations": "[Circular Reference]",
            "smsSubscribed": true,
            "status": "ACTIVE,PREPARATION"
          }
        ]
      },
      "smsSubscribed": true,
      "status": "ACTIVE,PREPARATION"
    }
  ],
  "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
}

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

get
Authorizations
Path parameters
serviceIdinteger · int64Required

Service Id, example: 500063721

Query parameters
actionsstring[]Optional

Actions, example: enable_monitoring

statusesstring[]Optional

Statuses, example: SUCCESS

namesstring[]Optional

Names, example: REBITTEST01

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{serviceId}/history HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "completedAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "lastUpdatedAt": "2025-05-08T23:05:48.413Z",
    "message": "text",
    "process": "text",
    "resourceName": "text",
    "resourceType": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR",
    "submittedAt": "2025-05-08T23:05:48.413Z",
    "submittedBy": "text"
  }
]

Get detailed information of a service by its Id

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 123

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "advancedMonitoringAllowed": true,
  "cloud": "text",
  "cloudId": 1,
  "comment": "text",
  "environment": "text",
  "id": 1,
  "key": "text",
  "name": "text",
  "relations": {
    "dependencies": [
      {
        "advancedMonitoringAllowed": true,
        "cloud": "text",
        "cloudId": 1,
        "comment": "text",
        "environment": "text",
        "id": 1,
        "key": "text",
        "name": "text",
        "relations": {
          "dependencies": [
            "[Circular Reference]"
          ],
          "impacts": [
            "[Circular Reference]"
          ]
        },
        "smsSubscribed": true,
        "status": "ACTIVE,PREPARATION"
      }
    ],
    "impacts": [
      {
        "advancedMonitoringAllowed": true,
        "cloud": "text",
        "cloudId": 1,
        "comment": "text",
        "environment": "text",
        "id": 1,
        "key": "text",
        "name": "text",
        "relations": {
          "dependencies": [
            "[Circular Reference]"
          ],
          "impacts": [
            "[Circular Reference]"
          ]
        },
        "smsSubscribed": true,
        "status": "ACTIVE,PREPARATION"
      }
    ]
  },
  "smsSubscribed": true,
  "status": "ACTIVE,PREPARATION"
}

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

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: devvcaglfs02

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

sizesstringOptional

Sizing of the resource, example: 2cpu4gb

nodeCountinteger · int32Optional

Number of nodes, example: 2

vipstringOptional

IP Address, ex: 10.10.10.10

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/storage HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "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-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "label": "text",
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "nodeCount": "text",
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "ram": 1,
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "sizing": "text",
    "status": "text",
    "supportPhase": "text",
    "technology": "text",
    "topology": "text",
    "type": "text",
    "version": "text",
    "virtualIp": "text",
    "volumeCount": "text"
  }
]

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

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 123

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/stats HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": 1
}

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

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

categoriesstring[]Optional

Categories, example: INSTANCES,APPLICATION_SERVERS,LOAD_BALANCERS

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/resources HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "category": "text",
    "cloudId": 1,
    "cloudName": "text",
    "comment": "text",
    "creationTime": "text",
    "creationUser": "text",
    "endOfSalesAt": "2025-05-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "label": "text",
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "status": "text",
    "supportPhase": "text",
    "technology": "text",
    "type": "text"
  }
]

Get Relations of a service : dependencies and impacts

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/relations HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "dependencies": [
    {
      "advancedMonitoringAllowed": true,
      "cloud": "text",
      "cloudId": 1,
      "comment": "text",
      "environment": "text",
      "id": 1,
      "key": "text",
      "name": "text",
      "relations": {
        "dependencies": [
          {
            "advancedMonitoringAllowed": true,
            "cloud": "text",
            "cloudId": 1,
            "comment": "text",
            "environment": "text",
            "id": 1,
            "key": "text",
            "name": "text",
            "relations": "[Circular Reference]",
            "smsSubscribed": true,
            "status": "ACTIVE,PREPARATION"
          }
        ],
        "impacts": [
          {
            "advancedMonitoringAllowed": true,
            "cloud": "text",
            "cloudId": 1,
            "comment": "text",
            "environment": "text",
            "id": 1,
            "key": "text",
            "name": "text",
            "relations": "[Circular Reference]",
            "smsSubscribed": true,
            "status": "ACTIVE,PREPARATION"
          }
        ]
      },
      "smsSubscribed": true,
      "status": "ACTIVE,PREPARATION"
    }
  ],
  "impacts": [
    {
      "advancedMonitoringAllowed": true,
      "cloud": "text",
      "cloudId": 1,
      "comment": "text",
      "environment": "text",
      "id": 1,
      "key": "text",
      "name": "text",
      "relations": "[Circular Reference]",
      "smsSubscribed": true,
      "status": "ACTIVE,PREPARATION"
    }
  ]
}

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

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/relations/stats HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "dependencies": 1,
  "impacts": 1
}

Get NetworkCluster list of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: PET1

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/network-clusters HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "allowMonitoringDisplay": true,
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "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-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "ipAddress": "text",
    "label": "text",
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "nodeCount": 1,
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "ram": 1,
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "sizing": "text",
    "status": "text",
    "supportPhase": "text",
    "technology": "text",
    "type": "text",
    "version": "text"
  }
]

Get Managed DataBases of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: www.cegedim.com,www.egypt.eg

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/managed-databases HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "backupSystem": "text",
    "category": "text",
    "cloudId": 1,
    "cloudName": "text",
    "comment": "text",
    "cpu": 1,
    "creationTime": "text",
    "creationUser": "text",
    "drpClass": "text",
    "endOfSalesAt": "2025-05-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "label": "text",
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "nodeCount": 1,
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "ram": 1,
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "sizing": "text",
    "status": "text",
    "supportPhase": "text",
    "technology": "text",
    "topology": "text",
    "type": "text",
    "version": "text"
  }
]

Get LOADBALANCERS of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: www.cegedim.com,www.egypt.eg

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

nodesinteger · int32Optional

Number of Members, example: 2

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/loadbalancers HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "botDefenseEnabled": true,
    "botDefenseUpdating": true,
    "category": "text",
    "certificate": {
      "certificateName": "text",
      "commonName": "text",
      "description": "text",
      "expirationDate": "text",
      "id": 1
    },
    "cloudId": 1,
    "cloudName": "text",
    "comment": "text",
    "creationTime": "text",
    "creationUser": "text",
    "defaultPersistence": "text",
    "endOfSalesAt": "2025-05-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "fallbackPersistence": "text",
    "family": "text",
    "healthChecks": [
      {
        "comment": "text",
        "description": "text",
        "id": 1,
        "name": "text"
      }
    ],
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "ipAddress": "text",
    "irules": [
      {
        "description": "text",
        "name": "text"
      }
    ],
    "label": "text",
    "loadBalancingMode": "text",
    "members": [
      {
        "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-08T23:05:48.413Z",
          "size": 1,
          "type": "text"
        },
        "backupPolicyDetails": {
          "backups": [
            {
              "backupLastDate": "2025-05-08T23:05:48.413Z",
              "backupSize": 1,
              "id": 1,
              "type": "text"
            }
          ],
          "policies": [
            {
              "backupLastDate": "2025-05-08T23:05:48.413Z",
              "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-08T23:05:48.413Z",
        "endOfSupportAt": "2025-05-08T23:05:48.413Z",
        "environment": "text",
        "extendedSupportAt": "2025-05-08T23:05:48.413Z",
        "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-08T23:05:48.413Z",
          "exclusionReason": "text",
          "id": 1,
          "name": "text",
          "patchDate": "2025-05-08T23:05:48.413Z",
          "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-08T23:05:48.413Z",
        "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-08T23:05:48.413Z",
          "createdBy": "text",
          "description": "text",
          "expiresAt": "2025-05-08T23:05:48.413Z",
          "id": "text",
          "label": "text",
          "recoveredAt": "2025-05-08T23:05:48.413Z",
          "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"
      }
    ],
    "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,
    "parentResource": {
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-05-08T23:05:48.413Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-05-08T23:05:48.413Z",
            "backupSize": 1,
            "durationInHours": 1,
            "frequencies": {},
            "label": "text",
            "name": "text",
            "policyId": "text",
            "replication": true,
            "scope": "text",
            "startTime": "text",
            "timezone": "text",
            "type": "text"
          }
        ]
      },
      "backupStatus": true,
      "category": "text",
      "cloudId": 1,
      "cloudName": "text",
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "endOfSalesAt": "2025-05-08T23:05:48.413Z",
      "endOfSupportAt": "2025-05-08T23:05:48.413Z",
      "environment": "text",
      "extendedSupportAt": "2025-05-08T23:05:48.413Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "label": "text",
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-05-08T23:05:48.413Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-05-08T23:05:48.413Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "releasedAt": "2025-05-08T23:05:48.413Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "status": "text",
      "supportPhase": "text",
      "technology": "text",
      "type": "text"
    },
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "protocols": [
      {
        "comment": "text",
        "isCertificateRequired": true,
        "name": "text",
        "order": 1,
        "persistence": true,
        "port": 1,
        "profileNoPersistenceNoRedirect": "text",
        "profileNoPersistenceOnly": "text",
        "profileNoPersistenceRedirect": "text",
        "profilePersistenceNoRedirect": "text",
        "profilePersistenceOnly": "text",
        "profilePersistenceRedirect": "text",
        "protocol": "text",
        "redirectToHttps": true
      }
    ],
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "securityProfile": {
      "comment": "text",
      "description": "text",
      "enforcement": "text",
      "id": "text",
      "name": "text",
      "profile": "text",
      "template": "text",
      "whiteList": [
        {
          "comment": "text",
          "ip": "text",
          "url": "text"
        }
      ]
    },
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "snatAutomap": true,
    "status": "text",
    "supportPhase": "text",
    "technology": "text",
    "type": "text",
    "urls": [
      {
        "comment": "text",
        "creationTime": "text",
        "creationUser": "text",
        "description": "text",
        "endOfSalesAt": "2025-05-08T23:05:48.413Z",
        "endOfSupportAt": "2025-05-08T23:05:48.413Z",
        "environment": "text",
        "extendedSupportAt": "2025-05-08T23:05:48.413Z",
        "id": 1,
        "monitoringAlerting": true,
        "monitoringEnabled": true,
        "monitoringMode": "text",
        "monitoringOnCallEnabled": true,
        "name": "text",
        "releasedAt": "2025-05-08T23:05:48.413Z",
        "serviceId": 1,
        "serviceKey": "text",
        "serviceName": "text",
        "specificChecks": [
          {
            "name": "text",
            "parameter": {
              "authentification": {
                "password": "text",
                "user": "text"
              },
              "criticalContent": "text",
              "criticalStatus": "text",
              "expectedContent": "text",
              "headers": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "method": "text",
              "parameters": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "path": "text",
              "port": 1,
              "prefix": "text",
              "protocol": "text",
              "warningContent": "text"
            }
          }
        ],
        "status": "text",
        "supportPhase": "text",
        "tags": [
          {
            "tagKey": "text",
            "tagValue": "text"
          }
        ],
        "type": "text"
      }
    ]
  }
]

Get K8sContainers of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

versionsstring[]Optional

Versions, example: EB,ET,NK

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/kubernetes HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "allowMonitoringDisplay": true,
    "availableAZs": [
      "text"
    ],
    "availableDCs": [
      "text"
    ],
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "category": "text",
    "cloudId": 1,
    "cloudName": "text",
    "comment": "text",
    "creationTime": "text",
    "creationUser": "text",
    "endOfSalesAt": "2025-05-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "ingressProvider": "NGINX",
    "internalResourceId": 1,
    "internalType": "text",
    "label": "text",
    "labelAreaList": [
      "text"
    ],
    "labelRegion": "text",
    "managementUrl": "text",
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "nodeCount": 1,
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "status": "text",
    "supportPhase": "text",
    "supportsHAMode": true,
    "technicalId": "text",
    "technology": "text",
    "topology": "text",
    "type": "text",
    "version": "text",
    "versionDetailed": "text"
  }
]

Get INSTANCES of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

familiesstring[]Optional

Families, example: DEBIAN,RHEL

backupbooleanOptional

Backup

drpbooleanOptional

Drp

withManagedNodesbooleanOptional

withManagedNodes

withApplicationServersbooleanOptional

withApplicationServers

withOracleDbsbooleanOptional

withOracleDbs

withMongoNodeJsbooleanOptional

withMongoNodeJs

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/instances 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-08T23:05:48.413Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "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-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "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-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "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-08T23:05:48.413Z",
    "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-08T23:05:48.413Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2025-05-08T23:05:48.413Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2025-05-08T23:05:48.413Z",
      "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 Hardware list of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: PET1

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/hardwares HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "category": "text",
    "cloudId": 1,
    "cloudName": "text",
    "comment": "text",
    "creationTime": "text",
    "creationUser": "text",
    "dc": "text",
    "endOfCoverDate": "text",
    "endOfSalesAt": "2025-05-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "ip": "text",
    "label": "text",
    "location": "text",
    "maintenanceType": "text",
    "metrologyUrl": "text",
    "model": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "rack": "text",
    "region": "text",
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serial": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "status": "text",
    "sticker": "text",
    "supportPhase": "text",
    "technology": "text",
    "type": "text"
  }
]

Get MessageBrokers of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Broker name, example: deblaprmq01

statusesstring[]Optional

Broker status, example: ACTIVE

versionsstring[]Optional

Broker version, example: 3.9

sizesstring[]Optional

Broker size, example: 4cpu8gb

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/brokers HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "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-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "family": "text",
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "label": "text",
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "nodeCount": 1,
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "ram": 1,
    "releasedAt": "2025-05-08T23:05:48.413Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "sizing": "text",
    "status": "text",
    "supportPhase": "text",
    "technology": "text",
    "topology": "text",
    "type": "text",
    "version": "text"
  }
]

Get Application servers of a service

get
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

backupbooleanOptional

Backup

drpbooleanOptional

Drp

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/application-servers 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-08T23:05:48.413Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T23:05:48.413Z",
          "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-08T23:05:48.413Z",
    "endOfSupportAt": "2025-05-08T23:05:48.413Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T23:05:48.413Z",
    "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-08T23:05:48.413Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T23:05:48.413Z",
      "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-08T23:05:48.413Z",
    "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-08T23:05:48.413Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2025-05-08T23:05:48.413Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2025-05-08T23:05:48.413Z",
      "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"
  }
]

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

get
Authorizations
Path parameters
idinteger · int64Required
Query parameters
categorystringOptional

Category, example: INSTANCES

Default: ""
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/actions-in-progress HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "family": "text",
    "id": 1,
    "internalId": 1,
    "lastUpdatedAt": "2025-05-08T23:05:48.413Z",
    "message": "text",
    "process": "text",
    "resourceName": "text",
    "resourceType": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR"
  }
]
  • GETGet a list of the resources excluded from Patch Party
  • PATCHUpdate patch party configuration for resources for a service
  • GETList Compute Resources
  • GETList the action history of a service. Retrieves all operations / events that occurs on a resource : start, stop, monitoring operations ...
  • GETGet detailed information of a service by its Id
  • GETGet Resources related to Storage (e.g : Glusterfs ...) of a service
  • GETGet service statistics such as number of Computable items linked to the service
  • GETGet a service Resources List. It is possible to filter by category : See the '/resource-types' endpoint for all available options
  • GETGet Relations of a service : dependencies and impacts
  • GETGet a service Relations Stats: counts of dependencies and impacts of service
  • GETGet NetworkCluster list of a service
  • GETGet Managed DataBases of a service
  • GETGet LOADBALANCERS of a service
  • GETGet K8sContainers of a service
  • GETGet INSTANCES of a service
  • GETGet Hardware list of a service
  • GETGet MessageBrokers of a service
  • GETGet Application servers of a service
  • GETList actions in progress for a list of resources of a service by category. No category means all resources of the service

Get a list of the resources excluded from Patch Party

get

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.

Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
withHistorybooleanOptional

boolean flag to fetch history details for every ci

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/compute/services/{id}/patch-policies HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-05-08T23:05:48.413Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-05-08T23:05:48.413Z",
    "patchGroup": "text",
    "patchTag": "text"
  }
]

Update patch party configuration for resources for a service

patch
Authorizations
Path parameters
idinteger · int64Required

Service Id, example: 44411

Body

Update Patch party configuration for resources of a service

excludedbooleanOptional
exclusionReasonstringOptional
patchGroupstringOptional
resourceIdinteger · int64Required
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
patch
PATCH /itcare/compute/services/{id}/patch-policies HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 79

[
  {
    "excluded": true,
    "exclusionReason": "text",
    "patchGroup": "text",
    "resourceId": 1
  }
]
[
  {
    "family": "text",
    "id": 1,
    "internalId": 1,
    "lastUpdatedAt": "2025-05-08T23:05:48.413Z",
    "message": "text",
    "process": "text",
    "resourceName": "text",
    "resourceType": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR"
  }
]