Apify icon

Apify

Apify API
Join our community

Actions36

Overview

This node updates an existing actor on the Apify platform. It allows users to modify various attributes of an actor such as its name, description, visibility (public or private), SEO metadata, restart behavior on errors, environment variable versions, categories, and default run options. Users can specify the actor either by selecting from a list, providing a URL, or directly using the actor ID. This node is useful for managing and maintaining actors programmatically, ensuring that actor configurations are kept up-to-date without manual intervention on the Apify console.

Use Case Examples

  1. Updating an actor's description and making it public to share with others.
  2. Changing environment variables for an actor to update its runtime configuration.
  3. Modifying SEO titles and descriptions to improve actor discoverability.

Properties

Name Meaning
Actor ID The unique identifier or a tilde-separated owner's username and actor name to specify which actor to update. It supports selection from a list, URL input, or direct ID input.
Name The new name for the actor.
Description A description for the actor.
Is Public Boolean flag indicating whether the actor is publicly accessible.
Seo Title SEO title metadata for the actor.
Seo Description SEO description metadata for the actor.
Title Title of the actor.
Restart On Error Boolean flag to specify if the actor should restart automatically on errors.
Versions A collection of environment variable versions for the actor, each with a name, value, and secret flag.
Categories Categories to which the actor belongs.
Default Run Options Default options to use when running the actor.
Use Custom Body Flag to indicate if a custom JSON body should be used for the update request.
Custom Body Custom JSON body to send in the update request, allowing full control over the actor's properties.

Output

JSON

  • id - The unique identifier of the updated actor.
  • name - The name of the updated actor.
  • description - The description of the updated actor.
  • isPublic - Indicates if the actor is public.
  • seoTitle - SEO title of the actor.
  • seoDescription - SEO description of the actor.
  • title - Title of the actor.
  • restartOnError - Whether the actor restarts on error.
  • versions - List of environment variable versions associated with the actor.
  • categories - Categories assigned to the actor.
  • defaultRunOptions - Default run options for the actor.

Dependencies

  • Requires Apify API credentials for authentication.

Troubleshooting

  • Ensure the Actor ID is correctly specified either by list selection, URL, or direct ID input to avoid 'actor not found' errors.
  • If using a custom body, ensure the JSON is valid and correctly structured to prevent request failures.
  • Check API credentials and network connectivity if the update request fails with authentication or connection errors.

Links

Discussion