Message Brokers

List brokers

get
Authorizations
Query parameters
servicesinteger · int64[]Optional
namesstring[]Optional

Names, example: resource01,!resource02,resource42

typesstring[]Optional

Types, example: WINDOWS,AIX,LINUX

familiesstring[]Optional

Families, example: DEBIAN,CENTOS,RHEL

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Status, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

backupStatusbooleanOptional

Filter list by backup status

recoveryStatusbooleanOptional

Filter list by DRP status

includedInPatchPartybooleanOptional

Filter list by patch party status

topologiesstring[]Optional

Topology, example: Cluster, Standalone, etc..

versionsstring[]Optional

Version, example: 2.7.0, 3.6.0, 3.9.29-1, etc...

azstring[]Optional

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

ipstring[]Optional

IPs, example: 10.59.13.29

vlanstring[]Optional

VLAN, example: EB_1125_DMZ8

cloudsintegerOptional
pagestringOptional

Results page you want to retrieve (0..N)

sizestringOptional

Number of records per page.

sortanyOptional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.

Responses
200

OK

*/*
get
GET /itcare/message-brokers HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "content": [
    {
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-09-03T13:27:16.639Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-09-03T13:27:16.639Z",
            "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",
      "cpu": 1,
      "creationTime": "text",
      "creationUser": "text",
      "endOfSalesAt": "2025-09-03T13:27:16.639Z",
      "endOfSupportAt": "2025-09-03T13:27:16.639Z",
      "environment": "text",
      "extendedSupportAt": "2025-09-03T13:27:16.639Z",
      "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
      },
      "nodeCount": 1,
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-09-03T13:27:16.639Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-09-03T13:27:16.639Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "ram": 1,
      "releasedAt": "2025-09-03T13:27:16.639Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "sizing": "text",
      "status": "text",
      "supportLevel": "NO_MONITORING_NO_SUPPORT",
      "supportPhase": "text",
      "technology": "text",
      "topology": "text",
      "type": "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
}

Last updated