Sign in
latestOpenAPI 3.1.02026-08-18276982.8 KB

804f3e7e0182

batches

Get batch information

Retrieve information about a batch.

get/v2/batches/{batch_id}

Path parameters

batch_idinteger required

The batch ID.

Headers

Authorizationstring required

Bearer HTTP authentication.

IB-Contextstring

Typically your organization ID. See Authorization and context identification for details.

Response

Batch successfully retrieved.

idinteger required

The batch ID.

namestring required

The batch name.

workspacestring

The name of the workspace in which the batch exists.

mount_pointstring

The name of the connected drive in which the batch is stored.

repo_ownerstring

The owner of the workspace (also known as the repo) in which the batch exists.

batch_ownerstring

Username of the user that created the batch.

created_at_msinteger

When the batch was created, in Unix time milliseconds.

updated_at_msinteger

When the batch was last updated, in Unix time milliseconds.

path_suffixstring

Batch path suffix from the mount point.