Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Catalog

Create catalog draft

Create the pending draft from the current live catalog. Returns the existing draft when one is already pending.

post/v1/catalog/versions/draft

Request body

namestring nullable

Optional display name for the draft.

descriptionstring nullable

Optional internal description for the draft.

Example request

{
  "name": "Q3 catalog draft",
  "description": "Draft for Q3 pricing updates."
}

Response

idstring required

Catalog version ID.

versionnumber required

Monotonic version number assigned to the catalog version.

status'draft' | 'published' | 'archived' required

Catalog version status. Draft versions contain unpublished changes, published versions are live, and archived versions are discarded drafts.

namestring nullable required

Optional display name for the catalog version.

descriptionstring nullable required

Optional internal description for the catalog version.

base_version_idstring nullable required

ID of the published catalog version this version was created from.

revert_of_version_idstring nullable required

ID of the published catalog version restored by this revert, or null when the version was not created by a revert.

source_file_namestring nullable required

Name of the source import file that created this catalog version, or null when the version was not imported.

resource_countnumber nullable required

Number of resources tracked in the catalog snapshot.

published_atstring date-time nullable required

Catalog version publication date. UTC date time string in the ISO 8601 format.

created_atstring date-time required

Catalog version creation date. UTC date time string in the ISO 8601 format.

updated_atstring date-time required

Catalog version last update date. UTC date time string in the ISO 8601 format.

Example response

{
  "id": "pcv_9x8v7u6t5s4r",
  "version": 12,
  "status": "published",
  "name": "Q3 catalog",
  "description": "Catalog published for Q3 pricing.",
  "base_version_id": "pcv_1a2b3c4d5e6f",
  "resource_count": 42,
  "published_at": "2026-06-17T12:30:00Z",
  "created_at": "2026-06-17T12:15:00Z",
  "updated_at": "2026-06-17T12:30:00Z"
}