Skip to main content
Version: Next

BuildCollectionClient

Client for managing the collection of Actor builds.

Provides methods to list Actor builds across all Actors or for a specific Actor. To access an individual build, use the build() method on the main ApifyClient.

@example
const client = new ApifyClient({ token: 'my-token' });

// List all builds
const buildsClient = client.builds();
const { items } = await buildsClient.list();

// List builds for a specific Actor
const actorBuildsClient = client.actor('my-actor-id').builds();
const { items: actorBuilds } = await actorBuildsClient.list();
@see

https://docs.apify.com/platform/actors/running/runs-and-builds#builds

Hierarchy

  • ResourceCollectionClient
    • BuildCollectionClient

Index

Properties

Methods

Properties

inheritedapifyClient

apifyClient: ApifyClient

inheritedbaseUrl

baseUrl: string

inheritedhttpClient

httpClient: HttpClient

optionalinheritedid

id?: string

optionalinheritedparams

params?: Record<string, unknown>

inheritedpublicBaseUrl

publicBaseUrl: string

inheritedresourcePath

resourcePath: string

optionalinheritedsafeId

safeId?: string

inheritedurl

url: string

Methods

list

  • Lists all Actor builds.

    Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched items in a single API call is limited.

    const paginatedList = await client.list(options);

    Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are retrieved.

    for await (const singleItem of client.list(options)) {...}
    @see

    https://docs.apify.com/api/v2/actor-builds-get

    Parameters

    Returns PaginatedIterator<BuildCollectionClientListItem>

    A paginated iterator of Actor builds.

Page Options