Interface ApiManagementApiInterface

ApiManagementApi - interface ApiManagementApi

interface ApiManagementApiInterface {
    addIpRestrictionForSubAccountApiKey(
        requestParameters: AddIpRestrictionForSubAccountApiKeyRequest,
    ): Promise<RestApiResponse<AddIpRestrictionForSubAccountApiKeyResponse>>;
    deleteIpListForASubAccountApiKey(
        requestParameters: DeleteIpListForASubAccountApiKeyRequest,
    ): Promise<RestApiResponse<DeleteIpListForASubAccountApiKeyResponse>>;
    getIpRestrictionForASubAccountApiKey(
        requestParameters: GetIpRestrictionForASubAccountApiKeyRequest,
    ): Promise<RestApiResponse<GetIpRestrictionForASubAccountApiKeyResponse>>;
}

Implemented by

ApiManagementApi

Index

Methods

addIpRestrictionForSubAccountApiKey deleteIpListForASubAccountApiKey getIpRestrictionForASubAccountApiKey

Methods

addIpRestrictionForSubAccountApiKey

addIpRestrictionForSubAccountApiKey(
requestParameters: AddIpRestrictionForSubAccountApiKeyRequest,
): Promise<RestApiResponse<AddIpRestrictionForSubAccountApiKeyResponse>>
Add IP Restriction for Sub-Account API key

You need to enable Enable Spot & Margin Trading option for the api key which requests this endpoint

Weight: 3000
Parameters
- requestParameters: AddIpRestrictionForSubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<AddIpRestrictionForSubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:230

deleteIpListForASubAccountApiKey

deleteIpListForASubAccountApiKey(
requestParameters: DeleteIpListForASubAccountApiKeyRequest,
): Promise<RestApiResponse<DeleteIpListForASubAccountApiKeyResponse>>
Delete IP List For a Sub-account API Key

You need to enable Enable Spot & Margin Trading option for the api key which requests this endpoint

Weight: 3000
Parameters
- requestParameters: DeleteIpListForASubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<DeleteIpListForASubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:246

getIpRestrictionForASubAccountApiKey

getIpRestrictionForASubAccountApiKey(
requestParameters: GetIpRestrictionForASubAccountApiKeyRequest,
): Promise<RestApiResponse<GetIpRestrictionForASubAccountApiKeyResponse>>
Get IP Restriction for a Sub-account API Key

Weight: 3000
Parameters
- requestParameters: GetIpRestrictionForASubAccountApiKeyRequest
  Request parameters.
Returns Promise<RestApiResponse<GetIpRestrictionForASubAccountApiKeyResponse>>
Throws
Memberof
ApiManagementApiInterface
- Defined in clients/sub-account/src/rest-api/modules/api-management-api.ts:260