List cronjobs belonging to a Project

GET/projects/{projectId}/cronjobs/

API version

v2

Request method

GET

Operation ID

cronjob-list-cronjobs

---

Request

• projectIdstring

  required

  ID of the Project for which to list Cronjobs for.

Responses

Response headers

• X-Pagination-Limitinteger

  The limit used to select the resources for the response

• X-Pagination-Skipinteger

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountinteger

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

OK

Schema documentation

• Array[
  • *object
    • activeboolean

      required
    • appIdstring (uuid)

      deprecated

      required

      DEPRECATED: Use 'appInstallationId' instead. This field will be removed in a future version.

    • appInstallationIdstring (uuid)
    • concurrencyPolicystring (one of: allow, forbid, replace)
    • createdAtstring (date-time)

      required
    • descriptionstring

      required
    • destinationone of 2 alternatives

      required
      • Alternativeobject
        • urlstring

          required
      • Alternativeobject
        • interpreterstring

          required
        • parametersstring
        • pathstring

          required
    • emailstring (email)
    • failedExecutionAlertThresholdinteger (≥ 1)

      required
    • idstring (uuid)

      required
    • intervalstring

      required
    • latestExecutionobject
      • abortedByobject
        • idstring (uuid)
      • cronjobIdstring

        required
      • durationInMillisecondsinteger (int64)
      • endstring (date-time)
      • executionEndstring (date-time)

        deprecated
      • executionStartstring (date-time)

        deprecated
      • exitCodeinteger (int32)
      • 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
    • timeZonestring
    • timeoutinteger (≥ 1)

      required
    • updatedAtstring (date-time)

      required
  ]

Example

Content-Type: application/json

[
  {
    "active": true,
    "appInstallationId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "concurrencyPolicy": "allow",
    "createdAt": "1985-10-26T01:21:00.000Z",
    "description": "i am a cronjob",
    "destination": {
      "url": "https://mydomain.com"
    },
    "email": "email@mittwald.example",
    "failedExecutionAlertThreshold": 123,
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "interval": "*/5 * * * *",
    "latestExecution": {
      "abortedBy": {
        "id": "f0f86186-0a5a-45b2-aa33-502777496347"
      },
      "cronjobId": "string",
      "durationInMilliseconds": 12374,
      "end": "1985-10-26T01:21:00.000Z",
      "exitCode": 123,
      "id": "cron-bd26li-28027320",
      "logPath": "/var/log/cronjobs/cron-bd26li-28027320.log",
      "start": "1985-10-26T01:21:00.000Z",
      "status": "Complete",
      "successful": true,
      "triggeredBy": {
        "id": "f0f86186-0a5a-45b2-aa33-502777496347"
      }
    },
    "nextExecutionTime": "1985-10-26T01:21:00.000Z",
    "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "shortId": "cron-bd26li",
    "timeZone": "string",
    "timeout": 123,
    "updatedAt": "1985-10-26T01:21:00.000Z"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "active": {
        "type": "boolean"
      },
      "appId": {
        "deprecated": true,
        "description": "DEPRECATED: Use 'appInstallationId' instead. This field will be removed in a future version.",
        "format": "uuid",
        "type": "string"
      },
      "appInstallationId": {
        "format": "uuid",
        "type": "string"
      },
      "concurrencyPolicy": {
        "enum": [
          "allow",
          "forbid",
          "replace"
        ],
        "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"
      },
      "failedExecutionAlertThreshold": {
        "minimum": 1,
        "type": "integer"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "interval": {
        "example": "*/5 * * * *",
        "type": "string"
      },
      "latestExecution": {
        "properties": {
          "abortedBy": {
            "properties": {
              "id": {
                "format": "uuid",
                "type": "string"
              }
            },
            "type": "object"
          },
          "cronjobId": {
            "type": "string"
          },
          "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"
          },
          "exitCode": {
            "example": 0,
            "format": "int32",
            "type": "integer"
          },
          "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",
          "cronjobId"
        ],
        "type": "object"
      },
      "nextExecutionTime": {
        "format": "date-time",
        "type": "string"
      },
      "projectId": {
        "format": "uuid",
        "type": "string"
      },
      "shortId": {
        "example": "cron-bd26li",
        "type": "string"
      },
      "timeZone": {
        "type": "string"
      },
      "timeout": {
        "maximum": 86400,
        "minimum": 1,
        "type": "integer"
      },
      "updatedAt": {
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "id",
      "appId",
      "shortId",
      "interval",
      "active",
      "createdAt",
      "updatedAt",
      "description",
      "destination",
      "timeout",
      "failedExecutionAlertThreshold"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/string/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": "string",
  "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: "string"
))
  ->withLimit(50)
  ->withPage(1);
$response = $client->cronjob()->listCronjobs($request);

var_dump($response->getBody();