Get a cronjob execution

GET /v2/cronjobs/{cronjobId}/executions/{executionId}/

API version

v2

Request method

GET

Operation ID

cronjob-get-execution

---

Request

• executionIdstring

  required

  ID of the CronjobExecution to be retrieved.

  Example:"cron-bd26li-28027320"
• cronjobIdstring (uuid)

  required

Responses

Format

application/json

Description

OK

Schema documentation

• 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)

Example

{
  "abortedBy": {
    "id": "f0f86186-0a5a-45b2-aa33-502777496347"
  },
  "durationInMilliseconds": 12374,
  "end": "2024-09-16T00:26:45.171Z",
  "executionEnd": "2024-09-16T00:26:45.171Z",
  "executionStart": "2024-09-16T00:26:45.171Z",
  "id": "cron-bd26li-28027320",
  "logPath": "/var/log/cronjobs/cron-bd26li-28027320.log",
  "start": "2024-09-16T00:26:45.171Z",
  "status": "Complete",
  "successful": true,
  "triggeredBy": {
    "id": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
}

JSON Schema

{
  "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"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/cronjobs/f0f86186-0a5a-45b2-aa33-502777496347/executions/string

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

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetExecutionRequest(
  executionId: "string",
  cronjobId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->cronjob()->getExecution($request);

var_dump($response->getBody();