Services
OAuth2 flow
Names, example: resource01,!resource02,resource42
Environments, example: PRODUCTION,DEVELOPMENT
Statuses, example: ACTIVE,INACTIVE
Tags, example: mytagkey:mytagvalue,application:itcare
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
Results page you want to retrieve (0..N)
Number of records per page.
OK
Bad Request
OAuth2 flow
Service Id, example: 123
OK
A Service is a Resource group (instances, load balancers...), forming a coherent whole, aiming to serve an application to your customers.
Grouping criterias of resources inside a service can change, but generally are :
- Product hosted on resources,
- Environment (test / production ...),
- Client : (if application is not multi-tenant).
Ex : An application App, for client ACME< in production environment requires 4 servers, 2 databases. Those resources will be grouped inside a service called App - ACME Production.
Tells If the service accepts advanced monitoring
Cloud Name of the service
Cloud Name of the service
Short comment of service
Environment of service. Use List Statuses API method to list possible values.
Id of service
Internal key of service
Name of service
Tells If the service has subscribed to cegedim.cloud sms service
Status of service. Use List Statuses API method to list possible values.
Bad Request
OAuth2 flow
Category, example: INSTANCES
""OK
An action gives status about processing of a task previously launched by an API call and asynchronously processed.
Human readable message of status
Code of action performed
Status label of action
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Backup
Drp
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Instance object
CPU of the resource
Internal Image linked to this instance
This instance is ingress external node
This instance is ingress internal node
Instance is member of load balancer
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
OS name of this instance
OS type of this instance
RAM of the resource
Storage after disks format in GB of the resource
Information about storage replication in Progress
Total Disk size of the resource
Bad Request
OAuth2 flow
Service Id, example: 44411
Broker name, example: deblaprmq01
Broker status, example: ACTIVE
Broker version, example: 3.9
Broker size, example: 4cpu8gb
OK
Managed Data Base
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: PET1
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Families, example: DEBIAN,RHEL
Backup
Drp
withManagedNodes
withApplicationServers
withOracleDbs
withMongoNodeJs
withAppliances
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Instance object
CPU of the resource
Internal Image linked to this instance
This instance is ingress external node
This instance is ingress internal node
Instance is member of load balancer
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
OS name of this instance
OS type of this instance
RAM of the resource
Storage after disks format in GB of the resource
Information about storage replication in Progress
Total Disk size of the resource
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Statuses, example: ACTIVE,INACTIVE,PREPARATION
Versions, example: EB,ET,NK
OK
K8s Container object
Indicates backup is active on the host
Kubernetes Container Ingress Providers
Area pretty name
A list of Area name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Recent Version of the K8S Cluster
Management host of the K8S Cluster
Number of Nodes of the K8s Cluster
Storage Replication Enabled - The farm has replicated storage
Technical ID of the K8S Cluster
High availability mode status
Version of the K8S Cluster
Version of the K8S Cluster
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: www.cegedim.com,www.egypt.eg
Statuses, example: ACTIVE,INACTIVE,PREPARATION
Number of Members, example: 2
OK
LoadBalancer object
Bot Defense state
Bot Defense is updating
Advanced property such as default persistence
Advanced property such as fallback persistence
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Advanced property such as load balancing mode
Source addresse translation automap enabled
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: www.cegedim.com,www.egypt.eg
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Managed Data Base
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: PET1
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
NetworkCluster
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Bad Request
This method allows to update the partch party informations related to the given service.
Structure of payload is generic and describes :
an arraycontaining the patch party configuration to apply for each resource of the given service- If the resource is to be excluded from the patch parties, an explanation must be given.
- If the resource is to be included to the patch parties, an patchGroup should be given unless the resource is part of a cluster.
Update Patch Party Statuses
PATCH /services/1234/patch-policies
[
{
"resourceId": 500079802,
"excluded": false,
"exclusionReason": "I don't want to include this resource"
},
{
"resourceId": 500079545,
"excluded": true,
"patchGroup": "2"
},
{
"resourceId": 500057033,
"excluded": false,
"exclusionReason": "Wrong patch group is set",
"patchGroup": "1c"
},
{
"resourceId": 500057055,
"excluded": false,
"patchGroup": "1"
}
]
- The response will give the status of all the submitted resources, for example :
[
{
"status": "FAILED",
"message": "The patch group is only allowed when the farm has one member",
"id": -1,
"internalId": 500057055
},
{
"status": "IN_PROGRESS",
"message": "Include PatchParty SQLServer rhutsql20",
"process": "INCLUDE_PATCHPARTY",
"id": 500079545,
"lastUpdatedAt": "2023-11-16T11:53:42.888+00:00"
},
{
"status": "FAILED",
"message": "Wrong patch party group set",
"id": -1,
"internalId": 500057033
},
{
"id": 202
}
]
There are 3 groups available defining the sequence on which the instance should be updated: 1 (First Group), 2 (Second Group) or 3 (Third Group).
If no group is set, it means that you have no preference while defining the sequences.
OAuth2 flow
Service Id, example: 44411
boolean flag to fetch history details for every ci
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Raison why the resource should be excluded from patch party.
Id of the resource under patch party or not
Name of the resource under patch party or not
Date of the last System Upgrade.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Tag to reference the last patch party
Bad Request
OAuth2 flow
Service Id, example: 44411
Update Patch party configuration for resources of a service
OK
An action gives status about processing of a task previously launched by an API call and asynchronously processed.
Human readable message of status
Code of action performed
Status label of action
Bad Request
OAuth2 flow
Service Id, example: 44411
OK
Holds dependencies of a Service : dependencies (other services that are required for a service to be fully functional) and impacts (other services that depends on current service)
Bad Request
OAuth2 flow
Service Id, example: 44411
OK
Holds dependencies stats of a Service : number of dependencies (other services that are required for a service to be fully functional) and number of impacts (other services that depends on current service)
Number of services that are required for current service to be fully functional
Number of services that requires current service to be fully functional
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Categories, example: INSTANCES,APPLICATION_SERVERS,LOAD_BALANCERS
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Holds common properties to all Resources managed in ITCare available on a Service
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Bad Request
OAuth2 flow
Service Id, example: 44411
Names, example: devvcaglfs02
Statuses, example: ACTIVE,INACTIVE,PREPARATION
Sizing of the resource, example: 2cpu4gb
Number of nodes, example: 2
IP Address, ex: 10.10.10.10
OK
Storage Information
Area pretty name
Availability Zone pretty name
DataCenter pretty name
Region pretty name
Bad Request
OAuth2 flow
Service Id, example: 500063721
Actions, example: enable_monitoring
Statuses, example: SUCCESS
Names, example: REBITTEST01
OK
Action performed on a resource
Human readable message of status
Code of action performed
Status label of action
Bad Request
Last updated