csle_rest_api package

Subpackages

• csle_rest_api.constants package
  • Submodules
  • csle_rest_api.constants.constants module
  • Module contents
• csle_rest_api.pages package
  • Subpackages
    • csle_rest_api.pages.about package
      • Submodules
      • csle_rest_api.pages.about.routes module
      • Module contents
    • csle_rest_api.pages.container_terminal package
      • Submodules
      • csle_rest_api.pages.container_terminal.routes module
      • Module contents
    • csle_rest_api.pages.control_plane package
      • Submodules
      • csle_rest_api.pages.control_plane.routes module
      • Module contents
    • csle_rest_api.pages.create_emulation package
      • Submodules
      • csle_rest_api.pages.create_emulation.routes module
      • Module contents
    • csle_rest_api.pages.downloads package
      • Submodules
      • csle_rest_api.pages.downloads.routes module
      • Module contents
    • csle_rest_api.pages.emulation_statistics package
      • Submodules
      • csle_rest_api.pages.emulation_statistics.routes module
      • Module contents
    • csle_rest_api.pages.emulations package
      • Submodules
      • csle_rest_api.pages.emulations.routes module
      • Module contents
    • csle_rest_api.pages.images package
      • Submodules
      • csle_rest_api.pages.images.routes module
      • Module contents
    • csle_rest_api.pages.jobs package
      • Submodules
      • csle_rest_api.pages.jobs.routes module
      • Module contents
    • csle_rest_api.pages.login package
      • Submodules
      • csle_rest_api.pages.login.routes module
      • Module contents
    • csle_rest_api.pages.logs_admin package
      • Submodules
      • csle_rest_api.pages.logs_admin.routes module
      • Module contents
    • csle_rest_api.pages.monitoring package
      • Submodules
      • csle_rest_api.pages.monitoring.routes module
      • Module contents
    • csle_rest_api.pages.policies package
      • Submodules
      • csle_rest_api.pages.policies.routes module
      • Module contents
    • csle_rest_api.pages.policy_examination package
      • Submodules
      • csle_rest_api.pages.policy_examination.routes module
      • Module contents
    • csle_rest_api.pages.register package
      • Submodules
      • csle_rest_api.pages.register.routes module
      • Module contents
    • csle_rest_api.pages.sdn_controllers package
      • Submodules
      • csle_rest_api.pages.sdn_controllers.routes module
      • Module contents
    • csle_rest_api.pages.server_cluster package
      • Submodules
      • csle_rest_api.pages.server_cluster.routes module
      • Module contents
    • csle_rest_api.pages.simulations package
      • Submodules
      • csle_rest_api.pages.simulations.routes module
      • Module contents
    • csle_rest_api.pages.system_admin package
      • Submodules
      • csle_rest_api.pages.system_admin.routes module
      • Module contents
    • csle_rest_api.pages.system_models package
      • Submodules
      • csle_rest_api.pages.system_models.routes module
      • Module contents
    • csle_rest_api.pages.traces package
      • Submodules
      • csle_rest_api.pages.traces.routes module
      • Module contents
    • csle_rest_api.pages.training package
      • Submodules
      • csle_rest_api.pages.training.routes module
      • Module contents
    • csle_rest_api.pages.user_admin package
      • Submodules
      • csle_rest_api.pages.user_admin.routes module
      • Module contents
  • Module contents
• csle_rest_api.resources package
  • Subpackages
    • csle_rest_api.resources.alpha_vec_policies package
      • Submodules
      • csle_rest_api.resources.alpha_vec_policies.routes module
      • Module contents
    • csle_rest_api.resources.cadvisor package
      • Submodules
      • csle_rest_api.resources.cadvisor.routes module
      • Module contents
    • csle_rest_api.resources.cluster_status package
      • Submodules
      • csle_rest_api.resources.cluster_status.routes module
      • Module contents
    • csle_rest_api.resources.config package
      • Submodules
      • csle_rest_api.resources.config.routes module
      • Module contents
    • csle_rest_api.resources.create_emulation package
      • Submodules
      • csle_rest_api.resources.create_emulation.routes module
      • Module contents
    • csle_rest_api.resources.data_collection_jobs package
      • Submodules
      • csle_rest_api.resources.data_collection_jobs.routes module
      • Module contents
    • csle_rest_api.resources.docker package
      • Submodules
      • csle_rest_api.resources.docker.routes module
      • Module contents
    • csle_rest_api.resources.dqn_policies package
      • Submodules
      • csle_rest_api.resources.dqn_policies.routes module
      • Module contents
    • csle_rest_api.resources.empirical_system_models package
      • Submodules
      • csle_rest_api.resources.empirical_system_models.routes module
      • Module contents
    • csle_rest_api.resources.emulation_executions package
      • Submodules
      • csle_rest_api.resources.emulation_executions.routes module
      • Module contents
    • csle_rest_api.resources.emulation_simulation_traces package
      • Submodules
      • csle_rest_api.resources.emulation_simulation_traces.routes module
      • Module contents
    • csle_rest_api.resources.emulation_statistics package
      • Submodules
      • csle_rest_api.resources.emulation_statistics.routes module
      • Module contents
    • csle_rest_api.resources.emulation_traces package
      • Submodules
      • csle_rest_api.resources.emulation_traces.routes module
      • Module contents
    • csle_rest_api.resources.emulations package
      • Submodules
      • csle_rest_api.resources.emulations.routes module
      • Module contents
    • csle_rest_api.resources.experiments package
      • Submodules
      • csle_rest_api.resources.experiments.routes module
      • Module contents
    • csle_rest_api.resources.file package
      • Submodules
      • csle_rest_api.resources.file.routes module
      • Module contents
    • csle_rest_api.resources.flask package
      • Submodules
      • csle_rest_api.resources.flask.routes module
      • Module contents
    • csle_rest_api.resources.fnn_w_softmax_policies package
      • Submodules
      • csle_rest_api.resources.fnn_w_softmax_policies.routes module
      • Module contents
    • csle_rest_api.resources.gaussian_mixture_system_models package
      • Submodules
      • csle_rest_api.resources.gaussian_mixture_system_models.routes module
      • Module contents
    • csle_rest_api.resources.gp_system_models package
      • Submodules
      • csle_rest_api.resources.gp_system_models.routes module
      • Module contents
    • csle_rest_api.resources.grafana package
      • Submodules
      • csle_rest_api.resources.grafana.routes module
      • Module contents
    • csle_rest_api.resources.images package
      • Submodules
      • csle_rest_api.resources.images.routes module
      • Module contents
    • csle_rest_api.resources.linear_threshold_policies package
      • Submodules
      • csle_rest_api.resources.linear_threshold_policies.routes module
      • Module contents
    • csle_rest_api.resources.login package
      • Submodules
      • csle_rest_api.resources.login.routes module
      • Module contents
    • csle_rest_api.resources.logs package
      • Submodules
      • csle_rest_api.resources.logs.routes module
      • Module contents
    • csle_rest_api.resources.mcmc_system_models package
      • Submodules
      • csle_rest_api.resources.mcmc_system_models.routes module
      • Module contents
    • csle_rest_api.resources.multi_threshold_policies package
      • Submodules
      • csle_rest_api.resources.multi_threshold_policies.routes module
      • Module contents
    • csle_rest_api.resources.nginx package
      • Submodules
      • csle_rest_api.resources.nginx.routes module
      • Module contents
    • csle_rest_api.resources.node_exporter package
      • Submodules
      • csle_rest_api.resources.node_exporter.routes module
      • Module contents
    • csle_rest_api.resources.pgadmin package
      • Submodules
      • csle_rest_api.resources.pgadmin.routes module
      • Module contents
    • csle_rest_api.resources.postgresql package
      • Submodules
      • csle_rest_api.resources.postgresql.routes module
      • Module contents
    • csle_rest_api.resources.ppo_policies package
      • Submodules
      • csle_rest_api.resources.ppo_policies.routes module
      • Module contents
    • csle_rest_api.resources.prometheus package
      • Submodules
      • csle_rest_api.resources.prometheus.routes module
      • Module contents
    • csle_rest_api.resources.sdn_controllers package
      • Submodules
      • csle_rest_api.resources.sdn_controllers.routes module
      • Module contents
    • csle_rest_api.resources.server_cluster package
      • Submodules
      • csle_rest_api.resources.server_cluster.routes module
      • Module contents
    • csle_rest_api.resources.simulation_traces package
      • Submodules
      • csle_rest_api.resources.simulation_traces.routes module
      • Module contents
    • csle_rest_api.resources.simulations package
      • Submodules
      • csle_rest_api.resources.simulations.routes module
      • Module contents
    • csle_rest_api.resources.statistics_datasets package
      • Submodules
      • csle_rest_api.resources.statistics_datasets.routes module
      • Module contents
    • csle_rest_api.resources.system_identification_jobs package
      • Submodules
      • csle_rest_api.resources.system_identification_jobs.routes module
      • Module contents
    • csle_rest_api.resources.system_models package
      • Submodules
      • csle_rest_api.resources.system_models.routes module
      • Module contents
    • csle_rest_api.resources.tabular_policies package
      • Submodules
      • csle_rest_api.resources.tabular_policies.routes module
      • Module contents
    • csle_rest_api.resources.traces_datasets package
      • Submodules
      • csle_rest_api.resources.traces_datasets.routes module
      • Module contents
    • csle_rest_api.resources.training_jobs package
      • Submodules
      • csle_rest_api.resources.training_jobs.routes module
      • Module contents
    • csle_rest_api.resources.users package
      • Submodules
      • csle_rest_api.resources.users.routes module
      • Module contents
    • csle_rest_api.resources.vector_policies package
      • Submodules
      • csle_rest_api.resources.vector_policies.routes module
      • Module contents
    • csle_rest_api.resources.version package
      • Submodules
      • csle_rest_api.resources.version.routes module
      • Module contents
  • Module contents
• csle_rest_api.util package
  • Submodules
  • csle_rest_api.util.rest_api_util module
  • Module contents
• csle_rest_api.web_sockets package
  • Subpackages
    • csle_rest_api.web_sockets.container_terminal package
      • Submodules
      • csle_rest_api.web_sockets.container_terminal.container_terminal module
      • Module contents
  • Module contents

Submodules

csle_rest_api.rest_api module

csle_rest_api.rest_api.create_app(static_folder: str)

Creates and initializes the Flask App

Parameters

static_folder – path to the folder to serve static resources

Returns

the flask app

csle_rest_api.rest_api.start_server(static_folder: str, port: int = 7777, num_threads: int = 100, host: str = '0.0.0.0', https: bool = False) → None

Creates the flask app and serves it

Parameters

• static_folder – path to the folder to server static resources

• port – the port for serving

• num_threads – number of threads for serving

• host – the host string for serving

• https – boolean flag whether to use https or not

Returns

None

Module contents