Releases & Change Endpoints

Releases & Change Management

Release

GET /Release

List releases. Requires authentication.

Parameter	Type	Description
count	integer	Number of records to return
include_devops_project	boolean	Include DevOps project details
includenotecount	boolean	Include release note count
order	string	Primary sort field
order2–order5	string	Secondary sort fields
orderdesc	boolean	Descending order for primary sort
orderdesc2–orderdesc5	boolean	Descending order for secondary sorts
page_no	integer	Page number for pagination
page_size	integer	Page size for pagination
pageinate	boolean	Enable pagination
product_id	integer	Filter by product ID
restrictmyversion	boolean	Restrict to versions relevant to current user
search	string	Search term
compare_version_seq	integer	Compare against a specific version sequence
exclude_releasenote_group_id	integer	Exclude a specific release note group
includedetails	boolean	Include full details
releasenote_group_id	integer	Filter by release note group ID

---

POST /Release

Create one or more releases.

Request Body: Array of Release objects.

---

GET /Release/{id}

Get a single release by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	Release ID (required)
includedetails	boolean	Include full details

---

DELETE /Release/{id}

Delete a release by ID.

Parameter	Type	Description
id (path)	integer	Release ID (required)

---

ReleaseBranch

GET /ProductBranch

List release branches. Requires authentication.

Parameter	Type	Description
product_id	integer	Filter by product ID

---

ReleaseComponent

GET /ProductComponent

List release components. Requires authentication.

Parameter	Type	Description
product_id	integer	Filter by product ID

---

POST /ProductComponent

Create one or more release components.

Request Body: Array of ReleaseComponent objects.

---

GET /ProductComponent/{id}

Get a single release component by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	Component ID (required)
includedetails	boolean	Include full details

---

DELETE /ProductComponent/{id}

Delete a release component by ID.

Parameter	Type	Description
id (path)	integer	Component ID (required)

---

ReleaseNoteGroup

GET /ReleaseNoteGroup

List release note groups.

---

POST /ReleaseNoteGroup

Create one or more release note groups.

Request Body: Array of ReleaseNoteGroup objects.

---

GET /ReleaseNoteGroup/{id}

Get a single release note group by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	Group ID (required)
includedetails	boolean	Include full details

---

DELETE /ReleaseNoteGroup/{id}

Delete a release note group by ID.

Parameter	Type	Description
id (path)	integer	Group ID (required)

---

ReleasePipeline

GET /ReleasePipeline

List release pipelines.

---

POST /ReleasePipeline

Create one or more release pipelines.

Request Body: Array of ReleasePipeline objects.

---

GET /ReleasePipeline/{id}

Get a single release pipeline by ID.

Parameter	Type	Description
id (path)	integer	Pipeline ID (required)

---

DELETE /ReleasePipeline/{id}

Delete a release pipeline by ID.

Parameter	Type	Description
id (path)	integer	Pipeline ID (required)

---

ReleaseProduct

GET /Product

List release products. Requires authentication.

Parameter	Type	Description
devops_instance	integer	Filter by DevOps instance ID
third_party_only	boolean	Return only third-party products

---

POST /Product

Create one or more release products.

Request Body: Array of ReleaseProduct objects.

---

GET /Product/{id}

Get a single release product by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	Product ID (required)
includedetails	boolean	Include full details

---

DELETE /Product/{id}

Delete a release product by ID.

Parameter	Type	Description
id (path)	integer	Product ID (required)

---

ReleaseType

GET /ReleaseType

List release types.

---

POST /ReleaseType

Create one or more release types.

Request Body: Array of ReleaseType objects.

---

GET /ReleaseType/{id}

Get a single release type by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	Release type ID (required)
includedetails	boolean	Include full details

---

DELETE /ReleaseType/{id}

Delete a release type by ID.

Parameter	Type	Description
id (path)	integer	Release type ID (required)

---

CabHeader

Change Advisory Board (CAB) headers define approval groups for change management.

GET /CAB

List CAB headers. Requires authentication.

Parameter	Type	Description
includemembers	boolean	Include CAB member details

---

POST /CAB

Create one or more CAB headers.

Request Body: Array of CabHeader objects.

---

GET /CAB/{id}

Get a single CAB header by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	CAB header ID (required)
includedetails	boolean	Include full details

---

DELETE /CAB/{id}

Delete a CAB header by ID.

Parameter	Type	Description
id (path)	integer	CAB header ID (required)

---

CabMember

GET /CABMember

List CAB members.

---

CabRole

GET /CABRole

List CAB roles.

---

Version

GET /VersionInfo

List version info records. Requires authentication.

Parameter	Type	Description
product_id	integer	Filter by product ID

---

GET /VersionInfo/{id}

Get a single version info record (Release) by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	Version ID (required)
includedetails	boolean	Include full details

---

GET /VersionInfo/SearchVersionInfo

Search version info records. Requires authentication.

Parameter	Type	Description
count	integer	Number of records to return
dontshownotes	boolean	Exclude release notes from results
product_id	integer	Filter by product ID
search	string	Search term

---

GET /VersionInfo/GetOneSpotlight/{id}

Get a single spotlight version by ID.

Parameter	Type	Description
id (path)	integer	Version ID (required)

---

GET /VersionInfo/Spotlight

List spotlight version info records. Requires authentication.

Parameter	Type	Description
count	integer	Number of records to return
dontshownotes	boolean	Exclude release notes from results
product_id	integer	Filter by product ID

---

GET /VersionInfo/IntegratorHash

Get integrator hash for version info.

---

ConfigCommit

Configuration commits track changes to HaloPSA configuration, enabling audit trails and rollback.

GET /ConfigCommit

List configuration commits. Requires authentication.

Response Schema: ConfigCommit_View (paginated list of commits).

Parameter	Type	Description
advanced_search	string	Advanced search query string
idonly	boolean	Return IDs only
instance_id	integer	Filter by source instance ID
notin_instance_id	integer	Exclude a specific instance ID
order	string	Primary sort field
order2–order5	string	Secondary sort fields
orderdesc	boolean	Descending order for primary sort
orderdesc2–orderdesc5	boolean	Descending order for secondary sorts
page_no	integer	Page number for pagination
page_size	integer	Page size for pagination
pageinate	boolean	Enable pagination
rollback_commit	string	Filter commits associated with a rollback
search	string	Search term

---

POST /ConfigCommit

Create one or more configuration commits. Returns 201 Created with the created ConfigCommit object.

Request Body: Array of ConfigCommit objects.

---

GET /ConfigCommit/{id}

Get a single configuration commit by ID. Requires authentication.

Parameter	Type	Description
id (path)	integer	Commit ID (required)
includedetails	boolean	Include full details
instance_id	integer	Filter by instance ID

---

DELETE /ConfigCommit/{id}

Delete a configuration commit by ID.

Parameter	Type	Description
id (path)	integer	Commit ID (required)