rapid7vmconsole.TagApi

All URIs are relative to https://localhost:3780

Method	HTTP request	Description
create_tag	POST /api/3/tags	Tags
delete_tag	DELETE /api/3/tags/{id}	Tag
get_tag	GET /api/3/tags/{id}	Tag
get_tag_asset_groups	GET /api/3/tags/{id}/asset_groups	Tag Asset Groups
get_tag_search_criteria	GET /api/3/tags/{id}/search_criteria	Tag Search Criteria
get_tagged_assets	GET /api/3/tags/{id}/assets	Tag Assets
get_tagged_sites	GET /api/3/tags/{id}/sites	Tag Sites
get_tags	GET /api/3/tags	Tags
remove_tag_search_criteria	DELETE /api/3/tags/{id}/search_criteria	Tag Search Criteria
remove_tagged_sites	DELETE /api/3/tags/{id}/sites	Tag Sites
set_tagged_asset_groups	PUT /api/3/tags/{id}/asset_groups	Tag Asset Groups
set_tagged_sites	PUT /api/3/tags/{id}/sites	Tag Sites
tag_asset	PUT /api/3/tags/{id}/assets/{assetId}	Tag Asset
tag_asset_group	PUT /api/3/tags/{id}/asset_groups/{assetGroupId}	Tag Asset Group
tag_site	PUT /api/3/tags/{id}/sites/{siteId}	Tag Site
untag_all_asset_groups	DELETE /api/3/tags/{id}/asset_groups	Tag Asset Groups
untag_asset	DELETE /api/3/tags/{id}/assets/{assetId}	Tag Asset
untag_asset_group	DELETE /api/3/tags/{id}/asset_groups/{assetGroupId}	Tag Asset Group
untag_site	DELETE /api/3/tags/{id}/sites/{siteId}	Tag Site
update_tag	PUT /api/3/tags/{id}	Tag
update_tag_search_criteria	PUT /api/3/tags/{id}/search_criteria	Tag Search Criteria

create_tag

ReferenceWithTagIDLink create_tag(tag=tag)

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
tag = rapid7vmconsole.Tag() # Tag | The details of the tag. (optional)

try:
    # Tags
    api_response = api_instance.create_tag(tag=tag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->create_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag	Tag	The details of the tag.	[optional]

Return type

ReferenceWithTagIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

delete_tag

Links delete_tag(id)

Tag

Deletes the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag
    api_response = api_instance.delete_tag(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->delete_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

get_tag

Tag get_tag(id)

Tag

Returns a tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag
    api_response = api_instance.get_tag(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->get_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

Tag

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

get_tag_asset_groups

ReferencesWithAssetGroupIDLink get_tag_asset_groups(id)

Tag Asset Groups

Returns the asset groups associated with the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag Asset Groups
    api_response = api_instance.get_tag_asset_groups(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->get_tag_asset_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

ReferencesWithAssetGroupIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

get_tag_search_criteria

SearchCriteria get_tag_search_criteria(id)

Tag Search Criteria

Returns the search criteria associated with the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag Search Criteria
    api_response = api_instance.get_tag_search_criteria(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->get_tag_search_criteria: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

SearchCriteria

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

get_tagged_assets

TaggedAssetReferences get_tagged_assets(id)

Tag Assets

Returns the assets tagged with a tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag Assets
    api_response = api_instance.get_tagged_assets(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->get_tagged_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

TaggedAssetReferences

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

get_tagged_sites

ReferencesWithSiteIDLink get_tagged_sites(id)

Tag Sites

Returns the sites associated with the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag Sites
    api_response = api_instance.get_tagged_sites(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->get_tagged_sites: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

ReferencesWithSiteIDLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

get_tags

PageOfTag get_tags(name=name, type=type, page=page, size=size, sort=sort)

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
name = 'name_example' # str | name (optional)
type = 'type_example' # str | type (optional)
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
sort = ['sort_example'] # list[str] | The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. (optional)

try:
    # Tags
    api_response = api_instance.get_tags(name=name, type=type, page=page, size=size, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->get_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name	[optional]
type	str	type	[optional]
page	int	The index of the page (zero-based) to retrieve.	[optional] [default to 0]
size	int	The number of records per page to retrieve.	[optional] [default to 10]
sort	list[str]	The criteria to sort the records by, in the format: `property[,ASC	DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

Return type

PageOfTag

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

remove_tag_search_criteria

Links remove_tag_search_criteria(id)

Tag Search Criteria

Removes the search criteria associated with the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag Search Criteria
    api_response = api_instance.remove_tag_search_criteria(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->remove_tag_search_criteria: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

remove_tagged_sites

Links remove_tagged_sites(id)

Tag Sites

Removes the associations between the tag and the sites.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag Sites
    api_response = api_instance.remove_tagged_sites(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->remove_tagged_sites: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

set_tagged_asset_groups

Links set_tagged_asset_groups(id, asset_group_ids=asset_group_ids)

Tag Asset Groups

Sets the asset groups associated with the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
asset_group_ids = [rapid7vmconsole.list[int]()] # list[int] | The asset groups to add to the tag. (optional)

try:
    # Tag Asset Groups
    api_response = api_instance.set_tagged_asset_groups(id, asset_group_ids=asset_group_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->set_tagged_asset_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
asset_group_ids	list[int]	The asset groups to add to the tag.	[optional]

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

set_tagged_sites

Links set_tagged_sites(id, sites=sites)

Tag Sites

Sets the sites associated with the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
sites = [rapid7vmconsole.list[int]()] # list[int] | The sites to add to the tag. (optional)

try:
    # Tag Sites
    api_response = api_instance.set_tagged_sites(id, sites=sites)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->set_tagged_sites: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
sites	list[int]	The sites to add to the tag.	[optional]

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

tag_asset

Links tag_asset(id, asset_id)

Tag Asset

Adds an asset to the tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
asset_id = 789 # int | The identifier of the asset.

try:
    # Tag Asset
    api_response = api_instance.tag_asset(id, asset_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->tag_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
asset_id	int	The identifier of the asset.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

tag_asset_group

Links tag_asset_group(id, asset_group_id)

Tag Asset Group

Adds an asset group to this tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
asset_group_id = 56 # int | The asset group identifier.

try:
    # Tag Asset Group
    api_response = api_instance.tag_asset_group(id, asset_group_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->tag_asset_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
asset_group_id	int	The asset group identifier.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

tag_site

Links tag_site(id, site_id)

Tag Site

Adds a site to this tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
site_id = 56 # int | The identifier of the site.

try:
    # Tag Site
    api_response = api_instance.tag_site(id, site_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->tag_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
site_id	int	The identifier of the site.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

untag_all_asset_groups

Links untag_all_asset_groups(id)

Tag Asset Groups

Removes the associations between the tag and all asset groups.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.

try:
    # Tag Asset Groups
    api_response = api_instance.untag_all_asset_groups(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->untag_all_asset_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

untag_asset

Links untag_asset(id, asset_id)

Tag Asset

Removes an asset from the tag. Note: The asset must be added through the asset or tag, if the asset is added using a site, asset group, or search criteria this will not remove the asset.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
asset_id = 789 # int | The identifier of the asset.

try:
    # Tag Asset
    api_response = api_instance.untag_asset(id, asset_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->untag_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
asset_id	int	The identifier of the asset.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

untag_asset_group

Links untag_asset_group(id, asset_group_id)

Tag Asset Group

Removes an asset group from this tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
asset_group_id = 56 # int | The asset group identifier.

try:
    # Tag Asset Group
    api_response = api_instance.untag_asset_group(id, asset_group_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->untag_asset_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
asset_group_id	int	The asset group identifier.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

untag_site

Links untag_site(id, site_id)

Tag Site

Removes a site from this tag.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
site_id = 56 # int | The identifier of the site.

try:
    # Tag Site
    api_response = api_instance.untag_site(id, site_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->untag_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
site_id	int	The identifier of the site.

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

update_tag

Links update_tag(id, tag=tag)

Tag

Updates the details of a tag. For more information about accepted fields for the tag search criteria see the PUT /search_criteria documentation.

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
tag = rapid7vmconsole.Tag() # Tag | The details of the tag. (optional)

try:
    # Tag
    api_response = api_instance.update_tag(id, tag=tag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->update_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
tag	Tag	The details of the tag.	[optional]

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

update_tag_search_criteria

Links update_tag_search_criteria(id, criterial=criterial)

Tag Search Criteria

Updates the search criteria associated with the tag. The following table outlines the search criteria fields and the available operators: | Field | Operators | | ---------- | ---------------- | | ip-address | is, is-not, in-range, not-in-range, is-like, not-like | | ip-address-type | in, not-in | | alternate-address-type | in | | host-name | is, is-not, starts-with, ends-with, contains, does-not-contain, is-empty, is-not-empty, is-like, not-like | | host-type | in, not-in | | operating-system | contains, does-not-contain, is-empty, is-not-empty | | software | contains, does-not-contain| | open-ports | is, is-not, in-range | | service-name | contains, does-not-contain | | risk-score | is, is-not, in-range, is-greater-than,is-less-than | | last-scan-date | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | | vulnerability-assessed | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | | vulnerability-category | is, is-not, starts-with, ends-with, contains, does-not-contain| | vulnerability-cvss-score | is, is-not, in-range, is-greater-than, is-less-than | | vulnerability-cvss-v3-score | is, is-not, in-range, is-greater-than, is-less-than | | vulnerability-exposures | includes, does not-include | | vulnerability-title | contains, does-not-contain, is, is-not, starts-with, ends-with | | cve | is, is-not, contains, does-not-contain | | cvss-access-complexity | is, is-not | | cvss-authentication-required | is, is-not | | cvss-access-vector | is, is-not | | cvss-availability-impact | is, is-not | | cvss-confidentiality-impact | is, is-not | | cvss-integrity-impact | is, is-not | | cvss-v3-confidentiality-impact | is, is-not | | cvss-v3-integrity-impact | is, is-not | | cvss-v3-availability-impact | is, is-not | | cvss-v3-attack-vector | is, is-not | | cvss-v3-attack-complexity | is, is-not | | cvss-v3-user-interaction | is, is-not | | cvss-v3-privileges-required | is, is-not | | mobile-device-last-sync | is-within-the-last, is-earlier-than | | pci-compliance | is | | site-id | in, not-in | | criticality-tag | is, is-not, is-greater-than, is-less-than, is-applied, is-not-applied | | custom-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | location-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | owner-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | | vulnerability-validated-status | are | | vasset-cluster | is, is-not, contains, does-not-contain, starts-with | | vasset-datacenter | is, is-not | | vasset-host name | is, is-not, contains, does-not-contain, starts-with | | vasset-power state | in, not-in | | vasset-resource pool path | contains, does-not-contain | | container-image | is, is-not, starts-with, ends-with, contains, does-not-contain, is-like, not-like | | container-status | is, is-not | | containers | are | The following table outlines the operators and the values associated with them: | Operator | Values | | -------- | ------ | | are | A single string property named "value" | | is-between | A number property named "lower" and a number property named "upper" | | contains | A single string property named "value" | | does-not-contain | A single string property named "value" | | is-earlier-than | A single number property named "value" | | ends-with | A single string property named "value" | | is-greater-than | A single number property named "value" | | in | An array property named "values" | | not-in | An array property named "values" | | in-range | A number property named "lower" and a number property named "upper" | | includes | An array property named "values" | | is | A single string property named "value" | | is-not | A single string property named "value" | | is-applied | No value | | is-not-applied | No value | | is-empty | No value | | is-not-empty | No value | | is-less-than | A single number property named "value" | | is-like | A single string property named "value" | | does-not-contain | A single string property named "value" | | not-in-range | A number property named "lower" and a number property named "upper" | | not-like | A single string property named "value" | | is-on-or-after | A single string property named "value", which is the date in ISO8601 format (yyyy-MM-dd) | | is-on-or-before | A single string property named "value", which is the date in ISO8601 format (yyyy-MM-dd) | | starts-with | A single string property named "value" | | is-within-the-last | A single number property named "value" | The following fields have enumerated values: | Field | Acceptable Values | | ----- | ----------------- | | containers | 0=present, 1=not present | | vulnerability-validated-status | 0=present, 1=not present | | pci-compliance | 0=fail, 1=pass | | alternate-address-type | 0=IPv4, 1=IPv6 | | ip-address-type | 0=IPv4, 1=IPv6 | | host-type | 0=Unknown, 1=Guest, 2=Hypervisor, 3=Physical, 4=Mobile | | cvss-access-complexity | L=Low, M=Medium, H=High | | cvss-integrity-impact | N=None, P=Partial, C=Complete | | cvss-confidentiality-impact | N=None, P=Partial, C=Complete | | cvss-availability-impact | N=None, P=Partial, C=Complete | | cvss-access-vector | L=Local, A=Adjacent, N=Network | | cvss-authentication-required | N=None, S=Single, M=Multiple | | cvss-access-complexity | L=Low, M=Medium, H=High | | cvss-v3-confidentiality-impact | N=None, L=Low, H=High | | cvss-v3-integrity-impact | N=None, L=Low, H=High | | cvss-v3-availability-impact | N=None, L=Low, H=High | | cvss-v3-attack-vector | N=Network, A=Adjacent, L=Local, P=Physical | | cvss-v3-attack-complexity | L=Low, H=High | | cvss-v3-user-interaction | N=None, R=Required | | cvss-v3-privileges-required | N=None, L=Low, H=High | | container-status | created, running, paused, restarting, exited, dead, unknown |

Example

from __future__ import print_function
import time
import rapid7vmconsole
from rapid7vmconsole.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = rapid7vmconsole.TagApi()
id = 56 # int | The identifier of the tag.
criterial = rapid7vmconsole.SearchCriteria() # SearchCriteria | The details of the search criteria. (optional)

try:
    # Tag Search Criteria
    api_response = api_instance.update_tag_search_criteria(id, criterial=criterial)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagApi->update_tag_search_criteria: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The identifier of the tag.
criterial	SearchCriteria	The details of the search criteria.	[optional]

Return type

Links

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

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

Files

TagApi.md

Latest commit

History

TagApi.md

File metadata and controls

rapid7vmconsole.TagApi

create_tag

Example

Parameters

Return type

Authorization

HTTP request headers

delete_tag

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_asset_groups

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_search_criteria

Example

Parameters

Return type

Authorization

HTTP request headers

get_tagged_assets

Example

Parameters

Return type

Authorization

HTTP request headers

get_tagged_sites

Example

Parameters

Return type

Authorization

HTTP request headers

get_tags

Example

Parameters

Return type

Authorization

HTTP request headers

remove_tag_search_criteria

Example

Parameters

Return type

Authorization

HTTP request headers

remove_tagged_sites

Example

Parameters

Return type

Authorization

HTTP request headers

set_tagged_asset_groups

Example

Parameters

Return type

Authorization

HTTP request headers

set_tagged_sites

Example

Parameters

Return type

Authorization

HTTP request headers

tag_asset