Skip to content

feat: add forcePermissionLevel run option #498

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

Merged
merged 1 commit into from
Sep 9, 2025
Merged

feat: add forcePermissionLevel run option #498

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ classifiers = [
]
keywords = ["apify", "api", "client", "automation", "crawling", "scraping"]
dependencies = [
"apify-shared>=2.0.0,<3.0.0",
"apify-shared>=2.1.0,<3.0.0",
"colorama>=0.4.0",
"impit>=0.5.3",
"more_itertools>=10.0.0",
Expand Down
20 changes: 19 additions & 1 deletion src/apify_client/clients/resource_clients/actor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
from decimal import Decimal
from logging import Logger

from apify_shared.consts import ActorJobStatus, MetaOrigin
from apify_shared.consts import ActorJobStatus, ActorPermissionLevel, MetaOrigin


def get_actor_representation(
Expand All @@ -50,6 +50,7 @@ def get_actor_representation(
default_run_max_items: int | None = None,
default_run_memory_mbytes: int | None = None,
default_run_timeout_secs: int | None = None,
default_run_force_permission_level: ActorPermissionLevel | None = None,
example_run_input_body: Any = None,
example_run_input_content_type: str | None = None,
actor_standby_is_enabled: bool | None = None,
Expand Down Expand Up @@ -78,6 +79,7 @@ def get_actor_representation(
'maxItems': default_run_max_items,
'memoryMbytes': default_run_memory_mbytes,
'timeoutSecs': default_run_timeout_secs,
'forcePermissionLevel': default_run_force_permission_level,
},
'exampleRunInput': {
'body': example_run_input_body,
Expand Down Expand Up @@ -224,6 +226,7 @@ def start(
max_total_charge_usd: Decimal | None = None,
memory_mbytes: int | None = None,
timeout_secs: int | None = None,
force_permission_level: ActorPermissionLevel | None = None,
wait_for_finish: int | None = None,
webhooks: list[dict] | None = None,
) -> dict:
Expand All @@ -243,6 +246,8 @@ def start(
specified in the default run configuration for the Actor.
timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified
in the default run configuration for the Actor.
force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run
with permissions configured in the Actor settings.
wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,
it is 0, the maximum value is 60.
webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with
Expand All @@ -265,6 +270,7 @@ def start(
memory=memory_mbytes,
timeout=timeout_secs,
waitForFinish=wait_for_finish,
forcePermissionLevel=force_permission_level.value if force_permission_level is not None else None,
webhooks=encode_webhook_list_to_base64(webhooks) if webhooks is not None else None,
)

Expand All @@ -289,6 +295,7 @@ def call(
memory_mbytes: int | None = None,
timeout_secs: int | None = None,
webhooks: list[dict] | None = None,
force_permission_level: ActorPermissionLevel | None = None,
wait_secs: int | None = None,
logger: Logger | None | Literal['default'] = 'default',
) -> dict | None:
Expand All @@ -310,6 +317,8 @@ def call(
specified in the default run configuration for the Actor.
timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified
in the default run configuration for the Actor.
force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run
with permissions configured in the Actor settings.
webhooks: Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can
be used to receive a notification, e.g. when the Actor finished or failed. If you already have
a webhook set up for the Actor, you do not have to add it again here.
Expand All @@ -332,6 +341,7 @@ def call(
memory_mbytes=memory_mbytes,
timeout_secs=timeout_secs,
webhooks=webhooks,
force_permission_level=force_permission_level,
)
if not logger:
return self.root_client.run(started_run['id']).wait_for_finish(wait_secs=wait_secs)
Expand Down Expand Up @@ -628,6 +638,7 @@ async def start(
max_total_charge_usd: Decimal | None = None,
memory_mbytes: int | None = None,
timeout_secs: int | None = None,
force_permission_level: ActorPermissionLevel | None = None,
wait_for_finish: int | None = None,
webhooks: list[dict] | None = None,
) -> dict:
Expand All @@ -647,6 +658,8 @@ async def start(
specified in the default run configuration for the Actor.
timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified
in the default run configuration for the Actor.
force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run
with permissions configured in the Actor settings.
wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,
it is 0, the maximum value is 60.
webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with
Expand All @@ -669,6 +682,7 @@ async def start(
memory=memory_mbytes,
timeout=timeout_secs,
waitForFinish=wait_for_finish,
forcePermissionLevel=force_permission_level,
webhooks=encode_webhook_list_to_base64(webhooks) if webhooks is not None else None,
)

Expand All @@ -693,6 +707,7 @@ async def call(
memory_mbytes: int | None = None,
timeout_secs: int | None = None,
webhooks: list[dict] | None = None,
force_permission_level: ActorPermissionLevel | None = None,
wait_secs: int | None = None,
logger: Logger | None | Literal['default'] = 'default',
) -> dict | None:
Expand All @@ -714,6 +729,8 @@ async def call(
specified in the default run configuration for the Actor.
timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified
in the default run configuration for the Actor.
force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run
with permissions configured in the Actor settings.
webhooks: Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can
be used to receive a notification, e.g. when the Actor finished or failed. If you already have
a webhook set up for the Actor, you do not have to add it again here.
Expand All @@ -736,6 +753,7 @@ async def call(
memory_mbytes=memory_mbytes,
timeout_secs=timeout_secs,
webhooks=webhooks,
force_permission_level=force_permission_level,
)

if not logger:
Expand Down
8 changes: 4 additions & 4 deletions uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading