ptctools 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

ptctools/portainer_client/openapi_client/docs/PortainerOAuthSettings.md

@@ -0,0 +1,42 @@
+# PortainerOAuthSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token_uri** | **str** |  | [optional] 
+**auth_style** | [**Oauth2AuthStyle**](Oauth2AuthStyle.md) |  | [optional] 
+**authorization_uri** | **str** |  | [optional] 
+**client_id** | **str** |  | [optional] 
+**client_secret** | **str** |  | [optional] 
+**default_team_id** | **int** |  | [optional] 
+**kube_secret_key** | **List[int]** |  | [optional] 
+**logout_uri** | **str** |  | [optional] 
+**o_auth_auto_create_users** | **bool** |  | [optional] 
+**redirect_uri** | **str** |  | [optional] 
+**resource_uri** | **str** |  | [optional] 
+**sso** | **bool** |  | [optional] 
+**scopes** | **str** |  | [optional] 
+**user_identifier** | **str** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_o_auth_settings import PortainerOAuthSettings
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerOAuthSettings from a JSON string
+portainer_o_auth_settings_instance = PortainerOAuthSettings.from_json(json)
+# print the JSON string representation of the object
+print(PortainerOAuthSettings.to_json())
+
+# convert the object into a dict
+portainer_o_auth_settings_dict = portainer_o_auth_settings_instance.to_dict()
+# create an instance of PortainerOAuthSettings from a dict
+portainer_o_auth_settings_from_dict = PortainerOAuthSettings.from_dict(portainer_o_auth_settings_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerOpenAMTConfiguration.md

@@ -0,0 +1,37 @@
+# PortainerOpenAMTConfiguration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cert_file_content** | **str** |  | [optional] 
+**cert_file_name** | **str** |  | [optional] 
+**cert_file_password** | **str** |  | [optional] 
+**domain_name** | **str** |  | [optional] 
+**enabled** | **bool** |  | [optional] 
+**mps_password** | **str** |  | [optional] 
+**mps_server** | **str** |  | [optional] 
+**mps_token** | **str** | retrieved from API | [optional] 
+**mps_user** | **str** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_open_amt_configuration import PortainerOpenAMTConfiguration
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerOpenAMTConfiguration from a JSON string
+portainer_open_amt_configuration_instance = PortainerOpenAMTConfiguration.from_json(json)
+# print the JSON string representation of the object
+print(PortainerOpenAMTConfiguration.to_json())
+
+# convert the object into a dict
+portainer_open_amt_configuration_dict = portainer_open_amt_configuration_instance.to_dict()
+# create an instance of PortainerOpenAMTConfiguration from a dict
+portainer_open_amt_configuration_from_dict = PortainerOpenAMTConfiguration.from_dict(portainer_open_amt_configuration_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerOpenAMTDeviceEnabledFeatures.md

@@ -0,0 +1,33 @@
+# PortainerOpenAMTDeviceEnabledFeatures
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ider** | **bool** |  | [optional] 
+**kvm** | **bool** |  | [optional] 
+**sol** | **bool** |  | [optional] 
+**redirection** | **bool** |  | [optional] 
+**user_consent** | **str** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_open_amt_device_enabled_features import PortainerOpenAMTDeviceEnabledFeatures
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerOpenAMTDeviceEnabledFeatures from a JSON string
+portainer_open_amt_device_enabled_features_instance = PortainerOpenAMTDeviceEnabledFeatures.from_json(json)
+# print the JSON string representation of the object
+print(PortainerOpenAMTDeviceEnabledFeatures.to_json())
+
+# convert the object into a dict
+portainer_open_amt_device_enabled_features_dict = portainer_open_amt_device_enabled_features_instance.to_dict()
+# create an instance of PortainerOpenAMTDeviceEnabledFeatures from a dict
+portainer_open_amt_device_enabled_features_from_dict = PortainerOpenAMTDeviceEnabledFeatures.from_dict(portainer_open_amt_device_enabled_features_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerPair.md

@@ -0,0 +1,30 @@
+# PortainerPair
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**value** | **str** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_pair import PortainerPair
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerPair from a JSON string
+portainer_pair_instance = PortainerPair.from_json(json)
+# print the JSON string representation of the object
+print(PortainerPair.to_json())
+
+# convert the object into a dict
+portainer_pair_dict = portainer_pair_instance.to_dict()
+# create an instance of PortainerPair from a dict
+portainer_pair_from_dict = PortainerPair.from_dict(portainer_pair_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerPerformanceMetrics.md

@@ -0,0 +1,31 @@
+# PortainerPerformanceMetrics
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cpu_usage** | **float** |  | [optional] 
+**memory_usage** | **float** |  | [optional] 
+**network_usage** | **float** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_performance_metrics import PortainerPerformanceMetrics
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerPerformanceMetrics from a JSON string
+portainer_performance_metrics_instance = PortainerPerformanceMetrics.from_json(json)
+# print the JSON string representation of the object
+print(PortainerPerformanceMetrics.to_json())
+
+# convert the object into a dict
+portainer_performance_metrics_dict = portainer_performance_metrics_instance.to_dict()
+# create an instance of PortainerPerformanceMetrics from a dict
+portainer_performance_metrics_from_dict = PortainerPerformanceMetrics.from_dict(portainer_performance_metrics_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerQuayRegistryData.md

@@ -0,0 +1,30 @@
+# PortainerQuayRegistryData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**organisation_name** | **str** |  | [optional] 
+**use_organisation** | **bool** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_quay_registry_data import PortainerQuayRegistryData
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerQuayRegistryData from a JSON string
+portainer_quay_registry_data_instance = PortainerQuayRegistryData.from_json(json)
+# print the JSON string representation of the object
+print(PortainerQuayRegistryData.to_json())
+
+# convert the object into a dict
+portainer_quay_registry_data_dict = portainer_quay_registry_data_instance.to_dict()
+# create an instance of PortainerQuayRegistryData from a dict
+portainer_quay_registry_data_from_dict = PortainerQuayRegistryData.from_dict(portainer_quay_registry_data_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerRegistry.md

@@ -0,0 +1,48 @@
+# PortainerRegistry
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **str** | Stores temporary access token | [optional] 
+**access_token_expiry** | **int** |  | [optional] 
+**authentication** | **bool** | Is authentication against this registry enabled | [optional] 
+**authorized_teams** | **List[int]** | Deprecated in DBVersion == 18 | [optional] 
+**authorized_users** | **List[int]** | Deprecated in DBVersion == 18 | [optional] 
+**base_url** | **str** | Base URL, introduced for ProGet registry | [optional] 
+**ecr** | [**PortainerEcrData**](PortainerEcrData.md) |  | [optional] 
+**github** | [**PortainerGithubRegistryData**](PortainerGithubRegistryData.md) |  | [optional] 
+**gitlab** | [**PortainerGitlabRegistryData**](PortainerGitlabRegistryData.md) |  | [optional] 
+**id** | **int** | Registry Identifier | [optional] 
+**management_configuration** | [**PortainerRegistryManagementConfiguration**](PortainerRegistryManagementConfiguration.md) |  | [optional] 
+**name** | **str** | Registry Name | [optional] 
+**password** | **str** | Password or SecretAccessKey used to authenticate against this registry | [optional] 
+**quay** | [**PortainerQuayRegistryData**](PortainerQuayRegistryData.md) |  | [optional] 
+**registry_accesses** | [**Dict[str, PortainerRegistryAccessPolicies]**](PortainerRegistryAccessPolicies.md) |  | [optional] 
+**team_access_policies** | [**Dict[str, PortainerAccessPolicy]**](PortainerAccessPolicy.md) | Deprecated in DBVersion == 31 | [optional] 
+**type** | [**PortainerRegistryType**](PortainerRegistryType.md) | Registry Type (1 - Quay, 2 - Azure, 3 - Custom, 4 - Gitlab, 5 - ProGet, 6 - DockerHub, 7 - ECR) | [optional] 
+**url** | **str** | URL or IP address of the Docker registry | [optional] 
+**user_access_policies** | [**Dict[str, PortainerAccessPolicy]**](PortainerAccessPolicy.md) | Deprecated fields Deprecated in DBVersion == 31 | [optional] 
+**username** | **str** | Username or AccessKeyID used to authenticate against this registry | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_registry import PortainerRegistry
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerRegistry from a JSON string
+portainer_registry_instance = PortainerRegistry.from_json(json)
+# print the JSON string representation of the object
+print(PortainerRegistry.to_json())
+
+# convert the object into a dict
+portainer_registry_dict = portainer_registry_instance.to_dict()
+# create an instance of PortainerRegistry from a dict
+portainer_registry_from_dict = PortainerRegistry.from_dict(portainer_registry_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerRegistryAccessPolicies.md

@@ -0,0 +1,31 @@
+# PortainerRegistryAccessPolicies
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**namespaces** | **List[str]** |  | [optional] 
+**team_access_policies** | [**Dict[str, PortainerAccessPolicy]**](PortainerAccessPolicy.md) |  | [optional] 
+**user_access_policies** | [**Dict[str, PortainerAccessPolicy]**](PortainerAccessPolicy.md) |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_registry_access_policies import PortainerRegistryAccessPolicies
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerRegistryAccessPolicies from a JSON string
+portainer_registry_access_policies_instance = PortainerRegistryAccessPolicies.from_json(json)
+# print the JSON string representation of the object
+print(PortainerRegistryAccessPolicies.to_json())
+
+# convert the object into a dict
+portainer_registry_access_policies_dict = portainer_registry_access_policies_instance.to_dict()
+# create an instance of PortainerRegistryAccessPolicies from a dict
+portainer_registry_access_policies_from_dict = PortainerRegistryAccessPolicies.from_dict(portainer_registry_access_policies_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerRegistryManagementConfiguration.md

@@ -0,0 +1,36 @@
+# PortainerRegistryManagementConfiguration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **str** |  | [optional] 
+**access_token_expiry** | **int** |  | [optional] 
+**authentication** | **bool** |  | [optional] 
+**ecr** | [**PortainerEcrData**](PortainerEcrData.md) |  | [optional] 
+**password** | **str** |  | [optional] 
+**tls_config** | [**PortainerTLSConfiguration**](PortainerTLSConfiguration.md) |  | [optional] 
+**type** | [**PortainerRegistryType**](PortainerRegistryType.md) |  | [optional] 
+**username** | **str** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_registry_management_configuration import PortainerRegistryManagementConfiguration
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerRegistryManagementConfiguration from a JSON string
+portainer_registry_management_configuration_instance = PortainerRegistryManagementConfiguration.from_json(json)
+# print the JSON string representation of the object
+print(PortainerRegistryManagementConfiguration.to_json())
+
+# convert the object into a dict
+portainer_registry_management_configuration_dict = portainer_registry_management_configuration_instance.to_dict()
+# create an instance of PortainerRegistryManagementConfiguration from a dict
+portainer_registry_management_configuration_from_dict = PortainerRegistryManagementConfiguration.from_dict(portainer_registry_management_configuration_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerRegistryType.md

@@ -0,0 +1,26 @@
+# PortainerRegistryType
+
+
+## Enum
+
+* `_` (value: `0`)
+
+* `QuayRegistry` (value: `1`)
+
+* `AzureRegistry` (value: `2`)
+
+* `CustomRegistry` (value: `3`)
+
+* `GitlabRegistry` (value: `4`)
+
+* `ProGetRegistry` (value: `5`)
+
+* `DockerHubRegistry` (value: `6`)
+
+* `EcrRegistry` (value: `7`)
+
+* `GithubRegistry` (value: `8`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerResourceAccessLevel.md

@@ -0,0 +1,12 @@
+# PortainerResourceAccessLevel
+
+
+## Enum
+
+* `_` (value: `0`)
+
+* `ReadWriteAccessLevel` (value: `1`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerResourceControl.md

@@ -0,0 +1,39 @@
+# PortainerResourceControl
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_level** | [**PortainerResourceAccessLevel**](PortainerResourceAccessLevel.md) |  | [optional] 
+**administrators_only** | **bool** | Permit access to resource only to admins | [optional] 
+**id** | **int** | ResourceControl Identifier | [optional] 
+**owner_id** | **int** | Deprecated fields Deprecated in DBVersion == 2 | [optional] 
+**public** | **bool** | Permit access to the associated resource to any user | [optional] 
+**resource_id** | **str** | Docker resource identifier on which access control will be applied.\\ In the case of a resource control applied to a stack, use the stack name as identifier | [optional] 
+**sub_resource_ids** | **List[str]** | List of Docker resources that will inherit this access control | [optional] 
+**system** | **bool** |  | [optional] 
+**team_accesses** | [**List[PortainerTeamResourceAccess]**](PortainerTeamResourceAccess.md) |  | [optional] 
+**type** | [**PortainerResourceControlType**](PortainerResourceControlType.md) | Type of Docker resource. Valid values are: 1- container, 2 -service 3 - volume, 4 - secret, 5 - stack, 6 - config or 7 - custom template | [optional] 
+**user_accesses** | [**List[PortainerUserResourceAccess]**](PortainerUserResourceAccess.md) |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_resource_control import PortainerResourceControl
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerResourceControl from a JSON string
+portainer_resource_control_instance = PortainerResourceControl.from_json(json)
+# print the JSON string representation of the object
+print(PortainerResourceControl.to_json())
+
+# convert the object into a dict
+portainer_resource_control_dict = portainer_resource_control_instance.to_dict()
+# create an instance of PortainerResourceControl from a dict
+portainer_resource_control_from_dict = PortainerResourceControl.from_dict(portainer_resource_control_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerResourceControlType.md

@@ -0,0 +1,28 @@
+# PortainerResourceControlType
+
+
+## Enum
+
+* `_` (value: `0`)
+
+* `ContainerResourceControl` (value: `1`)
+
+* `ServiceResourceControl` (value: `2`)
+
+* `VolumeResourceControl` (value: `3`)
+
+* `NetworkResourceControl` (value: `4`)
+
+* `SecretResourceControl` (value: `5`)
+
+* `StackResourceControl` (value: `6`)
+
+* `ConfigResourceControl` (value: `7`)
+
+* `CustomTemplateResourceControl` (value: `8`)
+
+* `ContainerGroupResourceControl` (value: `9`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerRole.md

@@ -0,0 +1,33 @@
+# PortainerRole
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authorizations** | **Dict[str, bool]** | Authorizations associated to a role | [optional] 
+**description** | **str** | Role description | [optional] 
+**id** | **int** | Role Identifier | [optional] 
+**name** | **str** | Role name | [optional] 
+**priority** | **int** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_role import PortainerRole
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerRole from a JSON string
+portainer_role_instance = PortainerRole.from_json(json)
+# print the JSON string representation of the object
+print(PortainerRole.to_json())
+
+# convert the object into a dict
+portainer_role_dict = portainer_role_instance.to_dict()
+# create an instance of PortainerRole from a dict
+portainer_role_from_dict = PortainerRole.from_dict(portainer_role_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerSSLSettings.md

@@ -0,0 +1,32 @@
+# PortainerSSLSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cert_path** | **str** |  | [optional] 
+**http_enabled** | **bool** |  | [optional] 
+**key_path** | **str** |  | [optional] 
+**self_signed** | **bool** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_ssl_settings import PortainerSSLSettings
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerSSLSettings from a JSON string
+portainer_ssl_settings_instance = PortainerSSLSettings.from_json(json)
+# print the JSON string representation of the object
+print(PortainerSSLSettings.to_json())
+
+# convert the object into a dict
+portainer_ssl_settings_dict = portainer_ssl_settings_instance.to_dict()
+# create an instance of PortainerSSLSettings from a dict
+portainer_ssl_settings_from_dict = PortainerSSLSettings.from_dict(portainer_ssl_settings_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerSettings.md

@@ -0,0 +1,62 @@
+# PortainerSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_secret** | **str** | Container environment parameter AGENT_SECRET | [optional] 
+**allow_bind_mounts_for_regular_users** | **bool** |  | [optional] 
+**allow_container_capabilities_for_regular_users** | **bool** |  | [optional] 
+**allow_device_mapping_for_regular_users** | **bool** |  | [optional] 
+**allow_host_namespace_for_regular_users** | **bool** |  | [optional] 
+**allow_privileged_mode_for_regular_users** | **bool** |  | [optional] 
+**allow_stack_management_for_regular_users** | **bool** |  | [optional] 
+**allow_volume_browser_for_regular_users** | **bool** |  | [optional] 
+**authentication_method** | [**PortainerAuthenticationMethod**](PortainerAuthenticationMethod.md) | Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth | [optional] 
+**black_listed_labels** | [**List[PortainerPair]**](PortainerPair.md) | A list of label name & value that will be used to hide containers when querying containers | [optional] 
+**display_donation_header** | **bool** | Deprecated fields | [optional] 
+**display_external_contributors** | **bool** |  | [optional] 
+**edge** | [**PortainerEdge**](PortainerEdge.md) |  | [optional] 
+**edge_agent_checkin_interval** | **int** | The default check in interval for edge agent (in seconds) | [optional] 
+**edge_portainer_url** | **str** | EdgePortainerURL is the URL that is exposed to edge agents | [optional] 
+**enable_edge_compute_features** | **bool** | Whether edge compute features are enabled | [optional] 
+**enable_host_management_features** | **bool** | Deprecated fields v26 | [optional] 
+**enable_telemetry** | **bool** | Whether telemetry is enabled | [optional] 
+**enforce_edge_id** | **bool** | EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone | [optional] 
+**feature_flag_settings** | **Dict[str, bool]** |  | [optional] 
+**global_deployment_options** | [**PortainerGlobalDeploymentOptions**](PortainerGlobalDeploymentOptions.md) | Deployment options for encouraging git ops workflows | [optional] 
+**helm_repository_url** | **str** | Helm repository URL, defaults to \"https://charts.bitnami.com/bitnami\" | [optional] 
+**internal_auth_settings** | [**PortainerInternalAuthSettings**](PortainerInternalAuthSettings.md) |  | [optional] 
+**is_docker_desktop_extension** | **bool** |  | [optional] 
+**kubeconfig_expiry** | **str** | The expiry of a Kubeconfig | [optional] 
+**kubectl_shell_image** | **str** | KubectlImage, defaults to portainer/kubectl-shell | [optional] 
+**ldap_settings** | [**PortainerLDAPSettings**](PortainerLDAPSettings.md) |  | [optional] 
+**logo_url** | **str** | URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string | [optional] 
+**o_auth_settings** | [**PortainerOAuthSettings**](PortainerOAuthSettings.md) |  | [optional] 
+**snapshot_interval** | **str** | The interval in which environment(endpoint) snapshots are created | [optional] 
+**templates_url** | **str** | URL to the templates that will be displayed in the UI when navigating to App Templates | [optional] 
+**trust_on_first_connect** | **bool** | TrustOnFirstConnect makes Portainer accepting edge agent connection by default | [optional] 
+**user_session_timeout** | **str** | The duration of a user session | [optional] 
+**open_amt_configuration** | [**PortainerOpenAMTConfiguration**](PortainerOpenAMTConfiguration.md) |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_settings import PortainerSettings
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerSettings from a JSON string
+portainer_settings_instance = PortainerSettings.from_json(json)
+# print the JSON string representation of the object
+print(PortainerSettings.to_json())
+
+# convert the object into a dict
+portainer_settings_dict = portainer_settings_instance.to_dict()
+# create an instance of PortainerSettings from a dict
+portainer_settings_from_dict = PortainerSettings.from_dict(portainer_settings_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerStack.md

@@ -0,0 +1,48 @@
+# PortainerStack
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**additional_files** | **List[str]** | Only applies when deploying stack with multiple files | [optional] 
+**auto_update** | [**PortainerAutoUpdateSettings**](PortainerAutoUpdateSettings.md) | The GitOps update settings of a git stack | [optional] 
+**endpoint_id** | **int** | Environment(Endpoint) identifier. Reference the environment(endpoint) that will be used for deployment | [optional] 
+**entry_point** | **str** | Path to the Stack file | [optional] 
+**env** | [**List[PortainerPair]**](PortainerPair.md) | A list of environment(endpoint) variables used during stack deployment | [optional] 
+**id** | **int** | Stack Identifier | [optional] 
+**name** | **str** | Stack name | [optional] 
+**option** | [**PortainerStackOption**](PortainerStackOption.md) | The stack deployment option | [optional] 
+**resource_control** | [**PortainerResourceControl**](PortainerResourceControl.md) |  | [optional] 
+**status** | [**PortainerStackStatus**](PortainerStackStatus.md) | Stack status (1 - active, 2 - inactive) | [optional] 
+**swarm_id** | **str** | Cluster identifier of the Swarm cluster where the stack is deployed | [optional] 
+**type** | [**PortainerStackType**](PortainerStackType.md) | Stack type. 1 for a Swarm stack, 2 for a Compose stack | [optional] 
+**created_by** | **str** | The username which created this stack | [optional] 
+**creation_date** | **int** | The date in unix time when stack was created | [optional] 
+**from_app_template** | **bool** | Whether the stack is from a app template | [optional] 
+**git_config** | [**GittypesRepoConfig**](GittypesRepoConfig.md) | The git config of this stack | [optional] 
+**namespace** | **str** | Kubernetes namespace if stack is a kube application | [optional] 
+**project_path** | **str** | Path on disk to the repository hosting the Stack file | [optional] 
+**update_date** | **int** | The date in unix time when stack was last updated | [optional] 
+**updated_by** | **str** | The username which last updated this stack | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_stack import PortainerStack
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerStack from a JSON string
+portainer_stack_instance = PortainerStack.from_json(json)
+# print the JSON string representation of the object
+print(PortainerStack.to_json())
+
+# convert the object into a dict
+portainer_stack_dict = portainer_stack_instance.to_dict()
+# create an instance of PortainerStack from a dict
+portainer_stack_from_dict = PortainerStack.from_dict(portainer_stack_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/PortainerStackDeploymentInfo.md

@@ -0,0 +1,31 @@
+# PortainerStackDeploymentInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config_hash** | **str** | ConfigHash is the commit hash of the git repository used for deploying the stack | [optional] 
+**file_version** | **int** | FileVersion is the version of the stack file, used to detect changes | [optional] 
+**version** | **int** | Version is the version of the stack and also is the deployed version in edge agent | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.portainer_stack_deployment_info import PortainerStackDeploymentInfo
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PortainerStackDeploymentInfo from a JSON string
+portainer_stack_deployment_info_instance = PortainerStackDeploymentInfo.from_json(json)
+# print the JSON string representation of the object
+print(PortainerStackDeploymentInfo.to_json())
+
+# convert the object into a dict
+portainer_stack_deployment_info_dict = portainer_stack_deployment_info_instance.to_dict()
+# create an instance of PortainerStackDeploymentInfo from a dict
+portainer_stack_deployment_info_from_dict = PortainerStackDeploymentInfo.from_dict(portainer_stack_deployment_info_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+