Skip to content
Ona Docs

DeleteTask

client.environments.automations.tasks.delete(TaskDeleteParams { id } body, RequestOptionsoptions?): TaskDeleteResponse
POST/gitpod.v1.EnvironmentAutomationService/DeleteTask

Deletes an automation task.

Use this method to:

  • Remove unused tasks
  • Clean up task configurations
  • Delete obsolete automations

Examples

  • Delete task:

    Removes a task and its configuration.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
body: TaskDeleteParams { id }
id?: string
formatuuid
ReturnsExpand Collapse
TaskDeleteResponse = unknown

DeleteTask

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const task = await client.environments.automations.tasks.delete({
  id: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(task);
{}
Returns Examples
{}