Metadata-Version: 2.1
Name: rootshell_platform_api
Version: 0.2.0
Summary: A Package to interact with Rootshells Public API
Author: Rootshell Developers
Author-email: chris.mills@rootshellsecurity.net
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Description-Content-Type: text/markdown


A project to access Rootshell's Public API. 

`pip install rootshell_platform_api`

The `BEARER_TOKEN` can be accessed in the Platform. 
The `API_ENDPOINT` is the tenant url which you want access the data.
```shell
export BEARER_TOKEN=your_token_here
export API_ENDPOINT=https://your.api.endpoint
```

Currently list of groups that are accessible

```text

asset_groups_assets
    get-paginated
    update
    
asset_groups
    get-paginated
    get-single
    create
    update
    delete
 
asset_tags
    get-paginated
    update
    delete
    
assets 
    get-paginated
    get-single
    create
    update
    delete

companies
    get-paginated
    get_single

issue_comments
    get-paginated    
    create
    delete
    
 issues
    get-paginated
 
merge_settings
    get-paginated
    get-single
 
phase_host_issues
    get-paginated
    get-single
    create
    update
    delete

phase-hosts
    get-paginated
    get-single
    create
    update
    delete
 
phase_issues
    get-paginated
    get-single
    create
    update
    delete

phase_tags
    get-paginated
    delete
    update
     
phase_testers
    get-paginated
    update
    delete
    
phases 
    get-paginated
    get-single
    create
    update
    delete
    
projects
    get-paginated
    get-single
    create
    update
    delete
    
project_statuses
    get-paginated
    
project_remediation_types
    get-paginated
    
project_service_types
    get-paginated
    
project_statuses
    get-paginated
    
project-tags
    get-paginated
    update
    delete
    
tags
    get-paginated
    get-single
    create
    update
    delete
    
test_types
    get-paginated
    
users
    get-paginated
    

```
Example:
```shell
rootshell_platform tags get_paginated
```


