Get constraint
Gets a constraint.
Gets a constraint.
bearerAuthorizationBearer <token>An access token, or an API key.
constraint*stringThe constraint's ID, such as environments.maxDiskGib.
^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$OK
application/json- response
category*stringWhat the constraint governs: a guardrail or data retention.
"guardrail""retention"defaultMax?integerOf a max: the most kosem itself allows where no policy sets a max, its maxValue; absent where nothing limits it then, as how long a stopped environment is kept.
int64description*stringWhat the constraint restricts, and how.
displayName*stringName shown in user interfaces.
entitlement?stringOf a max bounded by plan: the feature ID whose plan value caps it.
maxValue?integerThe most that a max's policy may set.
int64minValue?integerThe least that a max's policy may set.
int64name*stringResource name, constraints/{constraint_id}, such as constraints/environments.maxDiskGib.
organizationOnly?booleanSet on a constraint whose policies only organizations set.
type*stringHow its policies say what they allow: boolean, enforced or not; allowList, the values allowed; max, the most allowed. An organization's policy and its project's combine by the stricter.
"boolean""allowList""max"unit?stringWhat a max counts, such as GiB.
values?array<>The values that an allow-list's policies may name, in kosem's order.
curl -X GET 'https://api.kosem.ai/v1/constraints/string'{
"category": "guardrail",
"defaultMax": 0,
"description": "string",
"displayName": "string",
"entitlement": "string",
"maxValue": 0,
"minValue": 0,
"name": "string",
"organizationOnly": true,
"type": "boolean",
"unit": "string",
"values": [
{
"displayName": "string",
"value": "string"
}
]
}