unreal.WebAPIDeveloperSettings

class unreal.WebAPIDeveloperSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: DeveloperSettings

The base class of any auto generated WebAPI settings object.

C++ Source:

  • Plugin: WebAPI

  • Module: WebAPI

  • File: WebAPIDeveloperSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • authentication_settings (Array[WebAPIAuthenticationSettings]): [Read-Write] Authentication settings per security scheme.

  • base_url (str): [Read-Write] The Url path relative to the host address, ie. “/V1”.

  • date_time_format (str): [Read-Write] The date-time format this API uses to encode/decode from string.

  • host (str): [Read-Write] The default host address to access this API.

  • log_requests (bool): [Read-Write] Whether to print requests to the output log, useful for debugging.

  • override_scheme (bool): [Read-Write] Whether to override the URI scheme.

  • uri_scheme_override (str): [Read-Write] User specified Uniform Resource Identifier scheme.

  • uri_schemes (Array[str]): [Read-Only] Uniform Resource Identifier schemes (ie. https, http).

  • user_agent (str): [Read-Write] The UserAgent to encode in Http request headers.

property authentication_settings: None

[Read-Write] Authentication settings per security scheme.

Type:

(Array[WebAPIAuthenticationSettings])

property base_url: str

[Read-Write] The Url path relative to the host address, ie. “/V1”.

Type:

(str)

property date_time_format: str

[Read-Write] The date-time format this API uses to encode/decode from string.

Type:

(str)

property host: str

[Read-Write] The default host address to access this API.

Type:

(str)

property log_requests: bool

[Read-Write] Whether to print requests to the output log, useful for debugging.

Type:

(bool)

property override_scheme: bool

[Read-Write] Whether to override the URI scheme.

Type:

(bool)

property uri_scheme_override: str

[Read-Write] User specified Uniform Resource Identifier scheme.

Type:

(str)

property uri_schemes: None

[Read-Only] Uniform Resource Identifier schemes (ie. https, http).

Type:

(Array[str])

property user_agent: str

[Read-Write] The UserAgent to encode in Http request headers.

Type:

(str)