Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
OK
OK
OK
Resource Id, example: 123
FQDN to delete, example: my.fqdn.cegedim.cloud
OK
Service Id, example: 123
OK
Resource Id, example: 123
Resource/Node Ids, example: 123
Operation Type, example: available|available-nodes|in-progress|in-progress-nodes|list-actions-in-progress|list-available-actions
OK
Compute resource types : a compute can be a service or a resource (instance, db, url, ... )
OK
No Content
findComputeEnvironment
OK
OK
Key of tag
Value of tag
OK
Key of tag
Value of tag
K8sCluster Id, example: 123
type, example: az-distribution | dc-distribution
OK
Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.
123Key of tag
Value of tag
No Content
Service Id, example: 44411
OK
Number of services that are required for current service to be fully functional
Number of services that requires current service to be fully functional
Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.
Resource Id
OK
Key of tag
Value of tag
Resource Id, example: 123
OK
The type of the record (A,CNAME,TXT,…)
The full qualified domain name (fqdn)
The record name.
The related DNZ zone
Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.
123Key of tag
Value of tag
OK
Key of tag
Value of tag
Tags allows you to qualify your resources with a custom set of key-value pairs. Tags will be accessible using ITCare search.
123Key of tag
Value of tag
OK
Key of tag
Value of tag
OK
Resource Id, example: 123
Snapshot Id, example: 123-snap-42
OK
Code of action performed
Status label of action
Human readable message of status
Resource Id, example: 123
OK
Code of action performed
Status label of action
Human readable message of status
Service Ids, example: 1234
Environment, example: PRODUCTION,QA
Technologies of resource. For exemple LINUX,KUBERNETES
Count statistic with uncategorized types
global|count|obsolescence|service|network, example: global
Start Date (ISO8601 format), example: 2022-07-22T00:00:00.000Z
OK
Global score computed. Maximum value is 100, minimum is 0.
Category, example: INSTANCES
OK
Code of action performed
Status label of action
Human readable message of status
This method allows to delete a Kubernetes cluster node.
This operation cannot be undone afterwards.
This method is synchronous (status code 202).
To delete a Kubernetes node, the id of the Kubernetes cluster and the id of the node to delete must be specified.
To list the nodes of the Kubernetes cluster, use the endpoint : GET /containers/kubernetes/{kuberneteId}/nodes/{nodeId}.
Use the following to delete a node of a Kubernetes cluster.
DELETE /containers/kubernetes/1234/nodes/4567
To keep consistency on the Kubernetes cluster, please note that :
All nodes cannot be deleted.
All ingress nodes cannot be deleted.
API users will have a BAD_REQUEST when trying to break one of the rule above.
id, example: 123
id, example: 456
OK
Code of action performed
Status label of action
Human readable message of status
Service Id, example: 1234
availabilityZone
policyType, example: SERVER
backupReplicated
OK
BackupPolicy Id, example: 123
OK
Service Id, example: 500063721
Actions, example: enable_monitoring
Statuses, example: SUCCESS
Names, example: REBITTEST01
OK
Code of action performed
Status label of action
Human readable message of status
Resource Id, example: 123
Actions, example: enable_monitoring
Statuses, example: SUCCESS
OK
Code of action performed
Status label of action
Human readable message of status
Resource Id, example: 123
OK
Resource Id, example: 123
OK
The type of the record (A,CNAME,TXT,…)
The full qualified domain name (fqdn)
The record name.
The related DNZ zone
Resource Id, example: 123
OK
Resource Id, example: 123
OK
OK
ID of the Managed Node/URL
Name of the Managed Node/URL
Status of the Managed Node/URL
The Service ID
The Service environment
The Cloud ID
The resource type of the parent
The parent resource id
The Category of the Managed Node/URL
The parent technology
OK
ID of the Managed Node/URL
Name of the Managed Node/URL
Status of the Managed Node/URL
The Service ID
The Service environment
The Cloud ID
The resource type of the parent
The parent resource id
The Category of the Managed Node/URL
The parent technology
Resource Id, example: 123
OK
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Resource Id, example: 123
OK
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
This method allows to update the partch party informations related to the given service.
Structure of payload is generic and describes :
an array containing the patch party configuration to apply for each resource of the given serviceUpdate 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"
}
]
[
{
"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.
Service Id, example: 44411
boolean flag to fetch history details for every ci
OK
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Platform, example: cent7, ubu22
OK
true = display all technologies, false = display only technologies on which resources are available, example: false
OK
This method allows to delete an instance.
Instance has to be in INACTIVE status, meaning that you have to stop it before deleting it. Use Update Instance PATCH method with stop operation prior to this deletion.
This operation cannot be undone afterwards.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
Example (no body required) :
DELETE /instances/1233
With additional change reference :
DELETE /instances/1233
{
"changeReference": "RFC_123"
}
id, example: 123
Optional reference for change
OK
Code of action performed
Status label of action
Human readable message of status
This method allows to delete a K8s Cluster Container.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
DELETE /k8s-clusters/123
DELETE /k8s-clusters/123
{
"changeReference": "rfc nunmber 456"
}
id, example: 123
Optional reference for change
OK
Code of action performed
Status label of action
Human readable message of status
Resource Id, example: 123
OK
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
OK
Resource Id, example: 123
Snapshot description
Optional change reference
OK
Code of action performed
Status label of action
Human readable message of status
Service Id, example: 123
OK
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that are required for current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that requires current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
IDs, example: MARIADB or KUBERNETES or...
OK
This method allows to update an instance.
Structure of payload is generic and describes :
operation you want to be performedoptions to pass to operation to have the operation performed.Below are different operations currently implemented.
Stop an Instance
Use the stop operation to perform the stop of instance.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
Use this method only if instance is running and is in the ACTIVE state. Otherwise a 400 status error code will be returned.
PATCH /instances/1234
{
"operation": "stop"
}
You can also put an optional changeReference if you want ITCare keep a reference to external change management system :
PATCH /instances/1234
{
"operation": "stop",
"options": {
"changeReference": "RFC_123"
}
}
Start an Instance
Use the start operation to perform the start of instance.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
Use this method only if instance is not running and is in the INACTIVE state. Otherwise a 400 status error code will be returned.
PATCH /instances/1234
{
"operation": "start"
}
You can also put an optional changeReference if you want ITCare keep a reference to external change management system :
PATCH /instances/1234
{
"operation": "start",
"options": {
"changeReference": "RFC_123"
}
}
Reset an Instance
Use the reset operation to perform the reset of instance.
Reset operation will perform a hard reset of instance, like power off/power on.
This operation may result in data loss, your applications and services will not be stopped gracefully.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
Use this method only if instance is running and is in the ACTIVE state. Otherwise a 400 status error code will be returned.
PATCH /instances/1234
{
"operation": "reset"
}
You can also put an optional comment that will be display in monitoring system :
PATCH /instances/1234
{
"operation": "reset",
"options": {
"comment": "Reset instance because OS is freezed"
}
}
Resize an Instance
Use the resize operation to perform the resize of instance.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
Use this method only if instance is not running and is in the INACTIVE or ACTIVE state. Otherwise a 400 status error code will be returned.
PATCH /instances/1234
{
"operation": "resize",
"options": {
"sizing": "2cpu4gb",
"changeReference": ""
}
}
Update Monitoring
Use the update_monitoring operation to update the monitoring state of the instance.
Use the state option to turn on/off monitoring.
Use the alerting option to turn on/off alerting. When alerting is desactivated, no incident will be handled when the ressource is has alerts.
This method is asynchronous (status code 202).
PATCH /instances/1234
{
"operation": "update_monitoring",
"options": {
"state": true,
"alerting": false
}
}
Update Patch Party Statuses
Use the operation update_patch_party to manage the patch party settings of your instances.
2 options are available :
PATCH /instances/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": true,
"exclusionReason": "I want to handle this App. by myself"
}
}
}
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.
PATCH /instances/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": false,
"patchGroup": 3
}
}
}
Replication management
Use the operation update_storage_replication to manage the replication settings of your instances.
2 options are available :
PATCH /instances/1234
{
"operation": "update_storage_replication",
"options": {
"state": false
}
}
PATCH /instances/1234
{
"operation": "update_storage_replication",
"options": {
"state": true
}
}
PATCH /instances/1234
{
"operation": "update_storage_replication",
"options": {
"state": true,
"deactivationReason": "I want it ..."
}
}
Instance Backup Management
Use the update_backup operation to enable/disable instance backup.
Requirements to update manage backup are :
2 options are available:
PATCH /instances/1234
{
"operation": "update_backup",
"options": {
"state": true
}
}
PATCH /instances/1234
{
"operation": "update_backup",
"options": {
"state": false,
"deactivationReason": "Because.."
}
}
id, example: 123
OK
Code of action performed
Status label of action
Human readable message of status
This method allows to update a cluster.
Structure of payload is generic and describes :
operation you want to be performedoptions data relative to the operation performed - see details.Below are different operations currently implemented.
Create Nodes
Use the create_nodes operation to create the nodes of a cluster.
Create nodes operation will add the new nodes in the cluster by availability zone. You can specify the availability zone you need in the request.
This method is synchronous (status code 202).
Example :
PATCH /containers/kubernetes/1234
{
"operation": "create_nodes",
"options": {
"nodes": [
{
"nodesNb": 1,
"nodeSizing": "2cpu4gb",
"az": "EB-A"
},
{
"nodesNb": 2,
"nodeSizing": "4cpu8gb",
"az": "EB-B"
}
]
}
}
Delete Nodes
Use the delete_nodes operation to delete the nodes of a cluster.
This operation cannot be undone afterwards.
This method is synchronous (status code 202).
PATCH /containers/kubernetes/1234
{
"operation":"delete_nodes",
"options":{
"nodes": ["11112","11113","11114"]
}
}
Enable High Availability - HA
Use the enable_ha operation to enable the HA of a cluster.
This operation cannot be undone afterwards.
This method is synchronous (status code 202).
PATCH /containers/kubernetes/1234
{
"operation":"enable_ha"
}
Update Monitoring
Use the update_monitoring operation to update the monitoring state of the cluster.
Use the state option to turn on/off monitoring.
Use the on_call option to turn on/off 24/7 monitoring.
This method is synchronous (status code 202).
PATCH /containers/kubernetes/1234
{
"operation": "update_monitoring",
"options": {
"state": true,
"on_call": true
}
}
Update Patch Party
Use the update_patch_party operation to update the patch party scheduled plan of the cluster.
excluded option to turn on/off patch party.patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.exclusionReason option to explain the reason of excluding the resource from patch part.This method is synchronous (status code 202).
PATCH /containers/kubernetes/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": false,
"patchGroup": "3"
}
}
}
PATCH /containers/kubernetes/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": true,
"exclusionReason": "I want to handle this by myself"
}
}
}
Upgrade
Use the upgrade operation to upgrade the cluster.
version option to set the target version to be installed.The requirements are :
/compute/platform/products?type=KUBERNETES to list all versions available for the cluster.This method is synchronous (status code 202).
PATCH /containers/kubernetes/1234
{
"operation": "upgrade",
"options": {
"version": "1.24"
}
}
K8s Cluster Id, example: 123
OK
Code of action performed
Status label of action
Human readable message of status
Service Id, example: 44411
OK
Code of action performed
Status label of action
Human readable message of status
Resource Id, example: 123
OK
IDs, example: 123,456,789
Names, example: resource01,!resource02,resource42
Types, example: WINDOWS,AIX,LINUX
Families, example: DEBIAN,CENTOS,RHEL
Versions, example: DEBIAN_10,CENTOS_6,RHEL_5
Environments, example: PRODUCTION,DEVELOPMENT
Status, example: ACTIVE,INACTIVE
Tags, example: mytagkey:mytagvalue,application:itcare
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
OK
Unique Identifier of the resource.
Name of the resource
Brief comment or description of the resource
List of tags - metadata associated to this resource.
Key of tag
Value of tag
Status of resource.
type of resource
Cloud Name of the resource
API Path allowing to navigation in the resource category
Returns list of platforms, their current support phase and milestones concerning their phases of support.
Platform name, example: PaaS OpenSearch
OK
Id of the platform (ex : deb8 for Debian 8)
Short human readable description (ex. Debian 8)
Detailed description (ex: Debian 8 (jessie) operating system)
Internal Key of the platform.
Release date of platform.
End of sales date of platform.
Extended support date of platform.
End of support date of platform.
Current support phase of platform.
Current support phase of platform.
Pretty label of platform.
Names, example: resource01,!resource02,resource42
Types, example: TOMCAT or WILDFLY or WEB_ZONE
Families, example: DEBIAN,CENTOS,RHEL
Environments, example: PRODUCTION,DEVELOPMENT
Status, example: ACTIVE,INACTIVE
Tags, example: mytagkey:mytagvalue,application:itcare
Filter list by monitoring status
Filter list by monitoring on call status
Filter list by backup status
Filter list by DRP status
Filter list by patch party status
Availability Zone, example: EB-A, EB-B, EB-C, etc...
IPs, example: 10.59.13.29
VLAN, example: EB_1125_DMZ8
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Service Id, example: 44411
OK
Services that are required for current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that are required for current service to be fully functional
Services that requires current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that requires current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that are required for current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that requires current service to be fully functional
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
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that are required for current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Services that requires current service to be fully functional
Id of service
Name of service
Status of service. Use List Statuses API method to list possible values.
Environment of service. Use List Statuses API method to list possible values.
Internal key of service
Short comment of service
Cloud Name of the service
Cloud Name of the service
Tells If the service has subscribed to cegedim.cloud sms service
Tells If the service accepts advanced monitoring
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)
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Categories, example: INSTANCES,APPLICATION_SERVERS,LOAD_BALANCERS
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
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 operationsWhen the resource is retrieved, the *path* attribut allows to navigate to the right category of the resource.
Resource Id, example: 123
OK
Unique Identifier of the resource.
Name of the resource
Brief comment or description of the resource
List of tags - metadata associated to this resource.
Key of tag
Value of tag
Status of resource.
type of resource
Cloud Name of the resource
API Path allowing to navigation in the resource category
Service Id, example: 44411
Broker name, example: deblaprmq01
Broker status, example: ACTIVE
Broker version, example: 3.9
Broker size, example: 4cpu8gb
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Type, example: KUBERNETES
OK
Tells if the product if available to create resources on it.
Pretty label of platform.
Release date of product.
End of sales date of product.
Extended support date of product.
End of support date of product.
Support phase of product.
Order in which the category is displayed (rendering purposes).
Order in which the family is displayed (rendering purposes).
Order in which the technology is displayed (rendering purposes).
Technology leads to specific forms.
Support Form to be used in case not available for automation.
Version of the product if any.
Edition of the product if any.
Product magic form
Tell if a Support Form is ready to be used in case not available for automation.
Tell if the product can be displayed (rendering purposes).
Is product Disabled (e.g : when ongoing issue on the product ...)?.
Tell if the product is in beta mode
Tell if the product is skipping technology
Service Id, example: 44411
Names, example: PET1
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Service Id, example: 44411
Names, example: PET1
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
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
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Service Id, example: 44411
Names, example: www.cegedim.com,www.egypt.eg
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
This method allows to create a cluster.
You will have to know at the minimum :
area attribute)networkId attribute)name attribute)nodeSizing attribute)instanceCount attribute)serviceId attribute)This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
POST /clusters
{
"name": "PCLUSTER01",
"area": "EB",
"networkId": "ED145",
"serviceId": 123,
"nodeSizing":, "1cpu2gb"
"instanceCount": 2
}
id of service to put instance in.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.
Indicates why a production resource is not under monitoring.
Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.
Indicates if alerting should be activated. If absent, set to false.
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
Indicates why a production resource is not under backup.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
Indicates why a production resource is not replicated.
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Node sizing for cluster
The network Id of the ELS cluster
Product platform of the cluster
Name of k8s cluster
[a-z0-9\-]+Number of instances to create in k8s cluster
Kubernetes Container Ingress Providers
OK
Code of action performed
Status label of action
Human readable message of status
Resource Id, example: 1234
Service Id, example: 56789
Platform, example: Debian 8
Support Phases, example: STANDARD,EXTENDED
Start Date (ISO8601 format), example: 2022-07-22T00:00:00.000Z
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
OK
Unique Identifier of the resource.
Name of the resource
Brief comment or description of the resource
List of tags - metadata associated to this resource.
Key of tag
Value of tag
Status of resource.
type of resource
Cloud Name of the resource
API Path allowing to navigation in the resource category
K8sCluster Id, example: 123
id of service to put instance in.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.
Indicates why a production resource is not under monitoring.
Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.
Indicates if alerting should be activated. If absent, set to false.
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
Indicates why a production resource is not under backup.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
Indicates why a production resource is not replicated.
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
url of load balancer. Must be unique, and fit naming rules convention., example: url.cegedim.com
^(https?:\\/\\/)?(www\\.)?[a-zA-Z][a-zA-Z0-9.-]{2,63}+$profile name of load balancer.
healtcheck of load balancer., example: http
port member of load balancer., example: 80, 443, ...
Network id. Refer to networks available in List Networks method. If absent, a default network of AZ will be used.
certificate of the load balancer., example: wildcard_cegedim.com
ssl profile of the load balancer., example: profile_wildcard.cegedim.com_secure
port of load balancer in case of TCP VS Profile
Indicates if a DNS record is to be set. If absent, set to false.
OK
Code of action performed
Status label of action
Human readable message of status
Type, example: LINUX, WINDOWS, SQLSERVER, APACHE_KAFKA
OK
Tells if the product if available to create resources on it.
Pretty label of platform.
Release date of product.
End of sales date of product.
Extended support date of product.
End of support date of product.
Support phase of product.
Order in which the category is displayed (rendering purposes).
Order in which the family is displayed (rendering purposes).
Order in which the technology is displayed (rendering purposes).
Technology leads to specific forms.
Support Form to be used in case not available for automation.
Version of the product if any.
Edition of the product if any.
Product magic form
Tell if a Support Form is ready to be used in case not available for automation.
Tell if the product can be displayed (rendering purposes).
Is product Disabled (e.g : when ongoing issue on the product ...)?.
Tell if the product is in beta mode
Tell if the product is skipping technology
Resource Id, example: 123
OK
Storage Replication Enabled - The farm has replicated storage
Indicates backup is active on the host
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Number of Nodes of the K8s Cluster
High availability mode status
Version of the K8S Cluster
Version of the K8S Cluster
Management host of the K8S Cluster
Technical ID of the K8S Cluster
A list of Area name
A list of Area name
Region pretty name
Kubernetes Container Ingress Providers
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Statuses, example: ACTIVE,INACTIVE,PREPARATION
Versions, example: EB,ET,NK
OK
Storage Replication Enabled - The farm has replicated storage
Indicates backup is active on the host
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Number of Nodes of the K8s Cluster
High availability mode status
Version of the K8S Cluster
Version of the K8S Cluster
Management host of the K8S Cluster
Technical ID of the K8S Cluster
A list of Area name
A list of Area name
Region pretty name
Kubernetes Container Ingress Providers
Resource Id, example: 123
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Backup
Drp
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Names, example: resource01,!resource02,resource42
Environments, example: PRODUCTION,DEVELOPMENT
Status, example: ACTIVE,INACTIVE
Tags, example: agkey:mytagvalue,application:itcare
Filter list by monitoring status
Filter list by monitoring on call status
Filter list by backup status
Filter list by DRP status
Filter list by patch party status
Topology, example: Standard, HA
Version, example: v1.26.15, v1.28.13, etc...
Region, example: EB,ET
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
OK
Storage Replication Enabled - The farm has replicated storage
Indicates backup is active on the host
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Number of Nodes of the K8s Cluster
High availability mode status
Version of the K8S Cluster
Version of the K8S Cluster
Management host of the K8S Cluster
Technical ID of the K8S Cluster
A list of Area name
A list of Area name
Region pretty name
Kubernetes Container Ingress Providers
Names, example: resource01,!resource02,resource42
Types, example: WINDOWS,AIX,LINUX
Families, example: DEBIAN,CENTOS,RHEL
Environments, example: PRODUCTION,DEVELOPMENT
Status, example: ACTIVE,INACTIVE
Tags, example: mytagkey:mytagvalue,application:itcare
Filter list by monitoring status
Filter list by monitoring on call status
Filter list by backup status
Filter list by DRP status
Filter list by patch party status
Availability Zone, example: EB-A, EB-B, EB-C, etc...
IPs, example: 10.59.13.29
VLAN, example: EB_1125_DMZ8
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
id, example: 500060340
type, example: MESSAGE_BROKERS
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Service Id, example: 44411
Names, example: REBMYAPP01,REBMYSRV
Families, example: DEBIAN,RHEL
Backup
Drp
withManagedNodes
withApplicationServers
withOracleDbs
withMongoNodeJs
Statuses, example: ACTIVE,INACTIVE,PREPARATION
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Platform, example: cent7, ubu22
Storage specification of platform (disks / max sizes...)
Resource profiles (CPU/RAM) that can be allocated to instances.
Properties specification of platform (package / script, backup type...)
OK
Custom properties of platform
Key of property.
Ignored for creation. Description of property.
Value of property
Ignored for creation. Indicates if property is mandatory
Ignored for creation. Default value if applicable.
Ignored for creation. Indicates if variable is editable.
Ignored for creation, itcare internal property.
Resource profiles (CPU/RAM) that can be allocated to instances.
Text identifier.
Count of CPUs
Size in GB of RAM
Storage specification of platform (disks / max sizes...)
Maximum volumes that can be created on instance creation
Maximum size in GB volumes that can be created on instance creation
Minimum size of a single disk
List of volumes that will be created as platform requires it
Id corresponding to the volume (system/data).
"data"(?i)[A-Z0-9\-]{1,10}Simple description to explain what datas are hosting.
Size in GB of volume, must be between min and max values according to platform specification.
Ignored for instance creation operation. Indicates if volume is overridable when creating instance
Ignored for instance creation operation. Indicates if volume is mandatory when creating instance
Ignored for instance creation operation. Indicates minimal size in GB of volume.
Ignored for instance creation operation. Indicates Maximal size in GB of volume.
Ignored for instance creation operation. Indicates if it's a system volume.
Ignored for instance creation operation. Indicates if the volume should be excluded of not on snapshot
Ignored for instance creation operation. Indicates the order for displaying the volume
Tells about authentication on this Product.
Code of this Product.
This method allows to create an instance.
You will have to know at the minimum :
region attribute)platform attribute)name attribute)resourceId attribute)serviceId attribute)This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
POST /instances
{
"name": "PINSTANCE01",
"region": "EB4",
"serviceId": 13,
"platform": "deb8",
"resourceId": "1cpu2gb"
}
This will create a Debian 8 machine (1cpu 2gb RAM) in EB4 region, named PINSTANCE01, and put it into service of ID 13.
By setting only these parameters, ITCare will use default profile of image (disk configuration) and choose most appropriate Availability Zone and network to host your instance. If you want to specify those parameters take a look at other examples in this documentation.
Response :
{
"id": "1333",
"status": "IN_PROGRESS"
}
With some python code, you can create instance and wait for completion like this:
instance = {
"name": "PINSTANCE01",
"region": "EB4",
"serviceId": 13,
"platform": "deb8",
"resourceId": "1cpu2gb"
}
action = itcare.post('/api/instances', payload=instance)
while action['status']=='IN_PROGRESS':
time.sleep(1)
action = itcare.get('/api/actions/{}'.format(action['id']))
print action['status']
Choose target Platform and properties
You'll have to know which platform you want to create, and so use Platforms methods to properly fill in relevant attributes (disks / custom properties / allocated resources...).
Choose Availability Zone and Network
You may want to choose your availability zone and network, you can do this by adding availabilityZone and networkId parameters to your request.
To discover both availability zones and networks, you can use methods Regions, AZ, and Networks.
id of service to put instance in.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.
Indicates why a production resource is not under monitoring.
Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.
Indicates if alerting should be activated. If absent, set to false.
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
Indicates why a production resource is not under backup.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
Indicates why a production resource is not replicated.
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
hostname of instance. Must be unique, and fit naming rules convention., example: PEB4MYAPP01
Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
id of platform (image) of instance. To discover available platforms, use ListPlatforms method, example: deb8 for Debian 8
code of product., example: rmq11 for RabbitMQ 11
identifier of resources (cpu/ram) that will be allocated to the instance. Use List Platforms method to see resources available for each of them., example: 1cpu2gb
authentication domain id, if not set, will take default, example: CGDM-EMEA
specific request to be done by an administrator. Can differ delivery of instance up to 24h., example: Could you please install .NET framework 4.5 on instance ? Thanks.
Volumes to setup on instance. If absent, will be set to defaults.
Id corresponding to the volume (system/data).
"data"(?i)[A-Z0-9\-]{1,10}Simple description to explain what datas are hosting.
Size in GB of volume, must be between min and max values according to platform specification.
Ignored for instance creation operation. Indicates if volume is overridable when creating instance
Ignored for instance creation operation. Indicates if volume is mandatory when creating instance
Ignored for instance creation operation. Indicates minimal size in GB of volume.
Ignored for instance creation operation. Indicates Maximal size in GB of volume.
Ignored for instance creation operation. Indicates if it's a system volume.
Ignored for instance creation operation. Indicates if the volume should be excluded of not on snapshot
Ignored for instance creation operation. Indicates the order for displaying the volume
Custom properties to set up on instance such as security enforcement ... . Depends on which platform you choose to create (for some of them, properties are mandatory). Refer to platform specification to find out.
Key of property.
Ignored for creation. Description of property.
Value of property
Ignored for creation. Indicates if property is mandatory
Ignored for creation. Default value if applicable.
Ignored for creation. Indicates if variable is editable.
Ignored for creation, itcare internal property.
Availability zone id. Refer to AZ available in List Availability Zones method. If absent, default AZ of region will be used.
Network id. Refer to networks available in List Networks method. If absent, a default network of AZ will be used.
Indicates if backup off site (data replicated to another region) has to be setup on instance. If absent, backup off site will be setup automatically if instance is in a production service.
OK
Code of action performed
Status label of action
Human readable message of status
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
K8sCluster Id, example: 123
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
urls of the load balancer
List of tags - metadata associated to this resource.
Key of tag
Value of tag
Instances that are load balanced by this loadbalancer
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Protocols on which this loadbalancer expose a virtual service
Protocol of this loadbalancer
Port of this loadbalancer
iRules configured for this loadbalancer
Name of the iRule
Description of the iRule
Healthchecks configured for this loadbalancer
Advanced property such as default persistence
Advanced property such as fallback persistence
Advanced property such as load balancing mode
Bot Defense state
Bot Defense is updating
Whitelists of the Security Profile
Source addresse translation automap enabled
Holds common properties to all Resources managed in ITCare available on a Service
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
id, example: 500060340
type, example: MESSAGE_BROKERS
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
urls of the load balancer
List of tags - metadata associated to this resource.
Key of tag
Value of tag
Instances that are load balanced by this loadbalancer
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Protocols on which this loadbalancer expose a virtual service
Protocol of this loadbalancer
Port of this loadbalancer
iRules configured for this loadbalancer
Name of the iRule
Description of the iRule
Healthchecks configured for this loadbalancer
Advanced property such as default persistence
Advanced property such as fallback persistence
Advanced property such as load balancing mode
Bot Defense state
Bot Defense is updating
Whitelists of the Security Profile
Source addresse translation automap enabled
Holds common properties to all Resources managed in ITCare available on a Service
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Service Id, example: 44411
Names, example: www.cegedim.com,www.egypt.eg
Statuses, example: ACTIVE,INACTIVE,PREPARATION
Number of Members, example: 2
OK
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
urls of the load balancer
List of tags - metadata associated to this resource.
Key of tag
Value of tag
Instances that are load balanced by this loadbalancer
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed
Information about a Storage of an Instance
total size of all disks
fileSystems of an Instance
Mounting point of FS
Type of FS
Total Size in GB of FS
Free Size in GB of FS
total size of all file systems
Backup information on an instance
Backup system applied : TSM, RUBKIK, BRMS, Veeam, Barman
size in Gb of the backup data
Type of backup system
files count in backup system
date/time of last successful backup
Replication information on an instance
Storage class applied
Storage replication class applied
storage class overidden
Information if storage replication is in progress or not
When storage replication is in progress, reference of the action
If applicable, tells why storage replication is not activated (usually for PRODUCTION environments)
Snapshot of an instance
Ignored at creation. Indicates the snapshot identifiant
Ignored at creation. Indicates the label
Ignored at creation. User full-name who created snapshot
Ignored at creation. Creation date of snapshot
Ignored at creation. Recovery date of snapshot
Ignored at creation. Expiration date of snapshot
Snapshot description
Optional change reference
Ignored at creation. Size in Gb of snapshot
Region pretty name
DataCenter pretty name
Area pretty name
Availability Zone pretty name
Total Disk size of the resource
CPU of the resource
RAM of the resource
Storage after disks format in GB of the resource
Instance is member of load balancer
Id of the loadbalancer
Name of the loadbalancer
Status of the loadbalancer
Monitoring Status of the loadbalancer
Member count of the loadbalancer
ServiceId linked to the loadbalancer
Internal Image linked to this instance
OS name of this instance
OS type of this instance
This instance is ingress external node
This instance is ingress internal node
Information about storage replication in Progress
Protocols on which this loadbalancer expose a virtual service
Protocol of this loadbalancer
Port of this loadbalancer
iRules configured for this loadbalancer
Name of the iRule
Description of the iRule
Healthchecks configured for this loadbalancer
Advanced property such as default persistence
Advanced property such as fallback persistence
Advanced property such as load balancing mode
Bot Defense state
Bot Defense is updating
Whitelists of the Security Profile
Source addresse translation automap enabled
Holds common properties to all Resources managed in ITCare available on a Service
Representation of a resource patch party
Tells if the resource is excluded or not from patch party
Raison why the resource should be excluded from patch party.
Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference
Date of the last System Upgrade.
Tag to reference the last patch party
Name of the resource under patch party or not
Id of the resource under patch party or not
User who performed the exclusion from patch party action
Date on which the exclusion from patch party was performed