Marketplace Software Targets
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-software-targets/ |
List software targets |
| GET | /api/marketplace-software-targets/{uuid}/ |
Retrieve a software target |
| POST | /api/marketplace-software-targets/ |
Create a software target |
| PUT | /api/marketplace-software-targets/{uuid}/ |
Update a software target |
| PATCH | /api/marketplace-software-targets/{uuid}/ |
Partially update a software target |
| DELETE | /api/marketplace-software-targets/{uuid}/ |
Delete a software target |
List software targets
Returns a paginated list of software targets, which represent specific builds of a software version for a given CPU architecture.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_software_targets_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
catalog_uuid |
string (uuid) | |
cpu_family |
string | |
cpu_microarchitecture |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
package_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
path |
string | |
version_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
cpu_family |
string |
cpu_microarchitecture |
string |
path |
string |
Retrieve a software target
Returns the details of a specific software target, including its CPU family, microarchitecture, and path.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
cpu_family |
string |
cpu_microarchitecture |
string |
path |
string |
Create a software target
Creates a new target for a software version. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_software_targets_create
1 2 3 4 5 6 7 8 9 10 | |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
cpu_family |
string |
cpu_microarchitecture |
string |
path |
string |
Update a software target
Updates an existing software target. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
cpu_family |
string |
cpu_microarchitecture |
string |
path |
string |
Partially update a software target
Partially updates an existing software target. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
cpu_family |
string |
cpu_microarchitecture |
string |
path |
string |
Delete a software target
Deletes a software target. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body