Resources | cegedim.cloud

List Compute Resources

Allows to list resources available in your cloud.

This endpoint could be used as a main entry to get informations about the other kind of resource types.

When the resource is retrieved, the *path* attribut allows to navigate to the right category of the resource.

For example : *path=/compute/containers/kubernetes* tells to check the sections *compute > containers > kubernetes* for more details.

get

/compute/resources

Authorizations

Query parameters

servicesinteger · int64[]

idsinteger · int64[]

IDs, example: 123,456,789

namesstring[]

Names, example: resource01,!resource02,resource42

typesstring[]

Types, example: WINDOWS,AIX,LINUX

familiesstring[]

Families, example: DEBIAN,CENTOS,RHEL

versionsstring[]

Versions, example: DEBIAN_10,CENTOS_6,RHEL_5

environmentsstring[]

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]

Status, example: ACTIVE,INACTIVE

tagsstring[]

Tags, example: mytagkey:mytagvalue,application:itcare

cloudsinteger

pagestring

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

sizestring

Number of records per page.

sortany

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

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources'

200

400

{
  "content": [
    {
      "category": "text",
      "cloudName": "text",
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "description": "text",
      "endOfSalesAt": "2025-03-09T04:40:54.662Z",
      "endOfSupportAt": "2025-03-09T04:40:54.662Z",
      "environment": "text",
      "extendedSupportAt": "2025-03-09T04:40:54.662Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "label": "text",
      "name": "text",
      "path": "text",
      "platform": "text",
      "prettyLabel": "text",
      "productName": "text",
      "releasedAt": "2025-03-09T04:40:54.662Z",
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "status": "ACTIVE,INACTIVE,PREPARATION",
      "supportPhase": "text",
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "technology": "text",
      "type": "text"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": [
      {
        "ascending": true,
        "direction": "text",
        "ignoreCase": true,
        "nullHandling": "text",
        "property": "text"
      }
    ],
    "unpaged": true
  },
  "size": 1,
  "sort": [
    {
      "ascending": true,
      "direction": "text",
      "ignoreCase": true,
      "nullHandling": "text",
      "property": "text"
    }
  ],
  "totalElements": 1,
  "totalPages": 1
}

Measures resource types count resources per cloud, Measures obsolescence of the consummable resources per cloud

get

/compute/resources/metrics

Authorizations

Query parameters

servicesinteger · int64[]

Service Ids, example: 1234

environmentsstring[]

Environment, example: PRODUCTION,QA

typesstring[]

Technologies of resource. For exemple LINUX,KUBERNETES

consummableboolean

Count statistic with uncategorized types

kindstring

global|count|obsolescence|service|network, example: global

startstring · date-time

Start Date (ISO8601 format), example: 2022-07-22T00:00:00.000Z

cloudsinteger

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/metrics'

200

400

{
  "backupGb": 1,
  "coresCount": 1,
  "count": 1,
  "instancesCount": 1,
  "phasesDistribution": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "ramGb": 1,
  "score": 1,
  "servicesCount": 1,
  "storageGb": 1
}

List actions and available actions for resources

get

/compute/resources/operations

Authorizations

Query parameters

resourceIdinteger · int64

Resource Id, example: 123

nodeinteger · int64[] · default:

Resource/Node Ids, example: 123

typestring · default: available

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/operations'

200

400

[
  {}
]

Get a compute Resource by its id

Gets a compute Resource by its Id.

A Resource is the ITCare base object.

A resource is composed of :

*id* : Unique identifier of the resource
*name* : Name of the resource
*serviceId* : Each resource must be linked to a service . The service is a logical entity that hosts resources per environment, application ...
*environment* : The environment of the resource. Can be for example 'PRODUCTION', 'QA', 'RECETTE_UAT', 'DEV' ...
*creationUser* : The creator of the resource
*creationTime* : When the resource has been created
*comment* : Description of the resource
*category* : High level categorization of the resource
*family* : Family of the resource belonging the category
*status* : status of the resource. It can be 'ACTIVE' (running), 'INACTIVE' (stopped)
*resourceType* : Type of the resource
*cloudId* : Each cloud
*cloudName* : name of the related cloud
*path* : Helper that gives a path or location about which category to find the resource for more details operations

When the resource is retrieved, the *path* attribut allows to navigate to the right category of the resource.

get

/compute/resources/{id}

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

400

{
  "category": "text",
  "cloudName": "text",
  "comment": "text",
  "creationTime": "text",
  "creationUser": "text",
  "description": "text",
  "endOfSalesAt": "2025-03-09T04:40:54.662Z",
  "endOfSupportAt": "2025-03-09T04:40:54.662Z",
  "environment": "text",
  "extendedSupportAt": "2025-03-09T04:40:54.662Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "label": "text",
  "name": "text",
  "path": "text",
  "platform": "text",
  "prettyLabel": "text",
  "productName": "text",
  "releasedAt": "2025-03-09T04:40:54.662Z",
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "status": "ACTIVE,INACTIVE,PREPARATION",
  "supportPhase": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagValue": "text"
    }
  ],
  "technology": "text",
  "type": "text"
}

Get a resource backup policy details

get

/compute/resources/{id}/backup-policies

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/backup-policies'

200

400

{
  "backups": [
    {
      "backupLastDate": "2025-03-09T04:40:54.662Z",
      "backupSize": 1,
      "id": 1,
      "type": "text"
    }
  ],
  "policies": [
    {
      "backupLastDate": "2025-03-09T04:40:54.662Z",
      "backupSize": 1,
      "durationInHours": 1,
      "frequencies": {},
      "label": "text",
      "name": "text",
      "policyId": "text",
      "replication": true,
      "scope": "text",
      "startTime": "text",
      "timezone": "text",
      "type": "text"
    }
  ]
}

Update attribut comment of a resource (service or instance or PaaS)

patch

/compute/resources/{id}/comments

Authorizations

Path parameters

idinteger · int64required

Body

descriptionstring

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/comments' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "description": "text"
  }'

204

400

No body

No Content

Get a DNS record

get

/compute/resources/{id}/dns-aliases

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases'

200

400

[
  {
    "fqdn": "text",
    "type": "text",
    "value": "text",
    "zone": "text"
  }
]

Adds a DNS Record

post

/compute/resources/{id}/dns-aliases

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Body

fqdnstring

typestring

valuestring

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases' \
  --header 'Content-Type: application/json' \
  --data '{
    "fqdn": "text",
    "type": "text",
    "value": "text"
  }'

200

400

[
  {
    "fqdn": "text",
    "type": "text",
    "value": "text",
    "zone": "text"
  }
]

Delete a DNS Record

delete

/compute/resources/{id}/dns-aliases/{fqdn}

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

fqdnstringrequired

FQDN to delete, example: my.fqdn.cegedim.cloud

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases/{fqdn}'

200

400

No body

Get networks information of a farm resource.

get

/compute/resources/{id}/farm-networks

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/farm-networks'

200

400

[
  {
    "area": "text",
    "cidr": "text",
    "cloud": "text",
    "defaultNetwork": true,
    "description": "text",
    "dns": [
      {
        "alias": "text",
        "domain": "text"
      }
    ],
    "environment": "text",
    "gateway": "text",
    "id": 1,
    "ipAddress": "text",
    "ipFreeNumber": 1,
    "isIpRangePublic": true,
    "mask": "text",
    "networkShortDescription": "text",
    "region": "text",
    "scope": "text",
    "shortDescription": "text",
    "technicalId": "text",
    "usedPercent": 1
  }
]

List the action history of a resource.

Retrieves all operations and events that occurs on a resource : start, stop, monitoring operations ...

get

/compute/resources/{id}/history

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Query parameters

actionsstring[]

Actions, example: enable_monitoring

statusesstring[]

Statuses, example: SUCCESS

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/history'

200

400

[
  {
    "completedAt": "2025-03-09T04:40:54.662Z",
    "family": "text",
    "id": 1,
    "lastUpdatedAt": "2025-03-09T04:40:54.662Z",
    "message": "text",
    "process": "text",
    "resourceName": "text",
    "resourceType": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR",
    "submittedAt": "2025-03-09T04:40:54.662Z",
    "submittedBy": "text"
  }
]

Get a resources' list of nodes

get

/compute/resources/{id}/loadbalancers

Authorizations

Path parameters

idinteger · int64required

id, example: 500060340

Query parameters

typestringrequired

type, example: MESSAGE_BROKERS

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/loadbalancers?type=text'

200

400

[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-03-09T04:40:54.662Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-03-09T04:40:54.662Z",
          "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-03-09T04:40:54.662Z",
    "endOfSupportAt": "2025-03-09T04:40:54.662Z",
    "environment": "text",
    "extendedSupportAt": "2025-03-09T04:40:54.662Z",
    "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-03-09T04:40:54.662Z",
          "size": 1,
          "type": "text"
        },
        "backupPolicyDetails": {
          "backups": [
            {
              "backupLastDate": "2025-03-09T04:40:54.662Z",
              "backupSize": 1,
              "id": 1,
              "type": "text"
            }
          ],
          "policies": [
            {
              "backupLastDate": "2025-03-09T04:40:54.662Z",
              "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-03-09T04:40:54.662Z",
        "endOfSupportAt": "2025-03-09T04:40:54.662Z",
        "environment": "text",
        "extendedSupportAt": "2025-03-09T04:40:54.662Z",
        "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-03-09T04:40:54.662Z",
          "exclusionReason": "text",
          "id": 1,
          "name": "text",
          "patchDate": "2025-03-09T04:40:54.662Z",
          "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-03-09T04:40:54.662Z",
        "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-03-09T04:40:54.662Z",
          "createdBy": "text",
          "description": "text",
          "expiresAt": "2025-03-09T04:40:54.662Z",
          "id": "text",
          "label": "text",
          "recoveredAt": "2025-03-09T04:40:54.662Z",
          "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",
        "totalSizeDisks": "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-03-09T04:40:54.662Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-03-09T04:40:54.662Z",
            "backupSize": 1,
            "durationInHours": 1,
            "frequencies": {},
            "label": "text",
            "name": "text",
            "policyId": "text",
            "replication": true,
            "scope": "text",
            "startTime": "text",
            "timezone": "text",
            "type": "text"
          }
        ]
      },
      "backupStatus": true,
      "category": "text",
      "cloudId": 1,
      "cloudName": "text",
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "endOfSalesAt": "2025-03-09T04:40:54.662Z",
      "endOfSupportAt": "2025-03-09T04:40:54.662Z",
      "environment": "text",
      "extendedSupportAt": "2025-03-09T04:40:54.662Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "label": "text",
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-03-09T04:40:54.662Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-03-09T04:40:54.662Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "releasedAt": "2025-03-09T04:40:54.662Z",
      "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-03-09T04:40:54.662Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-03-09T04:40:54.662Z",
      "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-03-09T04:40:54.662Z",
    "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-03-09T04:40:54.662Z",
        "endOfSupportAt": "2025-03-09T04:40:54.662Z",
        "environment": "text",
        "extendedSupportAt": "2025-03-09T04:40:54.662Z",
        "id": 1,
        "monitoringAlerting": true,
        "monitoringEnabled": true,
        "monitoringMode": "text",
        "monitoringOnCallEnabled": true,
        "name": "text",
        "releasedAt": "2025-03-09T04:40:54.662Z",
        "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 network information of a resource

get

/compute/resources/{id}/networks

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/networks'

200

400

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

Get a resources' list of nodes

get

/compute/resources/{id}/nodes

Authorizations

Path parameters

idinteger · int64required

id, example: 500060340

Query parameters

typestringrequired

type, example: MESSAGE_BROKERS

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/nodes?type=text'

200

400

[
  {
    "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-03-09T04:40:54.662Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-03-09T04:40:54.662Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-03-09T04:40:54.662Z",
          "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-03-09T04:40:54.662Z",
    "endOfSupportAt": "2025-03-09T04:40:54.662Z",
    "environment": "text",
    "extendedSupportAt": "2025-03-09T04:40:54.662Z",
    "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-03-09T04:40:54.662Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-03-09T04:40:54.662Z",
      "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-03-09T04:40:54.662Z",
    "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-03-09T04:40:54.662Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2025-03-09T04:40:54.662Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2025-03-09T04:40:54.662Z",
      "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",
    "totalSizeDisks": "text",
    "type": "text"
  }
]

Get a managed node information of the given resource

#managed-node

get

/compute/resources/{id}/parent

Authorizations

Path parameters

idinteger · int64required

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/parent'

200

400

{
  "category": "text",
  "cloudId": 1,
  "environment": "text",
  "id": 1,
  "name": "text",
  "parentId": 1,
  "parentType": "text",
  "serviceId": 1,
  "status": "text",
  "technology": "text"
}

Get patch party policy for a resource.

get

/compute/resources/{id}/patch-policy

Authorizations

Path parameters

idinteger · int64required

Resource Id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/patch-policy'

200

400

{
  "excluded": true,
  "excludedBy": "text",
  "exclusionDate": "2025-03-09T04:40:54.662Z",
  "exclusionReason": "text",
  "id": 1,
  "name": "text",
  "patchDate": "2025-03-09T04:40:54.662Z",
  "patchGroup": "text",
  "patchTag": "text"
}

Removes Tags

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

delete

/compute/resources/{id}/tags

Authorizations

Path parameters

idinteger · int64required

Example: 123

Body

tagKeystringrequired

Key of tag

tagValuestringrequired

Value of tag

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/tags' \
  --header 'Content-Type: application/json' \
  --data '{
    "tagKey": "text",
    "tagValue": "text"
  }'

204

400

No body

No Content

List available Tags

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

get

/compute/resources/{id}/tags

Authorizations

Path parameters

idinteger · int64required

Resource Id

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/tags'

200

400

[
  {
    "tagKey": "text",
    "tagValue": "text"
  }
]

Adds created Tag on Resource

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

post

/compute/resources/{id}/tags

Authorizations

Path parameters

idinteger · int64required

Example: 123

Body

tagKeystringrequired

Key of tag

tagValuestringrequired

Value of tag

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/tags' \
  --header 'Content-Type: application/vnd.cegedim-it.v1+json' \
  --data '{
    "tagKey": "text",
    "tagValue": "text"
  }'

200

400

[
  {
    "tagKey": "text",
    "tagValue": "text"
  }
]

Replaces all Tags

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

put

/compute/resources/{id}/tags

Authorizations

Path parameters

idinteger · int64required

Example: 123

Body

tagKeystringrequired

Key of tag

tagValuestringrequired

Value of tag

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/tags' \
  --header 'Content-Type: application/vnd.cegedim-it.v1+json' \
  --data '[
    {
      "tagKey": "text",
      "tagValue": "text"
    }
  ]'

200

400

[
  {
    "tagKey": "text",
    "tagValue": "text"
  }
]

Get a managed url

Gets URLs linked to a resource. For example : URLs linked to a Load Balancer.

get

/compute/resources/{id}/urls

Authorizations

Path parameters

idinteger · int64required

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{id}/urls'

200

400

{
  "category": "text",
  "cloudId": 1,
  "environment": "text",
  "id": 1,
  "name": "text",
  "parentId": 1,
  "parentType": "text",
  "serviceId": 1,
  "status": "text",
  "technology": "text"
}

Verifies the existence of a resource

head

/compute/resources/{name}

Authorizations

Path parameters

namestringrequired

Query parameters

typestring

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request HEAD \
  --url 'https://api.cegedim.cloud/itcare/compute/resources/{name}'

200

400

No body