Function LogForwardersApiFp

Returns {
    createLogForwarder(groupId, appId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>;
    deleteGwarder(groupId, appId, forwarderId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    disableLogForwarder(groupId, appId, forwarderId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    enableLogForwarder(groupId, appId, forwarderId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    getLogForwarder(groupId, appId, forwarderId, options?) => Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>;
    listLogForwarders(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    updateLogForwarder(groupId, appId, forwarderId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>;
}

• createLogForwarder:function

  • createLogForwarder(groupId, appId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>

  • 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.

    • body: LogForwarder

      A log forwarder configuration

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>

    Summary

    Create a log forwarder.

    Throws

• deleteGwarder:function

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

  • 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.

    • forwarderId: any

      The _id ObjectID of a log forwarder.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a log forwarder.

    Throws

• disableLogForwarder:function

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

  • 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.

    • forwarderId: any

      The _id ObjectID of a log forwarder.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Disable a log forwarder.

    Throws

• enableLogForwarder:function

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

  • 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.

    • forwarderId: any

      The _id ObjectID of a log forwarder.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Enable a log forwarder.

    Throws

• getLogForwarder:function

  • getLogForwarder(groupId, appId, forwarderId, options?): Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>

  • 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.

    • forwarderId: any

      The _id ObjectID of a log forwarder.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>

    Summary

    Get a specific log forwarder.

    Throws

• listLogForwarders:function

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

  • 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 log forwarders.

    Throws

• updateLogForwarder:function

  • updateLogForwarder(groupId, appId, forwarderId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>

  • 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.

    • forwarderId: any

      The _id ObjectID of a log forwarder.

    • body: LogForwarder

      A log forwarder configuration

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<LogForwarder>)>

    Summary

    Update a log forwarder.

    Throws