Create Product

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`	Yes	The simplified name of the product
`description`	No	A description 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

The endpoint returns 201 Created with the new product.

{
  "id": "01JQPGDX8QW0YJ0XEKV1EVG534",
  "name": "New Product Series",
  "description": "",
  "createTime": "2024-01-28T12:00:00Z",
  "author": {
    "id": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "userId": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "email": "user@example.com",
    "status": "active"
  }
}

Field	Description
`id`	Product ID (ULID) of the new product
`name`	The name provided in the request
`description`	The description provided in the request, or an empty string
`createTime`	Creation timestamp
`author`	User or service that created the product
`author.email`	Email of the user or API client that created the product

A request without name returns 400 with {"details":[{"field":"name","reason":"Field value required"}],"message":"Product name field required"}.

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response