All URIs are relative to http://localhost:8080/api/v2
Method | HTTP request | Description |
---|---|---|
finding_templates_create | POST /finding_templates/ | |
finding_templates_list | GET /finding_templates/ | |
finding_templates_partial_update | PATCH /finding_templates/{id}/ | |
finding_templates_read | GET /finding_templates/{id}/ | |
finding_templates_update | PUT /finding_templates/{id}/ |
FindingTemplate finding_templates_create(data)
- Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.FindingTemplatesApi(openapi_client.ApiClient(configuration))
data = openapi_client.FindingTemplate() # FindingTemplate |
try:
api_response = api_instance.finding_templates_create(data)
pprint(api_response)
except ApiException as e:
print("Exception when calling FindingTemplatesApi->finding_templates_create: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
data | FindingTemplate |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2003 finding_templates_list(id=id, title=title, cwe=cwe, severity=severity, description=description, mitigation=mitigation, limit=limit, offset=offset)
- Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.FindingTemplatesApi(openapi_client.ApiClient(configuration))
id = 3.4 # float | (optional)
title = 'title_example' # str | (optional)
cwe = 3.4 # float | (optional)
severity = 'severity_example' # str | (optional)
description = 'description_example' # str | (optional)
mitigation = 'mitigation_example' # str | (optional)
limit = 56 # int | Number of results to return per page. (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
try:
api_response = api_instance.finding_templates_list(id=id, title=title, cwe=cwe, severity=severity, description=description, mitigation=mitigation, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling FindingTemplatesApi->finding_templates_list: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | float | [optional] | |
title | str | [optional] | |
cwe | float | [optional] | |
severity | str | [optional] | |
description | str | [optional] | |
mitigation | str | [optional] | |
limit | int | Number of results to return per page. | [optional] |
offset | int | The initial index from which to return the results. | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FindingTemplate finding_templates_partial_update(id, data)
- Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.FindingTemplatesApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this finding_ template.
data = openapi_client.FindingTemplate() # FindingTemplate |
try:
api_response = api_instance.finding_templates_partial_update(id, data)
pprint(api_response)
except ApiException as e:
print("Exception when calling FindingTemplatesApi->finding_templates_partial_update: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this finding_ template. | |
data | FindingTemplate |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FindingTemplate finding_templates_read(id)
- Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.FindingTemplatesApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this finding_ template.
try:
api_response = api_instance.finding_templates_read(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling FindingTemplatesApi->finding_templates_read: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this finding_ template. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FindingTemplate finding_templates_update(id, data)
- Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.FindingTemplatesApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this finding_ template.
data = openapi_client.FindingTemplate() # FindingTemplate |
try:
api_response = api_instance.finding_templates_update(id, data)
pprint(api_response)
except ApiException as e:
print("Exception when calling FindingTemplatesApi->finding_templates_update: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this finding_ template. | |
data | FindingTemplate |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]