Public Repositories

Parse a compose file's services for a public repository (supports GitHub and GitLab). Unlike env-example detection, the caller already knows the path (from the `compose_files` list `/preset` already returned), so this fetches that one file directly rather than scanning the tree first.

get/git/public/{provider}/{owner}/{repo}/compose-file

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/git/public/{provider}/{owner}/{repo}/compose-file
  • Auth: none declared

Path parameters

providerstring required

Git provider (github or gitlab)

ownerstring required

Repository owner

repostring required

Repository name

Query parameters

base_urlstring nullable

HTTPS/443 origin of a self-hosted GitLab instance. Requires authentication and git_repositories:read.

branchstring nullable

Branch to read the compose file from (default: repository's default branch)

pathstring required

Compose file path to fetch and parse (from the compose_files list /preset already returned, or a custom path the user typed)

Response

Compose services parsed successfully

branchstring required

Branch the file was read from

pathstring required

Changes

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