List workspace quotas
/v1/workspace/quotasconst { data } = await bird.workspace.quotas.list();
for (const quota of data) {
console.log(quota.key, quota.limit, quota.organization_limit);
}quotas = client.workspace.quotas.list()
for quota in quotas.data:
print(quota.key, quota.limit, quota.organization_limit)quotas, err := client.Workspace.Quotas.List(context.Background())
if err != nil {
log.Fatal(err)
}
for _, quota := range quotas.Data {
fmt.Println(quota.Key, quota.Limit, quota.OrganizationLimit)
}$quotas = $bird->workspace->quotas->list();
foreach ($quotas->getData() ?? [] as $quota) {
echo $quota->getKey() . ' ' . $quota->getLimit() . PHP_EOL;
}bird workspace quotas listcurl -X GET "https://us1.platform.bird.com/v1/workspace/quotas" \
-H "Authorization: Bearer $TOKEN"{
"data": [
{
"key": "email_mailboxes_max",
"unit": "mailboxes",
"kind": "counted",
"enforcement": "create",
"organization_source": "default",
"workspace_limit": {
"status": "active"
},
"usage": {
"status": "available"
}
}
],
"configuration": "available"
}
Returns each resource and value quota as it applies to the current workspace: the organization limit shared by
all workspaces, the workspace's own limit when one is set, and this workspace's current usage.
Organization usage and shared remaining capacity are withheld: organization_used,
organization_remaining and remaining are always null on this endpoint.
A workspace limit is a ceiling, not reserved capacity. Each quota's enforcement says how both limits apply:
create refuses a creation that would pass either one, outbound_send refuses outbound sends once the bytes
already held reach either one, and value bounds a setting when it is chosen. usage is null for a value
quota. When usage cannot be read, usage.status is unavailable and the counts are null.
响应载荷
data显示子属性
data.keyStable key of the quota.
data.namedata.descriptiondata.unitWhat the limit counts, such as mailboxes, bytes or days.
data.kindWhat the quota limits.
counted: an amount the workspace accumulates, such as mailboxes or stored bytes. Usage is reported.value: the largest setting a resource may be given, such as a retention period. No usage is counted.
Possible values: counted, value
data.enforcementWhen the limits are applied.
create: a request that would add more than the limits allow is refused, and nothing is created.outbound_send: sending is refused once the bytes already stored reach a limit. The size of the message being sent is not counted in advance, and incoming mail is still accepted.value: a setting above the limit is refused when it is chosen. Existing resources keep their settings.
Possible values: create, outbound_send, value
data.maximum_valueThe largest workspace limit this quota accepts, in its unit.
data.organization_limitThe organization's limit, shared by all its workspaces.
data.organization_sourceWhere the organization limit comes from.
default: Bird's standard limit.plan: the organization's plan.override: a limit Bird set for the organization.
Possible values (may grow over time): default, plan, override
data.workspace_limitThe workspace's own limit. null when the workspace has none and uses only the shared organization limit.
data.limitThe lower of the organization limit currently applied to requests and any active workspace limit. The applied organization limit can briefly differ from the configured organization_limit after a change. A request can still be refused below this value when other workspaces use the shared organization limit.
configurationWhether workspace limits can be set.
available: workspace limits can be set and changed.unavailable: new workspace limits cannot be set in this region yet. Existing workspace limits still apply and can be removed.
Possible values: available, unavailable