Skip to content

Autoprovisioning Rules

Operations Summary

Method Endpoint Description
GET /api/autoprovisioning-rules/ Manage autoprovisioning rules
GET /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules
POST /api/autoprovisioning-rules/ Manage autoprovisioning rules
PUT /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules
PATCH /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules
DELETE /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  GET \
  https://api.example.com/api/autoprovisioning-rules/ \
  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.autoprovisioning_rules import autoprovisioning_rules_list # (1)

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

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

try {
  const response = await autoprovisioningRulesList({
  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
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  GET \
  https://api.example.com/api/autoprovisioning-rules/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.autoprovisioning_rules import autoprovisioning_rules_retrieve # (1)

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

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

try {
  const response = await autoprovisioningRulesRetrieve({
  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
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/autoprovisioning-rules/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-autoprovisioning-rule"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rule_request import RuleRequest # (1)
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_create # (2)

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

body_data = RuleRequest(
    name="my-awesome-autoprovisioning-rule"
)
response = autoprovisioning_rules_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await autoprovisioningRulesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-autoprovisioning-rule"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_name string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)

201 -

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/autoprovisioning-rules/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-autoprovisioning-rule"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rule_request import RuleRequest # (1)
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_update # (2)

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

body_data = RuleRequest(
    name="my-awesome-autoprovisioning-rule"
)
response = autoprovisioning_rules_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await autoprovisioningRulesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-autoprovisioning-rule"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_name string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)

200 -

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/autoprovisioning-rules/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_rule_request import PatchedRuleRequest # (1)
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_partial_update # (2)

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

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

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

try {
  const response = await autoprovisioningRulesPartialUpdate({
  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
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_name string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)

200 -

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/autoprovisioning-rules/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.autoprovisioning_rules import autoprovisioning_rules_destroy # (1)

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

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

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