Sign in
Git Providers

Render a redacted effective Compose preview for a connected repository.

Changed on
post/repositories/{repository_id}/compose-file/preview

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/repositories/{repository_id}/compose-file/preview
  • Auth: HTTP bearer

Path parameters

repository_idinteger required

Repository ID

Request body

branchstring nullable
composeOverridestring nullable
excludedServicesstring[]
pathstring required

Response

Effective Compose preview rendered

disabledServicesstring[] required
effectiveComposestring required

Effective user-controlled Compose YAML with sensitive values redacted.

enabledServicesstring[] required
pathstring required
redactedValuesinteger required
repositoryIdinteger required

Changes

  • 4b228ebed583Revision changes
    • info

      added the new optional request property

    • info

      added the media type application/problem+json for the response with the status

  • 1dc3e6788214Revision changes
    • breaking

      removed the media type application/problem+json for the response with the status

    • warning

      removed the request property