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

    Interface DeploymentsRequestBuilder

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

    interface DeploymentsRequestBuilder {
        byDeployment_id(
            deployment_id: string,
        ): WithDeployment_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                DeploymentsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Apps_deployments_response>;
        post(
            body: Apps_create_deployment_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Apps_deployment_response>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                DeploymentsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Apps_create_deployment_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): DeploymentsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byDeployment_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • List all deployments of an app.

      Parameters

      Returns Promise<undefined | Apps_deployments_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

    post

    • post(
          body: Apps_create_deployment_request,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Apps_deployment_response>

      Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.

      Parameters

      • body: Apps_create_deployment_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Apps_deployment_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

    • Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.

      Parameters

      • body: Apps_create_deployment_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods