edge_stacks

Create an EdgeStack from file

Access policy: administrator

post/edge_stacks/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_stacks/create/file
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Query parameters

dryrunstring

if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object

Request body multipart/form-data

Namestring required

Name of the stack. it must only consist of lowercase alphanumeric characters, hyphens, or underscores as well as start with a letter or number

filestring binary required

Content of the Stack file

EdgeGroupsstring required

JSON stringified array of Edge Groups ids

DeploymentTypeinteger required

deploy type 0 - 'compose', 1 - 'kubernetes'

Registriesstring

JSON stringified array of Registry ids to use for this stack

UseManifestNamespacesboolean

Uses the manifest's namespaces instead of the default one, relevant only for kube environments

PrePullImageboolean

Pre Pull image

RetryDeployboolean

Retry deploy

Response

OK

CreatedBystring

The username which created this stack

CreatedByUserIdstring

The username id which created this stack

CreationDateinteger

StatusArray map[EndpointID][]EdgeStackStatus json:"StatusArray"

DeploymentType0 | 1
EdgeGroupsinteger[]
EntryPointstring
Idinteger

EdgeStack Identifier

ManifestPathstring
Namestring
NumDeploymentsinteger
ProjectPathstring
Statusobject
UseManifestNamespacesboolean

Uses the manifest's namespaces instead of the default one

Versioninteger

Example response

{
  "CreatedBy": "admin",
  "CreatedByUserId": "1",
  "Id": 1
}

Changes

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