Logo

Targets

Targets subsystem

Get all Targets in the Target List

SecuritySCAPIAuthToken
Request
path Parameters
pipeline_id
required
string

ID of the Pipeline

targetlist_id
required
string

ID of the Target List

Responses
200

All Targets in Target List

401

Target List get error

get/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Create a target for the target list
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string
ID of the Pipeline


 
targetlist_id
required
string
ID of the Target List


 
Request Body schema: application/json
required
device_id
required
string <uuid> 
 
device_alias
string
 
device_name
required
string
 
is_active
boolean
 
Responses 
200
All Targets in Target List


401
Target List get error


post/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/
Request samples 
application/json
{
  • "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  • "device_alias": "string",
  • "device_name": "string",
  • "is_active": true
}
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get one target from target list
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string <uuid> 
ID of the Pipeline


 
targetlist_id
required
string <uuid> 
ID of the Target List


 
target_id
required
string <uuid> 
ID of the Target


 
Responses 
200
Target from Target List


401
Target List device delete error


get/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Update a target in the target list
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string <uuid> 
ID of the Pipeline


 
targetlist_id
required
string <uuid> 
ID of the Target List


 
target_id
required
string <uuid> 
ID of the Target


 
Request Body schema: application/json
required
device_name
string
 
is_active
boolean
 
Responses 
200
Updated Target from Target List


401
Target List device delete error


put/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/
Request samples 
application/json
{
  • "device_name": "string",
  • "is_active": true
}
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Delete a Target or Device from a Target List
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string <uuid> 
ID of the Pipeline


 
targetlist_id
required
string <uuid> 
ID of the Target List


 
target_id
required
string <uuid> 
ID of the Target


 
Responses 
200
Deleted Target from Target List


401
Target List device delete error


delete/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Bulk add targets to a target list
Adds multiple targets to a target list. Creates target records if they don't exist, then links them to the target list. Existing targets in the list are left unchanged (skipped). Behaves the same as legacy /targets/ API. device_name should be provided for proper target run creation. device_alias can be provided as a direct property and will be stored in device_meta.


SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string <uuid> 
ID of the Pipeline


 
targetlist_id
required
string <uuid> 
ID of the Target List


 
Request Body schema: application/json
required
Array of device IDs (strings) or device objects with metadata


One of:
 Array 
string
Device ID


 
Responses 
200
Bulk add completed successfully


400
Bad request - invalid input


401
Unauthorized


500
Internal server error


post/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets-bulk/
Request samples 
application/json
[ ]
Response samples 
application/json
{
  • "code": 200,
  • "message": "Bulk add completed. 2 target(s) created, 5 target(s) added to list, 1 target(s) skipped.",
  • "content": {
    }
}
➔ Next to Device Groups