Topology
Last updated
English
Last updated
List Regions where resources are hosted
GET /itcare/topology/regions HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"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"
}
]EBEB-INTGET /itcare/topology/regions/{regionId}/areas/{areaId}/certificates HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"certificateName": "text",
"commonName": "text",
"description": "text",
"expirationDate": "text",
"id": 1
}
]EBEB-INT""GET /itcare/topology/regions/{regionId}/areas/{areaId}/ssl-profiles HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"certificat": "text",
"description": "text",
"id": 1,
"name": "text",
"serverName": "text",
"sniDefault": true
}
]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.
Region Name, example: EB
Include Areas
falseGET /itcare/topology/regions/{region} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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"
}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.
Region Name, example: EB
Platform Id, example: deb10
Include Availability Zone
trueGET /itcare/topology/regions/{region}/areas HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"availabilityZones": [
{
"availabilityZoneGroup": "text",
"datacenterId": "text",
"defaultZone": true,
"id": "text",
"location": "text",
"routable": true
}
],
"defaultArea": true,
"id": "text",
"location": "text",
"regulation": "text"
}
]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
Region Name, example: EB
Area Name, example: EB-QA
AZ Name, example: EB-QA-A
GET /itcare/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"area": "text",
"cidr": "text",
"cloud": "text",
"defaultNetwork": true,
"description": "text",
"dns": [
{
"alias": "text",
"domain": "text"
}
],
"environment": "text",
"gateway": "text",
"id": 1,
"ipAddress": "text",
"ipFreeNumber": 1,
"isIpRangePublic": true,
"mask": "text",
"networkShortDescription": "text",
"region": "text",
"scope": "text",
"shortDescription": "text",
"technicalId": "text",
"usedPercent": 1
}
]This method returns the list of accessible authentication domains within a network.
Region Name, example: EB
Area Name, example: EB-QA
AZ Name, example: EB-QA-A
Network Id, example: 123
GET /itcare/topology/regions/{region}/areas/{area}/availability-zones/{az}/networks/{network}/authentication-domains HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"description": "text",
"id": "text",
"isDefault": true
}
]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).
Region Name, example: EB
Area Name, example: EB-QA
GET /itcare/topology/regions/{region}/areas/{area}/healthchecks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"comment": "text",
"description": "text",
"id": 1,
"name": "text"
}
]This method returns the list of accessible networks from a Load balancing Zone.
scope query parameter to filter private, interco, internet networks. for 'frontend' and 'backend' networks, use scope=privateenvironment query parameter to filter production, non_production networks. for 'production' networks, use environment=productiononlyNonFull 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).Region Name, example: EB
Area Name, example: EB-QA
GET /itcare/topology/regions/{region}/areas/{area}/loadbalancers-networks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"area": "text",
"cidr": "text",
"cloud": "text",
"defaultNetwork": true,
"description": "text",
"dns": [
{
"alias": "text",
"domain": "text"
}
],
"environment": "text",
"gateway": "text",
"id": 1,
"ipAddress": "text",
"ipFreeNumber": 1,
"isIpRangePublic": true,
"mask": "text",
"networkShortDescription": "text",
"region": "text",
"scope": "text",
"shortDescription": "text",
"technicalId": "text",
"usedPercent": 1
}
]This method returns the list of accessible networks from an Area.
scope filter by network scopeonlyNonFull if you want only networks with available IP addresses to be listedRegion Name, example: EB
Area Name, example: EB-QA
GET /itcare/topology/regions/{region}/areas/{area}/networks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"area": "text",
"cidr": "text",
"cloud": "text",
"defaultNetwork": true,
"description": "text",
"dns": [
{
"alias": "text",
"domain": "text"
}
],
"environment": "text",
"gateway": "text",
"id": 1,
"ipAddress": "text",
"ipFreeNumber": 1,
"isIpRangePublic": true,
"mask": "text",
"networkShortDescription": "text",
"region": "text",
"scope": "text",
"shortDescription": "text",
"technicalId": "text",
"usedPercent": 1
}
]