alert-definitions/template-based

Lists template based alert definitions for the tenant.

Supported query params:

  • name
  • integrationId
  • customized
  • parentAlertDefinitionId
  • scopeLevel (global|partner|client)
  • resourceNativeType
  • page (default 1)
  • pageSize (default 50, min 1, max 100)
  • sortBy (name|createdAt|updatedAt|resourceNativeType|integrationId)
  • sortOrder (asc|desc)
  • isMinimal

Path Parameters

  • tenantIdstringrequired

    Describes partnerId or clientId of the tenant

Query Parameters

  • namestring

  • integrationIdstring

  • customizedboolean

  • parentAlertDefinitionIdstring

  • scopeLevelstring

    Enum:
    globalpartnerclient
  • resourceNativeTypestring

  • pageinteger

    Default: 1

    Minimum: 1

  • pageSizeinteger

    Default: 50

    Minimum: 1

    Maximum: 100

  • sortBystring

    Enum:
    namecreatedAtupdatedAtresourceNativeTypeintegrationId
  • sortOrderstring

    Enum:
    ascdesc
  • isMinimalboolean

Responses

  • resultsarray

  • totalResultsinteger

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • orderBystring

Loading Examples...

Creates a template based alert definition.

Requires valid authorization and appropriate access permissions.

Path Parameters

  • tenantIdstringrequired

    Describes partnerId or clientId of the tenant

Request Body

application/json

  • namestring

  • searchQuerystring

  • parentAlertDefinitionIdstring

  • integrationIdstring

  • resourceTypestring

  • resourceNativeTypestring

  • executionOrderinteger

  • scopeobject

  • actionsarray

  • executeboolean

Loading Examples...

Responses

Loading Examples...