# Portainer Git Ops API

**Canonical:** https://apis.io/apis/portainer/portainer-git-ops-api/  
**Provider:** Portainer — https://apis.io/providers/portainer/  
**Base URL:** https://api-docs.portainer.io  
**Documentation:** https://www.portainer.io/

Portainer Git Ops API is one of 32 APIs that [Portainer](https://apis.io/providers/portainer/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include GitOps. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and 2 JSON Schemas.

Operate git repository

## Operations (1)

| Method | Path | Summary |
|---|---|---|
| POST | `/gitops/repo/file/preview` | preview the content of target file in the git repository |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/openapi/portainer-git-ops-api-openapi.yml
- **Documentation** — https://docs.portainer.io/
- **APIReference** — https://api-docs.portainer.io/
- **GettingStarted** — https://docs.portainer.io/start
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-gitops-repository-file-preview-payload-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-gitops-file-response-schema.json

## Other Portainer APIs (12)

- [Portainer Auth API](https://apis.io/apis/portainer/portainer-auth-api/)
- [Portainer Backup API](https://apis.io/apis/portainer/portainer-backup-api/)
- [Portainer Custom Templates API](https://apis.io/apis/portainer/portainer-custom-templates-api/)
- [Portainer Docker API](https://apis.io/apis/portainer/portainer-docker-api/)
- [Portainer Edge API](https://apis.io/apis/portainer/portainer-edge-api/)
- [Portainer Edge Groups API](https://apis.io/apis/portainer/portainer-edge-groups-api/)
- [Portainer Edge Jobs API](https://apis.io/apis/portainer/portainer-edge-jobs-api/)
- [Portainer Edge Stacks API](https://apis.io/apis/portainer/portainer-edge-stacks-api/)
- [Portainer Endpoint Groups API](https://apis.io/apis/portainer/portainer-endpoint-groups-api/)
- [Portainer Endpoints API](https://apis.io/apis/portainer/portainer-endpoints-api/)
- [Portainer Helm API](https://apis.io/apis/portainer/portainer-helm-api/)
- [Portainer Intel API](https://apis.io/apis/portainer/portainer-intel-api/)

## Tags

GitOps

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/portainer/portainer-git-ops-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/portainer/.