Networks

List Compute Networks

GEThttps://api.cegedim.cloud/itcare/networking/networks

Query parameters

filtersarray of string

Filter, example: resource01,!resource02,resource42

itemsstring

publicIpboolean

publicIp

environmentsarray of string

Environments, example: QA

itemsstring

scopesarray of string

Scopes, example: frontend , backend

itemsstring

regionsarray of string

Regions, example: EB,NK

itemsstring

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.

Response

Body

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of NetworkV1 (object)

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

aliasstring

domainstring

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

numberinteger (int32)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageablePageableObject (object)

offsetinteger (int64)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageSizeinteger (int32)

pageNumberinteger (int32)

pagedboolean

unpagedboolean

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

Response

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/networking/networks/{id}/loadbalancers-networks

Path parameters

id*integer (int64)

Query parameters

scope, example: frontendstring

environment, example: productionstring

onlyNonFullboolean

cloudsinteger

Response

Body

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

aliasstring

domainstring

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

Response

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/networking/networks/{id}/loadbalancers-networks

Path parameters

id*integer (int64)

Query parameters

scope, example: frontendstring

environment, example: productionstring

onlyNonFullboolean

cloudsinteger

Response

Body

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

aliasstring

domainstring

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

Response

List Compute Networks

GEThttps://api.cegedim.cloud/itcare/networking/networks

Query parameters

filtersarray of string

Filter, example: resource01,!resource02,resource42

itemsstring

publicIpboolean

publicIp

environmentsarray of string

Environments, example: QA

itemsstring

scopesarray of string

Scopes, example: frontend , backend

itemsstring

regionsarray of string

Regions, example: EB,NK

itemsstring

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.

Response

Body

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of NetworkV1 (object)

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

aliasstring

domainstring

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

numberinteger (int32)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageablePageableObject (object)

offsetinteger (int64)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageSizeinteger (int32)

pageNumberinteger (int32)

pagedboolean

unpagedboolean

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

Response

const response = await fetch('https://api.cegedim.cloud/itcare/networking/networks/{id}/loadbalancers-networks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

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

{
  "totalElements": 0,
  "totalPages": 0,
  "first": false,
  "size": 0,
  "content": [
    {
      "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"
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": false,
      "property": "text",
      "ignoreCase": false
    }
  ],
  "pageable": {
    "offset": 0,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": false,
        "property": "text",
        "ignoreCase": false
      }
    ],
    "pageSize": 0,
    "pageNumber": 0,
    "paged": false,
    "unpaged": false
  },
  "numberOfElements": 0,
  "last": false,
  "empty": false
}