# Configuration<!-- -->

A class for specifying the configuration of an Actor.

Can be used either globally via `Configuration.get_global_configuration()`, or it can be specific to each `Actor` instance via the `Actor.configuration` property.

## Index[](#Index)

### Methods

* [disable_browser_sandbox_on_platform](https://docs.apify.com/sdk/python/reference/class/Configuration.md#disable_browser_sandbox_on_platform)
* [from_configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md#from_configuration)
* [get_global_configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md#get_global_configuration)

### Properties

* [actor_build_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_build_id)
* [actor_build_number](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_build_number)
* [actor_build_tags](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_build_tags)
* [actor_events_ws_url](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_events_ws_url)
* [actor_full_name](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_full_name)
* [actor_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_id)
* [actor_permission_level](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_permission_level)
* [actor_pricing_info](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_pricing_info)
* [actor_run_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_run_id)
* [actor_storages](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_storages)
* [actor_task_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#actor_task_id)
* [api_base_url](https://docs.apify.com/sdk/python/reference/class/Configuration.md#api_base_url)
* [api_public_base_url](https://docs.apify.com/sdk/python/reference/class/Configuration.md#api_public_base_url)
* [canonical_input_key](https://docs.apify.com/sdk/python/reference/class/Configuration.md#canonical_input_key)
* [charged_event_counts](https://docs.apify.com/sdk/python/reference/class/Configuration.md#charged_event_counts)
* [dedicated_cpus](https://docs.apify.com/sdk/python/reference/class/Configuration.md#dedicated_cpus)
* [default_dataset_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#default_dataset_id)
* [default_key_value_store_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#default_key_value_store_id)
* [default_request_queue_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#default_request_queue_id)
* [input_key](https://docs.apify.com/sdk/python/reference/class/Configuration.md#input_key)
* [input_key_candidates](https://docs.apify.com/sdk/python/reference/class/Configuration.md#input_key_candidates)
* [input_secrets_private_key_file](https://docs.apify.com/sdk/python/reference/class/Configuration.md#input_secrets_private_key_file)
* [input_secrets_private_key_passphrase](https://docs.apify.com/sdk/python/reference/class/Configuration.md#input_secrets_private_key_passphrase)
* [is_at_home](https://docs.apify.com/sdk/python/reference/class/Configuration.md#is_at_home)
* [max_paid_dataset_items](https://docs.apify.com/sdk/python/reference/class/Configuration.md#max_paid_dataset_items)
* [max_total_charge_usd](https://docs.apify.com/sdk/python/reference/class/Configuration.md#max_total_charge_usd)
* [meta_origin](https://docs.apify.com/sdk/python/reference/class/Configuration.md#meta_origin)
* [metamorph_after_sleep](https://docs.apify.com/sdk/python/reference/class/Configuration.md#metamorph_after_sleep)
* [model_config](https://docs.apify.com/sdk/python/reference/class/Configuration.md#model_config)
* [proxy_hostname](https://docs.apify.com/sdk/python/reference/class/Configuration.md#proxy_hostname)
* [proxy_password](https://docs.apify.com/sdk/python/reference/class/Configuration.md#proxy_password)
* [proxy_port](https://docs.apify.com/sdk/python/reference/class/Configuration.md#proxy_port)
* [proxy_status_url](https://docs.apify.com/sdk/python/reference/class/Configuration.md#proxy_status_url)
* [standby_url](https://docs.apify.com/sdk/python/reference/class/Configuration.md#standby_url)
* [started_at](https://docs.apify.com/sdk/python/reference/class/Configuration.md#started_at)
* [test_pay_per_event](https://docs.apify.com/sdk/python/reference/class/Configuration.md#test_pay_per_event)
* [timeout_at](https://docs.apify.com/sdk/python/reference/class/Configuration.md#timeout_at)
* [token](https://docs.apify.com/sdk/python/reference/class/Configuration.md#token)
* [user_id](https://docs.apify.com/sdk/python/reference/class/Configuration.md#user_id)
* [user_is_paying](https://docs.apify.com/sdk/python/reference/class/Configuration.md#user_is_paying)
* [web_server_port](https://docs.apify.com/sdk/python/reference/class/Configuration.md#web_server_port)
* [web_server_url](https://docs.apify.com/sdk/python/reference/class/Configuration.md#web_server_url)
* [workflow_key](https://docs.apify.com/sdk/python/reference/class/Configuration.md#workflow_key)

## Methods<!-- -->[](#Methods)

### [](#disable_browser_sandbox_on_platform)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L516)disable_browser_sandbox_on_platform

* **disable_browser_sandbox_on_platform**(): Self

- Disable the browser sandbox mode when running on the Apify platform.

  Running in environment where `is_at_home` is True does not benefit from browser sandbox as it is already running in a container. It can be on the contrary undesired as the process in the container might be running as root and this will crash chromium that was started with browser sandbox mode.

  ***

  #### Returns Self

### [](#from_configuration)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L558)from_configuration

* **from_configuration**(configuration): [Configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md)

- Create Apify Configuration from existing Crawlee Configuration.

  ***

  #### Parameters

  * ##### configuration: CrawleeConfiguration

    The existing Crawlee Configuration.

  #### Returns [Configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md)

  The created Apify Configuration.

### [](#get_global_configuration)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L537)get_global_configuration

* **get_global_configuration**(): [Configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md)

- Retrieve the global instance of the configuration.

  This method ensures that ApifyConfiguration is returned, even if CrawleeConfiguration was set in the service locator.

  ***

  #### Returns [Configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md)

## Properties<!-- -->[](#Properties)

### [](#actor_build_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L176)actor_build_id

actor_build_id: str | None

### [](#actor_build_number)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L187)actor_build_number

actor_build_number: str | None

### [](#actor_build_tags)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L198)actor_build_tags

actor_build_tags: list\[str] | None

### [](#actor_events_ws_url)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L217)actor_events_ws_url

actor_events_ws_url: str | None

### [](#actor_full_name)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L150)actor_full_name

actor_full_name: str | None

### [](#actor_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L138)actor_id

actor_id: str | None

### [](#actor_permission_level)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L157)actor_permission_level

actor_permission_level: str | None

### [](#actor_pricing_info)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L483)actor_pricing_info

actor_pricing_info: (((FreeActorPricingInfo | FlatPricePerMonthActorPricingInfo) | PricePerDatasetItemActorPricingInfo) | PayPerEventActorPricingInfo) | None

### [](#actor_run_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L164)actor_run_id

actor_run_id: str | None

### [](#actor_storages)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L506)actor_storages

actor_storages: [ActorStorages](https://docs.apify.com/sdk/python/reference/class/ActorStorages.md) | None

### [](#actor_task_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L206)actor_task_id

actor_task_id: str | None

### [](#api_base_url)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L228)api_base_url

api_base_url: str

### [](#api_public_base_url)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L236)api_public_base_url

api_public_base_url: str

### [](#canonical_input_key)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L529)canonical_input_key

canonical_input_key: str

### [](#charged_event_counts)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L497)charged_event_counts

charged_event_counts: dict\[str, int] | None

### [](#dedicated_cpus)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L244)dedicated_cpus

dedicated_cpus: float | None

### [](#default_dataset_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L252)default_dataset_id

default_dataset_id: str | None

### [](#default_key_value_store_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L263)default_key_value_store_id

default_key_value_store_id: str | None

### [](#default_request_queue_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L274)default_request_queue_id

default_request_queue_id: str | None

### [](#input_key)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L285)input_key

input_key: str

### [](#input_key_candidates)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L533)input_key_candidates

input_key_candidates: set\[str]

### [](#input_secrets_private_key_file)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L297)input_secrets_private_key_file

input_secrets_private_key_file: str | None

### [](#input_secrets_private_key_passphrase)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L305)input_secrets_private_key_passphrase

input_secrets_private_key_passphrase: str | None

### [](#is_at_home)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L313)is_at_home

is_at_home: bool

### [](#max_paid_dataset_items)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L321)max_paid_dataset_items

max_paid_dataset_items: int | None

### [](#max_total_charge_usd)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L330)max_total_charge_usd

max_total_charge_usd: Decimal | None

### [](#meta_origin)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L347)meta_origin

meta_origin: str | None

### [](#metamorph_after_sleep)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L355)metamorph_after_sleep

metamorph_after_sleep: timedelta_ms

### [](#model_config)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L136)model_config

model_config: Undefined

### [](#proxy_hostname)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L363)proxy_hostname

proxy_hostname: str

### [](#proxy_password)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L371)proxy_password

proxy_password: str | None

### [](#proxy_port)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L379)proxy_port

proxy_port: int

### [](#proxy_status_url)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L387)proxy_status_url

proxy_status_url: str

### [](#standby_url)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L418)standby_url

standby_url: str

### [](#started_at)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L395)started_at

started_at: datetime | None

### [](#test_pay_per_event)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L339)test_pay_per_event

test_pay_per_event: bool

### [](#timeout_at)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L406)timeout_at

timeout_at: datetime | None

### [](#token)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L427)token

token: str | None

### [](#user_id)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L435)user_id

user_id: str | None

### [](#user_is_paying)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L443)user_is_paying

user_is_paying: bool

### [](#web_server_port)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L452)web_server_port

web_server_port: int

### [](#web_server_url)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L464)web_server_url

web_server_url: str

### [](#workflow_key)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/_configuration.py#L475)workflow_key

workflow_key: str | None
