How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Portainer

Portainer edge_jobs API

Manage Edge Jobs

Documentation Provider Profile APIs.io OpenAPI GitHub

Portainer edge_jobs API is one of 32 APIs that Portainer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 11 operations across 7 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 2.39.1.

Requests are made against a single base URL, /api.

11 operations 7 paths 10 schemas 2 DELETE5 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.39.1
Base URL
https://api-docs.portainer.io
Authentication
API Key, API Key
Contact
info@portainer.io
License
zlib
Resource Areas
1

Authentication & Security 2

Portainer edge_jobs API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). An API key is passed in the header as Authorization (jwt).

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

edge_jobs 11

Manage Edge Jobs

GET
/edge_jobs
Fetch EdgeJobs list
EdgeJobList → 200400500503
DELETE
/edge_jobs/{id}
Delete an EdgeJob
EdgeJobDelete 1 param → 204400500503
GET
/edge_jobs/{id}
Inspect an EdgeJob
EdgeJobInspect 1 param → 200400500503
PUT
/edge_jobs/{id}
Update an EdgeJob
EdgeJobUpdate 1 param body → 200400500503
GET
/edge_jobs/{id}/file
Fetch a file of an EdgeJob
EdgeJobFile 1 param → 200400500503
GET
/edge_jobs/{id}/tasks
Fetch the list of tasks on an EdgeJob
EdgeJobTasksList 1 param → 200400500503
DELETE
/edge_jobs/{id}/tasks/{taskID}/logs
Clear the log for a specifc task on an EdgeJob
EdgeJobTasksClear 2 params → 204400500503
GET
/edge_jobs/{id}/tasks/{taskID}/logs
Fetch the log for a specifc task on an EdgeJob
EdgeJobTaskLogsInspect 2 params → 200400500503
POST
/edge_jobs/{id}/tasks/{taskID}/logs
Collect the log for a specifc task on an EdgeJob
EdgeJobTasksCollect 2 params → 204400500503
POST
/edge_jobs/create/file
Create an EdgeJob from a file
EdgeJobCreateFile body → 200500503
POST
/edge_jobs/create/string
Create an EdgeJob from a text
EdgeJobCreateString body → 200500503

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are portainer.EdgeJob (10 properties), portainer.EdgeGroup (7 properties), edgejobs.edgeJobCreateFromFileContentPayload (6 properties), edgejobs.edgeJobUpdatePayload (6 properties). Each schema is shown below with its type and property counts.

edgejobs.edgeJobUpdatePayload
object
6 properties
roar.Roar-portainer_EndpointID
object
edgejobs.edgeJobFileResponse
object
1 property
edgejobs.fileResponse
object
1 property
portainer.EdgeGroup
object
7 properties
portainer.EdgeJobEndpointMeta
object
2 properties
edgejobs.taskContainer
object
4 properties
edgejobs.edgeJobCreateFromFileContentPayload
object
6 properties
portainer.EdgeJob
object
10 properties
portainer.EdgeJobLogsStatus
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portainer-edge-jobs-api-openapi.yml Raw ↑

Other APIs Portainer publishes across the network.

Portainer auth API
AE Profile APIs.io
Portainer backup API
AE Profile APIs.io
Portainer custom_templates API
AE Profile APIs.io
Portainer docker API
AE Profile APIs.io
Portainer edge API
AE Profile APIs.io
Portainer edge_groups API
AE Profile APIs.io
Portainer edge_stacks API
AE Profile APIs.io
Portainer endpoint_groups API
AE Profile APIs.io
Portainer endpoints API
AE Profile APIs.io
Portainer gitops API
AE Profile APIs.io
Portainer helm API
AE Profile APIs.io
Portainer intel API
AE Profile APIs.io
← Back to P APIs
API Details
ID
portainer:portainer-edge-jobs-api
Base URL
https://api-docs.portainer.io
Docs
https://www.portainer.io/
Provider
Portainer
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=portainer-edge-jobs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/portainer-edge-jobs-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Portainer edge_jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.