# stairwell-api
Restful APIs for the Stairwell platform. Most APIs expose named resources: each resource has a unique identifier that users use to reference that resource, and these names are what users should store as the canonical names for the resources. The base URL for this API is https://app.stairwell.com
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
## Requirements.
Python 3.8+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/stairwell-inc/stairwell-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/stairwell-inc/stairwell-python.git`)
Then import the package:
```python
import stairwell_openapi_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import stairwell_openapi_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import stairwell_openapi_client
from stairwell_openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://app.stairwell.com
# See configuration.py for a list of all supported configuration parameters.
configuration = stairwell_openapi_client.Configuration(
host = "https://app.stairwell.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: AuthToken
configuration.api_key['AuthToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthToken'] = 'Bearer'
# Enter a context with an instance of the API client
async with stairwell_openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = stairwell_openapi_client.AssetsApi(api_client)
asset = 'asset_example' # str | The asset id.
tag = stairwell_openapi_client.Tag() # Tag |
try:
# CreateTag
api_response = await api_instance.assets_create_tag(asset, tag)
print("The response of AssetsApi->assets_create_tag:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetsApi->assets_create_tag: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://app.stairwell.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AssetsApi* | [**assets_create_tag**](docs/AssetsApi.md#assets_create_tag) | **POST** /v1/assets/{asset}/tags | CreateTag
*AssetsApi* | [**assets_delete_tag**](docs/AssetsApi.md#assets_delete_tag) | **DELETE** /v1/assets/{asset}/tags/{tag} | DeleteTag
*AssetsApi* | [**assets_get_asset**](docs/AssetsApi.md#assets_get_asset) | **GET** /v1/assets/{asset} | GetAsset
*AssetsApi* | [**assets_get_tag**](docs/AssetsApi.md#assets_get_tag) | **GET** /v1/assets/{asset}/tags/{tag} | GetTag
*AssetsApi* | [**assets_list_assets**](docs/AssetsApi.md#assets_list_assets) | **GET** /v1/environments/{environment}/assets | ListAssets
*AssetsApi* | [**assets_list_tags**](docs/AssetsApi.md#assets_list_tags) | **GET** /v1/assets/{asset}/tags | ListTags
*HostnamesApi* | [**hostnames_create_comment**](docs/HostnamesApi.md#hostnames_create_comment) | **POST** /v1/hostnames/{hostname}/comments | CreateComment
*HostnamesApi* | [**hostnames_create_opinion**](docs/HostnamesApi.md#hostnames_create_opinion) | **POST** /v1/hostnames/{hostname}/opinions | CreateOpinion
*HostnamesApi* | [**hostnames_create_tag**](docs/HostnamesApi.md#hostnames_create_tag) | **POST** /v1/hostnames/{hostname}/tags | CreateTag
*HostnamesApi* | [**hostnames_delete_tag**](docs/HostnamesApi.md#hostnames_delete_tag) | **DELETE** /v1/hostnames/{hostname}/tags/{tag} | DeleteTag
*HostnamesApi* | [**hostnames_get_hostname_metadata**](docs/HostnamesApi.md#hostnames_get_hostname_metadata) | **GET** /v1/hostnames/{hostname}/metadata | GetHostnameMetadata
*HostnamesApi* | [**hostnames_get_tag**](docs/HostnamesApi.md#hostnames_get_tag) | **GET** /v1/hostnames/{hostname}/tags/{tag} | GetTag
*HostnamesApi* | [**hostnames_list_comments**](docs/HostnamesApi.md#hostnames_list_comments) | **GET** /v1/hostnames/{hostname}/comments | ListComments
*HostnamesApi* | [**hostnames_list_opinions**](docs/HostnamesApi.md#hostnames_list_opinions) | **GET** /v1/hostnames/{hostname}/opinions | ListOpinions
*HostnamesApi* | [**hostnames_list_tags**](docs/HostnamesApi.md#hostnames_list_tags) | **GET** /v1/hostnames/{hostname}/tags | ListTags
*IpAddressesApi* | [**ip_addresses_create_comment**](docs/IpAddressesApi.md#ip_addresses_create_comment) | **POST** /v1/ipAddresses/{ipAddress}/comments | CreateComment
*IpAddressesApi* | [**ip_addresses_create_opinion**](docs/IpAddressesApi.md#ip_addresses_create_opinion) | **POST** /v1/ipAddresses/{ipAddress}/opinions | CreateOpinion
*IpAddressesApi* | [**ip_addresses_create_tag**](docs/IpAddressesApi.md#ip_addresses_create_tag) | **POST** /v1/ipAddresses/{ipAddress}/tags | CreateTag
*IpAddressesApi* | [**ip_addresses_delete_tag**](docs/IpAddressesApi.md#ip_addresses_delete_tag) | **DELETE** /v1/ipAddresses/{ipAddress}/tags/{tag} | DeleteTag
*IpAddressesApi* | [**ip_addresses_get_ip_address_metadata**](docs/IpAddressesApi.md#ip_addresses_get_ip_address_metadata) | **GET** /v1/ipAddresses/{ipAddress}/metadata | GetIpAddressMetadata
*IpAddressesApi* | [**ip_addresses_get_tag**](docs/IpAddressesApi.md#ip_addresses_get_tag) | **GET** /v1/ipAddresses/{ipAddress}/tags/{tag} | GetTag
*IpAddressesApi* | [**ip_addresses_list_comments**](docs/IpAddressesApi.md#ip_addresses_list_comments) | **GET** /v1/ipAddresses/{ipAddress}/comments | ListComments
*IpAddressesApi* | [**ip_addresses_list_opinions**](docs/IpAddressesApi.md#ip_addresses_list_opinions) | **GET** /v1/ipAddresses/{ipAddress}/opinions | ListOpinions
*IpAddressesApi* | [**ip_addresses_list_tags**](docs/IpAddressesApi.md#ip_addresses_list_tags) | **GET** /v1/ipAddresses/{ipAddress}/tags | ListTags
*ObjectsApi* | [**objects_create_comment**](docs/ObjectsApi.md#objects_create_comment) | **POST** /v1/objects/{object}/comments | CreateComment
*ObjectsApi* | [**objects_create_opinion**](docs/ObjectsApi.md#objects_create_opinion) | **POST** /v1/objects/{object}/opinions | CreateOpinion
*ObjectsApi* | [**objects_create_tag**](docs/ObjectsApi.md#objects_create_tag) | **POST** /v1/objects/{object}/tags | CreateTag
*ObjectsApi* | [**objects_delete_tag**](docs/ObjectsApi.md#objects_delete_tag) | **DELETE** /v1/objects/{object}/tags/{tag} | DeleteTag
*ObjectsApi* | [**objects_download_object**](docs/ObjectsApi.md#objects_download_object) | **GET** /v1/objects/{object}:download | DownloadObject
*ObjectsApi* | [**objects_get_object_detonation**](docs/ObjectsApi.md#objects_get_object_detonation) | **GET** /v1/objects/{object}/detonation | GetObjectDetonation
*ObjectsApi* | [**objects_get_object_metadata**](docs/ObjectsApi.md#objects_get_object_metadata) | **GET** /v1/objects/{object}/metadata | GetObjectMetadata
*ObjectsApi* | [**objects_get_tag**](docs/ObjectsApi.md#objects_get_tag) | **GET** /v1/objects/{object}/tags/{tag} | GetTag
*ObjectsApi* | [**objects_list_comments**](docs/ObjectsApi.md#objects_list_comments) | **GET** /v1/objects/{object}/comments | ListComments
*ObjectsApi* | [**objects_list_object_metadata**](docs/ObjectsApi.md#objects_list_object_metadata) | **GET** /v1/objects/metadata | ListObjectMetadata
*ObjectsApi* | [**objects_list_object_sightings**](docs/ObjectsApi.md#objects_list_object_sightings) | **GET** /v1/objects/{object}/sightings | ListObjectSightings
*ObjectsApi* | [**objects_list_object_variants**](docs/ObjectsApi.md#objects_list_object_variants) | **GET** /v1/objects/{object}/variants | ListObjectVariants
*ObjectsApi* | [**objects_list_opinions**](docs/ObjectsApi.md#objects_list_opinions) | **GET** /v1/objects/{object}/opinions | ListOpinions
*ObjectsApi* | [**objects_list_tags**](docs/ObjectsApi.md#objects_list_tags) | **GET** /v1/objects/{object}/tags | ListTags
*ObjectsApi* | [**objects_trigger_object_detonation**](docs/ObjectsApi.md#objects_trigger_object_detonation) | **POST** /v1/objects/{object}/detonation:trigger | TriggerObjectDetonation
*YaraRulesApi* | [**yara_rules_create_tag**](docs/YaraRulesApi.md#yara_rules_create_tag) | **POST** /v1/environments/{environment}/yaraRules/{yaraRule}/tags | CreateTag
*YaraRulesApi* | [**yara_rules_create_yara_rule**](docs/YaraRulesApi.md#yara_rules_create_yara_rule) | **POST** /v1/environments/{environment}/yaraRules | CreateYaraRule
*YaraRulesApi* | [**yara_rules_delete_tag**](docs/YaraRulesApi.md#yara_rules_delete_tag) | **DELETE** /v1/environments/{environment}/yaraRules/{yaraRule}/tags/{tag} | DeleteTag
*YaraRulesApi* | [**yara_rules_delete_yara_rule**](docs/YaraRulesApi.md#yara_rules_delete_yara_rule) | **DELETE** /v1/environments/{environment}/yaraRules/{yaraRule} | DeleteYaraRule
*YaraRulesApi* | [**yara_rules_get_tag**](docs/YaraRulesApi.md#yara_rules_get_tag) | **GET** /v1/environments/{environment}/yaraRules/{yaraRule}/tags/{tag} | GetTag
*YaraRulesApi* | [**yara_rules_get_yara_rule**](docs/YaraRulesApi.md#yara_rules_get_yara_rule) | **GET** /v1/environments/{environment}/yaraRules/{yaraRule} | GetYaraRule
*YaraRulesApi* | [**yara_rules_list_tags**](docs/YaraRulesApi.md#yara_rules_list_tags) | **GET** /v1/environments/{environment}/yaraRules/{yaraRule}/tags | ListTags
*YaraRulesApi* | [**yara_rules_list_yara_rules**](docs/YaraRulesApi.md#yara_rules_list_yara_rules) | **GET** /v1/environments/{environment}/yaraRules | ListYaraRules
*YaraRulesApi* | [**yara_rules_update_yara_rule**](docs/YaraRulesApi.md#yara_rules_update_yara_rule) | **PATCH** /v1/environments/{environment}/yaraRules/{yaraRule} | UpdateYaraRule
## Documentation For Models
- [Asset](docs/Asset.md)
- [Comment](docs/Comment.md)
- [DNSLookupResult](docs/DNSLookupResult.md)
- [Detection](docs/Detection.md)
- [FileAction](docs/FileAction.md)
- [HostnameMetadata](docs/HostnameMetadata.md)
- [IpAddressMetadata](docs/IpAddressMetadata.md)
- [ListAssetsResponse](docs/ListAssetsResponse.md)
- [ListCommentsResponse](docs/ListCommentsResponse.md)
- [ListObjectMetadataResponse](docs/ListObjectMetadataResponse.md)
- [ListObjectSightingsResponse](docs/ListObjectSightingsResponse.md)
- [ListObjectVariantsResponse](docs/ListObjectVariantsResponse.md)
- [ListOpinionsResponse](docs/ListOpinionsResponse.md)
- [ListTagsResponse](docs/ListTagsResponse.md)
- [ListYaraRulesResponse](docs/ListYaraRulesResponse.md)
- [MalEval](docs/MalEval.md)
- [MitreAttackTTP](docs/MitreAttackTTP.md)
- [NetworkIndicators](docs/NetworkIndicators.md)
- [ObjectDetonation](docs/ObjectDetonation.md)
- [ObjectMetadata](docs/ObjectMetadata.md)
- [ObjectSighting](docs/ObjectSighting.md)
- [ObjectSignature](docs/ObjectSignature.md)
- [ObjectVariant](docs/ObjectVariant.md)
- [Opinion](docs/Opinion.md)
- [RegistryKeyAction](docs/RegistryKeyAction.md)
- [Tag](docs/Tag.md)
- [TriggerObjectDetonationRequest](docs/TriggerObjectDetonationRequest.md)
- [X509Certificate](docs/X509Certificate.md)
- [YaraRule](docs/YaraRule.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="AuthToken"></a>
### AuthToken
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
Raw data
{
"_id": null,
"home_page": "https://stairwell.com/",
"name": "stairwell",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Stairwell V1 HTTP APIs",
"author": "Andrew Liu",
"author_email": "liu@stairwell.com",
"download_url": "https://files.pythonhosted.org/packages/77/f2/a2efe9ab2e15f1a3b10aa8303d0a05e0b96d0495f84f8eeecb900026bcae/stairwell-0.0.4.tar.gz",
"platform": null,
"description": "# stairwell-api\nRestful APIs for the Stairwell platform. Most APIs expose named resources: each resource has a unique identifier that users use to reference that resource, and these names are what users should store as the canonical names for the resources. The base URL for this API is https://app.stairwell.com\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/stairwell-inc/stairwell-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/stairwell-inc/stairwell-python.git`)\n\nThen import the package:\n```python\nimport stairwell_openapi_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport stairwell_openapi_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport stairwell_openapi_client\nfrom stairwell_openapi_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://app.stairwell.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = stairwell_openapi_client.Configuration(\n host = \"https://app.stairwell.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: AuthToken\nconfiguration.api_key['AuthToken'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['AuthToken'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nasync with stairwell_openapi_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = stairwell_openapi_client.AssetsApi(api_client)\n asset = 'asset_example' # str | The asset id.\n tag = stairwell_openapi_client.Tag() # Tag | \n\n try:\n # CreateTag\n api_response = await api_instance.assets_create_tag(asset, tag)\n print(\"The response of AssetsApi->assets_create_tag:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AssetsApi->assets_create_tag: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://app.stairwell.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AssetsApi* | [**assets_create_tag**](docs/AssetsApi.md#assets_create_tag) | **POST** /v1/assets/{asset}/tags | CreateTag\n*AssetsApi* | [**assets_delete_tag**](docs/AssetsApi.md#assets_delete_tag) | **DELETE** /v1/assets/{asset}/tags/{tag} | DeleteTag\n*AssetsApi* | [**assets_get_asset**](docs/AssetsApi.md#assets_get_asset) | **GET** /v1/assets/{asset} | GetAsset\n*AssetsApi* | [**assets_get_tag**](docs/AssetsApi.md#assets_get_tag) | **GET** /v1/assets/{asset}/tags/{tag} | GetTag\n*AssetsApi* | [**assets_list_assets**](docs/AssetsApi.md#assets_list_assets) | **GET** /v1/environments/{environment}/assets | ListAssets\n*AssetsApi* | [**assets_list_tags**](docs/AssetsApi.md#assets_list_tags) | **GET** /v1/assets/{asset}/tags | ListTags\n*HostnamesApi* | [**hostnames_create_comment**](docs/HostnamesApi.md#hostnames_create_comment) | **POST** /v1/hostnames/{hostname}/comments | CreateComment\n*HostnamesApi* | [**hostnames_create_opinion**](docs/HostnamesApi.md#hostnames_create_opinion) | **POST** /v1/hostnames/{hostname}/opinions | CreateOpinion\n*HostnamesApi* | [**hostnames_create_tag**](docs/HostnamesApi.md#hostnames_create_tag) | **POST** /v1/hostnames/{hostname}/tags | CreateTag\n*HostnamesApi* | [**hostnames_delete_tag**](docs/HostnamesApi.md#hostnames_delete_tag) | **DELETE** /v1/hostnames/{hostname}/tags/{tag} | DeleteTag\n*HostnamesApi* | [**hostnames_get_hostname_metadata**](docs/HostnamesApi.md#hostnames_get_hostname_metadata) | **GET** /v1/hostnames/{hostname}/metadata | GetHostnameMetadata\n*HostnamesApi* | [**hostnames_get_tag**](docs/HostnamesApi.md#hostnames_get_tag) | **GET** /v1/hostnames/{hostname}/tags/{tag} | GetTag\n*HostnamesApi* | [**hostnames_list_comments**](docs/HostnamesApi.md#hostnames_list_comments) | **GET** /v1/hostnames/{hostname}/comments | ListComments\n*HostnamesApi* | [**hostnames_list_opinions**](docs/HostnamesApi.md#hostnames_list_opinions) | **GET** /v1/hostnames/{hostname}/opinions | ListOpinions\n*HostnamesApi* | [**hostnames_list_tags**](docs/HostnamesApi.md#hostnames_list_tags) | **GET** /v1/hostnames/{hostname}/tags | ListTags\n*IpAddressesApi* | [**ip_addresses_create_comment**](docs/IpAddressesApi.md#ip_addresses_create_comment) | **POST** /v1/ipAddresses/{ipAddress}/comments | CreateComment\n*IpAddressesApi* | [**ip_addresses_create_opinion**](docs/IpAddressesApi.md#ip_addresses_create_opinion) | **POST** /v1/ipAddresses/{ipAddress}/opinions | CreateOpinion\n*IpAddressesApi* | [**ip_addresses_create_tag**](docs/IpAddressesApi.md#ip_addresses_create_tag) | **POST** /v1/ipAddresses/{ipAddress}/tags | CreateTag\n*IpAddressesApi* | [**ip_addresses_delete_tag**](docs/IpAddressesApi.md#ip_addresses_delete_tag) | **DELETE** /v1/ipAddresses/{ipAddress}/tags/{tag} | DeleteTag\n*IpAddressesApi* | [**ip_addresses_get_ip_address_metadata**](docs/IpAddressesApi.md#ip_addresses_get_ip_address_metadata) | **GET** /v1/ipAddresses/{ipAddress}/metadata | GetIpAddressMetadata\n*IpAddressesApi* | [**ip_addresses_get_tag**](docs/IpAddressesApi.md#ip_addresses_get_tag) | **GET** /v1/ipAddresses/{ipAddress}/tags/{tag} | GetTag\n*IpAddressesApi* | [**ip_addresses_list_comments**](docs/IpAddressesApi.md#ip_addresses_list_comments) | **GET** /v1/ipAddresses/{ipAddress}/comments | ListComments\n*IpAddressesApi* | [**ip_addresses_list_opinions**](docs/IpAddressesApi.md#ip_addresses_list_opinions) | **GET** /v1/ipAddresses/{ipAddress}/opinions | ListOpinions\n*IpAddressesApi* | [**ip_addresses_list_tags**](docs/IpAddressesApi.md#ip_addresses_list_tags) | **GET** /v1/ipAddresses/{ipAddress}/tags | ListTags\n*ObjectsApi* | [**objects_create_comment**](docs/ObjectsApi.md#objects_create_comment) | **POST** /v1/objects/{object}/comments | CreateComment\n*ObjectsApi* | [**objects_create_opinion**](docs/ObjectsApi.md#objects_create_opinion) | **POST** /v1/objects/{object}/opinions | CreateOpinion\n*ObjectsApi* | [**objects_create_tag**](docs/ObjectsApi.md#objects_create_tag) | **POST** /v1/objects/{object}/tags | CreateTag\n*ObjectsApi* | [**objects_delete_tag**](docs/ObjectsApi.md#objects_delete_tag) | **DELETE** /v1/objects/{object}/tags/{tag} | DeleteTag\n*ObjectsApi* | [**objects_download_object**](docs/ObjectsApi.md#objects_download_object) | **GET** /v1/objects/{object}:download | DownloadObject\n*ObjectsApi* | [**objects_get_object_detonation**](docs/ObjectsApi.md#objects_get_object_detonation) | **GET** /v1/objects/{object}/detonation | GetObjectDetonation\n*ObjectsApi* | [**objects_get_object_metadata**](docs/ObjectsApi.md#objects_get_object_metadata) | **GET** /v1/objects/{object}/metadata | GetObjectMetadata\n*ObjectsApi* | [**objects_get_tag**](docs/ObjectsApi.md#objects_get_tag) | **GET** /v1/objects/{object}/tags/{tag} | GetTag\n*ObjectsApi* | [**objects_list_comments**](docs/ObjectsApi.md#objects_list_comments) | **GET** /v1/objects/{object}/comments | ListComments\n*ObjectsApi* | [**objects_list_object_metadata**](docs/ObjectsApi.md#objects_list_object_metadata) | **GET** /v1/objects/metadata | ListObjectMetadata\n*ObjectsApi* | [**objects_list_object_sightings**](docs/ObjectsApi.md#objects_list_object_sightings) | **GET** /v1/objects/{object}/sightings | ListObjectSightings\n*ObjectsApi* | [**objects_list_object_variants**](docs/ObjectsApi.md#objects_list_object_variants) | **GET** /v1/objects/{object}/variants | ListObjectVariants\n*ObjectsApi* | [**objects_list_opinions**](docs/ObjectsApi.md#objects_list_opinions) | **GET** /v1/objects/{object}/opinions | ListOpinions\n*ObjectsApi* | [**objects_list_tags**](docs/ObjectsApi.md#objects_list_tags) | **GET** /v1/objects/{object}/tags | ListTags\n*ObjectsApi* | [**objects_trigger_object_detonation**](docs/ObjectsApi.md#objects_trigger_object_detonation) | **POST** /v1/objects/{object}/detonation:trigger | TriggerObjectDetonation\n*YaraRulesApi* | [**yara_rules_create_tag**](docs/YaraRulesApi.md#yara_rules_create_tag) | **POST** /v1/environments/{environment}/yaraRules/{yaraRule}/tags | CreateTag\n*YaraRulesApi* | [**yara_rules_create_yara_rule**](docs/YaraRulesApi.md#yara_rules_create_yara_rule) | **POST** /v1/environments/{environment}/yaraRules | CreateYaraRule\n*YaraRulesApi* | [**yara_rules_delete_tag**](docs/YaraRulesApi.md#yara_rules_delete_tag) | **DELETE** /v1/environments/{environment}/yaraRules/{yaraRule}/tags/{tag} | DeleteTag\n*YaraRulesApi* | [**yara_rules_delete_yara_rule**](docs/YaraRulesApi.md#yara_rules_delete_yara_rule) | **DELETE** /v1/environments/{environment}/yaraRules/{yaraRule} | DeleteYaraRule\n*YaraRulesApi* | [**yara_rules_get_tag**](docs/YaraRulesApi.md#yara_rules_get_tag) | **GET** /v1/environments/{environment}/yaraRules/{yaraRule}/tags/{tag} | GetTag\n*YaraRulesApi* | [**yara_rules_get_yara_rule**](docs/YaraRulesApi.md#yara_rules_get_yara_rule) | **GET** /v1/environments/{environment}/yaraRules/{yaraRule} | GetYaraRule\n*YaraRulesApi* | [**yara_rules_list_tags**](docs/YaraRulesApi.md#yara_rules_list_tags) | **GET** /v1/environments/{environment}/yaraRules/{yaraRule}/tags | ListTags\n*YaraRulesApi* | [**yara_rules_list_yara_rules**](docs/YaraRulesApi.md#yara_rules_list_yara_rules) | **GET** /v1/environments/{environment}/yaraRules | ListYaraRules\n*YaraRulesApi* | [**yara_rules_update_yara_rule**](docs/YaraRulesApi.md#yara_rules_update_yara_rule) | **PATCH** /v1/environments/{environment}/yaraRules/{yaraRule} | UpdateYaraRule\n\n\n## Documentation For Models\n\n - [Asset](docs/Asset.md)\n - [Comment](docs/Comment.md)\n - [DNSLookupResult](docs/DNSLookupResult.md)\n - [Detection](docs/Detection.md)\n - [FileAction](docs/FileAction.md)\n - [HostnameMetadata](docs/HostnameMetadata.md)\n - [IpAddressMetadata](docs/IpAddressMetadata.md)\n - [ListAssetsResponse](docs/ListAssetsResponse.md)\n - [ListCommentsResponse](docs/ListCommentsResponse.md)\n - [ListObjectMetadataResponse](docs/ListObjectMetadataResponse.md)\n - [ListObjectSightingsResponse](docs/ListObjectSightingsResponse.md)\n - [ListObjectVariantsResponse](docs/ListObjectVariantsResponse.md)\n - [ListOpinionsResponse](docs/ListOpinionsResponse.md)\n - [ListTagsResponse](docs/ListTagsResponse.md)\n - [ListYaraRulesResponse](docs/ListYaraRulesResponse.md)\n - [MalEval](docs/MalEval.md)\n - [MitreAttackTTP](docs/MitreAttackTTP.md)\n - [NetworkIndicators](docs/NetworkIndicators.md)\n - [ObjectDetonation](docs/ObjectDetonation.md)\n - [ObjectMetadata](docs/ObjectMetadata.md)\n - [ObjectSighting](docs/ObjectSighting.md)\n - [ObjectSignature](docs/ObjectSignature.md)\n - [ObjectVariant](docs/ObjectVariant.md)\n - [Opinion](docs/Opinion.md)\n - [RegistryKeyAction](docs/RegistryKeyAction.md)\n - [Tag](docs/Tag.md)\n - [TriggerObjectDetonationRequest](docs/TriggerObjectDetonationRequest.md)\n - [X509Certificate](docs/X509Certificate.md)\n - [YaraRule](docs/YaraRule.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"AuthToken\"></a>\n### AuthToken\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A Python client for the Stairwell platform.",
"version": "0.0.4",
"project_urls": {
"Documentation": "https://docs.stairwell.com/",
"Homepage": "https://stairwell.com/",
"Repository": "https://github.com/stairwell-inc/stairwell-python"
},
"split_keywords": [
"openapi",
"openapi-generator",
"stairwell v1 http apis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e5870ac9449b00e20dac4b4a4449d578dc7479bd348c62b4f3143d491ca2379",
"md5": "e726769abbe5e2fc4740721d76c9faef",
"sha256": "eb821c1e05fae3690976be08044192d33dfc6d63c59f29e1dcdb3224da7f73a2"
},
"downloads": -1,
"filename": "stairwell-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e726769abbe5e2fc4740721d76c9faef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8056,
"upload_time": "2024-01-09T19:40:10",
"upload_time_iso_8601": "2024-01-09T19:40:10.425751Z",
"url": "https://files.pythonhosted.org/packages/7e/58/70ac9449b00e20dac4b4a4449d578dc7479bd348c62b4f3143d491ca2379/stairwell-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "77f2a2efe9ab2e15f1a3b10aa8303d0a05e0b96d0495f84f8eeecb900026bcae",
"md5": "7f11e88e04338a739ef5f458a3a65cd1",
"sha256": "3cd3ef1738cd678051e041dc81f4dee9a4a7257c6885afdbe6234b95cb1cc553"
},
"downloads": -1,
"filename": "stairwell-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "7f11e88e04338a739ef5f458a3a65cd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7682,
"upload_time": "2024-01-09T19:40:12",
"upload_time_iso_8601": "2024-01-09T19:40:12.952413Z",
"url": "https://files.pythonhosted.org/packages/77/f2/a2efe9ab2e15f1a3b10aa8303d0a05e0b96d0495f84f8eeecb900026bcae/stairwell-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-09 19:40:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stairwell-inc",
"github_project": "stairwell-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "stairwell"
}
JSON
