pulsar-admin-sdk 2.2.0

This provides the REST API for admin operations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

# \TenantsApi

All URIs are relative to */admin/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**tenants_base_create_tenant**](TenantsApi.md#tenants_base_create_tenant) | **PUT** /tenants/{tenant} | Create a new tenant.
[**tenants_base_delete_tenant**](TenantsApi.md#tenants_base_delete_tenant) | **DELETE** /tenants/{tenant} | Delete a tenant and all namespaces and topics under it.
[**tenants_base_get_tenant_admin**](TenantsApi.md#tenants_base_get_tenant_admin) | **GET** /tenants/{tenant} | Get the admin configuration for a given tenant.
[**tenants_base_get_tenants**](TenantsApi.md#tenants_base_get_tenants) | **GET** /tenants | Get the list of existing tenants.
[**tenants_base_update_tenant**](TenantsApi.md#tenants_base_update_tenant) | **POST** /tenants/{tenant} | Update the admins for a tenant.



## tenants_base_create_tenant

> tenants_base_create_tenant(tenant, body)
Create a new tenant.

This operation requires Pulsar super-user privileges.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant** | **String** | The tenant name | [required] |
**body** | Option<[**TenantInfo**](TenantInfo.md)> | TenantInfo |  |

### Return type

 (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## tenants_base_delete_tenant

> tenants_base_delete_tenant(tenant, force)
Delete a tenant and all namespaces and topics under it.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant** | **String** | The tenant name | [required] |
**force** | Option<**bool**> |  |  |[default to false]

### Return type

 (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## tenants_base_get_tenant_admin

> models::TenantInfo tenants_base_get_tenant_admin(tenant)
Get the admin configuration for a given tenant.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant** | **String** | The tenant name | [required] |

### Return type

[**models::TenantInfo**](TenantInfo.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## tenants_base_get_tenants

> Vec<String> tenants_base_get_tenants()
Get the list of existing tenants.

### Parameters

This endpoint does not need any parameter.

### Return type

**Vec<String>**

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## tenants_base_update_tenant

> tenants_base_update_tenant(tenant, body)
Update the admins for a tenant.

This operation requires Pulsar super-user privileges.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant** | **String** | The tenant name | [required] |
**body** | Option<[**TenantInfo**](TenantInfo.md)> | TenantInfo |  |

### Return type

 (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)