Bulk delete organization custom patterns | Sample

1 parameter · 2 body fields

orgstringrequired

The organization name. The name is not case sensitive.

patternsarray<SecretScanningCustomPatternToDelete>required

The list of custom patterns to delete.

post_delete_actionstringoptional

What to do with alerts associated with the deleted patterns. `delete_alerts` permanently removes the alerts. `resolve_alerts` resolves the alerts as "pattern deleted". Defaults to `delete_alerts` when not specified.

Allowed:delete_alertsresolve_alertsDefault:delete_alerts

5 status codes

204All patterns deleted successfully.

400Bad Request

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

412Precondition Failed

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 400 is returned: Bad Request. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 412 is returned: Precondition Failed.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.customPatterns.delete({
  org: "acme-inc",
  patterns: [],
  postDeleteAction: "example",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors