# Portainer Edge Jobs API

**Canonical:** https://apis.io/apis/portainer/portainer-edge-jobs-api/  
**Provider:** Portainer — https://apis.io/providers/portainer/  
**Base URL:** https://api-docs.portainer.io  
**Documentation:** https://www.portainer.io/

Portainer Edge Jobs API is one of 32 APIs that [Portainer](https://apis.io/providers/portainer/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and 6 JSON Schemas.

Manage Edge Jobs

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| GET | `/edge_jobs` | Fetch EdgeJobs list |
| DELETE | `/edge_jobs/{id}` | Delete an EdgeJob |
| GET | `/edge_jobs/{id}` | Inspect an EdgeJob |
| PUT | `/edge_jobs/{id}` | Update an EdgeJob |
| GET | `/edge_jobs/{id}/file` | Fetch a file of an EdgeJob |
| GET | `/edge_jobs/{id}/tasks` | Fetch the list of tasks on an EdgeJob |
| DELETE | `/edge_jobs/{id}/tasks/{taskID}/logs` | Clear the log for a specifc task on an EdgeJob |
| GET | `/edge_jobs/{id}/tasks/{taskID}/logs` | Fetch the log for a specifc task on an EdgeJob |
| POST | `/edge_jobs/{id}/tasks/{taskID}/logs` | Collect the log for a specifc task on an EdgeJob |
| POST | `/edge_jobs/create/file` | Create an EdgeJob from a file |
| POST | `/edge_jobs/create/string` | Create an EdgeJob from a text |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/openapi/portainer-edge-jobs-api-openapi.yml
- **Documentation** — https://docs.portainer.io/
- **APIReference** — https://api-docs.portainer.io/
- **GettingStarted** — https://docs.portainer.io/start
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-portainer-edge-job-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-portainer-edge-group-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-edgejobs-edge-job-create-from-file-content-payload-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-edgejobs-edge-job-update-payload-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-edgejobs-task-container-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-edgejobs-edge-job-file-response-schema.json

## Other Portainer APIs (12)

- [Portainer Auth API](https://apis.io/apis/portainer/portainer-auth-api/)
- [Portainer Backup API](https://apis.io/apis/portainer/portainer-backup-api/)
- [Portainer Custom Templates API](https://apis.io/apis/portainer/portainer-custom-templates-api/)
- [Portainer Docker API](https://apis.io/apis/portainer/portainer-docker-api/)
- [Portainer Edge API](https://apis.io/apis/portainer/portainer-edge-api/)
- [Portainer Edge Groups API](https://apis.io/apis/portainer/portainer-edge-groups-api/)
- [Portainer Edge Stacks API](https://apis.io/apis/portainer/portainer-edge-stacks-api/)
- [Portainer Endpoint Groups API](https://apis.io/apis/portainer/portainer-endpoint-groups-api/)
- [Portainer Endpoints API](https://apis.io/apis/portainer/portainer-endpoints-api/)
- [Portainer Helm API](https://apis.io/apis/portainer/portainer-helm-api/)
- [Portainer Intel API](https://apis.io/apis/portainer/portainer-intel-api/)
- [Portainer Kubernetes API](https://apis.io/apis/portainer/portainer-kubernetes-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/portainer/portainer-edge-jobs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/portainer/.