Class APIKeysApi

APIKeysApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • APIKeysApi

Constructors

constructor

Properties

axios basePath configuration

Methods

createAPIKey deleteAPIKey listAPIKeys updateAPIKey

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns APIKeysApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createAPIKey

  • Creates a new API Key. For security reasons, secret keys are only fully displayed upon creation. Store this key securely to authenticate your application to the API.

    Summary

    Create an API key

    Throws

    Memberof

    APIKeysApi

    Parameters

    • requestParameters: APIKeysApiCreateAPIKeyRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ApiKey, any>>

deleteAPIKey

  • Deletes an API Key. This cannot be undone.

    Summary

    Delete an API Key

    Throws

    Memberof

    APIKeysApi

    Parameters

    • requestParameters: APIKeysApiDeleteAPIKeyRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<object, any>>

listAPIKeys

  • Returns a list of API Keys. The API Keys are sorted with the most recently created appearing first.

    Summary

    List all API Keys

    Throws

    Memberof

    APIKeysApi

    Parameters

    • requestParameters: APIKeysApiListAPIKeysRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListAPIKeys200Response, any>>

updateAPIKey

  • Updates the API Keys by setting the values of the provided parameters. Any parameters not provided will be left unchanged.

    Summary

    Update an API key

    Throws

    Memberof

    APIKeysApi

    Parameters

    • requestParameters: APIKeysApiUpdateAPIKeyRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ApiKey, any>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc