Sign in

v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Actors/Actor versions

Update version

Updates Actor version using values specified by a Version object passed as JSON in the POST payload.

If the object does not define a specific property, its value will not be updated.

The request needs to specify the Content-Type: application/json HTTP header!

When providing your API authentication token, we recommend using the request's Authorization header, rather than the URL. (More info).

The response is the Version object as returned by the Get version endpoint.

put/v2/actors/{actorId}/versions/{versionNumber}

Path parameters

actorIdstring required
Example:janedoe~my-actor

Actor ID or a tilde-separated owner's username and Actor name.

versionNumberstring required
Example:0.1

Actor version.

Request body

versionNumberstring nullable

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

sourceType'SOURCE_FILES' | 'GIT_REPO' | 'TARBALL' | 'GITHUB_GIST' | 'SOURCE_CODE'
applyEnvVarsToBuildboolean nullable

Whether to inject the environment variables at build time.

buildTagstring nullable

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

gitRepoUrlstring nullable

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

tarballUrlstring nullable

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

gitHubGistUrlstring nullable

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

Example request

{
  "versionNumber": "1.6",
  "envVars": [
    {
      "name": "MY_ENV_VAR",
      "value": "my-value"
    }
  ],
  "buildTag": "latest",
  "sourceFiles": [
    {
      "format": "TEXT",
      "content": "console.log('This is the main.js file');",
      "name": "src/main.js"
    }
  ]
}

Response

Example response

{
  "data": {
    "versionNumber": "0.0",
    "envVars": [
      {
        "name": "MY_ENV_VAR",
        "value": "my-value"
      }
    ],
    "buildTag": "latest",
    "sourceFiles": [
      {
        "format": "TEXT",
        "content": "console.log('This is the main.js file');",
        "name": "src/main.js"
      }
    ]
  }
}