curl --request PUT \
--url https://ndi-api.nace.ai/v1/tenants/{external_ref} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"disabled": true,
"display_name": "<string>",
"limits": {
"max_concurrent_jobs": 2,
"rpm": 2
}
}
'{
"created_at": "2023-11-07T05:31:56Z",
"data_retention": "short",
"disabled": true,
"display_name": "<string>",
"external_ref": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": {
"max_concurrent_jobs": 123,
"rpm": 123
},
"retention_tier": "paid"
}{
"created_at": "2023-11-07T05:31:56Z",
"data_retention": "short",
"disabled": true,
"display_name": "<string>",
"external_ref": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": {
"max_concurrent_jobs": 123,
"rpm": 123
},
"retention_tier": "paid"
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}put_tenant
Create the tenant, or update the one with this external_ref.
Answers 201 when it was created and 200 when it already existed, so it is safe to repeat. Limits above the partner’s own are lowered to them. Cost class: write.
curl --request PUT \
--url https://ndi-api.nace.ai/v1/tenants/{external_ref} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"disabled": true,
"display_name": "<string>",
"limits": {
"max_concurrent_jobs": 2,
"rpm": 2
}
}
'{
"created_at": "2023-11-07T05:31:56Z",
"data_retention": "short",
"disabled": true,
"display_name": "<string>",
"external_ref": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": {
"max_concurrent_jobs": 123,
"rpm": 123
},
"retention_tier": "paid"
}{
"created_at": "2023-11-07T05:31:56Z",
"data_retention": "short",
"disabled": true,
"display_name": "<string>",
"external_ref": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"limits": {
"max_concurrent_jobs": 123,
"rpm": 123
},
"retention_tier": "paid"
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}Authorizations
Path Parameters
The partner's own reference for the tenant, such as its account id.
1 - 128^\S(.*\S)?$Body
Create a tenant, or update the one with this external_ref. Omitted fields stay as they are.
How the tenant's document operations retain data: short or zero_retention. Omit it when creating to inherit your own setting, or when updating to leave it unchanged.
short, zero_retention True disables the tenant (its requests answer tenant_disabled); false re-enables it.
Human-readable name of the tenant.
1 - 128Limits to set on the tenant.
Show child attributes
Show child attributes
The tenant's account tier for job retention: a paid tenant's job inputs, outputs and processing files are removed 48 hours after the job finishes, a free tenant's 7 days after. A failed or cancelled job counts from the failure or cancel. Omit it to leave the tenant's tier unchanged; a tenant never given one is paid. Applies to jobs that finish afterwards.
paid, free Response
Successful Response
One of the partner's child tenants. Send X-NDI-Tenant: ext:<external_ref> to act for it.
When the tenant was created.
The data-retention setting in force for the tenant. A stored zero_retention reads as short while this deployment does not offer zero retention.
short, zero_retention Whether the tenant is disabled. Its data is kept.
Human-readable name of the tenant.
The partner's own reference for the tenant, unique per partner.
NDI's id for the tenant; X-NDI-Tenant accepts it too.
The limits in force for the tenant.
Show child attributes
Show child attributes
The tenant's account tier for job retention: a paid tenant's job inputs, outputs and processing files are removed 48 hours after the job finishes, a free tenant's 7 days after. A failed or cancelled job counts from the failure or cancel.
paid, free