Skip to main content
GET
/
tenant
/
{tenantId}
/
admin
/
custodians_for_deployment
GetCustodiansForTokenDeployment
curl --request GET \
  --url https://api.example.com/tenant/{tenantId}/admin/custodians_for_deployment
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

This endpoint retrieves custodians that have contract ownership permissions and gas station wallets available for deploying tokens on a specified blockchain network within a tenant context. The response includes both custodian providers and their associated gas station wallets.

​
Input

  • tenantId (path, required): Identifier of the tenant requesting custodian information
  • blockchainId (path, required): Identifier of the blockchain network to query for deployment options
  • cancellationToken (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<CustodianWithGasStationsForDeploymentModel> containing:
  • Custodians: List of custodian providers with contract ownership permissions
  • GasStationWalletsForDeploys: List of gas station wallets available for deployment operations

​
Examples

Request: 
GET /api/tenant/1024/custodians/blockchain/137/for-deployment
Response (200 OK): 
{
  "data": {
    "custodians": [
      {
        "id": 1,
        "custodianName": "Fireblocks"
      }
    ],
    "gasStationWalletsForDeploys": [
      {
        "custodianId": 1,
        "walletTenantId": 2048,
        "walletCustodianId": 12,
        "name": "Main Gas Station",
        "blockchainName": "Polygon",
        "blockchainNativeCoinName": "MATIC",
        "balance": "125.50"
      }
    ]
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid tenant or blockchain identifier format
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to view custodians for this tenant
  • 404 Not Found: Tenant or blockchain does not exist
  • 500 Internal Server Error: Unexpected server error occurred during retrieval

​
Notes

  • Only custodians with contract ownership permissions are included in the response
  • Gas station wallets must have sufficient balance to facilitate deployment operations
  • The blockchain must be configured and active for the tenant

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant.

Query Parameters

​
blockchainId
integer<int64>

Identifier of the blockchain network.

Response

Custodians for deployment retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.