List cost-allocation-rules

GET

/cost-allocation-rules

• Current canonical versioned path (F3.API.01)

Rule for splitting shared cloud resource costs (NAT GW, ALB, Transit GW, shared RDS) per cost-center/project/team using tag-based allocation (W4-05 / F2.PRICE.08).

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Query Parameters

pagination[page]

integer

pagination[pageSize]

integer

filters

Strapi REST filter syntax

object

sort

string

populate

string

Responses

200

OK

object

data

Array

object

name

required

Human-friendly rule name (e.g. ‘NAT Gateway allocation - EU West’).

string

provider

required

Cloud provider this rule applies to. ‘all’ matches any provider.

string

Allowed values: aws azure gcp hetzner ovhcloud scaleway upcloud digitalocean all

resource_type

Matches cost-record service field (e.g. ‘NatGateway’, ‘LoadBalancer’, ‘all’). Empty or ‘all’ = matches any.

string

algorithm

required

Split algorithm. ‘even’ = equal split; ‘custom’ = use weights JSON; ‘usage-weighted’ = usage metric split (v1: treated as even).

string

Allowed values: even usage-weighted custom

weights

For custom algorithm: { “team-a”: 40, “team-b”: 35, “team-c”: 25 } — percentages summing to 100.

allocation_tag_key

Which tag key to group cost recipients by (default: ‘cost-center’).

string

effective_from

required

Date from which this rule is effective.

string format: date

is_active

When false the rule is soft-disabled without deleting it.

boolean

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

home_region

Logical data-residency region of the tenant (CELL invariant, F2.CELL.01).

string

cell_id

Deployment cell within home_region for blast-radius isolation (CELL invariant, F2.CELL.01).

string

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

meta

object

pagination

object

page

integer

pageSize

integer

pageCount

integer

total

integer

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)