List cronjobs belonging to a Project

GET/projects/{projectId}/cronjobs/

API version

v2

Request method

GET

Operation ID

cronjob-list-cronjobs

---

Request

• projectIdstring (uuid)

  required

  ID of the Project for which to list Cronjobs for.

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
• *object
  • activeboolean

    required
  • appIdstring (uuid)

    required
  • createdAtstring (date-time)

    required
  • descriptionstring

    required
  • destinationone of 2 alternatives

    required
  • emailstring (email)
  • idstring (uuid)

    required
  • intervalstring

    required
  • latestExecutionobject
    • abortedByobject
      • idstring (uuid)
    • durationInMillisecondsinteger (int64)
    • endstring (date-time)
    • executionEndstring (date-time)
    • executionStartstring (date-time)
    • idstring

      required
    • logPathstring
    • startstring (date-time)
    • statusstring (one of: Complete, Failed, AbortedBySystem, Pending, Running, AbortedByUser, TimedOut)

      required
    • successfulboolean

      required
    • triggeredByobject
      • idstring (uuid)
  • nextExecutionTimestring (date-time)
  • projectIdstring (uuid)
  • shortIdstring

    required
  • timeoutnumber (≥ 1)

    required
  • updatedAtstring (date-time)

    required
]

Example

[
  {
    "active": true,
    "appId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "createdAt": "2024-11-23T00:28:27.794Z",
    "description": "i am a cronjob",
    "destination": {
      "url": "https://mydomain.com"
    },
    "email": "email@mittwald.example",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "interval": "*/5 * * * *",
    "latestExecution": {
      "abortedBy": {
        "id": "f0f86186-0a5a-45b2-aa33-502777496347"
      },
      "durationInMilliseconds": 12374,
      "end": "2024-11-23T00:28:27.794Z",
      "executionEnd": "2024-11-23T00:28:27.794Z",
      "executionStart": "2024-11-23T00:28:27.794Z",
      "id": "cron-bd26li-28027320",
      "logPath": "/var/log/cronjobs/cron-bd26li-28027320.log",
      "start": "2024-11-23T00:28:27.794Z",
      "status": "Complete",
      "successful": true,
      "triggeredBy": {
        "id": "f0f86186-0a5a-45b2-aa33-502777496347"
      }
    },
    "nextExecutionTime": "2024-11-23T00:28:27.794Z",
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "shortId": "cron-bd26li",
    "timeout": 123,
    "updatedAt": "2024-11-23T00:28:27.794Z"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "active": {
        "type": "boolean"
      },
      "appId": {
        "format": "uuid",
        "type": "string"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "description": {
        "example": "i am a cronjob",
        "type": "string"
      },
      "destination": {
        "oneOf": [
          {
            "properties": {
              "url": {
                "example": "https://mydomain.com",
                "type": "string"
              }
            },
            "required": [
              "url"
            ],
            "type": "object"
          },
          {
            "properties": {
              "interpreter": {
                "example": "/usr/bin/bash",
                "type": "string"
              },
              "parameters": {
                "example": "--debug",
                "type": "string"
              },
              "path": {
                "example": "/html/my-wordpress/script.sh",
                "type": "string"
              }
            },
            "required": [
              "interpreter",
              "path"
            ],
            "type": "object"
          }
        ]
      },
      "email": {
        "format": "email",
        "type": "string"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "interval": {
        "example": "*/5 * * * *",
        "type": "string"
      },
      "latestExecution": {
        "properties": {
          "abortedBy": {
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              }
            },
            "type": "object"
          },
          "durationInMilliseconds": {
            "example": 12374,
            "format": "int64",
            "type": "integer"
          },
          "end": {
            "format": "date-time",
            "type": "string"
          },
          "executionEnd": {
            "deprecated": true,
            "format": "date-time",
            "type": "string"
          },
          "executionStart": {
            "deprecated": true,
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "example": "cron-bd26li-28027320",
            "type": "string"
          },
          "logPath": {
            "example": "/var/log/cronjobs/cron-bd26li-28027320.log",
            "type": "string"
          },
          "start": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "Complete",
              "Failed",
              "AbortedBySystem",
              "Pending",
              "Running",
              "AbortedByUser",
              "TimedOut"
            ],
            "type": "string"
          },
          "successful": {
            "type": "boolean"
          },
          "triggeredBy": {
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "required": [
          "id",
          "status",
          "successful"
        ],
        "type": "object"
      },
      "nextExecutionTime": {
        "format": "date-time",
        "type": "string"
      },
      "projectId": {
        "format": "uuid",
        "type": "string"
      },
      "shortId": {
        "example": "cron-bd26li",
        "type": "string"
      },
      "timeout": {
        "maximum": 86400,
        "minimum": 1,
        "type": "number"
      },
      "updatedAt": {
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "id",
      "appId",
      "shortId",
      "interval",
      "active",
      "createdAt",
      "updatedAt",
      "description",
      "destination",
      "timeout"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/cronjobs?limit=50&page=1

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.listCronjobs({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "queryParameters": {
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListCronjobsRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347"
))
  ->withLimit(50)
  ->withPage(1);
$response = $client->cronjob()->listCronjobs($request);

var_dump($response->getBody();