Returns a list of all notification rules | Dependency-Track unofficial

7 parameters

pageNumberstringoptional

The page to return. To be used in conjunction with <code>pageSize</code>.

Default:1

pageSizestringoptional

Number of elements to return per page. To be used in conjunction with <code>pageNumber</code>.

Default:100

offsetstringoptional

Offset to start returning elements from. To be used in conjunction with <code>limit</code>.

limitstringoptional

Number of elements to return per page. To be used in conjunction with <code>offset</code>.

sortNamestringoptional

Name of the resource field to sort on.

sortOrderstringoptional

Ordering of items when sorting with <code>sortName</code>.

Allowed:asc, desc

triggerTypestringoptional

The notification trigger type to filter on

Allowed:EVENTSCHEDULE

2 status codes

200A list of all notification rules

enabledbooleanoptional

filterExpressionstringoptional

logSuccessfulPublishbooleanoptional

messagestringoptional

namestringrequired

notificationLevelstringoptional

Allowed:INFORMATIONALWARNINGERROR

notifyChildrenbooleanoptional

notifyOnarray<string>optional

projectsarray<object>optional

publisherobjectoptional

publisherConfigstringoptional

scheduleCronstringoptional

Schedule of this rule as cron expression. Must not be set for rules with trigger type EVENT.

scheduleLastTriggeredAtintegeroptional

When the schedule last triggered, as UNIX epoch timestamp in milliseconds

scheduleNextTriggerAtintegeroptional

When the schedule triggers next, as UNIX epoch timestamp in milliseconds

scheduleSkipUnchangedbooleanoptional

Whether to skip emitting a scheduled notification if it doesn't contain any changes since its last emission. Must not be set for rules with trigger type EVENT.

scopestringrequired

Allowed:SYSTEMPORTFOLIO

tagsarray<object>optional

teamsarray<object>optional

triggerTypestringrequired

Allowed:EVENTSCHEDULE

uuidstringrequired

401Unauthorized

Error handling

A 401 is returned: Unauthorized.

import { Client } from "dependency-track-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:8081/api",
  auth: { apiKey: process.env.API_KEY },
});

const result = await client.rule.list({
  pageNumber: 1,
  pageSize: 20,
  offset: 0,
  limit: 20,
  sortName: "Untitled",
});

[
  {
    "enabled": true,
    "filterExpression": "example_value",
    "logSuccessfulPublish": true,
    "message": "This is an example message.",
    "name": "Example Name",
    "notificationLevel": "INFORMATIONAL",
    "notifyChildren": true,
    "notifyOn": [
      "CONFIGURATION"
    ],
    "projects": [
      {
        "accessTeams": [
          {
            "apiKeys": [
              null
            ],
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "mappedLdapGroups": [
              null
            ],
            "mappedOidcGroups": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ],
            "permissions": [
              null
            ],
            "serviceAccounts": [
              null
            ],
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "active": true,
        "author": "example_value",
        "authors": [
          {
            "email": "user@example.com",
            "name": "Example Name",
            "phone": "+44 7700 900123"
          }
        ],
        "bomRef": "example_value",
        "children": [
          {
            "accessTeams": [
              null
            ],
            "active": true,
            "author": "example_value",
            "authors": [
              null
            ],
            "bomRef": "example_value",
            "children": [
              null
            ],
            "classifier": "APPLICATION",
            "collectionLogic": "AGGREGATE_DIRECT_CHILDREN",
            "collectionTag": {
              "name": null
            },
            "cpe": "example_value",
            "description": "Example description",
            "directDependencies": "example_value",
            "externalReferences": [
              null
            ],
            "group": "example_value",
            "inactiveSince": 1,
            "isLatest": true,
            "lastBomImport": 1,
            "lastBomImportFormat": "example_value",
            "lastInheritedRiskScore": 1,
            "lastVulnerabilityAnalysis": 1,
            "manufacturer": {
              "contacts": null,
              "name": null,
              "urls": null
            },
            "metadata": {
              "authors": null,
              "supplier": null,
              "tools": null
            },
            "metrics": {
              "components": null,
              "critical": null,
              "findingsAudited": null,
              "findingsTotal": null,
              "findingsUnaudited": null,
              "firstOccurrence": null,
              "high": null,
              "inheritedRiskScore": null,
              "kev": null,
              "lastOccurrence": null,
              "low": null,
              "medium": null,
              "policyViolationsAudited": null,
              "policyViolationsFail": null,
              "policyViolationsInfo": null,
              "policyViolationsLicenseAudited": null,
              "policyViolationsLicenseTotal": null,
              "policyViolationsLicenseUnaudited": null,
              "policyViolationsOperationalAudited": null,
              "policyViolationsOperationalTotal": null,
              "policyViolationsOperationalUnaudited": null,
              "policyViolationsSecurityAudited": null,
              "policyViolationsSecurityTotal": null,
              "policyViolationsSecurityUnaudited": null,
              "policyViolationsTotal": null,
              "policyViolationsUnaudited": null,
              "policyViolationsWarn": null,
              "suppressed": null,
              "unassigned": null,
              "vulnerabilities": null,
              "vulnerableComponents": null
            },
            "name": "Example Name",
            "parent": {
              "accessTeams": null,
              "active": null,
              "author": null,
              "authors": null,
              "bomRef": null,
              "children": null,
              "classifier": null,
              "collectionLogic": null,
              "collectionTag": null,
              "cpe": null,
              "description": null,
              "directDependencies": null,
              "externalReferences": null,
              "group": null,
              "inactiveSince": null,
              "isLatest": null,
              "lastBomImport": null,
              "lastBomImportFormat": null,
              "lastInheritedRiskScore": null,
              "lastVulnerabilityAnalysis": null,
              "manufacturer": null,
              "metadata": null,
              "metrics": null,
              "name": null,
              "parent": null,
              "publisher": null,
              "purl": null,
              "supplier": null,
              "swidTagId": null,
              "tags": null,
              "uuid": null,
              "version": null,
              "versions": null
            },
            "publisher": "example_value",
            "purl": "https://example.com",
            "supplier": {
              "contacts": null,
              "name": null,
              "urls": null
            },
            "swidTagId": "550e8400-e29b-41d4-a716-446655440000",
            "tags": [
              null
            ],
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "version": "example_value",
            "versions": [
              null
            ]
          }
        ],
        "classifier": "APPLICATION",
        "collectionLogic": "AGGREGATE_DIRECT_CHILDREN",
        "collectionTag": {
          "name": "Example Name"
        },
        "cpe": "example_value",
        "description": "Example description",
        "directDependencies": "example_value",
        "externalReferences": [
          {
            "comment": "example_value",
            "type": "vcs",
            "url": "https://example.com"
          }
        ],
        "group": "example_value",
        "inactiveSince": 1,
        "isLatest": true,
        "lastBomImport": 1,
        "lastBomImportFormat": "example_value",
        "lastInheritedRiskScore": 1,
        "lastVulnerabilityAnalysis": 1,
        "manufacturer": {
          "contacts": [
            {
              "email": null,
              "name": null,
              "phone": null
            }
          ],
          "name": "Example Name",
          "urls": [
            "https://example.com"
          ]
        },
        "metadata": {
          "authors": [
            {
              "email": null,
              "name": null,
              "phone": null
            }
          ],
          "supplier": {
            "contacts": [
              null
            ],
            "name": "Example Name",
            "urls": [
              null
            ]
          },
          "tools": {
            "components": [
              null
            ],
            "services": [
              null
            ]
          }
        },
        "metrics": {
          "components": 1,
          "critical": 1,
          "findingsAudited": 1,
          "findingsTotal": 42,
          "findingsUnaudited": 1,
          "firstOccurrence": 1,
          "high": 1,
          "inheritedRiskScore": 1,
          "kev": 1,
          "lastOccurrence": 1,
          "low": 1,
          "medium": 1,
          "policyViolationsAudited": 1,
          "policyViolationsFail": 1,
          "policyViolationsInfo": 1,
          "policyViolationsLicenseAudited": 1,
          "policyViolationsLicenseTotal": 42,
          "policyViolationsLicenseUnaudited": 1,
          "policyViolationsOperationalAudited": 1,
          "policyViolationsOperationalTotal": 42,
          "policyViolationsOperationalUnaudited": 1,
          "policyViolationsSecurityAudited": 1,
          "policyViolationsSecurityTotal": 42,
          "policyViolationsSecurityUnaudited": 1,
          "policyViolationsTotal": 42,
          "policyViolationsUnaudited": 1,
          "policyViolationsWarn": 1,
          "suppressed": 1,
          "unassigned": 1,
          "vulnerabilities": 1,
          "vulnerableComponents": 1
        },
        "name": "Example Name",
        "parent": {
          "accessTeams": [
            {
              "apiKeys": null,
              "ldapUsers": null,
              "managedUsers": null,
              "mappedLdapGroups": null,
              "mappedOidcGroups": null,
              "name": null,
              "oidcUsers": null,
              "permissions": null,
              "serviceAccounts": null,
              "uuid": null
            }
          ],
          "active": true,
          "author": "example_value",
          "authors": [
            {
              "email": null,
              "name": null,
              "phone": null
            }
          ],
          "bomRef": "example_value",
          "children": [
            {
              "accessTeams": null,
              "active": null,
              "author": null,
              "authors": null,
              "bomRef": null,
              "children": null,
              "classifier": null,
              "collectionLogic": null,
              "collectionTag": null,
              "cpe": null,
              "description": null,
              "directDependencies": null,
              "externalReferences": null,
              "group": null,
              "inactiveSince": null,
              "isLatest": null,
              "lastBomImport": null,
              "lastBomImportFormat": null,
              "lastInheritedRiskScore": null,
              "lastVulnerabilityAnalysis": null,
              "manufacturer": null,
              "metadata": null,
              "metrics": null,
              "name": null,
              "parent": null,
              "publisher": null,
              "purl": null,
              "supplier": null,
              "swidTagId": null,
              "tags": null,
              "uuid": null,
              "version": null,
              "versions": null
            }
          ],
          "classifier": "APPLICATION",
          "collectionLogic": "AGGREGATE_DIRECT_CHILDREN",
          "collectionTag": {
            "name": "Example Name"
          },
          "cpe": "example_value",
          "description": "Example description",
          "directDependencies": "example_value",
          "externalReferences": [
            {
              "comment": null,
              "type": null,
              "url": null
            }
          ],
          "group": "example_value",
          "inactiveSince": 1,
          "isLatest": true,
          "lastBomImport": 1,
          "lastBomImportFormat": "example_value",
          "lastInheritedRiskScore": 1,
          "lastVulnerabilityAnalysis": 1,
          "manufacturer": {
            "contacts": [
              null
            ],
            "name": "Example Name",
            "urls": [
              null
            ]
          },
          "metadata": {
            "authors": [
              null
            ],
            "supplier": {
              "contacts": null,
              "name": null,
              "urls": null
            },
            "tools": {
              "components": null,
              "services": null
            }
          },
          "metrics": {
            "components": 1,
            "critical": 1,
            "findingsAudited": 1,
            "findingsTotal": 42,
            "findingsUnaudited": 1,
            "firstOccurrence": 1,
            "high": 1,
            "inheritedRiskScore": 1,
            "kev": 1,
            "lastOccurrence": 1,
            "low": 1,
            "medium": 1,
            "policyViolationsAudited": 1,
            "policyViolationsFail": 1,
            "policyViolationsInfo": 1,
            "policyViolationsLicenseAudited": 1,
            "policyViolationsLicenseTotal": 42,
            "policyViolationsLicenseUnaudited": 1,
            "policyViolationsOperationalAudited": 1,
            "policyViolationsOperationalTotal": 42,
            "policyViolationsOperationalUnaudited": 1,
            "policyViolationsSecurityAudited": 1,
            "policyViolationsSecurityTotal": 42,
            "policyViolationsSecurityUnaudited": 1,
            "policyViolationsTotal": 42,
            "policyViolationsUnaudited": 1,
            "policyViolationsWarn": 1,
            "suppressed": 1,
            "unassigned": 1,
            "vulnerabilities": 1,
            "vulnerableComponents": 1
          },
          "name": "Example Name",
          "parent": {
            "accessTeams": [
              null
            ],
            "active": true,
            "author": "example_value",
            "authors": [
              null
            ],
            "bomRef": "example_value",
            "children": [
              null
            ],
            "classifier": "APPLICATION",
            "collectionLogic": "AGGREGATE_DIRECT_CHILDREN",
            "collectionTag": {
              "name": null
            },
            "cpe": "example_value",
            "description": "Example description",
            "directDependencies": "example_value",
            "externalReferences": [
              null
            ],
            "group": "example_value",
            "inactiveSince": 1,
            "isLatest": true,
            "lastBomImport": 1,
            "lastBomImportFormat": "example_value",
            "lastInheritedRiskScore": 1,
            "lastVulnerabilityAnalysis": 1,
            "manufacturer": {
              "contacts": null,
              "name": null,
              "urls": null
            },
            "metadata": {
              "authors": null,
              "supplier": null,
              "tools": null
            },
            "metrics": {
              "components": null,
              "critical": null,
              "findingsAudited": null,
              "findingsTotal": null,
              "findingsUnaudited": null,
              "firstOccurrence": null,
              "high": null,
              "inheritedRiskScore": null,
              "kev": null,
              "lastOccurrence": null,
              "low": null,
              "medium": null,
              "policyViolationsAudited": null,
              "policyViolationsFail": null,
              "policyViolationsInfo": null,
              "policyViolationsLicenseAudited": null,
              "policyViolationsLicenseTotal": null,
              "policyViolationsLicenseUnaudited": null,
              "policyViolationsOperationalAudited": null,
              "policyViolationsOperationalTotal": null,
              "policyViolationsOperationalUnaudited": null,
              "policyViolationsSecurityAudited": null,
              "policyViolationsSecurityTotal": null,
              "policyViolationsSecurityUnaudited": null,
              "policyViolationsTotal": null,
              "policyViolationsUnaudited": null,
              "policyViolationsWarn": null,
              "suppressed": null,
              "unassigned": null,
              "vulnerabilities": null,
              "vulnerableComponents": null
            },
            "name": "Example Name",
            "parent": {
              "accessTeams": null,
              "active": null,
              "author": null,
              "authors": null,
              "bomRef": null,
              "children": null,
              "classifier": null,
              "collectionLogic": null,
              "collectionTag": null,
              "cpe": null,
              "description": null,
              "directDependencies": null,
              "externalReferences": null,
              "group": null,
              "inactiveSince": null,
              "isLatest": null,
              "lastBomImport": null,
              "lastBomImportFormat": null,
              "lastInheritedRiskScore": null,
              "lastVulnerabilityAnalysis": null,
              "manufacturer": null,
              "metadata": null,
              "metrics": null,
              "name": null,
              "parent": null,
              "publisher": null,
              "purl": null,
              "supplier": null,
              "swidTagId": null,
              "tags": null,
              "uuid": null,
              "version": null,
              "versions": null
            },
            "publisher": "example_value",
            "purl": "https://example.com",
            "supplier": {
              "contacts": null,
              "name": null,
              "urls": null
            },
            "swidTagId": "550e8400-e29b-41d4-a716-446655440000",
            "tags": [
              null
            ],
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "version": "example_value",
            "versions": [
              null
            ]
          },
          "publisher": "example_value",
          "purl": "https://example.com",
          "supplier": {
            "contacts": [
              null
            ],
            "name": "Example Name",
            "urls": [
              null
            ]
          },
          "swidTagId": "550e8400-e29b-41d4-a716-446655440000",
          "tags": [
            {
              "name": null
            }
          ],
          "uuid": "550e8400-e29b-41d4-a716-446655440000",
          "version": "example_value",
          "versions": [
            {
              "active": null,
              "isLatest": null,
              "uuid": null,
              "version": null
            }
          ]
        },
        "publisher": "example_value",
        "purl": "https://example.com",
        "supplier": {
          "contacts": [
            {
              "email": null,
              "name": null,
              "phone": null
            }
          ],
          "name": "Example Name",
          "urls": [
            "https://example.com"
          ]
        },
        "swidTagId": "550e8400-e29b-41d4-a716-446655440000",
        "tags": [
          {
            "name": "Example Name"
          }
        ],
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "version": "example_value",
        "versions": [
          {
            "active": true,
            "isLatest": true,
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "version": "example_value"
          }
        ]
      }
    ],
    "publisher": {
      "defaultPublisher": true,
      "description": "Example description",
      "extensionName": "Example Name",
      "name": "Example Name",
      "template": "example_value",
      "templateMimeType": "example_value",
      "uuid": "550e8400-e29b-41d4-a716-446655440000"
    },
    "publisherConfig": "example_value",
    "scheduleCron": "example_value",
    "scheduleLastTriggeredAt": 1,
    "scheduleNextTriggerAt": 1,
    "scheduleSkipUnchanged": true,
    "scope": "SYSTEM",
    "tags": [
      {
        "name": "Example Name"
      }
    ],
    "teams": [
      {
        "apiKeys": [
          {
            "comment": "example_value",
            "created": 1,
            "expiresAt": 1,
            "key": "example_key_abc123",
            "lastUsed": 1,
            "legacy": true,
            "maskedKey": "example_key_abc123",
            "publicId": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "ldapUsers": [
          {
            "dn": "example_value",
            "email": "user@example.com",
            "permissions": [
              null
            ],
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "managedUsers": [
          {
            "confirmPassword": "example_value",
            "email": "user@example.com",
            "forcePasswordChange": true,
            "fullname": "Jane Doe",
            "lastPasswordChange": 1,
            "newPassword": "example_value",
            "nonExpiryPassword": true,
            "permissions": [
              null
            ],
            "suspended": true,
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "mappedLdapGroups": [
          {
            "dn": "example_value",
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "mappedOidcGroups": [
          {
            "group": {
              "name": null,
              "uuid": null
            },
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "name": "Example Name",
        "oidcUsers": [
          {
            "email": "user@example.com",
            "permissions": [
              null
            ],
            "subjectIdentifier": "example_value",
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "permissions": [
          {
            "description": "Example description",
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ]
          }
        ],
        "serviceAccounts": [
          {
            "email": "user@example.com",
            "permissions": [
              null
            ],
            "suspended": true,
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "uuid": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "triggerType": "EVENT",
    "uuid": "550e8400-e29b-41d4-a716-446655440000"
  }
]

Request

Response

Errors