Create Resource Monitors

Creates resource monitors.
If you export the monitor JSON from the Monitors page, the monitorScope will be by default 0, and if you want to create the same monitor using the API, update the fields as follows:

  • Partner user API login: Set monitorScope = 18 for partner scope.
  • Partner user login (client scope): Set monitorScope = 52 and add clientId (UUID).
  • Client user login: Set monitorScope = 52 for client scope.

Notes

  • Get monitors list

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant.

Query Parameters

  • tenantIdstring

    Tenant identifier

  • pageNointeger

    Current page number to fetch.

  • pageSizeinteger

    Number of items per page.

  • queryStringstring

    Search filter. Includes information such as scope (like partner).

Responses

  • resultsarray

  • totalResultsinteger

    Total number of results available.

  • orderBystring

    Field used for ordering results.

  • pageNointeger

    Current page number.

  • pageSizeinteger

    Number of items per page.

  • totalPagesinteger

    Total number of pages available.

  • nextPageboolean

    Indicates whether there is a next page.

  • nextPageNointeger

    Next page number (if nextPage is true).

  • previousPageNointeger

    Previous page number (if applicable).

  • descendingOrderboolean

    Indicates whether sorting is in descending order.

Loading Examples...

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant.

Request Body

application/json

  • namestring

  • scriptstring

  • monitorScopeinteger

  • clientIdstring

  • mspIdstring

  • serviceProviderIdstring

  • resourceMonAdditionalParamsarray

  • instanceTypestring

  • instanceIds

  • uuidstring

  • descstring

  • mulInstboolean

  • disc_freq_minstring

  • disc_metric

  • disc_typestring

  • disc_lookup_Oid

  • create_ts

  • update_ts

  • discoveryFilters

  • staticMetrics

  • dynamicMetricsarray

Loading Examples...

Responses

  • failedCountinteger

  • failedListobject

  • updatedCountinteger

  • createdCountinteger

Loading Examples...