Skip to content

Rancher Projects

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-projects/ List Rancher Projects
GET /api/rancher-projects/{uuid}/ Retrieve
Other Actions
GET /api/rancher-projects/{uuid}/secrets/ Returns project's secrets

Core CRUD

List Rancher Projects

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

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

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

try {
  const response = await rancherProjectsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid)
name string
name_exact string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string
settings_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)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
namespaces array of objects
namespaces.url string (uri)
namespaces.uuid string (uuid)
namespaces.name string

Retrieve

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

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

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

try {
  const response = await rancherProjectsRetrieve({
  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
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
namespaces array of objects
namespaces.url string (uri)
namespaces.uuid string (uuid)
namespaces.name string

Other Actions

Returns project's secrets

Returns project's secrets.

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/secrets/ \
  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_projects import rancher_projects_secrets_retrieve # (1)

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

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

try {
  const response = await rancherProjectsSecretsRetrieve({
  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
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
namespaces array of objects
namespaces.url string (uri)
namespaces.uuid string (uuid)
namespaces.name string