Tenant API
API Endpoints
| Class | Method | HTTP request | Description |
|---|---|---|---|
| TenantApi | collectServicesSummary | GET /tenants/servicesSummary | Returns the Service summary. |
| TenantApi | collectServicesSummaryFile | GET /tenants/servicesSummaryFile | Returns the Service summary file. |
| TenantApi | createTenant | POST /tenants | Create a Tenant. |
| TenantApi | deleteTenant | DELETE /tenants/{id} | Delete the Tenant |
| TenantApi | generateUsageReport | GET /tenants/usageReport | Returns the Tenant usage report file. |
| TenantApi | getAdmin | GET /tenants/{id}/admin | Returns details for the identified Tenant's Primary Administrator. |
| TenantApi | getChildren | GET /tenants/{id}/children | Returns a list of the identified Parent Tenant's existing Child Tenant IDs. |
| TenantApi | getHostname | GET /tenants/{id}/hostname | Returns hostname of the requested Tenant ID. |
| TenantApi | getLogo | GET /tenants/logo | Returns logo image for the targeted host. |
| TenantApi | getLogoById | GET /tenants/{id}/logo | Returns the logo image for the targeted Tenant. |
| TenantApi | getQuotas | GET /tenants/{id}/quotas | Returns the quota information for the requested Tenant ID. |
| TenantApi | getTenant | GET /tenants/{id} | Returns details for the specified Tenant. |
| TenantApi | getTenantHierarchy | GET /tenants/hierarchy | Returns a tree representation of the Tenant hierarchy. |
| TenantApi | getTenantSettings | GET /tenants/settings | Returns Tenant settings. |
| TenantApi | getUsageDetails | GET /tenants/usageDetails | Returns the usage details for all the Tenants. |
| TenantApi | listTenants | GET /tenants | Returns a list of Tenants. |
| TenantApi | setLogo | PUT /tenants/{id}/logo | Set logo image for the targeted Tenant. |
| TenantApi | updateTenant | PATCH /tenants/{id} | Update an existing Tenant. |
| TenantApi | updateTenantSettings | PATCH /tenants/settings | Update Tenant settings. |
Models
- Address
- Admin
- DetailedServiceSummary
- Error
- ResourceCollection
- Tenant
- TenantCreateParams
- TenantNode
- TenantQuota
- TenantQuotaList
- TenantResourceCollection
- TenantResourceCollection_allOf
- TenantSettings
- TenantUpdateParams
- TenantUsageDetails
Authorization
OAuth2
For more information about authorization see Getting Started Using the DPoD API.
- Type: OAuth
- Scopes:
- dpod.tenant.spadmin: Service Provider Administrator
- dpod.tenant.admin: Tenant Administrator
- dpod.tenant.appowner: Application Owner
- dpod.tenant.api_appowner: Application Owner API platform credentials
- dpod.tenant.api_service: Service credentials
- dpod.tenant.api_spadmin: Service Provider Administrator API platform credentials