Skip to content

Marketplace Sections

Operations Summary

Method Endpoint Description
GET /api/marketplace-sections/ List sections
GET /api/marketplace-sections/{key}/ Retrieve a section
POST /api/marketplace-sections/ Create a section
PUT /api/marketplace-sections/{key}/ Update a section
PATCH /api/marketplace-sections/{key}/ Partially update a section
DELETE /api/marketplace-sections/{key}/ Delete a section

List sections

Returns a paginated list of all sections. Sections are used to group attributes within a category.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-sections/ \
  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_sections import marketplace_sections_list # (1)

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

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

try {
  const response = await marketplaceSectionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Retrieve a section

Returns the details of a specific section, identified by its key.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  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_sections import marketplace_sections_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_sections_retrieve.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client
)

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

try {
  const response = await marketplaceSectionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.

200 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Create a section

Creates a new section within a category. Requires staff permissions.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-sections/ \
  Authorization:"Token YOUR_API_TOKEN" \
  key="ssh-rsa AAAAB3NzaC1yc2EAAA..." \
  title="string-value" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.section_request import SectionRequest # (1)
from waldur_api_client.api.marketplace_sections import marketplace_sections_create # (2)

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

body_data = SectionRequest(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_sections_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SectionRequest
  2. API Source: marketplace_sections_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceSectionsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA...",
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
key string ✓
title string ✓
category string (uri) ✓
is_standalone boolean Whether section is rendered as a separate tab.

201 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Update a section

Updates an existing section. Requires staff permissions.

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  Authorization:"Token YOUR_API_TOKEN" \
  key="ssh-rsa AAAAB3NzaC1yc2EAAA..." \
  title="string-value" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.section_request import SectionRequest # (1)
from waldur_api_client.api.marketplace_sections import marketplace_sections_update # (2)

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

body_data = SectionRequest(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_sections_update.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SectionRequest
  2. API Source: marketplace_sections_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceSectionsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  },
  body: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA...",
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.
Field Type Required Description
key string ✓
title string ✓
category string (uri) ✓
is_standalone boolean Whether section is rendered as a separate tab.

200 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Partially update a section

Partially updates an existing section. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_section_request import PatchedSectionRequest # (1)
from waldur_api_client.api.marketplace_sections import marketplace_sections_partial_update # (2)

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

body_data = PatchedSectionRequest()
response = marketplace_sections_partial_update.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client,
    body=body_data
)

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

try {
  const response = await marketplaceSectionsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.
Field Type Required Description
key string
title string
category string (uri)
is_standalone boolean Whether section is rendered as a separate tab.

200 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Delete a section

Deletes a section. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  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_sections import marketplace_sections_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_sections_destroy.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client
)

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

try {
  const response = await marketplaceSectionsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.

204 - No response body