Documentation Index
Fetch the complete documentation index at: https://docs.binarly.io/llms.txt
Use this file to discover all available pages before exploring further.
Create a new product container to organize your scanned binary images.
When to Use This Endpoint
Use this endpoint to programmatically provision new products, for example when onboarding a new device model in your CI/CD pipeline.
- Organization: Group related images.
- Automation: setup environments dynamically.
Request
Endpoint
POST <BINARLY_API_URL>/api/v4/products
Headers
| Header | Value |
|---|
Authorization | Bearer <access_token> |
Content-Type | application/json |
Body
| Field | Required | Description |
|---|
name | ✅ | The simplified name of the product |
Example Request
curl -s -X POST \
-H "Authorization: Bearer ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{"name": "New Product Series"}' \
"${BINARLY_API_URL}/api/v4/products"
Response
{
"id": "products/01JQPGDX8QW0YJ0XEKV1EVG534",
"name": "New Product Series",
"createTime": "2024-01-28T12:00:00Z"
}
| Field | Description |
|---|
id | Unique identifier (resource name) for the new product |
name | The name provided in the request |
createTime | Creation timestamp |