Skip to content

Openportal Allocations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-allocations/ List Openportal Allocations
GET /api/openportal-allocations/{uuid}/ Retrieve
POST /api/openportal-allocations/ Create
POST /api/openportal-allocations/{uuid}/pull/ Synchronize resource state
POST /api/openportal-allocations/{uuid}/unlink/ Unlink resource
PUT /api/openportal-allocations/{uuid}/ Update
PATCH /api/openportal-allocations/{uuid}/ Partial Update
DELETE /api/openportal-allocations/{uuid}/ Delete
Other Actions
POST /api/openportal-allocations/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openportal-allocations/{uuid}/set_limits/ Set limits
POST /api/openportal-allocations/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Openportal Allocations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-allocations/ \
  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.models.allocation_field_enum import AllocationFieldEnum # (1)
from waldur_api_client.models.core_states import CoreStates # (2)
from waldur_api_client.api.openportal_allocations import openportal_allocations_list # (3)

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

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

try {
  const response = await openportalAllocationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
is_active boolean
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) 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
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.allocation_field_enum import AllocationFieldEnum # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_retrieve # (2)

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

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

try {
  const response = await openportalAllocationsRetrieve({
  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) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openportal-allocations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/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.allocation_request import AllocationRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_create # (2)

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

body_data = AllocationRequest(
    name="my-awesome-openportal-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_allocations_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await openportalAllocationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openportal-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
node_limit integer (int64)
groupname string

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  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.openportal_allocations import openportal_allocations_pull # (1)

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

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

try {
  const response = await openportalAllocationsPull({
  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) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  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.openportal_allocations import openportal_allocations_unlink # (1)

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

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

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

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/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.allocation_request import AllocationRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_update # (2)

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

body_data = AllocationRequest(
    name="my-awesome-openportal-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_allocations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await openportalAllocationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openportal-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/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
service_settings string (uri) ✓
project string (uri) ✓
node_limit integer (int64)
groupname string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-allocations/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_allocation_request import PatchedAllocationRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_partial_update # (2)

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

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

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

try {
  const response = await openportalAllocationsPartialUpdate({
  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
node_limit integer (int64)
groupname string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_type string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-allocations/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.openportal_allocations import openportal_allocations_destroy # (1)

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

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

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

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  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.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_set_erred # (2)

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

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

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

try {
  const response = await openportalAllocationsSetErred({
  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
error_message string
error_traceback string

200 -

Field Type
detail string

Set limits

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  node_limit=123

 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.allocation_set_limits_request import AllocationSetLimitsRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_set_limits # (2)

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

body_data = AllocationSetLimitsRequest(
    node_limit=123
)
response = openportal_allocations_set_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

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

200 -

Field Type
node_limit integer

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  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.openportal_allocations import openportal_allocations_set_ok # (1)

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

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

try {
  const response = await openportalAllocationsSetOk({
  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
detail string