helpers

Check if S3 path exists and is a folder

get/w/{workspace}/job_helpers/check_s3_folder_exists

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/job_helpers/check_s3_folder_exists
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

file_keystring required

S3 file key to check (e.g., gitrepos/{workspace_id}/u/user/resource/{commit_hash})

marker_filestring

If provided, the folder is only considered to exist when this exact sentinel file is present under file_key. Lets callers distinguish a fully populated folder from a partial upload.

Response

S3 folder existence check result

existsboolean required

Whether the path exists

is_folderboolean required

Whether the path is a folder (true) or file (false)

Changes

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