Skip to content

docs(apify-actor-development): document REST deploy path (PUT versions with JSON sourceFiles) #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
DaveHanns wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(apify-actor-development): document REST deploy path (PUT versions with JSON sourceFiles) #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions skills/apify-actor-development/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,14 @@ Actor input is one JSON object, not an array. `--input` accepts inline JSON obje

If no dedicated Actor exists for your target, search Apify Store for community options before building from scratch.

### Deploying without the CLI (REST API)

If `apify-cli` isn't available, deploy via `PUT /v2/acts/{actorId}/versions/{versionNumber}` with a JSON body whose `sourceType` and inline `sourceFiles` (base64 for binaries, plain text for text files) describe each file — see the [Update version reference](https://docs.apify.com/api/v2#/reference/actor-versions/version-object/update-version). Use `POST /v2/acts/{actorId}/versions` to create a new version, `PUT` to overwrite an existing one; there is no `?overwrite=true` or `?force=1` query parameter — overwrite semantics are governed by the HTTP verb.

Avoid the sibling `PUT /v2/acts/{id}/versions/{ver}/source-files` tarball endpoint. It is documented but currently returns 4xx regardless of payload shape; use the JSON `sourceFiles` form instead.

The `MAJOR.MINOR` version regex (each segment 0-99) applies to this endpoint as well — see the actor.json reference.

### Local and runtime commands

Always use `apify run` to test Actors locally. Do not use `npm run start`, `npm start`, `yarn start`, or other package manager commands - these will not properly configure the Apify environment and storage.
Expand Down
Loading