Create a cronjob

POST /v2/projects/{projectId}/cronjobs/

API version

v2

Request method

POST

Operation ID

cronjob-create-cronjob

---

Request

• projectIdstring (uuid)

  required

  ID of the Project you want to create a Cronjob for.

Responses

Format

application/json

Description

Created

Schema documentation

• idstring (uuid)

  required

Example

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"active":true,"appId":"f0f86186-0a5a-45b2-aa33-502777496347","description":"i am a cronjob","destination":{"url":"https://mydomain.com"},"email":"email@mittwald.example","interval":"*/5 * * * *","timeout":123}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/cronjobs

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.createCronjob({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "active": true,
    "appId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "description": "i am a cronjob",
    "destination": {
      "url": "https://mydomain.com"
    },
    "email": "email@mittwald.example",
    "interval": "*/5 * * * *",
    "timeout": 123
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Cronjob\CreateCronjob\CreateCronjobRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Cronjob\CreateCronjob\CreateCronjobRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new CreateCronjobRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->cronjob()->createCronjob($request);

var_dump($response->getBody();