NetBird Full API Reference + Read-Only MCP Prototype
POST/api/integrations/msp/tenants

Create an MSP tenant

Creates an MSP tenant account with a name, domain, and group access configuration. Supply name, domain, and groups; each group entry includes an id and role. The response includes the created tenant's identifier, status, and DNS challenge.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

MSP tenant details and the groups allowed to access the tenant.

domainstringrequired
The name for the MSP tenant
groupsarray<object>required
MSP users Groups that can access the Tenant and Roles to assume
namestringrequired
The name for the MSP tenant

4 status codes
200Returns the created MSP tenant object, including its identifier, name, domain, groups, status, and DNS challenge.
activated_atstringoptional
The date and time when the tenant was activated.
created_atstringrequired
The date and time when the tenant was created.
dns_challengestringrequired
The DNS challenge to set in a TXT record
domainstringrequired
The tenant account domain
groupsarray<object>required
MSP users Groups that can access the Tenant and Roles to assume
idstringrequired
The updated MSP tenant account ID
invited_atstringoptional
The date and time when the existing tenant was invited.
namestringrequired
The name for the MSP tenant
statusstringrequired
The status of the tenant
Allowed:existinginvitedpendingactive
updated_atstringrequired
The date and time when the tenant was last updated.
400Returned when required fields are missing or the request fails validation.
403Returned when the request is missing valid authentication.
500Returned when an internal server error occurs.

Error handling

name, domain, and groups are required, and each group entry must include id and role; a 400 is returned when the request fails validation. A 403 is returned when valid authentication is missing. A 500 indicates an internal server error.