Delete a container | Sample

1 parameter

container_idstringrequired

The unique identifier of the container to delete.

2 status codes

200Confirms that the container was deleted successfully.

429Returned when the request rate exceeds the permitted limit.

errorobjectrequired

Error handling

container_id must identify the container to delete. A 429 is returned when the request rate exceeds the permitted limit.

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.containers.delete({ containerId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "error": {
    "code": "123456",
    "message": "This is an example message.",
    "param": "example_value",
    "type": "standard",
    "misalignment": {
      "error_type": "example_value",
      "detailed_explanation": "example_value",
      "steer": {
        "message": "This is an example message."
      }
    }
  }
}

Request

Response

Errors