Skip to content

Latest commit

 

History

History
1293 lines (914 loc) · 50.5 KB

File metadata and controls

1293 lines (914 loc) · 50.5 KB

watchtowr_api_sdk.ContainersApi

All URIs are relative to https://your-tenant-id.sg.client.watchtowr.io

Method HTTP request Description
assign_container_to_business_units POST /api/client/assets/container/show/{id}/business-units Assign Container to Business Units
create_custom_property_container POST /api/client/assets/container/show/{id}/custom-property Create Custom Property
create_note_container POST /api/client/assets/container/show/{id}/note Create Note
delete_custom_property_container DELETE /api/client/assets/container/show/{id}/custom-property/{customPropertyId} Delete Custom Property
delete_note_container DELETE /api/client/assets/container/show/{id}/note/{noteId} Delete Note
get_asset_container_changelog GET /api/client/assets/container/show/{id}/changelog Get Container Changelog
get_asset_container_details GET /api/client/assets/container/show/{id} Get Container
get_asset_container_notes GET /api/client/assets/container/show/{id}/notes List Notes
get_custom_properties_container GET /api/client/assets/container/show/{id}/custom-properties List Custom Properties
get_list_asset_container GET /api/client/assets/container/list List Containers
set_criticality_container PUT /api/client/assets/container/show/{id}/criticality Set Criticality
unassign_container_from_business_units DELETE /api/client/assets/container/show/{id}/business-units Unassign Container from Business Units
update_asset_container_status PUT /api/client/assets/container/update-status/{id} Update Status
update_custom_property_container PUT /api/client/assets/container/show/{id}/custom-property/{customPropertyId} Update Custom Property
update_note_container PUT /api/client/assets/container/show/{id}/note/{noteId} Update Note

assign_container_to_business_units

ClientContainerData assign_container_to_business_units(id, asset_business_unit_ids_dto)

Assign Container to Business Units

Assign a specific Container asset to a list of Business Units

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.asset_business_unit_ids_dto import AssetBusinessUnitIdsDTO
from watchtowr_api_sdk.models.client_container_data import ClientContainerData
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The Container asset's ID.
    asset_business_unit_ids_dto = watchtowr_api_sdk.AssetBusinessUnitIdsDTO() # AssetBusinessUnitIdsDTO | 

    try:
        # Assign Container to Business Units
        api_response = api_instance.assign_container_to_business_units(id, asset_business_unit_ids_dto)
        print("The response of ContainersApi->assign_container_to_business_units:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->assign_container_to_business_units: %s\n" % e)

Parameters

Name Type Description Notes
id float The Container asset's ID.
asset_business_unit_ids_dto AssetBusinessUnitIdsDTO

Return type

ClientContainerData

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Not Found -
409 Conflict -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_custom_property_container

ClientCustomProperty create_custom_property_container(id, create_client_custom_property_dto)

Create Custom Property

Create a Custom Property for a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_custom_property import ClientCustomProperty
from watchtowr_api_sdk.models.create_client_custom_property_dto import CreateClientCustomPropertyDto
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of a Container asset to create a new custom property for.
    create_client_custom_property_dto = watchtowr_api_sdk.CreateClientCustomPropertyDto() # CreateClientCustomPropertyDto | 

    try:
        # Create Custom Property
        api_response = api_instance.create_custom_property_container(id, create_client_custom_property_dto)
        print("The response of ContainersApi->create_custom_property_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->create_custom_property_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of a Container asset to create a new custom property for.
create_client_custom_property_dto CreateClientCustomPropertyDto

Return type

ClientCustomProperty

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_note_container

ClientNoteData create_note_container(id, create_client_note_dto)

Create Note

Create a Note for a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_note_data import ClientNoteData
from watchtowr_api_sdk.models.create_client_note_dto import CreateClientNoteDto
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of the Container asset to create a new note for.
    create_client_note_dto = watchtowr_api_sdk.CreateClientNoteDto() # CreateClientNoteDto | 

    try:
        # Create Note
        api_response = api_instance.create_note_container(id, create_client_note_dto)
        print("The response of ContainersApi->create_note_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->create_note_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of the Container asset to create a new note for.
create_client_note_dto CreateClientNoteDto

Return type

ClientNoteData

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_custom_property_container

RemoveClientCustomPropertyResponseDto delete_custom_property_container(id, custom_property_id)

Delete Custom Property

Delete a Custom Property for a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.remove_client_custom_property_response_dto import RemoveClientCustomPropertyResponseDto
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of a Container asset with a custom property to delete.
    custom_property_id = 3.4 # float | The ID of the custom property to delete.

    try:
        # Delete Custom Property
        api_response = api_instance.delete_custom_property_container(id, custom_property_id)
        print("The response of ContainersApi->delete_custom_property_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->delete_custom_property_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of a Container asset with a custom property to delete.
custom_property_id float The ID of the custom property to delete.

Return type

RemoveClientCustomPropertyResponseDto

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_note_container

DeleteNoteSucces delete_note_container(id, note_id)

Delete Note

Delete a Note for a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.delete_note_succes import DeleteNoteSucces
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of a Container asset with a note to delete.
    note_id = 3.4 # float | The ID of the note to delete.

    try:
        # Delete Note
        api_response = api_instance.delete_note_container(id, note_id)
        print("The response of ContainersApi->delete_note_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->delete_note_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of a Container asset with a note to delete.
note_id float The ID of the note to delete.

Return type

DeleteNoteSucces

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_asset_container_changelog

GetAssetContainerChangelog200Response get_asset_container_changelog(id, page=page, page_size=page_size)

Get Container Changelog

Get paginated changelog for a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.get_asset_container_changelog200_response import GetAssetContainerChangelog200Response
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of the Container to retrieve changelog for.
    page = 1 # float | The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. (optional)
    page_size = 10 # float | The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 30. (optional)

    try:
        # Get Container Changelog
        api_response = api_instance.get_asset_container_changelog(id, page=page, page_size=page_size)
        print("The response of ContainersApi->get_asset_container_changelog:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->get_asset_container_changelog: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of the Container to retrieve changelog for.
page float The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. [optional]
page_size float The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 30. [optional]

Return type

GetAssetContainerChangelog200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_asset_container_details

ClientContainerData get_asset_container_details(id)

Get Container

Get the details of a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_container_data import ClientContainerData
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of the Container asset to get.

    try:
        # Get Container
        api_response = api_instance.get_asset_container_details(id)
        print("The response of ContainersApi->get_asset_container_details:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->get_asset_container_details: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of the Container asset to get.

Return type

ClientContainerData

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_asset_container_notes

ClientNoteListData get_asset_container_notes(id, page=page, page_size=page_size)

List Notes

List the Notes of a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_note_list_data import ClientNoteListData
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of the Container asset to list notes for.
    page = 1 # float | The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. (optional)
    page_size = 10 # float | The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 30. (optional)

    try:
        # List Notes
        api_response = api_instance.get_asset_container_notes(id, page=page, page_size=page_size)
        print("The response of ContainersApi->get_asset_container_notes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->get_asset_container_notes: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of the Container asset to list notes for.
page float The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. [optional]
page_size float The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 30. [optional]

Return type

ClientNoteListData

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_custom_properties_container

PaginatedClientCustomProperty get_custom_properties_container(id, page=page, page_size=page_size)

List Custom Properties

List the Custom Properties of a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.paginated_client_custom_property import PaginatedClientCustomProperty
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of the Container asset to list custom properties of.
    page = 1 # float | The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. (optional)
    page_size = 10 # float | The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 30. (optional)

    try:
        # List Custom Properties
        api_response = api_instance.get_custom_properties_container(id, page=page, page_size=page_size)
        print("The response of ContainersApi->get_custom_properties_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->get_custom_properties_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of the Container asset to list custom properties of.
page float The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. [optional]
page_size float The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 30. [optional]

Return type

PaginatedClientCustomProperty

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_list_asset_container

PaginatedClientContainer get_list_asset_container(page=page, page_size=page_size, asset_name=asset_name, statuses=statuses, source=source, integration_connections=integration_connections, business_unit_ids=business_unit_ids, created_from=created_from, created_to=created_to, custom_property_key=custom_property_key, custom_property_value=custom_property_value)

List Containers

List all discovered Containers, ordered by date identified.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.paginated_client_container import PaginatedClientContainer
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    page = 1 # float | The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. (optional)
    page_size = 10 # float | The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 100. (optional)
    asset_name = 'docker/container/name' # str | Search Container assets by name. (optional)
    statuses = ['statuses_example'] # List[str] | Filter assets by one or more comma separated asset statuses. Valid statuses are:       * verified       * tracked       * incorrect identification       * pending       * verifiedOutOfScope  (optional)
    source = 'module-adversarysight-ecr-containers-discovery' # str | Filter assets by the source that discovered the asset. (optional)
    integration_connections = '123:aws,456:azure,789:googlecloud' # str | Filter assets by integration connections (comma-separated list of integrationId:integrationType pairs).  Valid integration types: aws, googlecloud, azure, cloudflare, alibabacloud, prismacloud, prismacloudapigee, huaweicloud, tencentcloud, wiz, servicenowcmdb, akamaiedge, fastly, markmonitor, armiscentrix, qualysvmdr, tenablevm, orcasecurity, crowdstrikefalconspotlight, taniumvm, rapid7insightvm, fastlywaf, cloudflarewaf, awswaf  Format: integrationId:integrationType (e.g., 123:aws) Multiple connections: separate with commas (e.g., 123:aws,456:azure,789:googlecloud) (optional)
    business_unit_ids = '1,2,3' # str | Filter assets by a list of comma separated business unit IDs that the asset is related to. (optional)
    created_from = '2013-10-20T19:20:30+01:00' # datetime | Filter assets created after a given date and time. (optional)
    created_to = '2013-10-20T19:20:30+01:00' # datetime | Filter assets created before a given date and time. (optional)
    custom_property_key = 'environment' # str | Filter assets by custom property key. (optional)
    custom_property_value = 'production' # str | Filter assets by custom property value. Must be used together with customPropertyKey. (optional)

    try:
        # List Containers
        api_response = api_instance.get_list_asset_container(page=page, page_size=page_size, asset_name=asset_name, statuses=statuses, source=source, integration_connections=integration_connections, business_unit_ids=business_unit_ids, created_from=created_from, created_to=created_to, custom_property_key=custom_property_key, custom_property_value=custom_property_value)
        print("The response of ContainersApi->get_list_asset_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->get_list_asset_container: %s\n" % e)

Parameters

Name Type Description Notes
page float The page number for paginated results. If the page field is not provided in the request, it defaults to 1, which corresponds to the first page of results. [optional]
page_size float The number of items to be included on each page of paginated results. If the pageSize field is not specified, it defaults to 10. The maximum for pageSize is 100. [optional]
asset_name str Search Container assets by name. [optional]
statuses List[str] Filter assets by one or more comma separated asset statuses. Valid statuses are: * verified * tracked * incorrect identification * pending * verifiedOutOfScope [optional]
source str Filter assets by the source that discovered the asset. [optional]
integration_connections str Filter assets by integration connections (comma-separated list of integrationId:integrationType pairs). Valid integration types: aws, googlecloud, azure, cloudflare, alibabacloud, prismacloud, prismacloudapigee, huaweicloud, tencentcloud, wiz, servicenowcmdb, akamaiedge, fastly, markmonitor, armiscentrix, qualysvmdr, tenablevm, orcasecurity, crowdstrikefalconspotlight, taniumvm, rapid7insightvm, fastlywaf, cloudflarewaf, awswaf Format: integrationId:integrationType (e.g., 123:aws) Multiple connections: separate with commas (e.g., 123:aws,456:azure,789:googlecloud) [optional]
business_unit_ids str Filter assets by a list of comma separated business unit IDs that the asset is related to. [optional]
created_from datetime Filter assets created after a given date and time. [optional]
created_to datetime Filter assets created before a given date and time. [optional]
custom_property_key str Filter assets by custom property key. [optional]
custom_property_value str Filter assets by custom property value. Must be used together with customPropertyKey. [optional]

Return type

PaginatedClientContainer

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_criticality_container

SetCriticalityDataResponseDto set_criticality_container(id, set_criticality_dto)

Set Criticality

Set or update the criticality level of a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.set_criticality_data_response_dto import SetCriticalityDataResponseDto
from watchtowr_api_sdk.models.set_criticality_dto import SetCriticalityDto
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of the Container to set criticality for.
    set_criticality_dto = watchtowr_api_sdk.SetCriticalityDto() # SetCriticalityDto | 

    try:
        # Set Criticality
        api_response = api_instance.set_criticality_container(id, set_criticality_dto)
        print("The response of ContainersApi->set_criticality_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->set_criticality_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of the Container to set criticality for.
set_criticality_dto SetCriticalityDto

Return type

SetCriticalityDataResponseDto

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unassign_container_from_business_units

ClientContainerData unassign_container_from_business_units(id, business_unit_ids)

Unassign Container from Business Units

Unassign a specific Container asset from a list of Business Units

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_container_data import ClientContainerData
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The Container asset's ID.
    business_unit_ids = ['business_unit_ids_example'] # List[str] | List of comma-seperated business unit IDs to unassign from the asset.

    try:
        # Unassign Container from Business Units
        api_response = api_instance.unassign_container_from_business_units(id, business_unit_ids)
        print("The response of ContainersApi->unassign_container_from_business_units:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->unassign_container_from_business_units: %s\n" % e)

Parameters

Name Type Description Notes
id float The Container asset's ID.
business_unit_ids List[str] List of comma-seperated business unit IDs to unassign from the asset.

Return type

ClientContainerData

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Not Found -
409 Conflict -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_asset_container_status

ClientContainerData update_asset_container_status(id, update_client_next_gen_asset_status_dto)

Update Status

Update Status of a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_container_data import ClientContainerData
from watchtowr_api_sdk.models.update_client_next_gen_asset_status_dto import UpdateClientNextGenAssetStatusDto
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of the Container asset to update the status of.
    update_client_next_gen_asset_status_dto = watchtowr_api_sdk.UpdateClientNextGenAssetStatusDto() # UpdateClientNextGenAssetStatusDto | 

    try:
        # Update Status
        api_response = api_instance.update_asset_container_status(id, update_client_next_gen_asset_status_dto)
        print("The response of ContainersApi->update_asset_container_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->update_asset_container_status: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of the Container asset to update the status of.
update_client_next_gen_asset_status_dto UpdateClientNextGenAssetStatusDto

Return type

ClientContainerData

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_custom_property_container

ClientCustomProperty update_custom_property_container(id, custom_property_id, update_client_custom_property_dto)

Update Custom Property

Update a Custom Property for a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_custom_property import ClientCustomProperty
from watchtowr_api_sdk.models.update_client_custom_property_dto import UpdateClientCustomPropertyDto
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of a Container asset with a custom property to update.
    custom_property_id = 3.4 # float | The ID of the custom property to update.
    update_client_custom_property_dto = watchtowr_api_sdk.UpdateClientCustomPropertyDto() # UpdateClientCustomPropertyDto | 

    try:
        # Update Custom Property
        api_response = api_instance.update_custom_property_container(id, custom_property_id, update_client_custom_property_dto)
        print("The response of ContainersApi->update_custom_property_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->update_custom_property_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of a Container asset with a custom property to update.
custom_property_id float The ID of the custom property to update.
update_client_custom_property_dto UpdateClientCustomPropertyDto

Return type

ClientCustomProperty

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_note_container

ClientNoteData update_note_container(id, note_id, create_client_note_dto)

Update Note

Update a Note for a specific Container asset.

Example

  • Bearer (API_TOKEN) Authentication (bearer):
import watchtowr_api_sdk
from watchtowr_api_sdk.models.client_note_data import ClientNoteData
from watchtowr_api_sdk.models.create_client_note_dto import CreateClientNoteDto
from watchtowr_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://your-tenant-id.sg.client.watchtowr.io
# See configuration.py for a list of all supported configuration parameters.
configuration = watchtowr_api_sdk.Configuration(
    host = "https://your-tenant-id.sg.client.watchtowr.io"
)

# 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 Bearer authorization (API_TOKEN): bearer
configuration = watchtowr_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with watchtowr_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = watchtowr_api_sdk.ContainersApi(api_client)
    id = 3.4 # float | The asset ID of a Container asset with a note to update.
    note_id = 3.4 # float | The ID of the note to update.
    create_client_note_dto = watchtowr_api_sdk.CreateClientNoteDto() # CreateClientNoteDto | 

    try:
        # Update Note
        api_response = api_instance.update_note_container(id, note_id, create_client_note_dto)
        print("The response of ContainersApi->update_note_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContainersApi->update_note_container: %s\n" % e)

Parameters

Name Type Description Notes
id float The asset ID of a Container asset with a note to update.
note_id float The ID of the note to update.
create_client_note_dto CreateClientNoteDto

Return type

ClientNoteData

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]