Resources

Last updated 3 months ago

List Compute Resources

get

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.

Authorizations

Query parameters

servicesinteger · int64[]Optional

idsinteger · int64[]Optional

IDs, example: 123,456,789

namesstring[]Optional

Names, example: resource01,!resource02,resource42

typesstring[]Optional

Types, example: WINDOWS,AIX,LINUX

familiesstring[]Optional

Families, example: DEBIAN,CENTOS,RHEL

versionsstring[]Optional

Versions, example: DEBIAN_10,CENTOS_6,RHEL_5

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Status, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

cloudsintegerOptional

pagestringOptional

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

sizestringOptional

Number of records per page.

sortanyOptional

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

Responses

200

*/*

400

Bad Request

*/*

get

GET /itcare/compute/resources HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "content": [
    {
      "category": "text",
      "cloudName": "text",
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "description": "text",
      "endOfSalesAt": "2025-05-31T15:00:10.992Z",
      "endOfSupportAt": "2025-05-31T15:00:10.992Z",
      "environment": "text",
      "extendedSupportAt": "2025-05-31T15:00:10.992Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "label": "text",
      "name": "text",
      "path": "text",
      "platform": "text",
      "prettyLabel": "text",
      "productName": "text",
      "releasedAt": "2025-05-31T15:00:10.992Z",
      "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

Authorizations

Query parameters

servicesinteger · int64[]Optional

Service Ids, example: 1234

environmentsstring[]Optional

Environment, example: PRODUCTION,QA

typesstring[]Optional

Technologies of resource. For exemple LINUX,KUBERNETES

consummablebooleanOptional

Count statistic with uncategorized types

kindstringOptional

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

startstring · date-timeOptional

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

cloudsintegerOptional

Responses

200

*/*

400

Bad Request

*/*

get

GET /itcare/compute/resources/metrics HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Authorizations

Query parameters

resourceIdinteger · int64Optional

Resource Id, example: 123

nodeinteger · int64[]Optional

Resource/Node Ids, example: 123

Default: []

typestringOptional

Default: available

Responses

200

application/vnd.cegedim-it.v1+json

Responseobject[]

400

Bad Request

*/*

get

GET /itcare/compute/resources/operations HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {}
]

Get a compute Resource by its id

get

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.

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Responses

200

*/*

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "category": "text",
  "cloudName": "text",
  "comment": "text",
  "creationTime": "text",
  "creationUser": "text",
  "description": "text",
  "endOfSalesAt": "2025-05-31T15:00:10.992Z",
  "endOfSupportAt": "2025-05-31T15:00:10.992Z",
  "environment": "text",
  "extendedSupportAt": "2025-05-31T15:00:10.992Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "label": "text",
  "name": "text",
  "path": "text",
  "platform": "text",
  "prettyLabel": "text",
  "productName": "text",
  "releasedAt": "2025-05-31T15:00:10.992Z",
  "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

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Responses

200

*/*

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/backup-policies HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "backups": [
    {
      "backupLastDate": "2025-05-31T15:00:10.992Z",
      "backupSize": 1,
      "id": 1,
      "type": "text"
    }
  ],
  "policies": [
    {
      "backupLastDate": "2025-05-31T15:00:10.992Z",
      "backupSize": 1,
      "durationInHours": 1,
      "frequencies": {},
      "label": "text",
      "name": "text",
      "policyId": "text",
      "replication": true,
      "scope": "text",
      "startTime": "text",
      "timezone": "text",
      "type": "text"
    }
  ]
}

Get a DNS record

get

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/dns-aliases HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Delete a DNS Record

delete

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

fqdnstringRequired

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

Responses

200

400

Bad Request

*/*

delete

DELETE /itcare/compute/resources/{id}/dns-aliases/{fqdn} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get networks information of a farm resource.

get

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/farm-networks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

List the action history of a resource.

get

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

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Query parameters

actionsstring[]Optional

Actions, example: enable_monitoring

statusesstring[]Optional

Statuses, example: SUCCESS

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/history HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "completedAt": "2025-05-31T15:00:10.992Z",
    "family": "text",
    "id": 1,
    "lastUpdatedAt": "2025-05-31T15:00:10.992Z",
    "message": "text",
    "process": "text",
    "resourceName": "text",
    "resourceType": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR",
    "submittedAt": "2025-05-31T15:00:10.992Z",
    "submittedBy": "text"
  }
]

Get a resources' list of nodes

get

Authorizations

Path parameters

idinteger · int64Required

id, example: 500060340

Query parameters

typestringRequired

type, example: MESSAGE_BROKERS

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/loadbalancers HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-31T15:00:10.992Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-31T15:00:10.992Z",
          "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-31T15:00:10.992Z",
    "endOfSupportAt": "2025-05-31T15:00:10.992Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-31T15:00:10.992Z",
    "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-31T15:00:10.992Z",
          "size": 1,
          "type": "text"
        },
        "backupPolicyDetails": {
          "backups": [
            {
              "backupLastDate": "2025-05-31T15:00:10.992Z",
              "backupSize": 1,
              "id": 1,
              "type": "text"
            }
          ],
          "policies": [
            {
              "backupLastDate": "2025-05-31T15:00:10.992Z",
              "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-31T15:00:10.992Z",
        "endOfSupportAt": "2025-05-31T15:00:10.992Z",
        "environment": "text",
        "extendedSupportAt": "2025-05-31T15:00:10.992Z",
        "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-31T15:00:10.992Z",
          "exclusionReason": "text",
          "id": 1,
          "name": "text",
          "patchDate": "2025-05-31T15:00:10.992Z",
          "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-31T15:00:10.992Z",
        "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-31T15:00:10.992Z",
          "createdBy": "text",
          "description": "text",
          "expiresAt": "2025-05-31T15:00:10.992Z",
          "id": "text",
          "label": "text",
          "recoveredAt": "2025-05-31T15:00:10.992Z",
          "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-31T15:00:10.992Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-05-31T15:00:10.992Z",
            "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-31T15:00:10.992Z",
      "endOfSupportAt": "2025-05-31T15:00:10.992Z",
      "environment": "text",
      "extendedSupportAt": "2025-05-31T15:00:10.992Z",
      "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-31T15:00:10.992Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-05-31T15:00:10.992Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "releasedAt": "2025-05-31T15:00:10.992Z",
      "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-31T15:00:10.992Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-31T15:00:10.992Z",
      "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-31T15:00:10.992Z",
    "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-31T15:00:10.992Z",
        "endOfSupportAt": "2025-05-31T15:00:10.992Z",
        "environment": "text",
        "extendedSupportAt": "2025-05-31T15:00:10.992Z",
        "id": 1,
        "monitoringAlerting": true,
        "monitoringEnabled": true,
        "monitoringMode": "text",
        "monitoringOnCallEnabled": true,
        "name": "text",
        "releasedAt": "2025-05-31T15:00:10.992Z",
        "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

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/networks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get a resources' list of nodes

get

Authorizations

Path parameters

idinteger · int64Required

id, example: 500060340

Query parameters

typestringRequired

type, example: MESSAGE_BROKERS

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/nodes HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
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-31T15:00:10.992Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-31T15:00:10.992Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-31T15:00:10.992Z",
          "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-31T15:00:10.992Z",
    "endOfSupportAt": "2025-05-31T15:00:10.992Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-31T15:00:10.992Z",
    "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-31T15:00:10.992Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-31T15:00:10.992Z",
      "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-31T15:00:10.992Z",
    "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-31T15:00:10.992Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2025-05-31T15:00:10.992Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2025-05-31T15:00:10.992Z",
      "snapshotSize": 1
    },
    "status": "text",
    "storage": 1,
    "storageInformation": {
      "fileSystems": [
        {
          "free": 1,
          "mountingPoint": "text",
          "sizeOf": 1,
          "type": "text"
        }
      ],
      "totalSizeDisks": 1,
      "totalSizeFileSystems": 1
    },
    "storageMoveInProgress": true,
    "supportPhase": "text",
    "technology": "text",
    "type": "text"
  }
]

Get a managed node information of the given resource

get

#managed-node

Authorizations

Path parameters

idinteger · int64Required

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/parent HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/patch-policy HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "excluded": true,
  "excludedBy": "text",
  "exclusionDate": "2025-05-31T15:00:10.992Z",
  "exclusionReason": "text",
  "id": 1,
  "name": "text",
  "patchDate": "2025-05-31T15:00:10.992Z",
  "patchGroup": "text",
  "patchTag": "text"
}

List available Tags

get

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

Authorizations

Path parameters

idinteger · int64Required

Resource Id

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/tags HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get a managed url

get

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

Authorizations

Path parameters

idinteger · int64Required

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/compute/resources/{id}/urls HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Authorizations

Path parameters

namestringRequired

Query parameters

typestringOptional

Responses

200

400

Bad Request

*/*

head

HEAD /itcare/compute/resources/{name} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

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

patch

Authorizations

Path parameters

idinteger · int64Required

Body

descriptionstringOptional

Responses

204

No Content

400

Bad Request

*/*

patch

PATCH /itcare/compute/resources/{id}/comments HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 22

{
  "description": "text"
}

No content

Adds a DNS Record

post

Authorizations

Path parameters

idinteger · int64Required

Resource Id, example: 123

Body

Model to update a DNS Record

fqdnstringOptional

typestringOptional

valuestringOptional

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

post

POST /itcare/compute/resources/{id}/dns-aliases HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "fqdn": "text",
  "type": "text",
  "value": "text"
}

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

Removes Tags

delete

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

Authorizations

Path parameters

idinteger · int64RequiredExample: 123

Body

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

Responses

204

No Content

400

Bad Request

*/*

delete

DELETE /itcare/compute/resources/{id}/tags HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

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

No content

Adds created Tag on Resource

post

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

Authorizations

Path parameters

idinteger · int64RequiredExample: 123

Body

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

post

POST /itcare/compute/resources/{id}/tags HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 35

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

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

Replaces all Tags

put

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

Authorizations

Path parameters

idinteger · int64RequiredExample: 123

Body

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

put

PUT /itcare/compute/resources/{id}/tags HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 37

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

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