Security Vulnerability Importers API
TrueSight Network Automation REST API – SecurityVulnerabilityImporterService
The base URL for the API is:
{{status colour="Blue" title="GET"/}}
/v3.0/security_vulnerability_importers
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
orderBy | query | Sort by the specified attribute (name, transformerName or a listable security vulnerability importer dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending) | "+name" | string |
offset | query | Return the specified page number | 1 | integer |
limit | query | Define the number of rows in a page or the maximum number of security vulnerability importers to return | 25 | integer |
Authorization | header | Authorization token formatted as 'Bearer [token]' | String* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access security vulnerability importers | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Green" title="POST"/}}
/v3.0/security_vulnerability_importers
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Complete attributes of the new security vulnerability importer | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | String* |
Responses
Code | Description | Schema |
---|---|---|
201 | Created: New security vulnerability importer successfully added | |
400 | Bad request: Input security vulnerability importer DTO is missing or the new security vulnerability importer is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new security vulnerability importer | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Blue" title="GET"/}}
/v3.0/security_vulnerability_importers/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the security vulnerability importer of interest | string* | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | String* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access security vulnerability importers | |
404 | Not found: No single matching security vulnerability importer found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Yellow" title="PUT"/}}
/v3.0/security_vulnerability_importers/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the security vulnerability importer to be modified | string* | |
body | body | Complete new attribute values for the security vulnerability importer; anything left out will be considered to be null and will be nulled out in the security vulnerability importer | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input security vulnerability importer DTO is missing or modified security vulnerability importer is invalid | |
401 | Unauthorized: Failed to provide a suitable authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the security vulnerability importer | |
404 | Not found: No single matching security vulnerability importer found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Red" title="DELETE"/}}
/v3.0/security_vulnerability_importers/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the security vulnerability importer to be deleted | string* | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | string |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to delete the security vulnerability importer | |
404 | Not found: No single matching security vulnerability importer found | |
500 | Internal server error: Unexpected exception occurred |
{{status colour="Yellow" title="PATCH"/}}
/v3.0/security_vulnerability_importers/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the security vulnerability importer to be modified | string* | |
body | body | New attribute values for the security vulnerability importer, in JSON Patch format | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input JSON patch information is missing or modified security vulnerability importer is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the security vulnerability importer | |
404 | Not found: No single matching security vulnerability importer found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
---|---|
DynamicFieldValueDTO | Click here to expand...{ |
EndorsedProgramBasedTransformerDTO | Click here to expand...Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.SecurityVulnerabilityImporterService$EndorsedProgramBasedTransformerDTO" { |
JsonPatch | Click here to expand...[ |
JsonPatch.OneOperation | Click here to expand... |
JsonPatch.Pointer | Click here to expand...string |
JsonPatch.Add | Click here to expand...{ |
JsonPatch.Remove | Click here to expand...{ |
JsonPatch.Replace | Click here to expand...{ |
JsonPatch.Move | Click here to expand...{ |
JsonPatch.Copy | Click here to expand...{ |
JsonPatch.Test | Click here to expand...{ |
OsVersionConverterDTO | Click here to expand...{ |
SecurityVulnerabilityImporterDTO | Click here to expand...{ |
StylesheetBasedTransformerDTO | Click here to expand...Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.SecurityVulnerabilityImporterService$StylesheetBasedTransformerDTO" { |
TimePeriodDTO | Click here to expand...{ |
TransformerDTO | Click here to expand... |