Upload an inventory for processing

Upload an inventory to the web application

post/inventories/upload

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/inventories/upload/post.ts
A function with typed inputs. Its response is checked against the schema.

filestring binary

The inventory file. The original file name is used to check extension, that should be .xml[.gz] or .ocs[.gz]

signaturestring binary

The signature file. The original file name is used to check extension, that should be ${originalInventoryFileName}.sign[.gz]

Inventory uploaded

result'success' | 'error' required

Result of the request

action'uploadInventory' required

The id of the action

datastring required

{
  "data": "Inventory 'file.xml' for Node 'c1bab9fc-bcf6-4d59-a397-84c8e2fc06c0' added to processing queue."
}

No recorded changes to this operation across all 7 revisions of this API.