portainer.EdgeJob

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/portainer/main/json-schema/portainer-portainer-edge-job-schema.json",
  "title": "portainer.EdgeJob",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/portainer-edge-jobs-api-openapi.yml#/components/schemas/portainer.EdgeJob",
  "properties": {
    "Created": {
      "type": "integer"
    },
    "CronExpression": {
      "type": "string"
    },
    "EdgeGroups": {
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "Endpoints": {
      "additionalProperties": {
        "$ref": "#/$defs/portainer.EdgeJobEndpointMeta"
      },
      "type": "object"
    },
    "GroupLogsCollection": {
      "additionalProperties": {
        "$ref": "#/$defs/portainer.EdgeJobEndpointMeta"
      },
      "description": "Field used for log collection of Endpoints belonging to EdgeGroups",
      "type": "object"
    },
    "Id": {
      "description": "EdgeJob Identifier",
      "type": "integer"
    },
    "Name": {
      "type": "string"
    },
    "Recurring": {
      "type": "boolean"
    },
    "ScriptPath": {
      "type": "string"
    },
    "Version": {
      "type": "integer"
    }
  },
  "type": "object",
  "$defs": {
    "portainer.EdgeJobEndpointMeta": {
      "properties": {
        "CollectLogs": {
          "type": "boolean"
        },
        "LogsStatus": {
          "$ref": "#/$defs/portainer.EdgeJobLogsStatus"
        }
      },
      "type": "object"
    },
    "portainer.EdgeJobLogsStatus": {
      "enum": [
        0,
        1,
        2,
        3
      ],
      "type": "integer",
      "x-enum-varnames": [
        "_",
        "EdgeJobLogsStatusIdle",
        "EdgeJobLogsStatusPending",
        "EdgeJobLogsStatusCollected"
      ]
    }
  }
}