Skip to content

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
http \
  GET \
  https://api.example.com/api/marketplace-software-targets/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_software_targets_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareTargetsList } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
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 Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Retrieve a software target

Returns the details of a specific software target, including its CPU family, microarchitecture, and path.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Create a software target

Creates a new target for a software version. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-software-targets/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_create # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_create.sync(client=client)

print(response)
  1. API Source: marketplace_software_targets_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareTargetsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Update a software target

Updates an existing software target. Requires staff permissions.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Partially update a software target

Partially updates an existing software target. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Delete a software target

Deletes a software target. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body