gitops

Get a GitOps workflow by ID

Changed on

Returns the detail view of a single GitOps workflow, with one entry per backing stack or edge stack artifact. Access policy: authenticated

get/gitops/workflows/{id}

Request

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

Path parameters

idinteger required

Workflow identifier

Response

OK

creationDateinteger
idinteger required
lastSyncDateinteger
namestring required

Example response

{
  "artifacts": [
    {
      "autoUpdate": {
        "Interval": "1m30s",
        "JobID": "15",
        "Webhook": "05de31a2-79fa-4644-9c12-faa67e5c49f0"
      },
      "files": [
        {
          "hash": "abc123",
          "path": "portainer.yaml",
          "ref": "refs/heads/main"
        }
      ]
    }
  ]
}

Changes

  • 337ae34995abRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • f944baf68a3eRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status