Networks
Authorizations
Query parameters
filtersstring[]Optional
Filter, example: resource01,!resource02,resource42
publicIpbooleanOptional
publicIp
environmentsstring[]Optional
Environments, example: QA
scopesstring[]Optional
Scopes, example: frontend , backend
regionsstring[]Optional
Regions, example: EB,NK
cloudsintegerOptional
pagestringOptional
Results page you want to retrieve (0..N)
sizestringOptional
Number of records per page.
sortanyOptional
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
Responses
200
OK
*/*
400
Bad Request
*/*
get
GET /itcare/networking/networks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"content": [
{
"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
}
],
"empty": true,
"first": true,
"last": true,
"number": 1,
"numberOfElements": 1,
"pageable": {
"offset": 1,
"pageNumber": 1,
"pageSize": 1,
"paged": true,
"sort": [
{
"ascending": true,
"direction": "text",
"ignoreCase": true,
"nullHandling": "text",
"property": "text"
}
],
"unpaged": true
},
"size": 1,
"sort": [
{
"ascending": true,
"direction": "text",
"ignoreCase": true,
"nullHandling": "text",
"property": "text"
}
],
"totalElements": 1,
"totalPages": 1
}
List Load Balancing Networks
This method returns the list of accessible networks from a Load balancing Zone.
Available Parameters:
scope
query parameter to filterprivate
,interco
,internet
networks. for 'frontend' and 'backend' networks, usescope=private
environment
query parameter to filterproduction
,non_production
networks. for 'production' networks, useenvironment=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
idinteger · int64Required
Query parameters
scope, example: frontendstringOptional
environment, example: productionstringOptional
onlyNonFullbooleanOptional
cloudsintegerOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/networks/{id}/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
}
]
Last updated