Class: AdminApi
AdminApi - object-oriented interface
Export
Hierarchy
↳
AdminApi
Table of contents
Constructors
Properties
Methods
- adminPeeringPeersDelete
- adminPeeringPeersGet
- adminPeeringPeersPost
- adminPeeringStartPost
- adminPeeringStatusGet
- adminPeeringStopPost
- adminSystemConfigGet
- adminUsersGet
Constructors
constructor
• new AdminApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
adminPeeringPeersDelete
▸ adminPeeringPeersDelete(body, options?): Promise<Response>
This endpoint can be used to remove a Peer from the Peering Service
Summary
Remove peers on Peering Service
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
body | string[] | Peer ids |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:927
adminPeeringPeersGet
▸ adminPeeringPeersGet(options?): Promise<Response>
This endpoint can be used to list all peers on Peering Service
Summary
List all Peering peers
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:938
adminPeeringPeersPost
▸ adminPeeringPeersPost(options?): Promise<Response>
This endpoint can be used to add a Peer from the Peering Service
Summary
Add peers on Peering Service
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:949
adminPeeringStartPost
▸ adminPeeringStartPost(options?): Promise<Response>
This endpoint can be used to start the Peering Service
Summary
Start Peering
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:960
adminPeeringStatusGet
▸ adminPeeringStatusGet(options?): Promise<Response>
This endpoint can be used to check the Peering status
Summary
Check Peering Status
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:971
adminPeeringStopPost
▸ adminPeeringStopPost(options?): Promise<Response>
This endpoint can be used to stop the Peering Service
Summary
Stop Peering
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:982
adminSystemConfigGet
▸ adminSystemConfigGet(options?): Promise<Response>
This endpoint is used to get system configs.
Summary
Get systems(estuary/shuttle) config
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:993
adminUsersGet
▸ adminUsersGet(options?): Promise<Response>
This endpoint is used to get all users.
Summary
Get all users
Throws
Memberof
AdminApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>