Portainer edge_jobs API

openapi: 3.2.0
info:
  contact:
    email: info@portainer.io
  description: 'Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API.

    Examples are available at https://documentation.portainer.io/api/api-examples/

    You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).


    # Authentication


    Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used.

    Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request

    with the **Bearer** authentication mechanism.


    Example:


    ```

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE

    ```


    # Security


    Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).


    Different access policies are available:


    - Public access

    - Authenticated access

    - Restricted access

    - Administrator access


    ### Public access


    No authentication is required to access the environments(endpoints) with this access policy.


    ### Authenticated access


    Authentication is required to access the environments(endpoints) with this access policy.


    ### Restricted access


    Authentication is required to access the environments(endpoints) with this access policy.

    Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.


    ### Administrator access


    Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.


    # Execute Docker requests


    Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).


    Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.


    To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).


    # Private Registry


    Using private registry, you will need to pass a based64 encoded JSON string ‘{"registryId":\<registryID value\>}’ inside the Request Header. The parameter name is "X-Registry-Auth".

    \<registryID value\> - The registry ID where the repository was created.


    Example:


    ```

    eyJyZWdpc3RyeUlkIjoxfQ==

    ```


    **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/).

    '
  license:
    name: zlib
    url: https://github.com/portainer/portainer/blob/develop/LICENSE
  title: PortainerCE auth Edge Jobs API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage Edge Jobs
  name: edge_jobs
paths:
  /edge_jobs:
    get:
      description: '**Access policy**: administrator'
      operationId: EdgeJobList
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/portainer.EdgeJob'
                type: array
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Fetch EdgeJobs list
      tags:
      - edge_jobs
  /edge_jobs/{id}:
    delete:
      description: '**Access policy**: administrator'
      operationId: EdgeJobDelete
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Delete an EdgeJob
      tags:
      - edge_jobs
    get:
      description: '**Access policy**: administrator'
      operationId: EdgeJobInspect
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EdgeJob'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Inspect an EdgeJob
      tags:
      - edge_jobs
    put:
      description: '**Access policy**: administrator'
      operationId: EdgeJobUpdate
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EdgeJob'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Update an EdgeJob
      tags:
      - edge_jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/edgejobs.edgeJobUpdatePayload'
        description: EdgeGroup data
        required: true
  /edge_jobs/{id}/file:
    get:
      description: '**Access policy**: administrator'
      operationId: EdgeJobFile
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/edgejobs.edgeJobFileResponse'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Fetch a file of an EdgeJob
      tags:
      - edge_jobs
  /edge_jobs/{id}/tasks:
    get:
      description: '**Access policy**: administrator'
      operationId: EdgeJobTasksList
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/edgejobs.taskContainer'
                type: array
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Fetch the list of tasks on an EdgeJob
      tags:
      - edge_jobs
  /edge_jobs/{id}/tasks/{taskID}/logs:
    delete:
      description: '**Access policy**: administrator'
      operationId: EdgeJobTasksClear
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      - description: Task Id
        in: path
        name: taskID
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Clear the log for a specifc task on an EdgeJob
      tags:
      - edge_jobs
    get:
      description: '**Access policy**: administrator'
      operationId: EdgeJobTaskLogsInspect
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      - description: Task Id
        in: path
        name: taskID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/edgejobs.fileResponse'
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Fetch the log for a specifc task on an EdgeJob
      tags:
      - edge_jobs
    post:
      description: '**Access policy**: administrator'
      operationId: EdgeJobTasksCollect
      parameters:
      - description: EdgeJob Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      - description: Task Id
        in: path
        name: taskID
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Collect the log for a specifc task on an EdgeJob
      tags:
      - edge_jobs
  /edge_jobs/create/file:
    post:
      description: '**Access policy**: administrator'
      operationId: EdgeJobCreateFile
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EdgeGroup'
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Create an EdgeJob from a file
      tags:
      - edge_jobs
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Content of the Stack file
                  format: binary
                Name:
                  type: string
                  description: Name of the stack
                CronExpression:
                  type: string
                  description: A cron expression to schedule this job
                EdgeGroups:
                  type: string
                  description: JSON stringified array of Edge Groups ids
                Endpoints:
                  type: string
                  description: JSON stringified array of Environment ids
                Recurring:
                  type: boolean
                  description: If recurring
              required:
              - file
              - Name
              - CronExpression
              - EdgeGroups
              - Endpoints
  /edge_jobs/create/string:
    post:
      description: '**Access policy**: administrator'
      operationId: EdgeJobCreateString
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EdgeGroup'
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Create an EdgeJob from a text
      tags:
      - edge_jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/edgejobs.edgeJobCreateFromFileContentPayload'
        description: EdgeGroup data when method is string
        required: true
components:
  schemas:
    edgejobs.edgeJobUpdatePayload:
      properties:
        CronExpression:
          type: string
        EdgeGroups:
          items:
            type: integer
          type: array
        Endpoints:
          items:
            type: integer
          type: array
        FileContent:
          type: string
        Name:
          type: string
        Recurring:
          type: boolean
      type: object
    roar.Roar-portainer_EndpointID:
      type: object
    edgejobs.edgeJobFileResponse:
      properties:
        FileContent:
          type: string
      type: object
    edgejobs.fileResponse:
      properties:
        FileContent:
          type: string
      type: object
    portainer.EdgeGroup:
      properties:
        Dynamic:
          type: boolean
        EndpointIds:
          $ref: '#/components/schemas/roar.Roar-portainer_EndpointID'
        Endpoints:
          description: 'Deprecated: only used for API responses'
          items:
            type: integer
          type: array
        Id:
          description: EdgeGroup Identifier
          example: 1
          type: integer
        Name:
          type: string
        PartialMatch:
          type: boolean
        TagIds:
          items:
            type: integer
          type: array
      type: object
    portainer.EdgeJobEndpointMeta:
      properties:
        CollectLogs:
          type: boolean
        LogsStatus:
          $ref: '#/components/schemas/portainer.EdgeJobLogsStatus'
      type: object
    edgejobs.taskContainer:
      properties:
        EndpointId:
          type: integer
        EndpointName:
          type: string
        Id:
          type: string
        LogsStatus:
          $ref: '#/components/schemas/portainer.EdgeJobLogsStatus'
      type: object
    edgejobs.edgeJobCreateFromFileContentPayload:
      properties:
        CronExpression:
          type: string
        EdgeGroups:
          items:
            type: integer
          type: array
        Endpoints:
          items:
            type: integer
          type: array
        FileContent:
          type: string
        Name:
          type: string
        Recurring:
          type: boolean
      type: object
    portainer.EdgeJob:
      properties:
        Created:
          type: integer
        CronExpression:
          type: string
        EdgeGroups:
          items:
            type: integer
          type: array
        Endpoints:
          additionalProperties:
            $ref: '#/components/schemas/portainer.EdgeJobEndpointMeta'
          type: object
        GroupLogsCollection:
          additionalProperties:
            $ref: '#/components/schemas/portainer.EdgeJobEndpointMeta'
          description: Field used for log collection of Endpoints belonging to EdgeGroups
          type: object
        Id:
          description: EdgeJob Identifier
          example: 1
          type: integer
        Name:
          type: string
        Recurring:
          type: boolean
        ScriptPath:
          type: string
        Version:
          type: integer
      type: object
    portainer.EdgeJobLogsStatus:
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
      x-enum-varnames:
      - _
      - EdgeJobLogsStatusIdle
      - EdgeJobLogsStatusPending
      - EdgeJobLogsStatusCollected
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey