Skip to navigation
Benchling APIWarehouse Credential

Create a WarehouseCredential

Beta

Create a new WarehouseCredential. Generates a username and password, provisions the credential in the warehouse, and returns the one-time password.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
expiresAtdatetimeRequired

The time after which new connections using the username/password will not be permitted. Upon expiration, currently open connections are not terminated. Must be no more than the tenant’s configured maximum (24 hours by default) in the future.

labelstring or nullOptional
An optional label defined by the user who created the WarehouseCredential.

Response

OK
passwordstringOptional
The generated password for the warehouse credential. This value is only returned once at creation time and cannot be retrieved again.
warehouseCredentialobjectOptional
The created WarehouseCredential.

Errors

400
Warehouse Credential Create Warehouse Credential Request Bad Request Error
403
Warehouse Credential Create Warehouse Credential Request Forbidden Error
404
Warehouse Credential Create Warehouse Credential Request Not Found Error
409
Warehouse Credential Create Warehouse Credential Request Conflict Error
429
Warehouse Credential Create Warehouse Credential Request Too Many Requests Error
500
Warehouse Credential Create Warehouse Credential Request Internal Server Error