Build Limits

This documentation describes the Platform Administration API endpoint for retrieving system limits for a specific build (tenant).

Authentication

All Platform Administration API endpoints require a valid API key sent in the X-API-Key HTTP header over HTTPS.

X-API-Key: <key>

Condition	Response
Header missing	`401 Unauthorized`
Header present, key incorrect	`403 Forbidden`

GET /api/builds/<build_domain>/limits/

Returns the current system resource limits for a specific build, identified by its domain name.

This endpoint is accessible via the global cluster domain (e.g. catalyst-vnext-be.iac-eu-west-1-0.autologyx.com). The tenant is resolved from the <build_domain> path parameter, not the request domain.

For the list of deployed builds, see clientvalue.autologyx.com.

Permissions

Requires a valid Platform Administration API Key.

Request

Headers

Content-Type: application/json
X-API-Key: <key>

Schema

GET /api/builds/<build_domain>/limits/

Path parameters

Parameter	Type	Notes
build_domain	string	The domain name identifying the build (e.g. `acme.catalyst.autologyx.com`)

Response

The response contains two categories of fields:

Count/limit objects — resources where both current usage and the configured maximum are returned.
Flat integer fields — limits for which only the maximum value is returned (no usage counter).

Count/limit response objects

Key	Type	Notes
authentication_object	object	Count and limit of authentication objects.
custom_components	object	Count and limit of custom components.
object_classes	object	Count and limit of object classes.
public_files	object	Count and limit of public files.
roles	object	Count and limit of roles.
sequences	object	Count and limit of sequences.
single_sign_on	object	Count and limit of SSO configurations.
task_group_templates	object	Count and limit of task group templates.
task_templates	object	Count and limit of task templates.
ui_config	object	Count and limit of UI configurations.
user_groups	object	Count and limit of user groups.

Each of these objects has the following structure:

Key	Type	Notes
count	int	The current number of objects in this build.
limit	int	The maximum permitted number of objects.

Flat limit fields

INFO

The fields listed below reflect the limits available at the time of writing. New limit fields may be added in future platform releases as additional resource types are introduced. The response structure (count/limit objects and flat integers) is not expected to change.

Key	Type	Notes
api_filters_on_object_models_object_records_list	int	Limit of API filters on object records list.
assignees_standard	int	Limit of standard assignees.
object_class_document_templates	int	Limit of document templates per object class.
object_class_fields	int	Limit of fields per object class.
object_class_forms	int	Limit of standalone forms per object class.
object_class_owners	int	Limit of owners per object class.
object_class_permission_set	int	Limit of permission sets per object class.
object_class_permission_set_assignees	int	Limit of user assignees per object class permission set.
object_class_permission_set_users_groups_assignees	int	Limit of user group assignees per object class permission set.
object_record_owners	int	Limit of owners per object record.
object_record_permission_set_assignees	int	Limit of user assignees per object record permission set.
object_record_permission_set_users_groups_assignees	int	Limit of user group assignees per object record permission set.
object_records_per_object_class	int	Limit of records per object class.
object_relations_children	int	Limit of children in object relations.
object_relations_depth	int	Limit of depth in object relations.
object_relations_top_parent	int	Limit of top-level parents in object relations.
personal_authentication_objects_per_user_per_provider	int	Limit of personal authentication objects per user per provider.
record_relations_transaction	int	Limit of record relations per transaction.
records_permission_set	int	Limit of record permission sets per object class.
task_assignees_user_groups	int	Limit of user groups as default task assignees.
user_group_members	int	Limit of members per user group.
user_group_owners	int	Limit of owners per user group.
user_group_permission_set	int	Limit of permission sets per user group.
user_preferences	int	Limit of user preferences.
users_external	int	Limit of external users.
users_full	int	Limit of full users.
users_group_permission_set_assignees_user_groups	int	Limit of user group assignees per user group permission set.
users_group_permission_set_assignees_users	int	Limit of user assignees per user group permission set.
users_internal	int	Limit of internal users.
users_ip_restrictions	int	Limit of IP restriction rules per user.
users_one_time_completion	int	Limit of one-time completion users.
users_service_external	int	Limit of external service users.
users_service_internal	int	Limit of internal service users.
users_super_admin	int	Limit of super admin users.
api_object_field_string_type_length_limit	int	String field character limit.
api_object_field_enum_options_max_count	int	Limit of enum field options.
api_task_string_type_length_limit	int	Task response string field character limit.
api_object_field_set_options_max_count	int	Limit of set field options.
api_document_max_num_of_files	int	Limit of document field files.
allowed_file_extensions	list	List of allowed file extensions.

Successful status 200 OK
Response body schema:

json

{
  "authentication_object": { "count": "<int>", "limit": "<int>" },
  "custom_components": { "count": "<int>", "limit": "<int>" },
  "object_classes": { "count": "<int>", "limit": "<int>" },
  "public_files": { "count": "<int>", "limit": "<int>" },
  "roles": { "count": "<int>", "limit": "<int>" },
  "sequences": { "count": "<int>", "limit": "<int>" },
  "single_sign_on": { "count": "<int>", "limit": "<int>" },
  "task_group_templates": { "count": "<int>", "limit": "<int>" },
  "task_templates": { "count": "<int>", "limit": "<int>" },
  "ui_config": { "count": "<int>", "limit": "<int>" },
  "user_groups": { "count": "<int>", "limit": "<int>" },

  "api_filters_on_object_models_object_records_list": "<int>",
  "assignees_standard": "<int>",
  "object_class_document_templates": "<int>",
  "object_class_fields": "<int>",
  "object_class_forms": "<int>",
  "object_class_owners": "<int>",
  "object_class_permission_set": "<int>",
  "object_class_permission_set_assignees": "<int>",
  "object_class_permission_set_users_groups_assignees": "<int>",
  "object_record_owners": "<int>",
  "object_record_permission_set_assignees": "<int>",
  "object_record_permission_set_users_groups_assignees": "<int>",
  "object_records_per_object_class": "<int>",
  "object_relations_children": "<int>",
  "object_relations_depth": "<int>",
  "object_relations_top_parent": "<int>",
  "personal_authentication_objects_per_user_per_provider": "<int>",
  "record_relations_transaction": "<int>",
  "records_permission_set": "<int>",
  "task_assignees_user_groups": "<int>",
  "user_group_members": "<int>",
  "user_group_owners": "<int>",
  "user_group_permission_set": "<int>",
  "user_preferences": "<int>",
  "users_external": "<int>",
  "users_full": "<int>",
  "users_group_permission_set_assignees_user_groups": "<int>",
  "users_group_permission_set_assignees_users": "<int>",
  "users_internal": "<int>",
  "users_ip_restrictions": "<int>",
  "users_one_time_completion": "<int>",
  "users_service_external": "<int>",
  "users_service_internal": "<int>",
  "users_super_admin": "<int>",
  "api_object_field_string_type_length_limit": "<int>",
  "api_object_field_enum_options_max_count": "<int>",
  "api_task_string_type_length_limit": "<int>",
  "api_object_field_set_options_max_count": "<int>",
  "api_document_max_num_of_files": "<int>",
  "allowed_file_extensions": "<list>"
}

Errors

Error	Status code	Notes
Unauthorized	401 Unauthorized	Standard message
Incorrect API Key	403 Forbidden	Standard message
Build not found	404 Not Found	The specified `build_domain` does not match any active build

PATCH /api/builds/<build_domain>/limits/

Updates system limits for a specific build, identified by its domain name.

For the list of deployed builds, see clientvalue.autologyx.com.

Permissions

Requires a valid Platform Administration API Key.

Request

Headers

Content-Type: application/json
X-API-Key: <key>

Sample request body

json

{
  "object_classes": 600,
  "object_class_fields": 6500,
  "object_records_per_object_class": 200000
}

Path parameters

Parameter	Type	Notes
build_domain	string	The domain name identifying the build (e.g. `acme.catalyst.autologyx.com`)

Response

Response is the same as in GET /api/builds/<build_domain>/limits/

Errors

Error	Status code	Notes
Unauthorized	401 Unauthorized	Standard message
Incorrect API Key	403 Forbidden	Standard message
Build not found	404 Not Found	The specified `build_domain` does not match any active build
Invalid value type	400 Bad Request	"{limit_key}": ["A valid integer is required."]
Value to large	400 Bad Request	"{limit_key}": ["Ensure this value is less than or equal to 32767."]
Value to small	400 Bad Request	"{limit_key}": ["Ensure this value is greater than or equal to 1."]
Value is not list	400 Bad Request	"allowed_file_extensions": ["Expected a list of items but got type "str"."]
Extension not valid	400 Bad Request	"allowed_file_extensions": ["Invalid extension format."]

Build Limits ​

Authentication ​

GET /api/builds/<build_domain>/limits/ ​

Permissions ​

Request ​

Path parameters ​

Response ​

Count/limit response objects ​

Flat limit fields ​

Errors ​

PATCH /api/builds/<build_domain>/limits/ ​

Permissions ​

Request ​

Path parameters ​

Response ​

Errors ​

Build Limits

Authentication

GET /api/builds/<build_domain>/limits/

Permissions

Request

Path parameters

Response

Count/limit response objects

Flat limit fields

Errors

PATCH /api/builds/<build_domain>/limits/

Permissions

Request

Path parameters

Response

Errors