Skip to main content
PUT
Create or replace an end user's execution policy

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito).

Path Parameters

externalUserId
string
required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$

Body

application/json
mode
enum<string>
required
Available options:
ask,
bounded,
unlimited
budgetPeriod
enum<string> | null
Available options:
hour,
day,
week,
month,
null
budgetCredits
string | null

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
maxChargeCredits
string | null

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
allowProviders
string[] | null
Maximum array length: 200
denyProviders
string[] | null
Maximum array length: 200
allowEndpoints
string[] | null
Maximum array length: 200

provider/endpoint

denyEndpoints
string[] | null
Maximum array length: 200

provider/endpoint

allowModels
string[] | null
Maximum array length: 200
denyModels
string[] | null
Maximum array length: 200
maxConcurrentReservations
integer | null
Required range: 1 <= x <= 1000000
maxCallsPerPeriod
integer | null
Required range: 1 <= x <= 1000000
maxCallsPerLoop
integer | null
Required range: 1 <= x <= 1000000

Response

Policy applied

success
any
required
externalUserId
string
required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$
policy
object | null
required