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

    Interface InstancesRequestBuilder

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

    interface InstancesRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | App_instances>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): InstancesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • Retrieve the list of running instances for a given application, including instance names and component types. Please note that these instances are ephemeral and may change over time. It is recommended not to make persistent changes or develop scripts that rely on their persistence.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | App_instances>

      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 list of running instances for a given application, including instance names and component types. Please note that these instances are ephemeral and may change over time. It is recommended not to make persistent changes or develop scripts that rely on their persistence.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns InstancesRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods