​
Select Service
API Namespace Endpoints Reference
Published April 5, 2023 | Last modified May 28, 2025
| Endpoint | URL | Supported Namespace | Comment |
|---|---|---|---|
| MakePaymentMethodPrimary | /api/web/namespaces/{namespace}/billing/payment_method/{name}/primary | system | |
| MakePaymentMethodSecondary | /api/web/namespaces/{namespace}/billing/payment_method/{name}/secondary | system | |
| SwapPaymentMethodRole | /api/web/namespaces/{namespace}/billing/payment_method/{name}/swap-primary | system | |
| Create | /api/web/namespaces/{namespace}/billing/payment_methods | system | |
| Delete | /api/web/namespaces/{namespace}/billing/payment_methods/{name} | system | |
| InitiatePlanTransition | /api/web/namespaces/{namespace}/billing/plan_transition | system | |
| Comment | /api/web/namespaces/{namespace}/customer_support/{name}/comment | system | |
| AdminList | /api/web/namespaces/{namespace}/admin/customer_supports | system | |
| Close | /api/web/namespaces/{namespace}/customer_support/{name}/close | system | |
| Reopen | /api/web/namespaces/{namespace}/customer_support/{name}/reopen | system | |
| Priority | /api/web/namespaces/{namespace}/customer_support/{name}/priority | system | |
| Escalate | /api/web/namespaces/{namespace}/customer_support/{name}/escalate | system | |
| Create | /api/web/custom/namespaces/{namespace}/oidc_providers | system | |
| Replace | /api/web/custom/namespaces/{namespace}/oidc_providers/{name} | system | |
| UpdateScimIntegration | /api/web/custom/namespaces/{namespace}/oidc_providers/{name}/scim | system | |
| Get | /api/web/custom/namespaces/{namespace}/oidc_provider/{name} | system | |
| List | /api/web/custom/namespaces/{namespace}/oidc_providers | system | |
| Delete | /api/web/custom/namespaces/{namespace}/oidc_provider/{name}/delete | system | |
| GetOIDCMappers | /api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers | system | |
| UpdateOIDCMappers | /api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers | system | |
| GetQuotaUsage | /api/web/namespaces/{namespace}/quota/usage | system | |
| CustomGetQuotaLimits | /api/web/namespaces/{namespace}/quota/limits | system | |
| CustomList | /api/web/custom/namespaces/{namespace}/roles | shared/system | If the slug uses a shared namespace, only shared objects will be returned. If it uses a system namespace, both shared and system objects will be returned. |
| CustomGet | /api/web/custom/namespaces/{namespace}/roles/{name} | shared/system | If a shared namespace is provided, it will retrieve and return the shared role. If a system namespace is provided, it will retrieve and return the system role. |
| CustomCreate | /api/web/custom/namespaces/{namespace}/roles | system | |
| CustomReplace | /api/web/custom/namespaces/{namespace}/roles/{name} | system | |
| ListUsageDetails | /api/web/namespaces/{namespace}/usage_details | system | |
| ListHourlyUsageDetails | /api/web/namespaces/{namespace}/hourly_usage_details | system | |
| ListCurrentUsage | /api/web/namespaces/{namespace}/current_usage | system | |
| ListMonthlyUsage | /api/web/namespaces/{namespace}/monthly_usage | system | |
| ListInvoices | /api/web/namespaces/{namespace}/usage/invoices/custom_list | system | |
| DownloadInvoicePdf | /api/web/namespaces/{namespace}/usage/invoice_pdf | system | |
| ListSubscriptions | /api/web/namespaces/{namespace}/subscriptions/custom_list | system | |
| Create | /api/web/custom/namespaces/{namespace}/user_roles | system | |
| Replace | /api/web/custom/namespaces/{namespace}/user_roles/{name} | system | |
| List | /api/web/custom/namespaces/{namespace}/user_roles | system | |
| Get | /api/web/custom/namespaces/{namespace}/whoami | system | |
| CascadeDelete | /api/web/custom/namespaces/{namespace}/users/cascade_delete | system | |
| AssignRole | /api/web/custom/namespaces/{namespace}/role_users | system | |
| SendPasswordEmail | /api/web/custom/namespaces/{namespace}/send_password_email | system | |
| AcceptTOS | /api/web/custom/namespaces/{namespace}/accept_tos | system | |
| GetTOS | /api/web/custom/namespaces/{namespace}/tos | system | |
| Get | /api/web/namespaces/{namespace}/api_groups/{name} | shared | |
| List | /api/web/namespaces/{namespace}/api_groups | shared | |
| Get | /api/web/namespaces/{namespace}/api_group_elements/{name} | shared | |
| List | /api/web/namespaces/{namespace}/api_group_elements | shared | |
| Create | /api/web/namespaces/{metadata.namespace}/customer_supports | system | |
| Get | /api/web/namespaces/{namespace}/customer_supports/{name} | system | |
| List | /api/web/namespaces/{namespace}/customer_supports | system | |
| Get | /api/web/namespaces/{namespace}/namespace_roles/{name} | system | |
| List | /api/web/namespaces/{namespace}/namespace_roles | system | |
| Get | /api/web/namespaces/{namespace}/addon_services/{name} | shared | |
| List | /api/web/namespaces/{namespace}/addon_services | shared | |
| Get | /api/web/namespaces/{namespace}/navigation_tiles/{name} | shared | |
| List | /api/web/namespaces/{namespace}/navigation_tiles | shared | |
| Get | /api/web/namespaces/{namespace}/plans/{name} | shared | |
| List | /api/web/namespaces/{namespace}/plans | shared | |
| Create | /api/web/namespaces/{metadata.namespace}/quotas | system | |
| Get | /api/web/namespaces/{namespace}/quotas/{name} | shared/system | If a shared namespace is provided, it will retrieve and return the shared quota. If a system namespace is provided, it will retrieve and return the system quota. |
| List | /api/web/namespaces/{namespace}/quotas | shared/system | If the slug uses a shared namespace, only shared objects will be returned. If it uses a system namespace, both shared and system objects will be returned. |
| Replace | /api/web/namespaces/{metadata.namespace}/quotas/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/quotas/{name} | system | |
| Get | /api/web/namespaces/{namespace}/rbac_policys/{name} | shared/system | If a shared namespace is provided, it will retrieve and return the shared objects. If a system namespace is provided, it will retrieve and return the system objects. |
| List | /api/web/namespaces/{namespace}/rbac_policys | shared/system | If the slug uses a shared namespace, only shared objects will be returned. If it uses a system namespace, both shared and system objects will be returned. |
| Delete | /api/web/namespaces/{namespace}/roles/{name} | system | |
| Create | /api/web/namespaces/{metadata.namespace}/allowed_tenants | system | |
| Get | /api/web/namespaces/{namespace}/allowed_tenants/{name} | system | |
| List | /api/web/namespaces/{namespace}/allowed_tenants | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/allowed_tenants/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/allowed_tenants/{name} | system | |
| Create | /api/web/namespaces/{metadata.namespace}/child_tenants | system | |
| Get | /api/web/namespaces/{namespace}/child_tenants/{name} | system | |
| List | /api/web/namespaces/{namespace}/child_tenants | system | |
| Delete | /api/web/namespaces/{namespace}/child_tenants/{name} | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/child_tenants/{metadata.name} | system | |
| Create | /api/web/namespaces/{metadata.namespace}/child_tenant_managers | system | |
| Get | /api/web/namespaces/{namespace}/child_tenant_managers/{name} | system | |
| List | /api/web/namespaces/{namespace}/child_tenant_managers | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/child_tenant_managers/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/child_tenant_managers/{name} | system | |
| Create | /api/web/namespaces/{metadata.namespace}/managed_tenants | system | |
| Get | /api/web/namespaces/{namespace}/managed_tenants/{name} | system | |
| List | /api/web/namespaces/{namespace}/managed_tenants | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/managed_tenants/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/managed_tenants/{name} | system | |
| Create | /api/web/namespaces/{metadata.namespace}/tenant_profiles | system | |
| Get | /api/web/namespaces/{namespace}/tenant_profiles/{name} | system | |
| List | /api/web/namespaces/{namespace}/tenant_profiles | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/tenant_profiles/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/tenant_profiles/{name} | system | |
| Get | /api/web/namespaces/{namespace}/static_components/{name} | shared | |
| List | /api/web/namespaces/{namespace}/static_components | shared | |
| Get | /api/web/namespaces/{namespace}/user_groups/{name} | system | |
| List | /api/web/namespaces/{namespace}/user_groups | system | |
| ClearBillingFlag | /api/web/custom/namespaces/{namespace}/billing_account/clear_flag | system | |
| List | /api/web/namespaces/{namespace}/custom/payment_methods | system | |
| Delete | /api/web/namespaces/{namespace}/custom/payment_methods/{bms_payment_source_id} | system | |
| Update | /api/web/namespaces/{namespace}/custom/payment_methods/{bms_payment_source_id} | system | |
| AddCreditCard | /api/web/namespaces/{namespace}/custom/payment_methods | system | |
| MakeCreditCardDefault | /api/web/namespaces/{namespace}/custom/payment_methods/{bms_payment_source_id}/default | system | |
| MakeCreditCardBackup | /api/web/namespaces/{namespace}/custom/payment_methods/{bms_payment_source_id}/backup | system | |
| CustomGetTransactions | /api/web/namespaces/{namespace}/custom/transactions | system | |
| Get | /api/web/namespaces/{namespace}/billing_accounts/{name} | system | |
| List | /api/web/namespaces/{namespace}/billing_accounts | system | |
| Get | /api/web/namespaces/{namespace}/invoices/{name} | system | |
| List | /api/web/namespaces/{namespace}/invoices | system | |
| Create | /api/web/namespaces/{metadata.namespace}/payment_methods | system | |
| Get | /api/web/namespaces/{namespace}/payment_methods/{name} | system | |
| List | /api/web/namespaces/{namespace}/payment_methods | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/payment_methods/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/payment_methods/{name} | system | |
| Get | /api/web/namespaces/{namespace}/v2_plans/{name} | system | |
| List | /api/web/namespaces/{namespace}/v2_plans | system | |
| Get | /api/web/namespaces/{namespace}/v2_usage_plan_tmpls/{name} | shared | |
| List | /api/web/namespaces/{namespace}/v2_usage_plan_tmpls | shared | |
| Create | /api/web/namespaces/{metadata.namespace}/notifications | system | |
| Get | /api/web/namespaces/{namespace}/notifications/{name} | system | |
| List | /api/web/namespaces/{namespace}/notifications | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/notifications/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/notifications/{name} | system | |
| Create | /api/web/namespaces/{metadata.namespace}/ticket_tracking_systems | shared | |
| Get | /api/web/namespaces/{namespace}/ticket_tracking_systems/{name} | shared | |
| List | /api/web/namespaces/{namespace}/ticket_tracking_systems | shared | |
| Replace | /api/web/namespaces/{metadata.namespace}/ticket_tracking_systems/{metadata.name} | shared | |
| Delete | /api/web/namespaces/{namespace}/ticket_tracking_systems/{name} | shared | |
| Create | /api/web/namespaces/{metadata.namespace}/contacts | system | |
| Get | /api/web/namespaces/{namespace}/contacts/{name} | system | |
| List | /api/web/namespaces/{namespace}/contacts | system | |
| Replace | /api/web/namespaces/{metadata.namespace}/contacts/{metadata.name} | system | |
| Delete | /api/web/namespaces/{namespace}/contacts/{name} | system |