edge_jobs

Create an EdgeJob from a file

Access policy: administrator

post/edge_jobs/create/file

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/edge_jobs/create/file
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Request body multipart/form-data

filestring binary required

Content of the Stack file

Namestring required

Name of the stack

CronExpressionstring required

A cron expression to schedule this job

EdgeGroupsstring required

JSON stringified array of Edge Groups ids

Endpointsstring required

JSON stringified array of Environment ids

Recurringboolean

If recurring

Response

OK

Dynamicboolean
EndpointIdsRoarRoarPortainerEndpointID
Endpointsinteger[]

Deprecated: only used for API responses

Idinteger

EdgeGroup Identifier

Namestring
PartialMatchboolean
TagIdsinteger[]

Example response

{
  "Id": 1
}

Changes

No recorded changes to this operation across all 21 revisions of this API.