Matomo

List Matomo Instances

get

Authorizations

oauth2

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Query parameters

namesstring[]Optional

Names, example: matomo1

cloudsstringOptional

Responses

200

OK

application/vnd.cegedim-it.v1+json

emptybooleanOptional

firstbooleanOptional

lastbooleanOptional

numberinteger · int32Optional

numberOfElementsinteger · int32Optional

sizeinteger · int32Optional

totalElementsinteger · int64Optional

totalPagesinteger · int32Optional

400

Bad Request

*/*

get

/analytics/matomo

HTTPcURLJavaScriptPython

GET /itcare/analytics/matomo HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "content": [
    {
      "actionsInProgress": [
        {
          "family": "text",
          "id": 1,
          "internalId": 1,
          "lastUpdatedAt": "2026-03-01T20:40:08.751Z",
          "message": "text",
          "process": "text",
          "resourceName": "text",
          "resourceType": "text",
          "status": "SUCCESS,IN_PROGRESS,ERROR"
        }
      ],
      "availableActions": [
        {
          "available": true,
          "operation": "text",
          "unavailabilityCauses": [
            "text"
          ]
        }
      ],
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2026-03-01T20:40:08.751Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2026-03-01T20:40:08.751Z",
            "backupSize": 1,
            "durationInHours": 1,
            "frequencies": {},
            "label": "text",
            "name": "text",
            "policyId": "text",
            "replication": true,
            "scope": "text",
            "startTime": "text",
            "timezone": "text",
            "type": "text"
          }
        ]
      },
      "backupStatus": true,
      "category": "text",
      "cloudId": 1,
      "cloudName": "text",
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "endOfSalesAt": "2026-03-01T20:40:08.751Z",
      "endOfSupportAt": "2026-03-01T20:40:08.751Z",
      "environment": "text",
      "extendedSupportAt": "2026-03-01T20:40:08.751Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "ipAddress": "text",
      "label": "text",
      "labelArea": "text",
      "labelAvailabilityZone": "text",
      "labelDataCenter": "text",
      "labelRegion": "text",
      "metrologyUrl": "text",
      "monitoringRequested": true,
      "name": "text",
      "network": {
        "area": "text",
        "cidr": "text",
        "cloud": "text",
        "defaultNetwork": true,
        "description": "text",
        "dns": [
          {
            "alias": "text",
            "domain": "text"
          }
        ],
        "environment": "text",
        "gateway": "text",
        "id": 1,
        "ipAddress": "text",
        "ipFreeNumber": 1,
        "isIpRangePublic": true,
        "mask": "text",
        "networkShortDescription": "text",
        "region": "text",
        "scope": "text",
        "shortDescription": "text",
        "technicalId": "text",
        "usedPercent": 1
      },
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2026-03-01T20:40:08.751Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2026-03-01T20:40:08.751Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "releasedAt": "2026-03-01T20:40:08.751Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "sizing": "text",
      "status": "text",
      "supportLevel": "NO_MONITORING_NO_SUPPORT",
      "supportPhase": "text",
      "technology": "text",
      "type": "text",
      "url": "text",
      "version": "text"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": [
      {
        "ascending": true,
        "direction": "text",
        "ignoreCase": true,
        "nullHandling": "text",
        "property": "text"
      }
    ],
    "unpaged": true
  },
  "size": 1,
  "sort": [
    {
      "ascending": true,
      "direction": "text",
      "ignoreCase": true,
      "nullHandling": "text",
      "property": "text"
    }
  ],
  "totalElements": 1,
  "totalPages": 1
}

Create a Matomo instance

post

This method allows to create a matomo instance.

You will have to know at the minimum :

• where you want to host your instance (region attribute)
• name of instance (name attribute)
• sizing of the instance (sizing attribute). The possible values are : XS (Up to 100K ppm), S(Up to 1M ppm), M(Up to 10M ppm), L(Up to 100M ppm), XL(More than 100M ppm)
• how to connect to the instance (password attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
• On which service the matomo instance belongs to (serviceId attribute).
• Other settings (defaultWebSiteName, defaultWebUri).

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /analytics/matomo
{
	"name": "pmatomo01",
	"region": "EB",
	"sizing":"XS",
	"serviceId":"123",
	"password": "Password!!??",
	"defaultWebSiteName": "ITCare",
	"defaultWebUri": "https://itcare.cegedim.cloud"
	
}

Authorizations

oauth2

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Body

application/vnd.cegedim-it.v1+json

backupEnabledbooleanOptional

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

cloudIdinteger · int64Optional

dbBackupPolicyIdstringOptional

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

defaultWebSiteNamestringRequired

Default website name to be configured in Matomo, if left empty, a dummy value will be configured

defaultWebUristringRequired

Default website url to be configured in Matomo, if left empty, a dummy value will be configured

namestringRequired

Name of Matomo Instance

Pattern: [a-z0-9\-]{4,60}$

noBackupProdReasonstringOptional

Indicates why a production resource is not under backup.

noMonitoringProdReasonstringOptional

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstringOptional

Indicates why a production resource is not replicated.

passwordstringRequired

Password to connect to the matomo instance.

regionstringRequired

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

regulationstringOptional

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

replicationEnabledbooleanOptional

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

serverBackupPolicyIdstringOptional

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

serviceIdinteger · int64Required

id of service to put instance in.

sizingstringRequired

Sizing. L, XL , XS, S, M. Sizing for matomo instances

supportLevelstring · enumOptional

Indicates monitoring and support level, if absent then we use boolean variables to describe which level

Possible values:

Responses

200

OK

application/vnd.cegedim-it.v1+json

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

familystringOptional

idinteger · int32Optional

internalIdinteger · int64Optional

lastUpdatedAtstring · date-timeOptional

messagestringOptional

Human readable message of status

processstringOptional

Code of action performed

resourceNamestringOptional

resourceTypestringOptional

statusstring · enumOptional

Status label of action

Possible values:

400

Bad Request

*/*

post

/analytics/matomo

HTTPcURLJavaScriptPython

POST /itcare/analytics/matomo HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 1909

{
  "backupEnabled": true,
  "cloudId": 1,
  "dbBackupPolicyId": "text",
  "defaultWebSiteName": "text",
  "defaultWebUri": "text",
  "name": "text",
  "noBackupProdReason": "text",
  "noMonitoringProdReason": "text",
  "noReplicationProdReason": "text",
  "password": "text",
  "product": {
    "BACKUP_POLICY_TYPE": "text",
    "CATEGORY_WEIGHT": 1,
    "CODE": "text",
    "COMMENT": "text",
    "DOCUMENTATION": "text",
    "EDITION": "text",
    "END_OF_SALES_AT": "2026-03-01T20:40:08.751Z",
    "END_OF_SUPPORT_AT": "2026-03-01T20:40:08.751Z",
    "ENFORCED_AUTH_DOMAIN": true,
    "EXTENDED_SUPPORT_AT": "2026-03-01T20:40:08.751Z",
    "FAMILY_WEIGHT": 1,
    "ID": "text",
    "IMG": "text",
    "LABEL": "text",
    "NAME": "text",
    "PLATFORM": "text",
    "PRODUCT_CATEGORY": "text",
    "PRODUCT_DISPLAYABLE": true,
    "PRODUCT_IS_DISABLED": true,
    "PRODUCT_IS_IN_BETA_MODE": true,
    "PRODUCT_MAGIC_FORMS": "text",
    "PRODUCT_SKIP_TECHNOLOGY": true,
    "PRODUCT_TECHNOLOGY": "text",
    "PRODUCT_VERSION": "text",
    "RELEASED_AT": "2026-03-01T20:40:08.751Z",
    "STATUS": "text",
    "SUPPORT_FORM_AVAILABLE": true,
    "SUPPORT_FORM_ID": "text",
    "SUPPORT_PHASE": "text",
    "TECH_FORMONLY": true,
    "TECH_WEIGHT": 1,
    "TYPE": "text",
    "VERSION": "text",
    "configuration": {
      "topologies": [
        {
          "alwaysOn": "text",
          "cluster": "text",
          "galera": "text",
          "ha": "text",
          "replica": "text",
          "sentinel": "text",
          "single": "text",
          "standalone": "text"
        }
      ]
    },
    "properties": [
      {
        "defaultValue": "text",
        "description": "text",
        "displayed": true,
        "editable": true,
        "key": "text",
        "mandatory": true,
        "value": "text"
      }
    ],
    "resources": [
      {
        "available": true,
        "id": "text",
        "optionDescrEn": "text",
        "optionDescrFr": "text",
        "optionName": "text",
        "optionOrder": "text",
        "ram": 1,
        "vcpus": 1
      }
    ],
    "storage": {
      "maxVolumes": 1,
      "minVolumeSize": 1,
      "totalSizeAuthorized": 1,
      "totalVolumesSize": 1,
      "volumes": [
        {
          "description": "text",
          "editable": 1,
          "exclFromSnap": 1,
          "id": "data",
          "mandatory": true,
          "max": 1,
          "min": 1,
          "order": 1,
          "sizeGb": 1,
          "system": true
        }
      ]
    }
  },
  "region": "text",
  "regulation": "text",
  "replicationEnabled": true,
  "serverBackupPolicyId": "text",
  "serviceId": 1,
  "sizing": "text",
  "supportLevel": "NO_MONITORING_NO_SUPPORT"
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2026-03-01T20:40:08.751Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Delete a Matomo instance

delete

This method allows to delete a matomo instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /analytics/matomo/123

Authorizations

oauth2

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

id, example: 123

Responses

200

OK

application/vnd.cegedim-it.v1+json

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

familystringOptional

idinteger · int32Optional

internalIdinteger · int64Optional

lastUpdatedAtstring · date-timeOptional

messagestringOptional

Human readable message of status

processstringOptional

Code of action performed

resourceNamestringOptional

resourceTypestringOptional

statusstring · enumOptional

Status label of action

Possible values:

400

Bad Request

*/*

delete

/analytics/matomo/{id}

HTTPcURLJavaScriptPython

DELETE /itcare/analytics/matomo/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2026-03-01T20:40:08.751Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get a Matomo Instance

get

Authorizations

oauth2

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

id, example: 123

Responses

200

OK

application/vnd.cegedim-it.v1+json

backupStatusbooleanOptional

categorystringOptional

cloudIdinteger · int64Optional

cloudNamestringOptional

commentstringOptional

creationTimestringOptional

creationUserstringOptional

endOfSalesAtstring · date-timeOptional

endOfSupportAtstring · date-timeOptional

environmentstringOptional

extendedSupportAtstring · date-timeOptional

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

metrologyUrlstringOptional

monitoringRequestedbooleanOptional

namestringOptional

pathstringOptional

prettyLabelstringOptional

productCodestringOptional

productNamestringOptional

productVersionstringOptional

releasedAtstring · date-timeOptional

replicationStatusbooleanOptional

resourceTypestringOptional

serviceIdinteger · int64Optional

serviceKeystringOptional

serviceNamestringOptional

sizingstringOptional

statusstringOptional

supportLevelstring · enumOptionalPossible values:

supportPhasestringOptional

technologystringOptional

typestringOptional

urlstringOptional

versionstringOptional

400

Bad Request

*/*

get

/analytics/matomo/{id}

HTTPcURLJavaScriptPython

GET /itcare/analytics/matomo/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "actionsInProgress": [
    {
      "family": "text",
      "id": 1,
      "internalId": 1,
      "lastUpdatedAt": "2026-03-01T20:40:08.751Z",
      "message": "text",
      "process": "text",
      "resourceName": "text",
      "resourceType": "text",
      "status": "SUCCESS,IN_PROGRESS,ERROR"
    }
  ],
  "availableActions": [
    {
      "available": true,
      "operation": "text",
      "unavailabilityCauses": [
        "text"
      ]
    }
  ],
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2026-03-01T20:40:08.751Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2026-03-01T20:40:08.751Z",
        "backupSize": 1,
        "durationInHours": 1,
        "frequencies": {},
        "label": "text",
        "name": "text",
        "policyId": "text",
        "replication": true,
        "scope": "text",
        "startTime": "text",
        "timezone": "text",
        "type": "text"
      }
    ]
  },
  "backupStatus": true,
  "category": "text",
  "cloudId": 1,
  "cloudName": "text",
  "comment": "text",
  "creationTime": "text",
  "creationUser": "text",
  "endOfSalesAt": "2026-03-01T20:40:08.751Z",
  "endOfSupportAt": "2026-03-01T20:40:08.751Z",
  "environment": "text",
  "extendedSupportAt": "2026-03-01T20:40:08.751Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "ipAddress": "text",
  "label": "text",
  "labelArea": "text",
  "labelAvailabilityZone": "text",
  "labelDataCenter": "text",
  "labelRegion": "text",
  "metrologyUrl": "text",
  "monitoringRequested": true,
  "name": "text",
  "network": {
    "area": "text",
    "cidr": "text",
    "cloud": "text",
    "defaultNetwork": true,
    "description": "text",
    "dns": [
      {
        "alias": "text",
        "domain": "text"
      }
    ],
    "environment": "text",
    "gateway": "text",
    "id": 1,
    "ipAddress": "text",
    "ipFreeNumber": 1,
    "isIpRangePublic": true,
    "mask": "text",
    "networkShortDescription": "text",
    "region": "text",
    "scope": "text",
    "shortDescription": "text",
    "technicalId": "text",
    "usedPercent": 1
  },
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2026-03-01T20:40:08.751Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2026-03-01T20:40:08.751Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "releasedAt": "2026-03-01T20:40:08.751Z",
  "replicationStatus": true,
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "sizing": "text",
  "status": "text",
  "supportLevel": "NO_MONITORING_NO_SUPPORT",
  "supportPhase": "text",
  "technology": "text",
  "type": "text",
  "url": "text",
  "version": "text"
}

Update a Matomo instance

patch

This method allows to update a matomo instance.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start matomo instance

Use the start operation to start a matomo instance.

Starts matomo instance.

This method is synchronous (status code 202).

Example :

PATCH /analytics/matomo/1234
{
    "operation": "start"
}

Stop matomo instance

Use the stop operation to stop the nodes of the matomo instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /analytics/matomo/1234
{
	"operation":"stop"
}

Extend matomo instance

Use the extend operation to stop the nodes of the matomo instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /analytics/matomo/1234
{
	"operation":"extend",
	"options" : {
	  "sizing" : "M"
	}
}

Authorizations

oauth2

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

id, example: 123

Body

application/jsonapplication/vnd.cegedim-it.v1+json

operationstringOptional

Responses

200

OK

application/vnd.cegedim-it.v1+json

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

familystringOptional

idinteger · int32Optional

internalIdinteger · int64Optional

lastUpdatedAtstring · date-timeOptional

messagestringOptional

Human readable message of status

processstringOptional

Code of action performed

resourceNamestringOptional

resourceTypestringOptional

statusstring · enumOptional

Status label of action

Possible values:

400

Bad Request

*/*

patch

/analytics/matomo/{id}

HTTPcURLJavaScriptPython

PATCH /itcare/analytics/matomo/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

application/jsonapplication/vnd.cegedim-it.v1+json

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2026-03-01T20:40:08.751Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}