Sign in
Public Repositories

Detect and parse a `.env.example`-style file for a public repository (supports GitHub and GitLab)

get/git/public/{provider}/{owner}/{repo}/env-example

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}/env-example
  • 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 name to inspect (default: repository's default branch)

root_directorystring nullable

Project root directory to search (default: repository root)

Response

Detected env-example variables

branchstring required

Branch the file was read from

pathstring nullable

Path of the detected env-example file (e.g. ".env.example"), null if the repository has none

Changes

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