Containers

PreviousBackup Policies NextEnvironments

Last updated 25 days ago

List K8S Container

get

/compute/containers/kubernetes

Authorizations

Query parameters

servicesinteger · int64[]

namesstring[]

Names, example: resource01,!resource02,resource42

environmentsstring[]

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]

Status, example: ACTIVE,INACTIVE

tagsstring[]

Tags, example: agkey:mytagvalue,application:itcare

monitoringStatusboolean

Filter list by monitoring status

monitoringOnCallStatusboolean

Filter list by monitoring on call status

backupStatusboolean

Filter list by backup status

recoveryStatusboolean

Filter list by DRP status

includedInPatchPartyboolean

Filter list by patch party status

topologiesstring[]

Topology, example: Standard, HA

versionsstring[]

Version, example: v1.26.15, v1.28.13, etc...

regionsstring[]

Region, example: EB,ET

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

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

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

200

400

{
  "content": [
    {
      "allowMonitoringDisplay": true,
      "availableAZs": [
        "text"
      ],
      "availableDCs": [
        "text"
      ],
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-03-09T14:22:10.133Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-03-09T14:22:10.133Z",
            "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-09T14:22:10.133Z",
      "endOfSupportAt": "2025-03-09T14:22:10.133Z",
      "environment": "text",
      "extendedSupportAt": "2025-03-09T14:22:10.133Z",
      "family": "text",
      "id": 1,
      "ingressProvider": "NGINX",
      "internalResourceId": 1,
      "internalType": "text",
      "label": "text",
      "labelAreaList": [
        "text"
      ],
      "labelRegion": "text",
      "managementUrl": "text",
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "nodeCount": 1,
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-03-09T14:22:10.133Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-03-09T14:22:10.133Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "releasedAt": "2025-03-09T14:22:10.133Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "status": "text",
      "supportPhase": "text",
      "supportsHAMode": true,
      "technicalId": "text",
      "technology": "text",
      "topology": "text",
      "type": "text",
      "version": "text",
      "versionDetailed": "text"
    }
  ],
  "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
}

Create K8s Cluster

This method allows to create a cluster.

You will have to know at the minimum :

where you want to host your cluster (area attribute)
which network is used (networkId attribute)
name of cluster (name attribute)
sizing of cluster (nodeSizing attribute)
number of nodes instances of your cluster (instanceCount attribute)
service in which you want to put your cluster (serviceId attribute)

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /clusters
{
	"name": "PCLUSTER01",
	"area": "EB",
	"networkId": "ED145",
	"serviceId": 123,
	"nodeSizing":, "1cpu2gb"
	"instanceCount": 2
}

post

/compute/containers/kubernetes

Authorizations

Body

areastringrequired

Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

backupEnabledboolean

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

cloudIdinteger · int64

dbBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

ingressProviderstring · enumrequired

Kubernetes Container Ingress Providers

Options: NGINX, ISTIO, TRAEFIK, NGINX,ISTIO,TRAEFIK

instanceCountinteger · int32 · min: 2 · max: 12required

Number of instances to create in k8s cluster

monitoringAlertingboolean

Indicates if alerting should be activated. If absent, set to false.

monitoringEnabledboolean

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

namestringrequired

Name of k8s cluster

Pattern: [a-z0-9\-]+

networkIdinteger · int64required

The network Id of the ELS cluster

noBackupProdReasonstring

Indicates why a production resource is not under backup.

noMonitoringProdReasonstring

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstring

Indicates why a production resource is not replicated.

nodeSizingstringrequired

Node sizing for cluster

onCallSupervisionboolean

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

platformstringrequired

Product platform of the cluster

regionstringrequired

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

regulationstring

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

replicationEnabledboolean

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

serverBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

serviceIdinteger · int64required

id of service to put instance in.

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.cegedim.cloud/itcare/compute/containers/kubernetes' \
  --header 'Content-Type: application/vnd.cegedim-it.v1+json' \
  --data '{
    "area": "text",
    "backupEnabled": true,
    "cloudId": 1,
    "dbBackupPolicyId": "text",
    "ingressProvider": "NGINX",
    "instanceCount": 1,
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "name": "text",
    "networkId": 1,
    "noBackupProdReason": "text",
    "noMonitoringProdReason": "text",
    "noReplicationProdReason": "text",
    "nodeSizing": "text",
    "onCallSupervision": true,
    "platform": "text",
    "region": "text",
    "regulation": "text",
    "replicationEnabled": true,
    "serverBackupPolicyId": "text",
    "serviceId": 1
  }'

200

400

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

List ingress providers

get

/compute/containers/kubernetes/ingress-providers

Authorizations

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.cegedim.cloud/itcare/compute/containers/kubernetes/ingress-providers'

200

400

[
  "text"
]

Delete an existing k8s container

This method allows to delete a K8s Cluster Container.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /k8s-clusters/123

DELETE /k8s-clusters/123
{
    "changeReference": "rfc nunmber 456"
}

delete

/compute/containers/kubernetes/{id}

Authorizations

Path parameters

idinteger · int64required

id, example: 123

Body

changeReferencestring · max: 10

Optional reference for change

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}' \
  --header 'Content-Type: application/vnd.cegedim-it.v1+json' \
  --data '{
    "changeReference": "text"
  }'

200

400

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get detailed information for an k8s container.

get

/compute/containers/kubernetes/{id}

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/containers/kubernetes/{id}'

200

400

{
  "allowMonitoringDisplay": true,
  "availableAZs": [
    "text"
  ],
  "availableDCs": [
    "text"
  ],
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2025-03-09T14:22:10.133Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2025-03-09T14:22:10.133Z",
        "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-09T14:22:10.133Z",
  "endOfSupportAt": "2025-03-09T14:22:10.133Z",
  "environment": "text",
  "extendedSupportAt": "2025-03-09T14:22:10.133Z",
  "family": "text",
  "id": 1,
  "ingressProvider": "NGINX",
  "internalResourceId": 1,
  "internalType": "text",
  "label": "text",
  "labelAreaList": [
    "text"
  ],
  "labelRegion": "text",
  "managementUrl": "text",
  "metrologyUrl": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "name": "text",
  "nodeCount": 1,
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-03-09T14:22:10.133Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-03-09T14:22:10.133Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "releasedAt": "2025-03-09T14:22:10.133Z",
  "replicationStatus": true,
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "status": "text",
  "supportPhase": "text",
  "supportsHAMode": true,
  "technicalId": "text",
  "technology": "text",
  "topology": "text",
  "type": "text",
  "version": "text",
  "versionDetailed": "text"
}

update K8s Cluster

This method allows to update a cluster.

Structure of payload is generic and describes :

operation you want to be performed
options data relative to the operation performed - see details.

Below are different operations currently implemented.

Create Nodes

Use the create_nodes operation to create the nodes of a cluster.

Create nodes operation will add the new nodes in the cluster by availability zone. You can specify the availability zone you need in the request.

This method is synchronous (status code 202).

Example :

PATCH /containers/kubernetes/1234
{
    "operation": "create_nodes",
    "options": {
        "nodes": [
            {
                "nodesNb": 1,
                "nodeSizing": "2cpu4gb",
                "az": "EB-A"
            },
            {
                "nodesNb": 2,
                "nodeSizing": "4cpu8gb",
                "az": "EB-B"
            }
        ]
    }
}

Delete Nodes

Use the delete_nodes operation to delete the nodes of a cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
	"operation":"delete_nodes",
	"options":{
	    "nodes": ["11112","11113","11114"]
	}
}

Enable High Availability - HA

Use the enable_ha operation to enable the HA of a cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
	"operation":"enable_ha"
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the cluster.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the cluster.

Use the excluded option to turn on/off patch party.
Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

Include from patch party body:

PATCH /containers/kubernetes/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

Exclude from patch party body:

PATCH /containers/kubernetes/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

Upgrade

Use the upgrade operation to upgrade the cluster.

Use the version option to set the target version to be installed.

The requirements are :

step by step upgrade only : Use the /compute/platform/products?type=KUBERNETES to list all versions available for the cluster.
no downgrade possibility

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
  "operation": "upgrade",
  "options": {
    "version": "1.24"
 }
}

patch

/compute/containers/kubernetes/{id}

Authorizations

Path parameters

idinteger · int64required

K8s Cluster Id, example: 123

Body

operationstring

optionsobject

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "operation": "text",
    "options": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }'

200

400

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get K8s Container loadbalancer list.

get

/compute/containers/kubernetes/{id}/loadbalancers

Authorizations

Path parameters

idinteger · int64required

K8sCluster Id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

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

200

400

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

Create K8s Container custom loadbalancer

post

/compute/containers/kubernetes/{id}/loadbalancers

Authorizations

Path parameters

idinteger · int64required

K8sCluster Id, example: 123

Body

areastring

Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

backupEnabledboolean

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

certificateNamestring

certificate of the load balancer., example: wildcard_cegedim.com

cloudIdinteger · int64

dbBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

healthcheckstringrequired

healtcheck of load balancer., example: http

monitoringAlertingboolean

Indicates if alerting should be activated. If absent, set to false.

monitoringEnabledboolean

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

networkIdinteger · int64

Network id. Refer to networks available in List Networks method. If absent, a default network of AZ will be used.

noBackupProdReasonstring

Indicates why a production resource is not under backup.

noMonitoringProdReasonstring

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstring

Indicates why a production resource is not replicated.

onCallSupervisionboolean

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

persistenceboolean

portMembersstringrequired

port member of load balancer., example: 80, 443, ...

profileNamestringrequired

profile name of load balancer.

redirectToHttpsboolean

regionstringrequired

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

regulationstring

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

replicationEnabledboolean

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

serverBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

serviceIdinteger · int64required

id of service to put instance in.

setUpDNSEnabledboolean

Indicates if a DNS record is to be set. If absent, set to false.

sslProfilestring

ssl profile of the load balancer., example: profile_wildcard.cegedim.com_secure

urlstringrequired

url of load balancer. Must be unique, and fit naming rules convention., example: url.cegedim.com

Pattern: ^(https?:\\/\\/)?(www\\.)?[a-zA-Z][a-zA-Z0-9.-]{2,63}+$

vsPortinteger · int32

port of load balancer in case of TCP VS Profile

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/loadbalancers' \
  --header 'Content-Type: application/json' \
  --data '{
    "area": "text",
    "backupEnabled": true,
    "certificateName": "text",
    "cloudId": 1,
    "dbBackupPolicyId": "text",
    "healthcheck": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "networkId": 1,
    "noBackupProdReason": "text",
    "noMonitoringProdReason": "text",
    "noReplicationProdReason": "text",
    "onCallSupervision": true,
    "persistence": true,
    "portMembers": "text",
    "profileName": "text",
    "redirectToHttps": true,
    "region": "text",
    "regulation": "text",
    "replicationEnabled": true,
    "serverBackupPolicyId": "text",
    "serviceId": 1,
    "setUpDNSEnabled": true,
    "sslProfile": "text",
    "url": "text",
    "vsPort": 1
  }'

200

400

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get K8s Container stats distribution of Availability Zone and Datacenter of the nodes the cluster

get

/compute/containers/kubernetes/{id}/metrics

Authorizations

Path parameters

idinteger · int64required

K8sCluster Id, example: 123

Query parameters

typestringrequired

type, example: az-distribution | dc-distribution

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

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

200

400

{
  "ANY_ADDITIONAL_PROPERTY": {
    "cpuCount": 1,
    "nodeCount": 1,
    "ramCount": 1
  }
}

Get a Kubernetes containter network informations

get

/compute/containers/kubernetes/{id}/networks

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/containers/kubernetes/{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 Kubernetes containter node informations

get

/compute/containers/kubernetes/{id}/nodes

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/containers/kubernetes/{id}/nodes'

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

Delete a Kubernetes container node

This method allows to delete a Kubernetes cluster node.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

To delete a Kubernetes node, the id of the Kubernetes cluster and the id of the node to delete must be specified.

To list the nodes of the Kubernetes cluster, use the endpoint : GET /containers/kubernetes/{kuberneteId}/nodes/{nodeId}.

Use the following to delete a node of a Kubernetes cluster.

DELETE /containers/kubernetes/1234/nodes/4567

To keep consistency on the Kubernetes cluster, please note that :

All nodes cannot be deleted.
All ingress nodes cannot be deleted.

API users will have a BAD_REQUEST when trying to break one of the rule above.

delete

/compute/containers/kubernetes/{id}/nodes/{nodeId}

Authorizations

Path parameters

idinteger · int64required

id, example: 123

nodeIdinteger · int64required

id, example: 456

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/nodes/{nodeId}'

200

400

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T14:22:10.133Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

List K8S Container

Create K8s Cluster

List ingress providers

Delete an existing k8s container

Get detailed information for an k8s container.

update K8s Cluster

Show child attributes

Get K8s Container loadbalancer list.

Create K8s Container custom loadbalancer

Get K8s Container stats distribution of Availability Zone and Datacenter of the nodes the cluster

Get a Kubernetes containter network informations

Get a Kubernetes containter node informations

Delete a Kubernetes container node