Resources

List Compute Resources

get

Allows to list resources available in your cloud.

This endpoint could be used as a main entry to get informations about the other kind of resource types.

When the resource is retrieved, the *path* attribut allows to navigate to the right category of the resource.

For example : *path=/compute/containers/kubernetes* tells to check the sections *compute > containers > kubernetes* for more details.

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Query parameters
servicesinteger · int64[]Optional
idsinteger · int64[]Optional

IDs, example: 123,456,789

namesstring[]Optional

Names, example: resource01,!resource02,resource42

typesstring[]Optional

Types, example: WINDOWS,AIX,LINUX

familiesstring[]Optional

Families, example: DEBIAN,CENTOS,RHEL

versionsstring[]Optional

Versions, example: DEBIAN_10,CENTOS_6,RHEL_5

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Status, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

azstring[]Optional

Availability Zone, example: EB-A, EB-B, EB-C, etc...

ipstring[]Optional

IPs, example: 10.59.13.29

vlanstring[]Optional

VLAN, example: EB_1125_DMZ8

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
chevron-right
200

OK

*/*
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberinteger · int32Optional
numberOfElementsinteger · int32Optional
sizeinteger · int32Optional
totalElementsinteger · int64Optional
totalPagesinteger · int32Optional
get
/compute/resources

List Resource Metrics

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Query parameters
servicesinteger · int64[]Optional

Service Ids, example: 1234

environmentsstring[]Optional

Environment, example: PRODUCTION,QA

typesstring[]Optional

Technologies of resource. For exemple LINUX,KUBERNETES

consummablebooleanOptional

Count statistic with uncategorized types

kindstringOptional

global|count|obsolescence|service|network, example: global

startstring · date-timeOptional

Start Date (ISO8601 format), example: 2022-07-22T00:00:00.000Z

cloudsintegerOptional
Responses
chevron-right
200

OK

*/*
backupGbnumber · doubleOptional
coresCountinteger · int64Optional
countinteger · int64Optional
instancesCountinteger · int64Optional
ramGbinteger · int64Optional
scorenumberOptional

Global score computed. Maximum value is 100, minimum is 0.

servicesCountinteger · int64Optional
storageGbnumber · doubleOptional
get
/compute/resources/metrics

Returns a list of parents

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Query parameters
resourceIdsinteger · int64[]Required
Responses
chevron-right
200

OK

*/*

Holds common proprieties to all Managed Resource Nodes in ITCare

categorystringOptional

The Category of the Managed Node/URL

cloudIdinteger · int64Optional

The Cloud ID

environmentstringOptional

The Service environment

idinteger · int64Optional

ID of the Managed Node/URL

namestringOptional

Name of the Managed Node/URL

parentIdinteger · int64Optional

The parent resource id

parentTypestringOptional

The resource type of the parent

serviceIdinteger · int64Optional

The Service ID

statusstringOptional

Status of the Managed Node/URL

technologystringOptional

The parent technology

get
/compute/resources/parents

Get a compute Resource by its id

get

Gets a compute Resource by its Id.

A Resource is the ITCare base object.

A resource is composed of :

  • *id* : Unique identifier of the resource
  • *name* : Name of the resource
  • *serviceId* : Each resource must be linked to a service . The service is a logical entity that hosts resources per environment, application ...
  • *environment* : The environment of the resource. Can be for example 'PRODUCTION', 'QA', 'RECETTE_UAT', 'DEV' ...
  • *creationUser* : The creator of the resource
  • *creationTime* : When the resource has been created
  • *comment* : Description of the resource
  • *category* : High level categorization of the resource
  • *family* : Family of the resource belonging the category
  • *status* : status of the resource. It can be 'ACTIVE' (running), 'INACTIVE' (stopped)
  • *resourceType* : Type of the resource
  • *cloudId* : Each cloud
  • *cloudName* : name of the related cloud
  • *path* : Helper that gives a path or location about which category to find the resource for more details operations

When the resource is retrieved, the *path* attribute allows to navigate to the right category of the resource.

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Responses
chevron-right
200

OK

*/*

Describes a Compute Resource.

categorystringOptional
cloudNamestringOptional

Cloud Name of the resource

commentstringOptional

Brief comment or description of the resource

creationTimestringOptional
creationUserstringOptional
descriptionstringOptional
endOfSalesAtstring · date-timeOptional
endOfSupportAtstring · date-timeOptional
environmentstringOptional
extendedSupportAtstring · date-timeOptional
familystringOptional
idinteger · int64Required

Unique Identifier of the resource.

internalResourceIdinteger · int64Optional
ipAddressstringOptional
labelstringOptional
labelAreastringOptional

Area pretty name

labelAvailabilityZonestringOptional

Availability Zone pretty name

labelDataCenterstringOptional

DataCenter pretty name

labelRegionstringOptional

Region pretty name

namestringOptional

Name of the resource

pathstringOptional

API Path allowing to navigation in the resource category

platformstringOptional
prettyLabelstringOptional
productNamestringOptional
releasedAtstring · date-timeOptional
resourceTypestringOptional

type of resource

serviceIdinteger · int64Optional
serviceKeystringOptional
serviceNamestringOptional
statusstring · enumRequired

Status of resource.

Possible values:
supportLevelstring · enumOptional

Support Level

Possible values:
supportPhasestringOptional
technologystringOptional
typestringOptional
get
/compute/resources/{id}

Get a resource backup policy details

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Responses
chevron-right
200

OK

*/*
get
/compute/resources/{id}/backup-policies

Update comments

patch
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Body
descriptionstringOptional
Responses
patch
/compute/resources/{id}/comments

No content

Get a DNS record

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Representation of a dns alias record

fqdnstringOptional

The full qualified domain name (fqdn)

typestringOptional

The type of the record (A,CNAME,TXT,…)

valuestringOptional

The record name.

zonestringOptional

The related DNZ zone

get
/compute/resources/{id}/dns-aliases

Create a Dns Record

post
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Body

Model to update a DNS Record

fqdnstringOptional
typestringOptional
valuestringOptional
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Representation of a dns alias record

fqdnstringOptional

The full qualified domain name (fqdn)

typestringOptional

The type of the record (A,CNAME,TXT,…)

valuestringOptional

The record name.

zonestringOptional

The related DNZ zone

post
/compute/resources/{id}/dns-aliases

Delete a DNS Record

delete
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

fqdnstringRequired

FQDN to delete, example: my.fqdn.cegedim.cloud

Responses
chevron-right
200

OK

No content

delete
/compute/resources/{id}/dns-aliases/{fqdn}

No content

Get networks information of cluster

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json
areastringOptional
cidrstringOptional
cloudstringOptional
defaultNetworkbooleanOptional
descriptionstringOptional
environmentstringOptional
gatewaystringOptional
idinteger · int64Optional
ipAddressstringOptional
ipFreeNumberinteger · int32Optional
isIpRangePublicbooleanOptional
maskstringOptional
networkShortDescriptionstringOptional
regionstringOptional
scopestringOptional
shortDescriptionstringOptional
technicalIdstringOptional
usedPercentinteger · int32Optional
get
/compute/resources/{id}/farm-networks

List the action history of a resource.

get

Retrieves all operations and events that occurs on a resource : start, stop, monitoring operations ...

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Query parameters
actionsstring[]Optional

Actions, example: enable_monitoring

statusesstring[]Optional

Statuses, example: SUCCESS

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
chevron-right
200

OK

application/vnd.cegedim-it.v1+json
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberinteger · int32Optional
numberOfElementsinteger · int32Optional
sizeinteger · int32Optional
totalElementsinteger · int64Optional
totalPagesinteger · int32Optional
get
/compute/resources/{id}/history

List Load Balancers

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

id, example: 500060340

Query parameters
typestringRequired

type, example: MESSAGE_BROKERS

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

LoadBalancer object

backupStatusbooleanOptional
botDefenseEnabledbooleanOptional

Bot Defense state

botDefenseUpdatingbooleanOptional

Bot Defense is updating

categorystringOptional
cloudIdinteger · int64Optional
cloudNamestringOptional
commentstringOptional
creationTimestringOptional
creationUserstringOptional
defaultPersistencestringOptional

Advanced property such as default persistence

endOfSalesAtstring · date-timeOptional
endOfSupportAtstring · date-timeOptional
environmentstringOptional
extendedSupportAtstring · date-timeOptional
fallbackPersistencestringOptional

Advanced property such as fallback persistence

familystringOptional
idinteger · int64Optional
internalResourceIdinteger · int64Optional
internalTypestringOptional
ipAddressstringOptional
labelstringOptional
labelAreastringOptional

Area pretty name

labelAvailabilityZonestringOptional

Availability Zone pretty name

labelDataCenterstringOptional

DataCenter pretty name

labelRegionstringOptional

Region pretty name

loadBalancingModestringOptional

Advanced property such as load balancing mode

metrologyUrlstringOptional
monitoringRequestedbooleanOptional
namestringOptional
nodeCountinteger · int64Optional
pathstringOptional
prettyLabelstringOptional
productCodestringOptional
productNamestringOptional
productVersionstringOptional
releasedAtstring · date-timeOptional
replicationStatusbooleanOptional
resourceTypestringOptional
serviceIdinteger · int64Optional
serviceKeystringOptional
serviceNamestringOptional
snatAutomapbooleanOptional

Source addresse translation automap enabled

statusstringOptional
supportLevelstring · enumOptionalPossible values:
supportPhasestringOptional
technologystringOptional
typestringOptional
get
/compute/resources/{id}/loadbalancers

Get network information of a resource

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json
areastringOptional
cidrstringOptional
cloudstringOptional
defaultNetworkbooleanOptional
descriptionstringOptional
environmentstringOptional
gatewaystringOptional
idinteger · int64Optional
ipAddressstringOptional
ipFreeNumberinteger · int32Optional
isIpRangePublicbooleanOptional
maskstringOptional
networkShortDescriptionstringOptional
regionstringOptional
scopestringOptional
shortDescriptionstringOptional
technicalIdstringOptional
usedPercentinteger · int32Optional
get
/compute/resources/{id}/networks

List nodes

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

id, example: 500060340

Query parameters
typestringRequired

type, example: MESSAGE_BROKERS

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Instance object

authenticationDomainstringOptional
backupStatusbooleanOptional
categorystringOptional
cloudIdinteger · int64Optional
cloudNamestringOptional
commentstringOptional
cpuinteger · int64Optional

CPU of the resource

creationTimestringOptional
creationUserstringOptional
endOfSalesAtstring · date-timeOptional
endOfSupportAtstring · date-timeOptional
environmentstringOptional
extendedSupportAtstring · date-timeOptional
familystringOptional
idinteger · int64Optional
imageCodestringOptional

Internal Image linked to this instance

internalResourceIdinteger · int64Optional
internalTypestringOptional
ipAddressstringOptional
isExternalIngressNodebooleanOptional

This instance is ingress external node

isInternalIngressNodebooleanOptional

This instance is ingress internal node

isMemberOFLoadBalancerbooleanOptional

Instance is member of load balancer

labelstringOptional
labelAreastringOptional

Area pretty name

labelAvailabilityZonestringOptional

Availability Zone pretty name

labelDataCenterstringOptional

DataCenter pretty name

labelRegionstringOptional

Region pretty name

metrologyUrlstringOptional
monitoringRequestedbooleanOptional
namestringOptional
osNamestringOptional

OS name of this instance

osTypestringOptional

OS type of this instance

parentResourceTypestringOptional
pathstringOptional
prettyLabelstringOptional
productCodestringOptional
productNamestringOptional
productVersionstringOptional
raminteger · int64Optional

RAM of the resource

releasedAtstring · date-timeOptional
replicationStatusbooleanOptional
resourceTypestringOptional
serviceIdinteger · int64Optional
serviceKeystringOptional
serviceNamestringOptional
statusstringOptional
storagenumberOptional

Storage after disks format in GB of the resource

storageMoveInProgressbooleanOptional

Information about storage replication in Progress

supportLevelstring · enumOptionalPossible values:
supportPhasestringOptional
technologystringOptional
totalSizeDisksstringOptionalDeprecated

Total Disk size of the resource

typestringOptional
get
/compute/resources/{id}/nodes

Get Parent Node

get

Get the cluster containing the managed node or the load balancer if the resource is an URL

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Holds common proprieties to all Managed Resource Nodes in ITCare

categorystringOptional

The Category of the Managed Node/URL

cloudIdinteger · int64Optional

The Cloud ID

environmentstringOptional

The Service environment

idinteger · int64Optional

ID of the Managed Node/URL

namestringOptional

Name of the Managed Node/URL

parentIdinteger · int64Optional

The parent resource id

parentTypestringOptional

The resource type of the parent

serviceIdinteger · int64Optional

The Service ID

statusstringOptional

Status of the Managed Node/URL

technologystringOptional

The parent technology

get
/compute/resources/{id}/parent

Get patch party policy

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id, example: 123

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Representation of a resource patch party

excludedbooleanRequired

Tells if the resource is excluded or not from patch party

excludedBystringOptional

User who performed the exclusion from patch party action

exclusionDatestring · date-timeOptional

Date on which the exclusion from patch party was performed

exclusionReasonstringOptional

Raison why the resource should be excluded from patch party.

idinteger · int64Optional

Id of the resource under patch party or not

namestringOptional

Name of the resource under patch party or not

patchDatestring · date-timeOptional

Date of the last System Upgrade.

patchGroupstringOptional

Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference

patchTagstringOptional

Tag to reference the last patch party

get
/compute/resources/{id}/patch-policy

Remove Tags from a Resource

delete

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64RequiredExample: 123
Body

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

Responses
delete
/compute/resources/{id}/tags

No content

List Tags

get

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

Resource Id

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

get
/compute/resources/{id}/tags

Add a Tag to a Resource

post

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64RequiredExample: 123
Body

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

post
/compute/resources/{id}/tags

Replace Tags

put

Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64RequiredExample: 123
Bodyobject[]

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Simple key/value object to put on resources (services, instances, loadbalancers) to be able to search across resources easily, and to benefit dynamic resource groups.

tagKeystringRequired

Key of tag

tagValuestringRequired

Value of tag

put
/compute/resources/{id}/tags
Deprecated

Don't use anymore, use /{id}/parent

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Holds common proprieties to all Managed Resource Nodes in ITCare

categorystringOptional

The Category of the Managed Node/URL

cloudIdinteger · int64Optional

The Cloud ID

environmentstringOptional

The Service environment

idinteger · int64Optional

ID of the Managed Node/URL

namestringOptional

Name of the Managed Node/URL

parentIdinteger · int64Optional

The parent resource id

parentTypestringOptional

The resource type of the parent

serviceIdinteger · int64Optional

The Service ID

statusstringOptional

Status of the Managed Node/URL

technologystringOptional

The parent technology

get
/compute/resources/{id}/urls

Verifies the existence of a resource

head
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
namestringRequired
Query parameters
typestringOptional
Responses
chevron-right
200

OK

No content

head
/compute/resources/{name}

No content

Last updated