cegedim.cloudITCareAPI

Topology

List Regions where resources can be hosted

get

List Region

List Regions where resources are hosted

Authorizations
Query parameters
platformId, example: deb8stringOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
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"
  }
]

List Certificates available in a specific region and area

get
Authorizations
Path parameters
regionIdstringRequiredExample: EB
areaIdstringRequiredExample: EB-INT
Query parameters
domainstringRequired
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
GET /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
  }
]

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

get
Authorizations
Path parameters
regionIdstringRequiredExample: EB
areaIdstringRequiredExample: EB-INT
Query parameters
certificatestringOptionalDefault: ""
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
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
  }
]

Get Region by Id

get

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.

Authorizations
Path parameters
regionstringRequired

Region Name, example: EB

Query parameters
withAreasbooleanOptional

Include Areas

Default: false
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
GET /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"
}

List Areas

get

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.

Authorizations
Path parameters
regionstringRequired

Region Name, example: EB

Query parameters
platformIdstringOptional

Platform Id, example: deb10

withAvailabilityZonesbooleanOptional

Include Availability Zone

Default: true
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
GET /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"
  }
]

List Availability Zones Networks

get

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

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: frontendstringOptional
environment, example: productionstringOptional
onlyNonFull, example: falsebooleanOptional
onlyLoadBalancer, example: falsebooleanOptional
cloudsintegerOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
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
  }
]

List Authentication Domains

get

List Authentication Domains

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

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: deb11stringOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
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
  }
]

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

get

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

Authorizations
Path parameters
regionstringRequired

Region Name, example: EB

areastringRequired

Area Name, example: EB-QA

Query parameters
cloudsintegerOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
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"
  }
]

List Load Balancing Networks

get

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).
Authorizations
Path parameters
regionstringRequired

Region Name, example: EB

areastringRequired

Area Name, example: EB-QA

Query parameters
scope, example: privatestringOptional
environment, example: productionstringOptional
onlyNonFull, example: falsebooleanOptional
cloudsintegerOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
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
  }
]

List Area Networks

get

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
Authorizations
Path parameters
regionstringRequired

Region Name, example: EB

areastringRequired

Area Name, example: EB-QA

Query parameters
scope, example: frontendstringOptional
onlyNonFull, example: falsebooleanOptional
onlyLoadBalancer, example: falsebooleanOptional
cloudsintegerOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
get
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
  }
]
PreviousTopologyNextProducts

Last updated