Delete workflow run logs | Sample

3 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

run_idintegerrequired

The unique identifier of the workflow run.

3 status codes

204Response

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

500Internal Error

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 500 is returned: Internal Error.

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.logs.delete({
  owner: "octocat",
  repo: "hello-world",
  runId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

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

Request

Response

Errors