Function ApikeysApiFp

Returns {
    adminCreateApiKey(groupId, appId, adminCreateApiKeyRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<ApiKey>)>;
    adminDeleteApiKey(groupId, appId, apiKeyId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminDisableApiKey(groupId, appId, apiKeyId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminEnableApiKey(groupId, appId, apiKeyId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGetApiKey(groupId, appId, apiKeyId, options?) => Promise<((axios?, basePath?) => AxiosPromise<ApiKeyResponse>)>;
    adminListApiKeys(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
}

• adminCreateApiKey:function

  • adminCreateApiKey(groupId, appId, adminCreateApiKeyRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<ApiKey>)>

  • 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<((axios?, basePath?) => AxiosPromise<ApiKey>)>

    Summary

    Create a new API key

    Throws

• adminDeleteApiKey:function

  • adminDeleteApiKey(groupId, appId, apiKeyId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete an API key

    Throws

• adminDisableApiKey:function

  • adminDisableApiKey(groupId, appId, apiKeyId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Disable an API key

    Throws

• adminEnableApiKey:function

  • adminEnableApiKey(groupId, appId, apiKeyId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Enable an API key

    Throws

• adminGetApiKey:function

  • adminGetApiKey(groupId, appId, apiKeyId, options?): Promise<((axios?, basePath?) => AxiosPromise<ApiKeyResponse>)>

  • 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<((axios?, basePath?) => AxiosPromise<ApiKeyResponse>)>

    Summary

    Retrieve information about an API key

    Throws

• adminListApiKeys:function

  • adminListApiKeys(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • 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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List API keys

    Throws