Topology

List Regions where resources can be hosted

List Region

List Regions where resources are hosted

get

/topology/regions

Authorizations

Query parameters

platformId, example: deb8string

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions'

200

400

200

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

OK

Get Region by Id

List Area

A low-latency network area, in which we can create load balancers to address several availabilty-zones within this area.

Use param withAvailabilityZones=true to retrieve Availability Zones of the region.

get

/topology/regions/{region}

Authorizations

Path parameters

regionstringrequired

Region Name, example: EB

Query parameters

withAreasboolean · default: false

Include Areas

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{region}'

200

400

200

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

OK

List Areas

List Area

A low-latency network area, in which we can create load balancers to address several availabilty-zones within this area.

Use param withAvailabilityZones=true to retrieve Availability Zones of the region.

get

/topology/regions/{region}/areas

Authorizations

Path parameters

regionstringrequired

Region Name, example: EB

Query parameters

platformIdstring

Platform Id, example: deb10

withAvailabilityZonesboolean · default: true

Include Availability Zone

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{region}/areas'

200

400

200

[
  {
    "availabilityZones": [
      {
        "availabilityZoneGroup": "text",
        "datacenterId": "text",
        "defaultZone": true,
        "id": "text",
        "location": "text",
        "routable": true
      }
    ],
    "defaultArea": true,
    "id": "text",
    "location": "text",
    "regulation": "text"
  }
]

OK

List Area Networks

List Area Network

This method returns the list of accessible networks from an Area.

Parameters

• scope filter by network scope
• onlyNonFull if you want only networks with available IP addresses to be listed

get

/topology/regions/{region}/areas/{area}/networks

Authorizations

Path parameters

regionstringrequired

Region Name, example: EB

areastringrequired

Area Name, example: EB-QA

Query parameters

scope, example: frontendstring

onlyNonFull, example: falseboolean

onlyLoadBalancer, example: falseboolean

cloudsinteger

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/networks'

200

400

200

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

OK

List Load Balancing Networks

List Load Balancing Networks

This method returns the list of accessible networks from a Load balancing Zone.

Available Parameters:

• scope query parameter to filter private, interco, internet networks. for 'frontend' and 'backend' networks, use scope=private
• environment query parameter to filter production, non_production networks. for 'production' networks, use environment=production
• onlyNonFull if you want only networks with available IP addresses to be listed.
• clouds parameter (comma-separated list of long) to restrict results to specified Clouds IDs (use the /me to obtain the list of your Clouds).

get

/topology/regions/{region}/areas/{area}/loadbalancers-networks

Authorizations

Path parameters

regionstringrequired

Region Name, example: EB

areastringrequired

Area Name, example: EB-QA

Query parameters

scope, example: privatestring

environment, example: productionstring

onlyNonFull, example: falseboolean

cloudsinteger

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/loadbalancers-networks'

200

400

200

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

OK

List health checks that are present for a given region and area

List health checks that are present for a given region and area

A healthcheck is a test performed on a loadbalanced url to retrieve the status of the service Use the clouds parameter (comma-separated list of long) to restrict results to specified Clouds IDs (use the /me to obtain the list of your Clouds).

get

/topology/regions/{region}/areas/{area}/healthchecks

Authorizations

Path parameters

regionstringrequired

Region Name, example: EB

areastringrequired

Area Name, example: EB-QA

Query parameters

cloudsinteger

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/healthchecks'

200

400

200

[
  {
    "comment": "text",
    "description": "text",
    "id": 1,
    "name": "text"
  }
]

OK

List Availability Zones Networks

List Availability Zones Network

This method returns the list of accessible networks from an Availability Zone.

You can use scope query parameter to filter frontend/backend networks,

and onlyNonFull if you want only networks with available IP addresses to be listed

get

/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks

Authorizations

Path parameters

regionstringrequired

Region Name, example: EB

areastringrequired

Area Name, example: EB-QA

azstringrequired

AZ Name, example: EB-QA-A

Query parameters

scope, example: frontendstring

environment, example: productionstring

onlyNonFull, example: falseboolean

onlyLoadBalancer, example: falseboolean

cloudsinteger

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks'

200

400

200

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

OK

List Authentication Domains

List Authentication Domains

This method returns the list of accessible authentication domains within a network.

get

/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks/{network}/authentication-domains

Authorizations

Path parameters

regionstringrequired

Region Name, example: EB

areastringrequired

Area Name, example: EB-QA

azstringrequired

AZ Name, example: EB-QA-A

networkstringrequired

Network Id, example: 123

Query parameters

platform, example: deb11string

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks/{network}/authentication-domains'

200

400

200

[
  {
    "description": "text",
    "id": "text",
    "isDefault": true
  }
]

OK

List SSL Profiles available in a load balancing and related to a certificates in a specific region and area

get

/topology/regions/{regionId}/areas/{areaId}/ssl-profiles

Authorizations

Path parameters

regionIdstringrequired

Example: EB

areaIdstringrequired

Example: EB-INT

Query parameters

certificatestring · default:

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{regionId}/areas/{areaId}/ssl-profiles'

200

400

200

[
  {
    "certificat": "text",
    "description": "text",
    "id": 1,
    "name": "text",
    "serverName": "text",
    "sniDefault": true
  }
]

OK

List Certificates available in a specific region and area

get

/topology/regions/{regionId}/areas/{areaId}/certificates

Authorizations

Path parameters

regionIdstringrequired

Example: EB

areaIdstringrequired

Example: EB-INT

Query parameters

domainstringrequired

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/topology/regions/{regionId}/areas/{areaId}/certificates?domain=text'

200

400

200

[
  {
    "certificateName": "text",
    "commonName": "text",
    "description": "text",
    "expirationDate": "text",
    "id": 1
  }
]

OK