RIrilldata

GetRepoMeta returns credentials and other metadata for accessing a project's repo

Changed on
get/v1/projects/{projectId}/repo/meta

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

projectIdstring required

The project ID to get repository metadata for.

Response

A successful response.

archiveCreatedOnstring date-time

The creation time of the archive returned from archive_download_url.

archiveDownloadUrlstring

Signed URL for downloading a tarball of project files. If this is set, the git_* fields will be empty (and vice versa).

archiveIdstring

A stable ID for the archive returned from archive_download_url.

editableboolean

Whether editing is allowed. Set to true for dev deployments.

expiresOnstring date-time

How long the returned config is valid for. Clients should call GetRepoMeta again after this time.

gitBranchstring

The branch to use for the deployment.

gitSubpathstring

Optional subpath within the Git repository to use as the project root.

gitUrlstring

Git remote for cloning (and maybe pushing) a Git repository. The URL uses HTTPS with embedded username/password.

lastUpdatedOnstring date-time

When the returned config was last modified. This covers all fields in the response except the ephemeral credentials embedded in git_url and archive_download_url.

managedGitRepoboolean

Whether the git repo is managed by Rill.

primaryBranchstring

Primary branch of the project.

Changes

  • v1af5e88e19894Revision changes
    • warning

      removed the optional property from the response with the status

    • 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 optional property to the response with the status