Topology

List Regions where resources can be hosted

List Region

List Regions where resources are hosted

GEThttps://api.cegedim.cloud/itcare/topology/regions

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idstring

locationstring

areasarray of AreaV1 (object)

dataCenterstring

Request

JavaScriptCurlPython

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

Response

200

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

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.

GEThttps://api.cegedim.cloud/itcare/topology/regions/{region}

Path parameters

region*string

Region Name, example: EB

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idstring

locationstring

areasarray of AreaV1 (object)

dataCenterstring

Request

JavaScriptCurlPython

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

Response

200

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

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.

GEThttps://api.cegedim.cloud/itcare/topology/regions/{region}/areas

Path parameters

region*string

Region Name, example: EB

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idstring

locationstring

regulationstring

defaultAreaboolean

availabilityZonesarray of AvailabilityZoneV1 (object)

Request

JavaScriptCurlPython

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

Response

200

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

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

GEThttps://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/networks

Path parameters

region*string

Region Name, example: EB

area*string

Area Name, example: EB-QA

Query parameters

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/topology/regions/{region}/areas/{area}/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"
  }
]

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).

GEThttps://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/loadbalancers-networks

Path parameters

region*string

Region Name, example: EB

area*string

Area Name, example: EB-QA

Query parameters

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/topology/regions/{region}/areas/{area}/loadbalancers-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"
  }
]

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).

GEThttps://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/healthchecks

Path parameters

region*string

Region Name, example: EB

area*string

Area Name, example: EB-QA

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

descriptionstring

commentstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/healthchecks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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

GEThttps://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks

Path parameters

region*string

Region Name, example: EB

area*string

Area Name, example: EB-QA

az*string

AZ Name, example: EB-QA-A

Query parameters

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/topology/regions/{region}/areas/{area}/availability-zones/{az}/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"
  }
]

List Authentication Domains

List Authentication Domains

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

GEThttps://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks/{network}/authentication-domains

Path parameters

region*string

Region Name, example: EB

area*string

Area Name, example: EB-QA

az*string

AZ Name, example: EB-QA-A

network*string

Network Id, example: 123

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idstring

descriptionstring

isDefaultboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks/{network}/authentication-domains', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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

GEThttps://api.cegedim.cloud/itcare/topology/regions/{regionId}/areas/{areaId}/ssl-profiles

Path parameters

regionId*string

Example: "EB"

areaId*string

Example: "EB-INT"

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

namestring

descriptionstring

certificatstring

serverNamestring

sniDefaultboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/topology/regions/{regionId}/areas/{areaId}/ssl-profiles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "name": "text",
    "description": "text",
    "certificat": "text",
    "serverName": "text",
    "sniDefault": false
  }
]

List Certificates available in a specific region and area

GEThttps://api.cegedim.cloud/itcare/topology/regions/{regionId}/areas/{areaId}/certificates

Path parameters

regionId*string

Example: "EB"

areaId*string

Example: "EB-INT"

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

certificateNamestring

commonNamestring

descriptionstring

expirationDatestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/topology/regions/{regionId}/areas/{areaId}/certificates?domain=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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