Create assets in a batch
curl --request POST \
--url https://api.secfix.com/v1/inventory/assets/batch-create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"records": [
{
"categoryKey": "CUSTOM",
"name": "Office badge printer",
"classification": "CONFIDENTIAL",
"customIdentifier": "SN-48213",
"dataStored": {
"containsPatientData": false,
"containsUserData": true,
"userDataInfo": "Customer names and email addresses."
},
"description": "Printer in the front office.",
"externalAssetId": "CI-1042",
"externalSource": "servicenow-cmdb",
"ownerEmail": "alex@example.com",
"ownerId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}
]
}
'import requests
url = "https://api.secfix.com/v1/inventory/assets/batch-create"
payload = { "records": [
{
"categoryKey": "CUSTOM",
"name": "Office badge printer",
"classification": "CONFIDENTIAL",
"customIdentifier": "SN-48213",
"dataStored": {
"containsPatientData": False,
"containsUserData": True,
"userDataInfo": "Customer names and email addresses."
},
"description": "Printer in the front office.",
"externalAssetId": "CI-1042",
"externalSource": "servicenow-cmdb",
"ownerEmail": "alex@example.com",
"ownerId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}
] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
records: [
{
categoryKey: 'CUSTOM',
name: 'Office badge printer',
classification: 'CONFIDENTIAL',
customIdentifier: 'SN-48213',
dataStored: {
containsPatientData: false,
containsUserData: true,
userDataInfo: 'Customer names and email addresses.'
},
description: 'Printer in the front office.',
externalAssetId: 'CI-1042',
externalSource: 'servicenow-cmdb',
ownerEmail: 'alex@example.com',
ownerId: 'a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d'
}
]
})
};
fetch('https://api.secfix.com/v1/inventory/assets/batch-create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.secfix.com/v1/inventory/assets/batch-create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'records' => [
[
'categoryKey' => 'CUSTOM',
'name' => 'Office badge printer',
'classification' => 'CONFIDENTIAL',
'customIdentifier' => 'SN-48213',
'dataStored' => [
'containsPatientData' => false,
'containsUserData' => true,
'userDataInfo' => 'Customer names and email addresses.'
],
'description' => 'Printer in the front office.',
'externalAssetId' => 'CI-1042',
'externalSource' => 'servicenow-cmdb',
'ownerEmail' => 'alex@example.com',
'ownerId' => 'a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.secfix.com/v1/inventory/assets/batch-create"
payload := strings.NewReader("{\n \"records\": [\n {\n \"categoryKey\": \"CUSTOM\",\n \"name\": \"Office badge printer\",\n \"classification\": \"CONFIDENTIAL\",\n \"customIdentifier\": \"SN-48213\",\n \"dataStored\": {\n \"containsPatientData\": false,\n \"containsUserData\": true,\n \"userDataInfo\": \"Customer names and email addresses.\"\n },\n \"description\": \"Printer in the front office.\",\n \"externalAssetId\": \"CI-1042\",\n \"externalSource\": \"servicenow-cmdb\",\n \"ownerEmail\": \"alex@example.com\",\n \"ownerId\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.secfix.com/v1/inventory/assets/batch-create")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"records\": [\n {\n \"categoryKey\": \"CUSTOM\",\n \"name\": \"Office badge printer\",\n \"classification\": \"CONFIDENTIAL\",\n \"customIdentifier\": \"SN-48213\",\n \"dataStored\": {\n \"containsPatientData\": false,\n \"containsUserData\": true,\n \"userDataInfo\": \"Customer names and email addresses.\"\n },\n \"description\": \"Printer in the front office.\",\n \"externalAssetId\": \"CI-1042\",\n \"externalSource\": \"servicenow-cmdb\",\n \"ownerEmail\": \"alex@example.com\",\n \"ownerId\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.secfix.com/v1/inventory/assets/batch-create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"records\": [\n {\n \"categoryKey\": \"CUSTOM\",\n \"name\": \"Office badge printer\",\n \"classification\": \"CONFIDENTIAL\",\n \"customIdentifier\": \"SN-48213\",\n \"dataStored\": {\n \"containsPatientData\": false,\n \"containsUserData\": true,\n \"userDataInfo\": \"Customer names and email addresses.\"\n },\n \"description\": \"Printer in the front office.\",\n \"externalAssetId\": \"CI-1042\",\n \"externalSource\": \"servicenow-cmdb\",\n \"ownerEmail\": \"alex@example.com\",\n \"ownerId\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"action": "CREATED",
"code": "validation_failed",
"field": "ownerEmail",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"index": 0,
"message": "unknown owner",
"skippedFields": [
"description"
],
"status": "SUCCESS"
}
]
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}Inventory
Create assets in a batch
Creates up to 100 CUSTOM or INFORMATION assets in one request. Each record is validated and saved on its own, so one invalid record doesn’t stop the others. The response is 200 with one result per record, in request order.
A record whose externalSource and externalAssetId match an existing asset in its category updates that asset instead: its action is UPDATED, and only the fields you send change. So you can resend the same list without creating duplicates. If the same pair appears twice in one request, the whole request is rejected.
A batch counts as one write request for rate limiting. Requires the all:write scope.
POST
/
v1
/
inventory
/
assets
/
batch-create
Create assets in a batch
curl --request POST \
--url https://api.secfix.com/v1/inventory/assets/batch-create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"records": [
{
"categoryKey": "CUSTOM",
"name": "Office badge printer",
"classification": "CONFIDENTIAL",
"customIdentifier": "SN-48213",
"dataStored": {
"containsPatientData": false,
"containsUserData": true,
"userDataInfo": "Customer names and email addresses."
},
"description": "Printer in the front office.",
"externalAssetId": "CI-1042",
"externalSource": "servicenow-cmdb",
"ownerEmail": "alex@example.com",
"ownerId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}
]
}
'import requests
url = "https://api.secfix.com/v1/inventory/assets/batch-create"
payload = { "records": [
{
"categoryKey": "CUSTOM",
"name": "Office badge printer",
"classification": "CONFIDENTIAL",
"customIdentifier": "SN-48213",
"dataStored": {
"containsPatientData": False,
"containsUserData": True,
"userDataInfo": "Customer names and email addresses."
},
"description": "Printer in the front office.",
"externalAssetId": "CI-1042",
"externalSource": "servicenow-cmdb",
"ownerEmail": "alex@example.com",
"ownerId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}
] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
records: [
{
categoryKey: 'CUSTOM',
name: 'Office badge printer',
classification: 'CONFIDENTIAL',
customIdentifier: 'SN-48213',
dataStored: {
containsPatientData: false,
containsUserData: true,
userDataInfo: 'Customer names and email addresses.'
},
description: 'Printer in the front office.',
externalAssetId: 'CI-1042',
externalSource: 'servicenow-cmdb',
ownerEmail: 'alex@example.com',
ownerId: 'a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d'
}
]
})
};
fetch('https://api.secfix.com/v1/inventory/assets/batch-create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.secfix.com/v1/inventory/assets/batch-create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'records' => [
[
'categoryKey' => 'CUSTOM',
'name' => 'Office badge printer',
'classification' => 'CONFIDENTIAL',
'customIdentifier' => 'SN-48213',
'dataStored' => [
'containsPatientData' => false,
'containsUserData' => true,
'userDataInfo' => 'Customer names and email addresses.'
],
'description' => 'Printer in the front office.',
'externalAssetId' => 'CI-1042',
'externalSource' => 'servicenow-cmdb',
'ownerEmail' => 'alex@example.com',
'ownerId' => 'a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.secfix.com/v1/inventory/assets/batch-create"
payload := strings.NewReader("{\n \"records\": [\n {\n \"categoryKey\": \"CUSTOM\",\n \"name\": \"Office badge printer\",\n \"classification\": \"CONFIDENTIAL\",\n \"customIdentifier\": \"SN-48213\",\n \"dataStored\": {\n \"containsPatientData\": false,\n \"containsUserData\": true,\n \"userDataInfo\": \"Customer names and email addresses.\"\n },\n \"description\": \"Printer in the front office.\",\n \"externalAssetId\": \"CI-1042\",\n \"externalSource\": \"servicenow-cmdb\",\n \"ownerEmail\": \"alex@example.com\",\n \"ownerId\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.secfix.com/v1/inventory/assets/batch-create")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"records\": [\n {\n \"categoryKey\": \"CUSTOM\",\n \"name\": \"Office badge printer\",\n \"classification\": \"CONFIDENTIAL\",\n \"customIdentifier\": \"SN-48213\",\n \"dataStored\": {\n \"containsPatientData\": false,\n \"containsUserData\": true,\n \"userDataInfo\": \"Customer names and email addresses.\"\n },\n \"description\": \"Printer in the front office.\",\n \"externalAssetId\": \"CI-1042\",\n \"externalSource\": \"servicenow-cmdb\",\n \"ownerEmail\": \"alex@example.com\",\n \"ownerId\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.secfix.com/v1/inventory/assets/batch-create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"records\": [\n {\n \"categoryKey\": \"CUSTOM\",\n \"name\": \"Office badge printer\",\n \"classification\": \"CONFIDENTIAL\",\n \"customIdentifier\": \"SN-48213\",\n \"dataStored\": {\n \"containsPatientData\": false,\n \"containsUserData\": true,\n \"userDataInfo\": \"Customer names and email addresses.\"\n },\n \"description\": \"Printer in the front office.\",\n \"externalAssetId\": \"CI-1042\",\n \"externalSource\": \"servicenow-cmdb\",\n \"ownerEmail\": \"alex@example.com\",\n \"ownerId\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"action": "CREATED",
"code": "validation_failed",
"field": "ownerEmail",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"index": 0,
"message": "unknown owner",
"skippedFields": [
"description"
],
"status": "SUCCESS"
}
]
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}{
"code": "not_found",
"detail": "No asset found for the given id.",
"instance": "/v1/inventory/assets/3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
"requestId": "req_01HZY8Q3M4N5P6R7S8T9V0W1X2",
"status": 404,
"title": "Not Found",
"type": "https://api.secfix.com/problems/not_found"
}Authorizations
Access token from POST /oauth/token.
Headers
A unique key, up to 256 characters, that makes the request safe to retry. Use a new UUID for each distinct request. If you send the same key again, you get the first response back, for at least 24 hours after the first request completes. Only successful (2xx) responses are stored. If the first request is still running, you get 409 idempotency_in_progress: wait the number of seconds in Retry-After, then retry. See Idempotency.
Maximum string length:
256Example:
"b0f8e5a2-3c1d-4e6f-8a9b-0c1d2e3f4a5b"
Body
application/json
Creates up to 100 CUSTOM or INFORMATION assets. Each record is validated on its own.
The assets to create, 1-100. Each has the same fields as a single create.
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Response
Every record was processed. Check status on each entry in results; each entry has the record's index. Resend only the failed records, with a new Idempotency-Key.
Results of a batch request, one per record. The response is 200 even when some or all records failed. Resend only the failed records, with a new Idempotency-Key.
One result per record, in request order.
Show child attributes
Show child attributes