Function ApikeysApiAxiosParamCreator

Returns {
    adminCreateApiKey: ((groupId, appId, adminCreateApiKeyRequest, options?) => Promise<RequestArgs>);
    adminDeleteApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>);
    adminDisableApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>);
    adminEnableApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>);
    adminGetApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>);
    adminListApiKeys: ((groupId, appId, options?) => Promise<RequestArgs>);
}

• adminCreateApiKey: ((groupId, appId, adminCreateApiKeyRequest, options?) => Promise<RequestArgs>)

  • • (groupId, appId, adminCreateApiKeyRequest, options?): Promise<RequestArgs>

    • Create a new API key.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • adminCreateApiKeyRequest: AdminCreateApiKeyRequest

        The API key to create.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a new API key

      Throws

• adminDeleteApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, apiKeyId, options?): Promise<RequestArgs>

    • Delete an API key.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • apiKeyId: any

        The unique `_id` value of an API key

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete an API key

      Throws

• adminDisableApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, apiKeyId, options?): Promise<RequestArgs>

    • Disable an API key.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • apiKeyId: any

        The unique `_id` value of an API key

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Disable an API key

      Throws

• adminEnableApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, apiKeyId, options?): Promise<RequestArgs>

    • Enable an API key.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • apiKeyId: any

        The unique `_id` value of an API key

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Enable an API key

      Throws

• adminGetApiKey: ((groupId, appId, apiKeyId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, apiKeyId, options?): Promise<RequestArgs>

    • Retrieve information about an API key.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • apiKeyId: any

        The unique `_id` value of an API key

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Retrieve information about an API key

      Throws

• adminListApiKeys: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • List API keys associated with a Atlas App Services App.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List API keys

      Throws