| Name | csle-rest-api JSON |
| Version |
0.7.4
JSON |
| download |
| home_page | None |
| Summary | CSLE REST API |
| upload_time | 2025-01-12 06:40:34 |
| maintainer | None |
| docs_url | None |
| author | Kim Hammar |
| requires_python | >=3.8 |
| license | ## creative commons # Attribution-ShareAlike 4.0 International Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. ### Using Creative Commons Public Licenses Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. * __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors). * __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). ## Creative Commons Attribution-ShareAlike 4.0 International Public License By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. ### Section 1 – Definitions. a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. c. __BY-SA Compatible License__ means a license listed at [creativecommons.org/compatiblelicenses](http://creativecommons.org/compatiblelicenses), approved by Creative Commons as essentially the equivalent of this Public License. d. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. e. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. f. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. g. __License Elements__ means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike. h. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License. i. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. j. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License. k. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. l. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. m. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. ### Section 2 – Scope. a. ___License grant.___ 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: A. reproduce and Share the Licensed Material, in whole or in part; and B. produce, reproduce, and Share Adapted Material. 2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. 3. __Term.__ The term of this Public License is specified in Section 6(a). 4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. 5. __Downstream recipients.__ A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. B. __Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. C. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. 6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). b. ___Other rights.___ 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. 2. Patent and trademark rights are not licensed under this Public License. 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. ### Section 3 – License Conditions. Your exercise of the Licensed Rights is expressly made subject to the following conditions. a. ___Attribution.___ 1. If You Share the Licensed Material (including in modified form), You must: A. retain the following if it is supplied by the Licensor with the Licensed Material: i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); ii. a copyright notice; iii. a notice that refers to this Public License; iv. a notice that refers to the disclaimer of warranties; v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. b. ___ShareAlike.___ In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. ### Section 4 – Sui Generis Database Rights. Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. ### Section 5 – Disclaimer of Warranties and Limitation of Liability. a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__ b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__ c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. ### Section 6 – Term and Termination. a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or 2. upon express reinstatement by the Licensor. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. ### Section 7 – Other Terms and Conditions. a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.t stated herein are separate from and independent of the terms and conditions of this Public License. ### Section 8 – Interpretation. a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. ``` Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. Creative Commons may be contacted at creativecommons.org ``` ## Disclaimer All code and software in this repository is for Educational purpose ONLY. Do not use it without permission. The usual disclaimer applies, especially the fact that me (Kim Hammar) is not liable for any damages caused by direct or indirect use of the information or functionality provided by these programs. The author or any Internet provider bears NO responsibility for content or misuse of these programs or any derivatives thereof. By using these programs you accept the fact that any damage (dataloss, system crash, system compromise, etc.) caused by the use of these programs is not Kim Hammar's responsibility. |
| keywords |
reinforcement-learning
cyber-security
markov-games
markov-decision-processes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `csle-rest-api`
A REST API for the CSLE management platform.
[](https://badge.fury.io/py/csle-rest-api)
## Endpoints
| resource | description | Method |
|:------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:----------------------------------------|
| `/emulations` | List of emulations | `GET`,`DELETE` |
| `/emulations?ids=true&token=<valid_token>` | List of emulation ids only (fast to fetch) | `GET`,`DELETE` |
| `/emulations/<emulation_id>?token=<valid_token>` | Individual emulation | `GET`,`DELETE`, `POST` (for start/stop) |
| `/emulations/<emulation_id>/executions?token=<valid_token>` | List of executions | `GET`,`DELETE` |
| `/emulations/<emulation_id>/executions/<execution_id>?token=<valid_token>` | Individual execution | `GET`,`DELETE` |
| `/emulations/<emulation_id>/executions/<execution_id>/monitor/<minutes>?token=<valid_token>` | Get last X minutes of data from an execution | `GET` |
| `/simulations?token=<valid_token>` | List of simulations | `GET`,`DELETE` |
| `/simulations?ids=true&token=<valid_token>` | List of simulation ids only (fast to fetch) | `GET`,`DELETE` |
| `/simulations/<simulation_id>?token=<valid_token>` | Individual simulation | `GET`,`DELETE` |
| `/cadvisor?token=<valid_token>` | Starts/stops or gets status cadvisor | `GET`,`POST` |
| `/pgadmin?token=<valid_token>` | Starts/stops or gets status of pgadmin | `GET`,`POST` |
| `/nodeexporter?token=<valid_token>` | Starts/stops or gets status of nodeexporter | `GET`,`POST` |
| `/grafana?token=<valid_token>` | Starts/stops or gets status of grafana | `GET`, `POST` |
| `/clusterstatuses?token=<valid_token>` | Gets the status of management services of the cluster | `GET` |
| `/prometheus?token=<valid_token>` | Starts/stops or gets status of prometheus | `GET`,`POST` |
| `/postgresql?token=<valid_token>` | Starts/stops or gets status of postgresql | `GET`,`POST` |
| `/docker?token=<valid_token>` | Starts/stops or gets status of docker engine | `GET`,`POST` |
| `/nginx?token=<valid_token>` | Starts/stops or gets status of nginx | `GET`,`POST` |
| `/flask?token=<valid_token>` | Starts/stops or gets status of flask | `GET`,`POST` |
| `/alpha-vec-policies?token=<valid_token>` | List of alpha vector policies | `GET`,`DELETE` |
| `/alpha-vec-policies?ids=true&token=<valid_token>` | List of alpha vector policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/alpha-vec-policies/<policy_id>?token=<valid_token>` | Individual alpha vector policy | `GET`,`DELETE` |
| `/dqn-policies?token=<valid_token>` | List of DQN policies | `GET`,`DELETE` |
| `/dqn-policies?ids=true&token=<valid_token>` | List of DQN policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/dqn-policies/<policy_id>?token=<valid_token>` | Individual DQN policy | `GET`,`DELETE` |
| `/ppo-policies?token=<valid_token>` | List of PPO policies | `GET`,`DELETE` |
| `/ppo-policies?ids=true&token=<valid_token>` | List of PPO policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/ppo-policies/<policy_id>?token=<valid_token>` | Individual PPO policy | `GET`,`DELETE` |
| `/vector-policies?token=<valid_token>` | List of vector policies | `GET`,`DELETE` |
| `/vector-policies?ids=true&token=<valid_token>` | List of vector policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/vector-policies/<policy_id>?token=<valid_token>` | Individual vector policy | `GET`,`DELETE` |
| `/tabular-policies?token=<valid_token>` | List of tabular policies | `GET`,`DELETE` |
| `/tabular-policies?ids=true&token=<valid_token>` | List of tabular policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/tabular-policies/<policy_id>?token=<valid_token>` | Individual tabular policy | `GET`,`DELETE` |
| `/multi-threshold-policies?token=<valid_token>` | List of multi-threshold policies | `GET`,`DELETE` |
| `/multi-threshold-policies?ids=true&token=<valid_token>` | List of multi-threshold policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/multi-threshold-policies/<policy_id>?token=<valid_token>` | Individual multi-threshold policy | `GET`,`DELETE` |
| `/linear-threshold-policies?token=<valid_token>` | List of linear threshold policies | `GET`,`DELETE` |
| `/linear-threshold-policies?ids=true&token=<valid_token>` | List of linear threshold policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/linear-threshold-policies/<policy_id>?token=<valid_token>` | Individual linear threshold policy | `GET`,`DELETE` |
| `/fnn-w-softmax-policies?token=<valid_token>` | List of fnn-w-softmax policies | `GET`,`DELETE` |
| `/fnn-w-softmax-policies?ids=true&token=<valid_token>` | List of fnn-w-softmax policy ids only (fast to fetch) | `GET`,`DELETE` |
| `/fnn-w-softmax-policies/<policy_id>?token=<valid_token>` | Individual fnn-w-softmax policy | `GET`,`DELETE` |
| `/training-jobs?token=<valid_token>` | List of training jobs | `GET`,`DELETE` |
| `/training-jobs?ids=true&token=<valid_token>` | List of training job ids only (fast to fetch) | `GET`,`DELETE` |
| `/training-jobs/<job_id>?token=<valid_token>` | Individual training job | `GET`,`DELETE`, `POST` (for start/stop) |
| `/data-collection-jobs?token=<valid_token>` | List of data-collection jobs | `GET`,`DELETE` |
| `/data-collection-jobs?ids=true&token=<valid_token>` | List of data-collection job ids only (fast to fetch) | `GET`,`DELETE` |
| `/data-collection-jobs/<job_id>?token=<valid_token>` | Individual data-collection job | `GET`,`DELETE`, `POST` (for start/stop) |
| `/system-identification-jobs?token=<valid_token>` | List of system-identification jobs | `GET`,`DELETE` |
| `/system-identification-jobs?ids=true&token=<valid_token>` | List of system-identification job ids only (fast to fetch) | `GET`,`DELETE` |
| `/system-identification-jobs/<job_id>?token=<valid_token>` | Individual system-identification job | `GET`,`DELETE`, `POST` (for start/stop) |
| `/emulation-traces?token=<valid_token>` | List of emulation traces | `GET`,`DELETE` |
| `/emulation-traces?ids=true&token=<valid_token>` | List of emulation trace ids only (fast to fetch) | `GET`,`DELETE` |
| `/emulation-traces/<trace_id>?token=<valid_token>` | Individual emulation trace | `GET`,`DELETE` |
| `/simulation-traces?token=<valid_token>` | List of simulation traces | `GET`,`DELETE` |
| `/simulation-traces?ids=true&token=<valid_token>` | List of simulation trace ids only (fast to fetch) | `GET`,`DELETE` |
| `/simulation-traces/<trace_id>?token=<valid_token>` | Individual simulation trace | `GET`,`DELETE` |
| `/emulation-simulation-traces?token=<valid_token>` | List of emulation-simulation traces | `GET`,`DELETE` |
| `/emulation-simulation-traces?ids=true&token=<valid_token>` | List of emulation-simulation trace ids only (fast to fetch) | `GET`,`DELETE` |
| `/emulation-simulation-traces/<trace_id>?token=<valid_token>` | Individual emulation-simulation trace | `GET`,`DELETE` |
| `/images?token=<valid_token>` | List of Docker images | `GET` |
| `/file?token=<valid_token>` | Reads a given file from disk | `POST` |
| `/experiments?token=<valid_token>` | List of experiments | `GET`,`DELETE` |
| `/experiments?ids=true&token=<valid_token>` | List of experiment ids only (fast to fetch) | `GET`,`DELETE` |
| `/experiments/<trace_id>?token=<valid_token>` | Individual experiment | `GET`,`DELETE` |
| `/sdn-controllers?token=<valid_token>` | List of SDN controllers | `GET`,`DELETE` |
| `/sdn-controllers?ids=true&token=<valid_token>` | List of SDN controller ids only (fast to fetch) | `GET`,`DELETE` |
| `/emulation-statistics?token=<valid_token>` | List of emulation statistics | `GET`,`DELETE` |
| `/emulation-statistics?ids=true&token=<valid_token>` | List of emulation statistic ids only (fast to fetch) | `GET`,`DELETE` |
| `/emulation-statistics/<trace_id>?token=<valid_token>` | Individual emulation statistic | `GET`,`DELETE` |
| `/gaussian-mixture-system-models?token=<valid_token>` | List of gaussian mixture system-models | `GET`,`DELETE` |
| `/gaussian-mixture-system-models?ids=true&token=<valid_token>` | List of gaussian mixture system-model ids only (fast to fetch) | `GET`,`DELETE` |
| `/gaussian-mixture-system-models/<trace_id>?token=<valid_token>` | Individual gaussian mixture system model | `GET`,`DELETE` |
| `/empirical-system-models?token=<valid_token>` | List of empirical system-models | `GET`,`DELETE` |
| `/empirical-system-models?ids=true&token=<valid_token>` | List of empirical system-model ids only (fast to fetch) | `GET`,`DELETE` |
| `/empirical-system-models/<trace_id>?token=<valid_token>` | Individual empirical system model | `GET`,`DELETE` |
| `/mcmc-system-models?token=<valid_token>` | List of mcmc system-models | `GET`,`DELETE` |
| `/mcmc-system-models?ids=true&token=<valid_token>` | List of mcmc system-model ids only (fast to fetch) | `GET`,`DELETE` |
| `/mcmc-system-models/<trace_id>?token=<valid_token>` | Individual mcmc system model | `GET`,`DELETE` |
| `/gp-system-models?token=<valid_token>` | List of gp system-models | `GET`,`DELETE` |
| `/gp-system-models?ids=true&token=<valid_token>` | List of gp system-model ids only (fast to fetch) | `GET`,`DELETE` |
| `/gp-system-models/<model_id>?token=<valid_token>` | Individual gp system model | `GET`,`DELETE` |
| `/system-models?ids=true&token=<valid_token>` | List of all system model ids (fast to fetch) | `GET` |
| `/login` | Login and generate new token (credentials as payload) | `POST` |
| `/traces-datasets?token=<valid_token>` | List of traces datasets | `GET`,`DELETE` |
| `/traces-datasets?ids=true&token=<valid_token>` | List of traces datasets ids only (fast to fetch) | `GET`,`DELETE` |
| `/traces-datasets/<traces_datasets_id>?token=<valid_token>` | Individual traces dataset | `GET`,`DELETE` |
| `/traces-datasets/<traces_datasets_id>?token=<valid_token>&download=true` | Downloads and individual traces dataset | `GET` |
| `/statistics-datasets?token=<valid_token>` | List of statistics datasets | `GET`,`DELETE` |
| `/statistics-datasets?ids=true&token=<valid_token>` | List of statistics datasets ids only (fast to fetch) | `GET`,`DELETE` |
| `/statistics-datasets/<statistics_datasets_id>?token=<valid_token>` | Individual statistics dataset | `GET`,`DELETE` |
| `/statistics-datasets/<statistics_datasets_id>?token=<valid_token>&download=true` | Downloads and individual statistics dataset | `GET` |
| `/emulation-executions?token=<valid_token>` | List of emulation executions | `GET`,`DELETE` |
| `/emulation-executions?ids=true&token=<valid_token>` | List of emulation execution ids only (fast to fetch) | `GET`,`DELETE` |
| `/emulation-executions/<execution_id>?token=<valid_token>` | Individual emulation execution | `GET`,`DELETE` |
| `/emulation-executions/<execution_id>/info?token=<valid_token>&emulation=<emulation>` | Runtime information about an emulation execution | `GET` |
| `/emulation-executions/<execution_id>/docker-stats-manager?token=<valid_token>&emulation=<emulation>` | Start/stop docker stats manager of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/docker-stats-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop docker stats monitor of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/client-manager?token=<valid_token>&emulation=<emulation>` | Start/stop client manager of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/client-population?token=<valid_token>&emulation=<emulation>` | Start/stop client population of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/client-producer?token=<valid_token>&emulation=<emulation>` | Start/stop client producer of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/kafka-manager?token=<valid_token>&emulation=<emulation>` | Start/stop Kafka manager of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/kafka?token=<valid_token>&emulation=<emulation>` | Start/stop Kafka of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/snort-ids-manager?token=<valid_token>&emulation=<emulation>` | Start/stop Snort manager of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/snort-ids-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop Snort monitor of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/snort-ids?token=<valid_token>&emulation=<emulation>` | Start/stop Snort on an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/ossec-ids-manager?token=<valid_token>&emulation=<emulation>` | Start/stop OSSEC IDS manager of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/ossec-ids?token=<valid_token>&emulation=<emulation>` | Start/stop OSSEC IDS of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/ossec-ids-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop OSSEC IDS monitor of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/host-manager?token=<valid_token>&emulation=<emulation>` | Start/stop Host managers of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/host-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop Host monitors of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/elk-manager?token=<valid_token>&emulation=<emulation>` | Start/stop ELK managers of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/elastic?token=<valid_token>&emulation=<emulation>` | Start/stop Elasticsearch on an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/logstash?token=<valid_token>&emulation=<emulation>` | Start/stop Logstash on an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/kibana?token=<valid_token>&emulation=<emulation>` | Start/stop Kibana on an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/container?token=<valid_token>&emulation=<emulation>` | Start/stop container of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/elk-stack?token=<valid_token>&emulation=<emulation>` | Start/stop ELK stack of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/traffic-generator?token=<valid_token>&emulation=<emulation>` | Start/stop traffic generators of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/filebeat?token=<valid_token>&emulation=<emulation>` | Start/stop filebeats of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/packetbeat?token=<valid_token>&emulation=<emulation>` | Start/stop packetbeats of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/metricbeat?token=<valid_token>&emulation=<emulation>` | Start/stop metricbeats of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/ryu-manager?token=<valid_token>&emulation=<emulation>` | Start/stop ryu manager of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/ryu-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop ryu monitor of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/ryu-controller?token=<valid_token>&emulation=<emulation>` | Start/stop ryu controller of an emulation execution | `POST` |
| `/emulation-executions/<execution_id>/switches?token=<valid_token>&emulation=<emulation>` | List of SDN switches | `GET` |
| `/users?token=<valid_token>` | Get/Update/Delete List of users | `GET`,`DELETE`, `PUT` |
| `/users?ids=true&token=<valid_token>` | List of user ids only (fast to fetch) | `GET`,`DELETE` |
| `/users/<user_id>?token=<valid_token>` | Get/update/delete individual user | `GET`,`DELETE`, `PUT` |
| `/users/create` | Create a new user | `POST` |
| `/logs?token=<valid_token>` | Get list of log files from the log dir | `GET` |
| `/logs/docker-stats-manager?token=<valid_token>` | Get logs of the docker stats manager | `GET` |
| `/logs/prometheus?token=<valid_token>` | Get logs of Prometheus | `GET` |
| `/logs/grafana?token=<valid_token>` | Get logs of Grafana | `GET` |
| `/logs/nginx?token=<valid_token>` | Get logs of Nginx | `GET` |
| `/logs/postgresql?token=<valid_token>` | Get logs of PostgreSQL | `GET` |
| `/logs/docker?token=<valid_token>` | Get logs of Docker engine | `GET` |
| `/logs/flask?token=<valid_token>` | Get logs of Flask | `GET` |
| `/logs/clustermanager?token=<valid_token>` | Get logs of the Cluster manager | `GET` |
| `/logs/cadvisor?token=<valid_token>` | Get logs of CAdvisor | `GET` |
| `/logs/pgadmin?token=<valid_token>` | Get logs of pgAdmin | `GET` |
| `/logs/container?token=<valid_token>&container=<container_name>` | Get logs of a specific container | `POST` |
| `/logs/node-exporter?token=<valid_token>` | Get logs of node-exporter | `GET` |
| `/logs/client-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific client manager | `POST` |
| `/logs/kafka-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Kafka manager | `POST` |
| `/logs/elk-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific ELK manager | `POST` |
| `/logs/ryu-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Ryu manager | `POST` |
| `/logs/traffic-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific traffic manager | `POST` |
| `/logs/snort-ids-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Snort IDS manager | `POST` |
| `/logs/ossec-ids-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific OSSEC IDS manager | `POST` |
| `/logs/host-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific host manager | `POST` |
| `/logs/ossec-ids?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific OSSEC IDS | `POST` |
| `/logs/snort-ids?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Snort IDS | `POST` |
| `/logs/kafka?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Kafka server | `POST` |
| `/logs/elk-stack?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific ELK stack | `POST` |
| `/logs/ryu-controller?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Ryu controller | `POST` |
| `/config?token=<valid_token>` | Get/Update system configuration | `GET`,`PUT` |
| `/config/registration-allowed` | Get registration policy | `GET` |
| `/version` | Get the version of CSLE management system | `GET` |
| `/about-page` | Get the about page | `GET` |
| `/login-page` | Get the login page | `GET` |
| `/server-cluster-page` | Get the server-cluster page | `GET` |
| `/register-page` | Get the register page | `GET` |
| `/emulation-statistics-page` | Get the emulation-statistics | `GET` |
| `/emulations-page` | Get the emulation page | `GET` |
| `/images-page` | Get the images page | `GET` |
| `/downloads-page` | Get the downloads page | `GET` |
| `/jobs-page` | Get the jobs page | `GET` |
| `/monitoring-page` | Get the monitoring page | `GET` |
| `/policies-page` | Get the policies page | `GET` |
| `/policy-examination-page` | Get the policy-examination page | `GET` |
| `/sdn-controllers-page` | Get the SDN-controllers page | `GET` |
| `/control-plane-page` | Get the control-plane page | `GET` |
| `/user-admin-page` | Get the user administration page | `GET` |
| `/system-admin-page` | Get the system administration page | `GET` |
| `/logs-admin-page` | Get the logs administration page | `GET` |
| `/simulations-page` | Get the simulations page | `GET` |
| `/system-models-page` | Get the system models page | `GET` |
| `/traces-page` | Get the traces page | `GET` |
| `/training-page` | Get the training page | `GET` |
| `/container-terminal-page` | Get the container-terminal page | `GET` |
| `/server-cluster?token=<valid_token>` | Get details of the server cluster | `GET` |
| `/create-emulation?token=<valid_token>` | Create a new emulation configuration | `POST` |
| `/create-emulation-page` | Get the create emulation page | `GET` |
## Requirements
- Python 3.8+
- `flask` (for HTTP server)
- `flask-cors`
- `flask-socketio`
- `csle-base`
- `csle-common`
- `csle-agents`
- `csle-cluster`
- `csle-system-identification`
- `csle-ryu`
- `bcrypt` (for encrypting user credentials)
- `pyopenssl` (for encrypting user credentials)
- `eventlet` (for HTTP server)
- `dnspython` (for HTTP server)
- `gevent` (for HTTP server)
- `paramiko` (for terminal emulation)
- `types-paramiko` (for terminal emulation)
- `requests` (for making HTTP requests)
- `types-requests` (for making HTTP requests)
## Development Requirements
- Python 3.8+
- `flake8` (for linting)
- `flake8-rst-docstrings` (for linting docstrings)
- `tox` (for automated testing)
- `pytest` (for unit tests)
- `pytest-cov` (for unit test coverage)
- `mypy` (for static typing)
- `mypy-extensions` (for static typing)
- `mypy-protobuf` (for static typing)
- `types-PyYaml` (for static typing)
- `types-paramiko` (for static typing)
- `types-protobuf` (for static typing)
- `types-requests` (for static typing)
- `types-urllib3` (for static typing)
- `sphinx` (for API documentation)
- `sphinxcontrib-napoleon` (for API documentation)
- `sphinx-rtd-theme` (for API documentation)
- `pytest-mock` (for mocking tests)
- `pytest-grpc` (for grpc tests)
## Installation
```bash
# install from pip
pip install csle-rest-api==<version>
# local install from source
$ pip install -e csle-rest-api
# or (equivalently):
make install
# force upgrade deps
$ pip install -e csle-rest-api --upgrade
# git clone and install from source
git clone https://github.com/Limmen/csle
cd csle/simulation-system/libs/csle-rest-api
pip3 install -e .
# Install development dependencies
$ pip install -r requirements_dev.txt
```
### Development tools
Install all development tools at once:
```bash
make install_dev
```
or
```bash
pip install -r requirements_dev.txt
```
## API documentation
This section contains instructions for generating API documentation using `sphinx`.
### Latest Documentation
The latest documentation is available
at [https://limmen.dev/csle/docs/csle-rest-api](https://limmen.dev/csle/docs/csle-rest-api)
### Generate API Documentation
First make sure that the `CSLE_HOME` environment variable is set:
```bash
echo $CSLE_HOME
```
Then generate the documentation with the commands:
```bash
cd docs
sphinx-apidoc -f -o source/ ../src/csle_rest_api/
make html
```
To update the official documentation at [https://limmen.dev/csle](https://limmen.dev/csle), copy the generated HTML
files to the documentation folder:
```bash
cp -r build/html ../../../../docs/_docs/csle-rest-api
```
To run all documentation commands at once, use the command:
```bash
make docs
```
## Static code analysis
To run the Python linter, execute the following command:
```
flake8 .
# or (equivalently):
make lint
```
To run the mypy type checker, execute the following command:
```
mypy .
# or (equivalently):
make types
```
## Unit tests
To run the unit tests, execute the following command:
```
pytest
# or (equivalently):
make unit_tests
```
To run tests of a specific test suite, execute the following command:
```
pytest -k "ClassName"
```
To generate a coverage report, execute the following command:
```
pytest --cov=csle_rest_api
```
## Run tests and code analysis in different python environments
To run tests and code analysis in different python environemnts, execute the following command:
```bash
tox
# or (equivalently):
make tests
```
## Create a new release and publish to PyPi
First build the package by executing:
```bash
python3 -m build
# or (equivalently)
make build
```
After running the command above, the built package is available at `./dist`.
Push the built package to PyPi by running:
```bash
python3 -m twine upload dist/*
# or (equivalently)
make push
```
To run all commands for the release at once, execute:
```bash
make release
```
## Author & Maintainer
Kim Hammar <kimham@kth.se>
## Copyright and license
[LICENSE](LICENSE.md)
Creative Commons
(C) 2020-2025, Kim Hammar
Raw data
{
"_id": null,
"home_page": null,
"name": "csle-rest-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Kim Hammar <kimham@kth.se>",
"keywords": "Reinforcement-Learning, Cyber-Security, Markov-Games, Markov-Decision-Processes",
"author": "Kim Hammar",
"author_email": "hammar.kim@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/be/71/dcf89f8bdbd5575bfd6bd7f39b8b83b9f97c1a26e9bbc5e24569eba9794c/csle_rest_api-0.7.4.tar.gz",
"platform": "unix",
"description": "# `csle-rest-api`\n\nA REST API for the CSLE management platform.\n\n[](https://badge.fury.io/py/csle-rest-api)\n\n\n## Endpoints\n\n| resource | description | Method |\n|:------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:----------------------------------------|\n| `/emulations` | List of emulations | `GET`,`DELETE` |\n| `/emulations?ids=true&token=<valid_token>` | List of emulation ids only (fast to fetch) | `GET`,`DELETE` |\n| `/emulations/<emulation_id>?token=<valid_token>` | Individual emulation | `GET`,`DELETE`, `POST` (for start/stop) |\n| `/emulations/<emulation_id>/executions?token=<valid_token>` | List of executions | `GET`,`DELETE` |\n| `/emulations/<emulation_id>/executions/<execution_id>?token=<valid_token>` | Individual execution | `GET`,`DELETE` |\n| `/emulations/<emulation_id>/executions/<execution_id>/monitor/<minutes>?token=<valid_token>` | Get last X minutes of data from an execution | `GET` |\n| `/simulations?token=<valid_token>` | List of simulations | `GET`,`DELETE` |\n| `/simulations?ids=true&token=<valid_token>` | List of simulation ids only (fast to fetch) | `GET`,`DELETE` |\n| `/simulations/<simulation_id>?token=<valid_token>` | Individual simulation | `GET`,`DELETE` |\n| `/cadvisor?token=<valid_token>` | Starts/stops or gets status cadvisor | `GET`,`POST` |\n| `/pgadmin?token=<valid_token>` | Starts/stops or gets status of pgadmin | `GET`,`POST` |\n| `/nodeexporter?token=<valid_token>` | Starts/stops or gets status of nodeexporter | `GET`,`POST` |\n| `/grafana?token=<valid_token>` | Starts/stops or gets status of grafana | `GET`, `POST` |\n| `/clusterstatuses?token=<valid_token>` | Gets the status of management services of the cluster | `GET` |\n| `/prometheus?token=<valid_token>` | Starts/stops or gets status of prometheus | `GET`,`POST` |\n| `/postgresql?token=<valid_token>` | Starts/stops or gets status of postgresql | `GET`,`POST` |\n| `/docker?token=<valid_token>` | Starts/stops or gets status of docker engine | `GET`,`POST` |\n| `/nginx?token=<valid_token>` | Starts/stops or gets status of nginx | `GET`,`POST` |\n| `/flask?token=<valid_token>` | Starts/stops or gets status of flask | `GET`,`POST` |\n| `/alpha-vec-policies?token=<valid_token>` | List of alpha vector policies | `GET`,`DELETE` |\n| `/alpha-vec-policies?ids=true&token=<valid_token>` | List of alpha vector policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/alpha-vec-policies/<policy_id>?token=<valid_token>` | Individual alpha vector policy | `GET`,`DELETE` |\n| `/dqn-policies?token=<valid_token>` | List of DQN policies | `GET`,`DELETE` |\n| `/dqn-policies?ids=true&token=<valid_token>` | List of DQN policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/dqn-policies/<policy_id>?token=<valid_token>` | Individual DQN policy | `GET`,`DELETE` |\n| `/ppo-policies?token=<valid_token>` | List of PPO policies | `GET`,`DELETE` |\n| `/ppo-policies?ids=true&token=<valid_token>` | List of PPO policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/ppo-policies/<policy_id>?token=<valid_token>` | Individual PPO policy | `GET`,`DELETE` |\n| `/vector-policies?token=<valid_token>` | List of vector policies | `GET`,`DELETE` |\n| `/vector-policies?ids=true&token=<valid_token>` | List of vector policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/vector-policies/<policy_id>?token=<valid_token>` | Individual vector policy | `GET`,`DELETE` |\n| `/tabular-policies?token=<valid_token>` | List of tabular policies | `GET`,`DELETE` |\n| `/tabular-policies?ids=true&token=<valid_token>` | List of tabular policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/tabular-policies/<policy_id>?token=<valid_token>` | Individual tabular policy | `GET`,`DELETE` |\n| `/multi-threshold-policies?token=<valid_token>` | List of multi-threshold policies | `GET`,`DELETE` |\n| `/multi-threshold-policies?ids=true&token=<valid_token>` | List of multi-threshold policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/multi-threshold-policies/<policy_id>?token=<valid_token>` | Individual multi-threshold policy | `GET`,`DELETE` |\n| `/linear-threshold-policies?token=<valid_token>` | List of linear threshold policies | `GET`,`DELETE` |\n| `/linear-threshold-policies?ids=true&token=<valid_token>` | List of linear threshold policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/linear-threshold-policies/<policy_id>?token=<valid_token>` | Individual linear threshold policy | `GET`,`DELETE` |\n| `/fnn-w-softmax-policies?token=<valid_token>` | List of fnn-w-softmax policies | `GET`,`DELETE` |\n| `/fnn-w-softmax-policies?ids=true&token=<valid_token>` | List of fnn-w-softmax policy ids only (fast to fetch) | `GET`,`DELETE` |\n| `/fnn-w-softmax-policies/<policy_id>?token=<valid_token>` | Individual fnn-w-softmax policy | `GET`,`DELETE` |\n| `/training-jobs?token=<valid_token>` | List of training jobs | `GET`,`DELETE` |\n| `/training-jobs?ids=true&token=<valid_token>` | List of training job ids only (fast to fetch) | `GET`,`DELETE` |\n| `/training-jobs/<job_id>?token=<valid_token>` | Individual training job | `GET`,`DELETE`, `POST` (for start/stop) |\n| `/data-collection-jobs?token=<valid_token>` | List of data-collection jobs | `GET`,`DELETE` |\n| `/data-collection-jobs?ids=true&token=<valid_token>` | List of data-collection job ids only (fast to fetch) | `GET`,`DELETE` |\n| `/data-collection-jobs/<job_id>?token=<valid_token>` | Individual data-collection job | `GET`,`DELETE`, `POST` (for start/stop) |\n| `/system-identification-jobs?token=<valid_token>` | List of system-identification jobs | `GET`,`DELETE` |\n| `/system-identification-jobs?ids=true&token=<valid_token>` | List of system-identification job ids only (fast to fetch) | `GET`,`DELETE` |\n| `/system-identification-jobs/<job_id>?token=<valid_token>` | Individual system-identification job | `GET`,`DELETE`, `POST` (for start/stop) |\n| `/emulation-traces?token=<valid_token>` | List of emulation traces | `GET`,`DELETE` |\n| `/emulation-traces?ids=true&token=<valid_token>` | List of emulation trace ids only (fast to fetch) | `GET`,`DELETE` |\n| `/emulation-traces/<trace_id>?token=<valid_token>` | Individual emulation trace | `GET`,`DELETE` |\n| `/simulation-traces?token=<valid_token>` | List of simulation traces | `GET`,`DELETE` |\n| `/simulation-traces?ids=true&token=<valid_token>` | List of simulation trace ids only (fast to fetch) | `GET`,`DELETE` |\n| `/simulation-traces/<trace_id>?token=<valid_token>` | Individual simulation trace | `GET`,`DELETE` |\n| `/emulation-simulation-traces?token=<valid_token>` | List of emulation-simulation traces | `GET`,`DELETE` |\n| `/emulation-simulation-traces?ids=true&token=<valid_token>` | List of emulation-simulation trace ids only (fast to fetch) | `GET`,`DELETE` |\n| `/emulation-simulation-traces/<trace_id>?token=<valid_token>` | Individual emulation-simulation trace | `GET`,`DELETE` |\n| `/images?token=<valid_token>` | List of Docker images | `GET` |\n| `/file?token=<valid_token>` | Reads a given file from disk | `POST` |\n| `/experiments?token=<valid_token>` | List of experiments | `GET`,`DELETE` |\n| `/experiments?ids=true&token=<valid_token>` | List of experiment ids only (fast to fetch) | `GET`,`DELETE` |\n| `/experiments/<trace_id>?token=<valid_token>` | Individual experiment | `GET`,`DELETE` |\n| `/sdn-controllers?token=<valid_token>` | List of SDN controllers | `GET`,`DELETE` |\n| `/sdn-controllers?ids=true&token=<valid_token>` | List of SDN controller ids only (fast to fetch) | `GET`,`DELETE` |\n| `/emulation-statistics?token=<valid_token>` | List of emulation statistics | `GET`,`DELETE` |\n| `/emulation-statistics?ids=true&token=<valid_token>` | List of emulation statistic ids only (fast to fetch) | `GET`,`DELETE` |\n| `/emulation-statistics/<trace_id>?token=<valid_token>` | Individual emulation statistic | `GET`,`DELETE` |\n| `/gaussian-mixture-system-models?token=<valid_token>` | List of gaussian mixture system-models | `GET`,`DELETE` |\n| `/gaussian-mixture-system-models?ids=true&token=<valid_token>` | List of gaussian mixture system-model ids only (fast to fetch) | `GET`,`DELETE` |\n| `/gaussian-mixture-system-models/<trace_id>?token=<valid_token>` | Individual gaussian mixture system model | `GET`,`DELETE` |\n| `/empirical-system-models?token=<valid_token>` | List of empirical system-models | `GET`,`DELETE` |\n| `/empirical-system-models?ids=true&token=<valid_token>` | List of empirical system-model ids only (fast to fetch) | `GET`,`DELETE` |\n| `/empirical-system-models/<trace_id>?token=<valid_token>` | Individual empirical system model | `GET`,`DELETE` |\n| `/mcmc-system-models?token=<valid_token>` | List of mcmc system-models | `GET`,`DELETE` |\n| `/mcmc-system-models?ids=true&token=<valid_token>` | List of mcmc system-model ids only (fast to fetch) | `GET`,`DELETE` |\n| `/mcmc-system-models/<trace_id>?token=<valid_token>` | Individual mcmc system model | `GET`,`DELETE` |\n| `/gp-system-models?token=<valid_token>` | List of gp system-models | `GET`,`DELETE` |\n| `/gp-system-models?ids=true&token=<valid_token>` | List of gp system-model ids only (fast to fetch) | `GET`,`DELETE` |\n| `/gp-system-models/<model_id>?token=<valid_token>` | Individual gp system model | `GET`,`DELETE` |\n| `/system-models?ids=true&token=<valid_token>` | List of all system model ids (fast to fetch) | `GET` |\n| `/login` | Login and generate new token (credentials as payload) | `POST` |\n| `/traces-datasets?token=<valid_token>` | List of traces datasets | `GET`,`DELETE` |\n| `/traces-datasets?ids=true&token=<valid_token>` | List of traces datasets ids only (fast to fetch) | `GET`,`DELETE` |\n| `/traces-datasets/<traces_datasets_id>?token=<valid_token>` | Individual traces dataset | `GET`,`DELETE` |\n| `/traces-datasets/<traces_datasets_id>?token=<valid_token>&download=true` | Downloads and individual traces dataset | `GET` |\n| `/statistics-datasets?token=<valid_token>` | List of statistics datasets | `GET`,`DELETE` |\n| `/statistics-datasets?ids=true&token=<valid_token>` | List of statistics datasets ids only (fast to fetch) | `GET`,`DELETE` |\n| `/statistics-datasets/<statistics_datasets_id>?token=<valid_token>` | Individual statistics dataset | `GET`,`DELETE` |\n| `/statistics-datasets/<statistics_datasets_id>?token=<valid_token>&download=true` | Downloads and individual statistics dataset | `GET` |\n| `/emulation-executions?token=<valid_token>` | List of emulation executions | `GET`,`DELETE` |\n| `/emulation-executions?ids=true&token=<valid_token>` | List of emulation execution ids only (fast to fetch) | `GET`,`DELETE` |\n| `/emulation-executions/<execution_id>?token=<valid_token>` | Individual emulation execution | `GET`,`DELETE` |\n| `/emulation-executions/<execution_id>/info?token=<valid_token>&emulation=<emulation>` | Runtime information about an emulation execution | `GET` |\n| `/emulation-executions/<execution_id>/docker-stats-manager?token=<valid_token>&emulation=<emulation>` | Start/stop docker stats manager of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/docker-stats-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop docker stats monitor of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/client-manager?token=<valid_token>&emulation=<emulation>` | Start/stop client manager of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/client-population?token=<valid_token>&emulation=<emulation>` | Start/stop client population of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/client-producer?token=<valid_token>&emulation=<emulation>` | Start/stop client producer of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/kafka-manager?token=<valid_token>&emulation=<emulation>` | Start/stop Kafka manager of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/kafka?token=<valid_token>&emulation=<emulation>` | Start/stop Kafka of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/snort-ids-manager?token=<valid_token>&emulation=<emulation>` | Start/stop Snort manager of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/snort-ids-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop Snort monitor of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/snort-ids?token=<valid_token>&emulation=<emulation>` | Start/stop Snort on an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/ossec-ids-manager?token=<valid_token>&emulation=<emulation>` | Start/stop OSSEC IDS manager of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/ossec-ids?token=<valid_token>&emulation=<emulation>` | Start/stop OSSEC IDS of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/ossec-ids-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop OSSEC IDS monitor of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/host-manager?token=<valid_token>&emulation=<emulation>` | Start/stop Host managers of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/host-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop Host monitors of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/elk-manager?token=<valid_token>&emulation=<emulation>` | Start/stop ELK managers of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/elastic?token=<valid_token>&emulation=<emulation>` | Start/stop Elasticsearch on an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/logstash?token=<valid_token>&emulation=<emulation>` | Start/stop Logstash on an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/kibana?token=<valid_token>&emulation=<emulation>` | Start/stop Kibana on an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/container?token=<valid_token>&emulation=<emulation>` | Start/stop container of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/elk-stack?token=<valid_token>&emulation=<emulation>` | Start/stop ELK stack of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/traffic-generator?token=<valid_token>&emulation=<emulation>` | Start/stop traffic generators of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/filebeat?token=<valid_token>&emulation=<emulation>` | Start/stop filebeats of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/packetbeat?token=<valid_token>&emulation=<emulation>` | Start/stop packetbeats of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/metricbeat?token=<valid_token>&emulation=<emulation>` | Start/stop metricbeats of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/ryu-manager?token=<valid_token>&emulation=<emulation>` | Start/stop ryu manager of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/ryu-monitor?token=<valid_token>&emulation=<emulation>` | Start/stop ryu monitor of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/ryu-controller?token=<valid_token>&emulation=<emulation>` | Start/stop ryu controller of an emulation execution | `POST` |\n| `/emulation-executions/<execution_id>/switches?token=<valid_token>&emulation=<emulation>` | List of SDN switches | `GET` |\n| `/users?token=<valid_token>` | Get/Update/Delete List of users | `GET`,`DELETE`, `PUT` |\n| `/users?ids=true&token=<valid_token>` | List of user ids only (fast to fetch) | `GET`,`DELETE` |\n| `/users/<user_id>?token=<valid_token>` | Get/update/delete individual user | `GET`,`DELETE`, `PUT` |\n| `/users/create` | Create a new user | `POST` |\n| `/logs?token=<valid_token>` | Get list of log files from the log dir | `GET` |\n| `/logs/docker-stats-manager?token=<valid_token>` | Get logs of the docker stats manager | `GET` |\n| `/logs/prometheus?token=<valid_token>` | Get logs of Prometheus | `GET` |\n| `/logs/grafana?token=<valid_token>` | Get logs of Grafana | `GET` |\n| `/logs/nginx?token=<valid_token>` | Get logs of Nginx | `GET` |\n| `/logs/postgresql?token=<valid_token>` | Get logs of PostgreSQL | `GET` |\n| `/logs/docker?token=<valid_token>` | Get logs of Docker engine | `GET` |\n| `/logs/flask?token=<valid_token>` | Get logs of Flask | `GET` |\n| `/logs/clustermanager?token=<valid_token>` | Get logs of the Cluster manager | `GET` |\n| `/logs/cadvisor?token=<valid_token>` | Get logs of CAdvisor | `GET` |\n| `/logs/pgadmin?token=<valid_token>` | Get logs of pgAdmin | `GET` |\n| `/logs/container?token=<valid_token>&container=<container_name>` | Get logs of a specific container | `POST` |\n| `/logs/node-exporter?token=<valid_token>` | Get logs of node-exporter | `GET` |\n| `/logs/client-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific client manager | `POST` |\n| `/logs/kafka-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Kafka manager | `POST` |\n| `/logs/elk-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific ELK manager | `POST` |\n| `/logs/ryu-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Ryu manager | `POST` |\n| `/logs/traffic-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific traffic manager | `POST` |\n| `/logs/snort-ids-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Snort IDS manager | `POST` |\n| `/logs/ossec-ids-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific OSSEC IDS manager | `POST` |\n| `/logs/host-manager?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific host manager | `POST` |\n| `/logs/ossec-ids?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific OSSEC IDS | `POST` |\n| `/logs/snort-ids?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Snort IDS | `POST` |\n| `/logs/kafka?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Kafka server | `POST` |\n| `/logs/elk-stack?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific ELK stack | `POST` |\n| `/logs/ryu-controller?token=<valid_token>&emulation=<emulation_name>&executionid=<execution_id>` | Get logs of a specific Ryu controller | `POST` |\n| `/config?token=<valid_token>` | Get/Update system configuration | `GET`,`PUT` |\n| `/config/registration-allowed` | Get registration policy | `GET` |\n| `/version` | Get the version of CSLE management system | `GET` |\n| `/about-page` | Get the about page | `GET` |\n| `/login-page` | Get the login page | `GET` |\n| `/server-cluster-page` | Get the server-cluster page | `GET` |\n| `/register-page` | Get the register page | `GET` |\n| `/emulation-statistics-page` | Get the emulation-statistics | `GET` |\n| `/emulations-page` | Get the emulation page | `GET` |\n| `/images-page` | Get the images page | `GET` |\n| `/downloads-page` | Get the downloads page | `GET` |\n| `/jobs-page` | Get the jobs page | `GET` |\n| `/monitoring-page` | Get the monitoring page | `GET` |\n| `/policies-page` | Get the policies page | `GET` |\n| `/policy-examination-page` | Get the policy-examination page | `GET` |\n| `/sdn-controllers-page` | Get the SDN-controllers page | `GET` |\n| `/control-plane-page` | Get the control-plane page | `GET` |\n| `/user-admin-page` | Get the user administration page | `GET` |\n| `/system-admin-page` | Get the system administration page | `GET` |\n| `/logs-admin-page` | Get the logs administration page | `GET` |\n| `/simulations-page` | Get the simulations page | `GET` |\n| `/system-models-page` | Get the system models page | `GET` |\n| `/traces-page` | Get the traces page | `GET` |\n| `/training-page` | Get the training page | `GET` |\n| `/container-terminal-page` | Get the container-terminal page | `GET` |\n| `/server-cluster?token=<valid_token>` | Get details of the server cluster | `GET` |\n| `/create-emulation?token=<valid_token>` | Create a new emulation configuration | `POST` |\n| `/create-emulation-page` | Get the create emulation page | `GET` |\n\n## Requirements\n\n- Python 3.8+\n- `flask` (for HTTP server)\n- `flask-cors`\n- `flask-socketio`\n- `csle-base`\n- `csle-common`\n- `csle-agents`\n- `csle-cluster`\n- `csle-system-identification`\n- `csle-ryu`\n- `bcrypt` (for encrypting user credentials)\n- `pyopenssl` (for encrypting user credentials)\n- `eventlet` (for HTTP server)\n- `dnspython` (for HTTP server)\n- `gevent` (for HTTP server)\n- `paramiko` (for terminal emulation)\n- `types-paramiko` (for terminal emulation)\n- `requests` (for making HTTP requests)\n- `types-requests` (for making HTTP requests)\n\n## Development Requirements\n\n- Python 3.8+\n- `flake8` (for linting)\n- `flake8-rst-docstrings` (for linting docstrings)\n- `tox` (for automated testing)\n- `pytest` (for unit tests)\n- `pytest-cov` (for unit test coverage)\n- `mypy` (for static typing)\n- `mypy-extensions` (for static typing)\n- `mypy-protobuf` (for static typing)\n- `types-PyYaml` (for static typing)\n- `types-paramiko` (for static typing)\n- `types-protobuf` (for static typing)\n- `types-requests` (for static typing)\n- `types-urllib3` (for static typing)\n- `sphinx` (for API documentation)\n- `sphinxcontrib-napoleon` (for API documentation)\n- `sphinx-rtd-theme` (for API documentation)\n- `pytest-mock` (for mocking tests)\n- `pytest-grpc` (for grpc tests)\n\n## Installation\n\n```bash\n# install from pip\npip install csle-rest-api==<version>\n# local install from source\n$ pip install -e csle-rest-api\n# or (equivalently):\nmake install\n# force upgrade deps\n$ pip install -e csle-rest-api --upgrade\n# git clone and install from source\ngit clone https://github.com/Limmen/csle\ncd csle/simulation-system/libs/csle-rest-api\npip3 install -e .\n# Install development dependencies\n$ pip install -r requirements_dev.txt\n```\n\n### Development tools\n\nInstall all development tools at once:\n```bash\nmake install_dev\n```\nor\n```bash\npip install -r requirements_dev.txt\n```\n## API documentation\n\nThis section contains instructions for generating API documentation using `sphinx`.\n\n### Latest Documentation\n\nThe latest documentation is available\nat [https://limmen.dev/csle/docs/csle-rest-api](https://limmen.dev/csle/docs/csle-rest-api)\n\n### Generate API Documentation\n\nFirst make sure that the `CSLE_HOME` environment variable is set:\n\n```bash\necho $CSLE_HOME\n```\n\nThen generate the documentation with the commands:\n\n```bash\ncd docs\nsphinx-apidoc -f -o source/ ../src/csle_rest_api/\nmake html\n```\n\nTo update the official documentation at [https://limmen.dev/csle](https://limmen.dev/csle), copy the generated HTML\nfiles to the documentation folder:\n\n```bash\ncp -r build/html ../../../../docs/_docs/csle-rest-api\n```\n\nTo run all documentation commands at once, use the command:\n```bash\nmake docs\n```\n\n## Static code analysis\n\nTo run the Python linter, execute the following command:\n```\nflake8 .\n# or (equivalently):\nmake lint\n```\n\nTo run the mypy type checker, execute the following command:\n```\nmypy .\n# or (equivalently):\nmake types\n```\n\n## Unit tests\n\nTo run the unit tests, execute the following command:\n```\npytest\n# or (equivalently):\nmake unit_tests\n```\n\nTo run tests of a specific test suite, execute the following command:\n```\npytest -k \"ClassName\"\n```\n\nTo generate a coverage report, execute the following command:\n```\npytest --cov=csle_rest_api\n```\n\n## Run tests and code analysis in different python environments\n\nTo run tests and code analysis in different python environemnts, execute the following command:\n\n```bash\ntox\n# or (equivalently):\nmake tests\n```\n\n## Create a new release and publish to PyPi\n\nFirst build the package by executing:\n```bash\npython3 -m build\n# or (equivalently)\nmake build\n```\nAfter running the command above, the built package is available at `./dist`.\n\nPush the built package to PyPi by running:\n```bash\npython3 -m twine upload dist/*\n# or (equivalently)\nmake push\n```\n\nTo run all commands for the release at once, execute:\n```bash\nmake release\n```\n\n\n## Author & Maintainer\n\nKim Hammar <kimham@kth.se>\n\n## Copyright and license\n\n[LICENSE](LICENSE.md)\n\nCreative Commons\n\n(C) 2020-2025, Kim Hammar\n\n",
"bugtrack_url": null,
"license": "## creative commons # Attribution-ShareAlike 4.0 International Creative Commons Corporation (\u201cCreative Commons\u201d) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an \u201cas-is\u201d basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. ### Using Creative Commons Public Licenses Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. * __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors). * __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor\u2019s permission is not necessary for any reason\u2013for example, because of any applicable exception or limitation to copyright\u2013then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). ## Creative Commons Attribution-ShareAlike 4.0 International Public License By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License (\"Public License\"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. ### Section 1 \u2013 Definitions. a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. c. __BY-SA Compatible License__ means a license listed at [creativecommons.org/compatiblelicenses](http://creativecommons.org/compatiblelicenses), approved by Creative Commons as essentially the equivalent of this Public License. d. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. e. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. f. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. g. __License Elements__ means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike. h. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License. i. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. j. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License. k. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. l. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. m. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. ### Section 2 \u2013 Scope. a. ___License grant.___ 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: A. reproduce and Share the Licensed Material, in whole or in part; and B. produce, reproduce, and Share Adapted Material. 2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. 3. __Term.__ The term of this Public License is specified in Section 6(a). 4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. 5. __Downstream recipients.__ A. __Offer from the Licensor \u2013 Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. B. __Additional offer from the Licensor \u2013 Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter\u2019s License You apply. C. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. 6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). b. ___Other rights.___ 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. 2. Patent and trademark rights are not licensed under this Public License. 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. ### Section 3 \u2013 License Conditions. Your exercise of the Licensed Rights is expressly made subject to the following conditions. a. ___Attribution.___ 1. If You Share the Licensed Material (including in modified form), You must: A. retain the following if it is supplied by the Licensor with the Licensed Material: i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); ii. a copyright notice; iii. a notice that refers to this Public License; iv. a notice that refers to the disclaimer of warranties; v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. b. ___ShareAlike.___ In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. 1. The Adapter\u2019s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. ### Section 4 \u2013 Sui Generis Database Rights. Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. ### Section 5 \u2013 Disclaimer of Warranties and Limitation of Liability. a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__ b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__ c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. ### Section 6 \u2013 Term and Termination. a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or 2. upon express reinstatement by the Licensor. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. ### Section 7 \u2013 Other Terms and Conditions. a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.t stated herein are separate from and independent of the terms and conditions of this Public License. ### Section 8 \u2013 Interpretation. a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. ``` Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the \u201cLicensor.\u201d Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark \u201cCreative Commons\u201d or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. Creative Commons may be contacted at creativecommons.org ``` ## Disclaimer All code and software in this repository is for Educational purpose ONLY. Do not use it without permission. The usual disclaimer applies, especially the fact that me (Kim Hammar) is not liable for any damages caused by direct or indirect use of the information or functionality provided by these programs. The author or any Internet provider bears NO responsibility for content or misuse of these programs or any derivatives thereof. By using these programs you accept the fact that any damage (dataloss, system crash, system compromise, etc.) caused by the use of these programs is not Kim Hammar's responsibility.",
"summary": "CSLE REST API",
"version": "0.7.4",
"project_urls": {
"Homepage": "https://limmen.dev/csle",
"Source": "https://github.com/Limmen/csle"
},
"split_keywords": [
"reinforcement-learning",
" cyber-security",
" markov-games",
" markov-decision-processes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac38f16883003c7bb36bd116cf17bea64dd786a23d3ad3e846658ee31f2ee727",
"md5": "d30cdf82b041a5ddc14a436ee23df607",
"sha256": "5e8df42472f6d0a1f5949be7cd4dcfba25cecf2e2c68790eaf96d121f836652b"
},
"downloads": -1,
"filename": "csle_rest_api-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d30cdf82b041a5ddc14a436ee23df607",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 131610,
"upload_time": "2025-01-12T06:40:32",
"upload_time_iso_8601": "2025-01-12T06:40:32.432440Z",
"url": "https://files.pythonhosted.org/packages/ac/38/f16883003c7bb36bd116cf17bea64dd786a23d3ad3e846658ee31f2ee727/csle_rest_api-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be71dcf89f8bdbd5575bfd6bd7f39b8b83b9f97c1a26e9bbc5e24569eba9794c",
"md5": "ce100c9ea33d3f72e48babc52154bc91",
"sha256": "898aff782da8f3ff4c4b72423c50707354fedb87d87b0032b585d60cb41093ca"
},
"downloads": -1,
"filename": "csle_rest_api-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "ce100c9ea33d3f72e48babc52154bc91",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 165340,
"upload_time": "2025-01-12T06:40:34",
"upload_time_iso_8601": "2025-01-12T06:40:34.051157Z",
"url": "https://files.pythonhosted.org/packages/be/71/dcf89f8bdbd5575bfd6bd7f39b8b83b9f97c1a26e9bbc5e24569eba9794c/csle_rest_api-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-12 06:40:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Limmen",
"github_project": "csle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "csle-rest-api"
}
