Tag notification rules | Dependency-Track unofficial

1 parameter

namestringrequired

The name of the tag to assign to the notification rules.

2 status codes

204Returns no content after successfully tagging the notification rules.

404Returned when a tag with the supplied name does not exist.

detailstringrequired

Human-readable explanation specific to this occurrence of the problem

instancestringoptional

Reference URI that identifies the specific occurrence of the problem

statusintegerrequired

HTTP status code generated by the origin server for this occurrence of the problem

titlestringrequired

Short, human-readable summary of the problem type

typestringoptional

A URI reference that identifies the problem type

Error handling

A 404 is returned when the tag identified by the name path parameter does not exist. The request body must contain 1–100 UUID strings, each 1–100 characters long. The authenticated user must have SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE permission.

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.notificationRule.create({ name: "Untitled" });

{
  "detail": "Example detail",
  "instance": "https://api.example.org/foo/bar/example-instance",
  "status": 400,
  "title": "Example title",
  "type": "https://api.example.org/foo/bar/example-problem"
}

Request

Response

Errors