Abort a cronjob execution

POST /v2/cronjobs/{cronjobId}/executions/{executionId}/actions/abort/

API version

v2

Request method

POST

Operation ID

cronjob-abort-execution

---

Request

• cronjobIdstring (uuid)

  required

  ID of the CronjobExecution to be aborted.

• executionIdstring

  required

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/cronjobs/f0f86186-0a5a-45b2-aa33-502777496347/executions/cron-bd26li-28027320/actions/abort

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.cronjob.abortExecution({
  "cronjobId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "executionId": "cron-bd26li-28027320"
});

assertStatus(response, 204);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Cronjob\AbortExecution\AbortExecutionRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Cronjob\AbortExecution\AbortExecutionRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// AbortExecutionRequestBody to learn how to construct a valid instance
$body = new AbortExecutionRequestBody(/* TODO: ... */);

$request = (new AbortExecutionRequest(
  cronjobId: "f0f86186-0a5a-45b2-aa33-502777496347",
  executionId: "cron-bd26li-28027320",
  body: $body
));
$response = $client->cronjob()->abortExecution($request);

var_dump($response->getBody();