@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface LogsRequestBuilder

    Builds and executes requests for operations under /v2/apps/{app_-id}/logs

    interface LogsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                LogsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Apps_get_logs_response>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                LogsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): LogsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    • Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.

      Parameters

      Returns Promise<undefined | Apps_get_logs_response>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns LogsRequestBuilder