Skip to content

Rancher Catalogs

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-catalogs/ List Rancher Catalogs
GET /api/rancher-catalogs/{uuid}/ Retrieve
POST /api/rancher-catalogs/ Create
PUT /api/rancher-catalogs/{uuid}/ Update
PATCH /api/rancher-catalogs/{uuid}/ Partial Update
DELETE /api/rancher-catalogs/{uuid}/ Delete
Other Actions
POST /api/rancher-catalogs/{uuid}/refresh/ Refresh

Core CRUD

List Rancher Catalogs

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-catalogs/ \
  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.rancher_catalogs import rancher_catalogs_list # (1)

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

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

try {
  const response = await rancherCatalogsList({
  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
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-catalogs/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.rancher_catalogs import rancher_catalogs_retrieve # (1)

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

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

try {
  const response = await rancherCatalogsRetrieve({
  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
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/rancher-catalogs/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-catalog" \
  catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  branch="string-value" \
  scope="string-value"

 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.rancher_catalog_create_request import RancherCatalogCreateRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_create # (2)

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

body_data = RancherCatalogCreateRequest(
    name="my-awesome-rancher-catalog",
    catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    branch="string-value",
    scope="string-value"
)
response = rancher_catalogs_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await rancherCatalogsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-rancher-catalog",
    "catalog_url": "https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "branch": "string-value",
    "scope": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
catalog_url string (uri) ✓
branch string ✓
scope string ✓
username string
password string

201 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any
username string
password string

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-catalog" \
  catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  branch="string-value" \
  scope="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_catalog_update_request import RancherCatalogUpdateRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_update # (2)

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

body_data = RancherCatalogUpdateRequest(
    name="my-awesome-rancher-catalog",
    catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    branch="string-value",
    scope="string-value"
)
response = rancher_catalogs_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await rancherCatalogsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-catalog",
    "catalog_url": "https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "branch": "string-value",
    "scope": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
catalog_url string (uri) ✓
branch string ✓
scope string ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  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_rancher_catalog_request import PatchedRancherCatalogRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_partial_update # (2)

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

body_data = PatchedRancherCatalogRequest()
response = rancher_catalogs_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await rancherCatalogsPartialUpdate({
  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) ✓
Field Type Required
name string
description string
catalog_url string (uri)
branch string
scope string

200 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-catalogs/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.rancher_catalogs import rancher_catalogs_destroy # (1)

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

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

try {
  const response = await rancherCatalogsDestroy({
  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

Other Actions

Refresh

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/refresh/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-catalog" \
  catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  branch="string-value" \
  scope="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_catalog_request import RancherCatalogRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_refresh # (2)

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

body_data = RancherCatalogRequest(
    name="my-awesome-rancher-catalog",
    catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    branch="string-value",
    scope="string-value"
)
response = rancher_catalogs_refresh.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await rancherCatalogsRefresh({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-catalog",
    "catalog_url": "https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "branch": "string-value",
    "scope": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
catalog_url string (uri) ✓
branch string ✓
scope string ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any