Delete a Radar value list | Sample

1 parameter

value_liststringrequired

The unique identifier of the Radar value list to delete, limited to 5000 characters.

2 status codes

200Returns a deleted-object response with `deleted` set to true, the value list identifier, and the `radar.value_list` object type.

deletedbooleanrequired

Always true for a deleted object

Allowed:true

idstringrequired

Unique identifier for the object.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:radar.value_list

defaultError response.

errorobjectrequired

Error handling

value_list must identify the value list to delete and must be no more than 5000 characters. The list must not be referenced in any rules, because deleting it also removes its contained items.

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.valueLists.delete({ valueList: "example" });

{
  "deleted": "true",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "radar.value_list"
}

Request

Response

Errors