@runloop/api-client - v1.4.0
    Preparing search index...

    Class Blueprints

    Hierarchy

    • APIResource
      • Blueprints
    Index

    Constructors

    Properties

    _client: Runloop

    Methods

    • Starts build of custom defined container Blueprint. The Blueprint will begin in the 'provisioning' step and transition to the 'building' step once it is selected off the build queue., Upon build complete it will transition to 'building_complete' if the build is successful.

      Parameters

      Returns APIPromise<BlueprintView>

    • Get the details of a previously created Blueprint including the build status.

      Parameters

      • id: string
      • Optionaloptions: RequestOptions<unknown>

      Returns APIPromise<BlueprintView>

    • Wait for a blueprint to complete building. Polls the blueprint status until it reaches building_complete state or fails with an error.

      Parameters

      • id: string
      • Optionaloptions: RequestOptions<unknown> & { polling?: Partial<PollingOptions<BlueprintView>> }

      Returns Promise<BlueprintView>

    • Delete a previously created Blueprint. If a blueprint has dependent snapshots, it cannot be deleted. You can find them by querying: GET /v1/devboxes/disk_snapshots?source_blueprint_id={blueprint_id}.

      Parameters

      • id: string
      • Optionaloptions: RequestOptions<unknown>

      Returns APIPromise<unknown>