Resources

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.

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

Path parameters

id*integer (int64)

Resource Id

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

tagKey*string

Key of tag

tagValue*string

Value of tag

Request

JavaScriptCurlPython

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

Response

200

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

PUThttps://api.cegedim.cloud/itcare/compute/resources/{id}/tags

Path parameters

id*integer (int64)

Example: 123

Body

application/vnd.cegedim-it.v1+json

tagKey*string

Key of tag

tagValue*string

Value of tag

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

tagKey*string

Key of tag

tagValue*string

Value of tag

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/resources/{id}/tags', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify([
      {
        "tagKey": "text",
        "tagValue": "text"
      }
    ]),
});
const data = await response.json();

Response

200

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

POSThttps://api.cegedim.cloud/itcare/compute/resources/{id}/tags

Path parameters

id*integer (int64)

Example: 123

Body

application/vnd.cegedim-it.v1+json

tagKey*string

Key of tag

tagValue*string

Value of tag

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

tagKey*string

Key of tag

tagValue*string

Value of tag

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/resources/{id}/tags', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({
      "tagKey": "text",
      "tagValue": "text"
    }),
});
const data = await response.json();

Response

200

[
  {
    "tagKey": "text",
    "tagValue": "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.

DELETEhttps://api.cegedim.cloud/itcare/compute/resources/{id}/tags

Path parameters

id*integer (int64)

Example: 123

Body

application/json

tagKey*string

Key of tag

tagValue*string

Value of tag

Response

204400

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/resources/{id}/tags', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tagKey": "text",
      "tagValue": "text"
    }),
});
const data = await response.json();

Get a DNS record

GEThttps://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases

Path parameters

id*integer (int64)

Resource Id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

typestring

The type of the record (A,CNAME,TXT,…)

fqdnstring

The full qualified domain name (fqdn)

valuestring

The record name.

zonestring

The related DNZ zone

Request

JavaScriptCurlPython

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

Response

200

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

Adds a DNS Record

POSThttps://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases

Path parameters

id*integer (int64)

Resource Id, example: 123

Body

application/json

typestring

fqdnstring

valuestring

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

typestring

The type of the record (A,CNAME,TXT,…)

fqdnstring

The full qualified domain name (fqdn)

valuestring

The record name.

zonestring

The related DNZ zone

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

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

PATCHhttps://api.cegedim.cloud/itcare/compute/resources/{id}/comments

Path parameters

id*integer (int64)

Body

application/json-patch+json

descriptionstring

Response

204400

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/resources/{id}/comments', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Verifies the existence of a resource.Types can be found using /resource-types endpoint and are found under the 'types' attributes

HEADhttps://api.cegedim.cloud/itcare/compute/resources/{name}

Path parameters

name*string

Query parameters

Response

200400

OK

Request

JavaScriptCurlPython

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

List Compute Resources

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

Query parameters

Response

200400

OK

Body

*/*

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of ResourceV1 (object)

numberinteger (int32)

sortarray of SortObject (object)

pageablePageableObject (object)

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

JavaScriptCurlPython

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

Response

200

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

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.

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

Path parameters

id*integer (int64)

Resource Id, example: 123

Response

200400

OK

Body

*/*

id*integer (int64)

Unique Identifier of the resource.

namestring

Name of the resource

typestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

creationUserstring

creationTimestring

descriptionstring

commentstring

Brief comment or description of the resource

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

endOfSupportAtstring (date-time)

supportPhasestring

tagsarray of TagV1 (object)

List of tags - metadata associated to this resource.

internalResourceIdinteger (int64)

categorystring

technologystring

platformstring

labelstring

productNamestring

prettyLabelstring

familystring

status*enum

Status of resource.

ACTIVE,INACTIVE,PREPARATION

resourceTypestring

type of resource

cloudNamestring

Cloud Name of the resource

pathstring

API Path allowing to navigation in the resource category

Request

JavaScriptCurlPython

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

Response

200

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

Get a managed url information : A managed url is a url belonging to a load balancer ...

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

Path parameters

id*integer (int64)

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

ID of the Managed Node/URL

namestring

Name of the Managed Node/URL

statusstring

Status of the Managed Node/URL

serviceIdinteger (int64)

The Service ID

environmentstring

The Service environment

cloudIdinteger (int64)

The Cloud ID

parentTypestring

The resource type of the parent

parentIdinteger (int64)

The parent resource id

categorystring

The Category of the Managed Node/URL

technologystring

The parent technology

Request

JavaScriptCurlPython

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

Response

200

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

Get patch party policy for a resource.

GEThttps://api.cegedim.cloud/itcare/compute/resources/{id}/patch-policy

Path parameters

id*integer (int64)

Resource Id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

excluded*boolean

Tells if the resource is excluded or not from patch party

exclusionReasonstring

Raison why the resource should be excluded from patch party.

patchGroupstring

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

patchDatestring (date-time)

Date of the last System Upgrade.

patchTagstring

Tag to reference the last patch party

namestring

Name of the resource under patch party or not

idinteger (int64)

Id of the resource under patch party or not

excludedBystring

User who performed the exclusion from patch party action

exclusionDatestring (date-time)

Date on which the exclusion from patch party was performed

Request

JavaScriptCurlPython

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

Response

200

{
  "excluded": false,
  "exclusionReason": "text",
  "patchGroup": "text",
  "patchDate": "2025-01-03T03:47:02.327Z",
  "patchTag": "text",
  "name": "text",
  "id": 0,
  "excludedBy": "text",
  "exclusionDate": "2025-01-03T03:47:02.327Z"
}

Get a managed node information of the given resource : A managed node is a resource belonging to a cluster, farm ...

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

Path parameters

id*integer (int64)

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

ID of the Managed Node/URL

namestring

Name of the Managed Node/URL

statusstring

Status of the Managed Node/URL

serviceIdinteger (int64)

The Service ID

environmentstring

The Service environment

cloudIdinteger (int64)

The Cloud ID

parentTypestring

The resource type of the parent

parentIdinteger (int64)

The parent resource id

categorystring

The Category of the Managed Node/URL

technologystring

The parent technology

Request

JavaScriptCurlPython

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

Response

200

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

Get a resources' list of nodes

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

Path parameters

id*integer (int64)

id, example: 500060340

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

ipAddressstring

networkNetworkV1 (object)

storageInformationStorageInformationV1 (object)

Information about a Storage of an Instance

availabilityZoneAvailabilityZoneV1 (object)

areaAreaV1 (object)

regionRegionV1 (object)

backupBackupV1 (object)

Backup information on an instance

replicationReplicationV1 (object)

Replication information on an instance

snapshotSnapshotV1 (object)

Snapshot of an instance

labelRegionstring

Region pretty name

labelDataCenterstring

DataCenter pretty name

labelAreastring

Area pretty name

labelAvailabilityZonestring

Availability Zone pretty name

totalSizeDisksstring

Total Disk size of the resource

cpuinteger (int64)

CPU of the resource

raminteger (int64)

RAM of the resource

storagenumber

Storage after disks format in GB of the resource

isMemberOFLoadBalancerboolean

Instance is member of load balancer

loadbalancersarray of LoadbalancerInfoV1 (object)

imageCodestring

Internal Image linked to this instance

osNamestring

OS name of this instance

osTypestring

OS type of this instance

isExternalIngressNodeboolean

This instance is ingress external node

isInternalIngressNodeboolean

This instance is ingress internal node

storageMoveInProgressboolean

Information about storage replication in Progress

authenticationDomainstring

parentResourceTypestring

Request

JavaScriptCurlPython

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

Response

200

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

Get network information of a resource

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

Path parameters

id*integer (int64)

Resource Id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

JavaScriptCurlPython

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

Response

200

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

Get a resources' list of nodes

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

Path parameters

id*integer (int64)

id, example: 500060340

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

ipAddressstring

nodeCountinteger (int64)

networkNetworkV1 (object)

urlsarray of URL (object)

urls of the load balancer

membersarray of InstanceV1 (object)

Instances that are load balanced by this loadbalancer

protocolsarray of Protocol (object)

Protocols on which this loadbalancer expose a virtual service

irulesarray of Irule (object)

iRules configured for this loadbalancer

healthChecksarray of HealthCheckV1 (object)

Healthchecks configured for this loadbalancer

certificateCertificateV1 (object)

defaultPersistencestring

Advanced property such as default persistence

fallbackPersistencestring

Advanced property such as fallback persistence

loadBalancingModestring

Advanced property such as load balancing mode

botDefenseEnabledboolean

Bot Defense state

botDefenseUpdatingboolean

Bot Defense is updating

securityProfileSecurityProfileV1 (object)

snatAutomapboolean

Source addresse translation automap enabled

parentResourceServiceResourceBaseV1 (object)

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

Request

JavaScriptCurlPython

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

Response

200

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

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

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

Path parameters

id*integer (int64)

Resource Id, example: 123

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int64)

submittedAtstring (date-time)

completedAtstring (date-time)

lastUpdatedAtstring (date-time)

submittedBystring

resourceTypestring

resourceNamestring

familystring

Request

JavaScriptCurlPython

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

Response

200

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

Get networks information of a farm resource.

GEThttps://api.cegedim.cloud/itcare/compute/resources/{id}/farm-networks

Path parameters

id*integer (int64)

Resource Id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

JavaScriptCurlPython

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

Response

200

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

Get a resource backup policy details

GEThttps://api.cegedim.cloud/itcare/compute/resources/{id}/backup-policies

Path parameters

id*integer (int64)

Resource Id, example: 123

Response

200400

OK

Body

*/*

backupsarray of BackupInfoV1 (object)

policiesarray of ResourceBackupPolicyDetailsV1 (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "backups": [
    {
      "id": 0,
      "type": "text",
      "backupSize": 0,
      "backupLastDate": "2025-01-03T03:47:02.327Z"
    }
  ],
  "policies": [
    {
      "name": "text",
      "label": "text",
      "scope": "text",
      "type": "text",
      "replication": false,
      "durationInHours": 0,
      "startTime": "text",
      "timezone": "text",
      "policyId": "text",
      "backupLastDate": "2025-01-03T03:47:02.327Z",
      "backupSize": 0
    }
  ]
}

List actions and available actions for resources

GEThttps://api.cegedim.cloud/itcare/compute/resources/operations

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

array of object

Request

JavaScriptCurlPython

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

Response

200

[]

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

GEThttps://api.cegedim.cloud/itcare/compute/resources/metrics

Query parameters

Response

200400

OK

Body

*/*

countinteger (int64)

backupGbnumber (double)

coresCountinteger (int64)

instancesCountinteger (int64)

ramGbinteger (int64)

servicesCountinteger (int64)

storageGbnumber (double)

scorenumber

Global score computed. Maximum value is 100, minimum is 0.

phasesDistributionobject

Request

JavaScriptCurlPython

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

Response

200

{
  "count": 0,
  "backupGb": 0,
  "coresCount": 0,
  "instancesCount": 0,
  "ramGb": 0,
  "servicesCount": 0,
  "storageGb": 0,
  "score": 0
}

Delete a DNS Record

DELETEhttps://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases/{fqdn}

Path parameters

id*integer (int64)

Resource Id, example: 123

fqdn*string

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

Response

200400

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/compute/resources/{id}/dns-aliases/{fqdn}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();