Trigger a cronjob

POST/cronjobs/{cronjobId}/executions/

API version

v2

Request method

POST

Operation ID

cronjob-create-execution

---

Request

• cronjobIdstring (uuid)

  required

  ID of the Cronjob to trigger.

Responses

Format

application/json

Description

Created

Schema documentation

• idstring

  required

  execution-id

Example

{
  "id": "string"
}

JSON Schema

{
  "properties": {
    "id": {
      "description": "execution-id",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

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

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.createExecution({
  "cronjobId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Cronjob\CreateExecution\CreateExecutionRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Cronjob\CreateExecution\CreateExecutionRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new CreateExecutionRequest(
  cronjobId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->cronjob()->createExecution($request);

var_dump($response->getBody();