gitops

List all GitOps workflows

Changed on Jul 14, 2026

Returns a list of GitOps workflows, each with its aggregated status and the artifacts it contains. Access policy: authenticated

get/gitops/workflows

Request

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

Query parameters

searchstring

Search term (matches workflow name)

sort'name' | 'status' | 'creationDate' | 'lastSyncDate'

Sort field

order'asc' | 'desc'

Sort order

startinteger

Pagination start index

limitinteger

Pagination limit (0 = unlimited)

endpointIdsinteger[]

Filter by environment IDs (e.g. endpointIds[]=1&endpointIds[]=2)

status'healthy' | 'syncing' | 'error' | 'paused' | 'unknown'

Filter by status

type'stack'

Keep workflows that have at least one artifact of this type

platform'dockerStandalone' | 'dockerSwarm' | 'kubernetes'

Keep workflows that have at least one artifact on this platform

Response

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

Jul 14, 2026337ae34995ab Revision changes
- breaking
  the query request parameter order was restricted to a list of enum values
- breaking
  the query request parameter platform was restricted to a list of enum values
- breaking
  the query request parameter sort was restricted to a list of enum values
- breaking
  the query request parameter status was restricted to a list of enum values
- breaking
  the query request parameter type was restricted to a list of enum values
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- 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
- warning
  removed the optional property / from the response with the status
- info
  added the new enum value asc to the query request parameter order
- info
  added the new enum value creationDate to the query request parameter sort
- info
  added the new enum value desc to the query request parameter order
- info
  added the new enum value dockerStandalone to the query request parameter platform
- info
  added the new enum value dockerSwarm to the query request parameter platform
- info
  added the new enum value error to the query request parameter status
- info
  added the new enum value healthy to the query request parameter status
- info
  added the new enum value kubernetes to the query request parameter platform
- info
  added the new enum value lastSyncDate to the query request parameter sort
- info
  added the new enum value name to the query request parameter sort
- info
  added the new enum value paused to the query request parameter status
- info
  added the new enum value stack to the query request parameter type
- info
  added the new enum value status to the query request parameter sort
- info
  added the new enum value syncing to the query request parameter status
- info
  added the new enum value unknown to the query request parameter status
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
Jul 9, 202699d4ab22fc1e Revision changes
- info
  added the optional property / to the response with the status

Operation history (3 revisions)