Skip to main content
Version: 3.5

UpdateVersionRequest

Index

Properties

actor_path

actor_path: str | None

The Actor's directory inside the uploaded source, as a path relative to the upload root with / separators, for example actors/typescript-actor. Applies when the sourceType is SOURCE_FILES or TARBALL. The API rejects it when the sourceType is GIT_REPO or GITHUB_GIST. On an update without sourceType, the API checks it against the version's stored source type. When the version has no actorPath, the upload root is the Actor's directory. It has 1 to 255 characters, with no leading, trailing, or repeated / and no . or .. segments. An update that sends sourceType, sourceFiles, or tarballUrl without actorPath removes the stored actorPath, so send it again with every upload. An update of other fields, such as envVars or buildTag, keeps it. Send null to remove it.

apply_env_vars_to_build

apply_env_vars_to_build: bool | None

Whether to inject the environment variables at build time.

build_tag

build_tag: str | None

The tag name to apply to a successful build of this version. Can be null when the version has no build tag.

env_vars

env_vars: list[EnvVarRequest] | None

Environment variables for the version.

git_repo_url

git_repo_url: str | None

URL of the Git repository to clone the source code from. Applies when the sourceType is GIT_REPO.

github_gist_url

github_gist_url: str | None

URL of the GitHub Gist to clone the source code from. Applies when the sourceType is GITHUB_GIST.

model_config

model_config: Undefined

source_files

source_files: list[SourceCodeFile | SourceCodeFolder] | None

Applies when the sourceType is SOURCE_FILES. Represents the Actor's file structure as an array of files and folders.

source_type

source_type: WritableVersionSourceType | None

Where the source code of the version lives.

tarball_url

tarball_url: str | None

URL of the zip archive to download the source code from. Applies when the sourceType is TARBALL.

version_number

version_number: str | None

The version number of the Actor. Two numbers separated by a dot, that represent the MAJOR.MINOR part of the semantic versioning.