Update version

PUT 
https://api.apify.com/v2/acts/:actorId/versions/:versionNumber

ClientsUpdates 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.

Request

Path Parameters

actorId stringrequired

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

versionNumber stringrequired

Actor major and minor version of the Actor.

application/json

Bodyrequired

versionNumberstringnullable
Example: 0.0
sourceType object
oneOf
MOD1
VersionSourceType
string
Possible values: [SOURCE_FILES, GIT_REPO, TARBALL, GITHUB_GIST]
envVars object[]nullable
Array [
namestringrequired
Example: MY_ENV_VAR
valuestringrequired
Example: my-value
isSecretbooleannullable
Example: false
]
applyEnvVarsToBuildbooleannullable
Example: false
buildTagstringnullable
Example: latest
sourceFiles object[]
Array [
anyOf
SourceCodeFile
formatstringrequired
Possible values: [BASE64, TEXT]
Example: TEXT
contentstringrequired
Example: console.log('This is the main.js file');
namestringrequired
Example: src/main.js
SourceCodeFolder
namestringrequired
Example: src/placeholder
folderbooleanrequired
Possible values: [true]
Example: true
]

Responses

200

Response Headers

application/json

Schema

Schema

data objectrequired
versionNumberstringrequired
Example: 0.0
sourceType objectrequired
oneOf
MOD1
VersionSourceType
string
Possible values: [SOURCE_FILES, GIT_REPO, TARBALL, GITHUB_GIST]
envVars object[]nullable
Array [
namestringrequired
Example: MY_ENV_VAR
valuestringrequired
Example: my-value
isSecretbooleannullable
Example: false
]
applyEnvVarsToBuildbooleannullable
Example: false
buildTagstringrequired
Example: latest
sourceFiles object[]
Array [
anyOf
SourceCodeFile
formatstringrequired
Possible values: [BASE64, TEXT]
Example: TEXT
contentstringrequired
Example: console.log('This is the main.js file');
namestringrequired
Example: src/main.js
SourceCodeFolder
namestringrequired
Example: src/placeholder
folderbooleanrequired
Possible values: [true]
Example: true
]

Example (auto)

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

Authorization: http

name: httpBearertype: httpscheme: bearerdescription: API authentication token.

• CLI
• JavaScript
• Python
• PHP
• Java
• C
• C#
• Go
• Rust
• Node.js
• Ruby
• PowerShell
• Dart
• Objective-C
• OCaml
• R
• Swift
• Kotlin

• CURL

curl -L -X PUT 'https://api.apify.com/v2/acts/:actorId/versions/:versionNumber' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "versionNumber": "0.0",
  "envVars": [
    {
      "name": "MY_ENV_VAR",
      "value": "my-value",
      "isSecret": false
    }
  ],
  "applyEnvVarsToBuild": false,
  "buildTag": "latest",
  "sourceFiles": [
    {
      "format": "TEXT",
      "content": "console.log('\''This is the main.js file'\'');",
      "name": "src/main.js"
    },
    {
      "name": "src/placeholder",
      "folder": true
    }
  ]
}'

Request Collapse all

Base URL

https://api.apify.com

Auth

Security Scheme

httpBearerapiKey

Bearer Token

Parameters

actorId — pathrequired

versionNumber — pathrequired

Body required

• Example (from schema)
• Example

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

ResponseClear

Click the Send API Request button above and see the response here!