Skip to content

BinariesApi.md

Latest commit

 

History

History
586 lines (357 loc) · 17.3 KB

BinariesApi.md

File metadata and controls

586 lines (357 loc) · 17.3 KB

.BinariesApi

All URIs are relative to https://api.reveng.ai

Method HTTP request Description
downloadZippedBinary GET /v2/binaries/{binary_id}/download-zipped Downloads a zipped binary with password protection
getBinaryAdditionalDetails GET /v2/binaries/{binary_id}/additional-details Gets the additional details of a binary
getBinaryAdditionalDetailsStatus GET /v2/binaries/{binary_id}/additional-details/status Gets the status of the additional details task for a binary
getBinaryDetails GET /v2/binaries/{binary_id}/details Gets the details of a binary
getBinaryDieInfo GET /v2/binaries/{binary_id}/die-info Gets the die info of a binary
getBinaryExternals GET /v2/binaries/{binary_id}/externals Gets the external details of a binary
getBinaryRelatedStatus GET /v2/binaries/{binary_id}/related/status Gets the status of the unpack binary task for a binary
getRelatedBinaries GET /v2/binaries/{binary_id}/related Gets the related binaries of a binary.

downloadZippedBinary

HttpFile downloadZippedBinary()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiDownloadZippedBinaryRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiDownloadZippedBinaryRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.downloadZippedBinary(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

HttpFile

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/zip, application/json

HTTP response details

Status code Description Response headers
200 Download file -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBinaryAdditionalDetails

BaseResponseBinaryAdditionalResponse getBinaryAdditionalDetails()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiGetBinaryAdditionalDetailsRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiGetBinaryAdditionalDetailsRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.getBinaryAdditionalDetails(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseBinaryAdditionalResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBinaryAdditionalDetailsStatus

BaseResponseAdditionalDetailsStatusResponse getBinaryAdditionalDetailsStatus()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiGetBinaryAdditionalDetailsStatusRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiGetBinaryAdditionalDetailsStatusRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.getBinaryAdditionalDetailsStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseAdditionalDetailsStatusResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBinaryDetails

BaseResponseBinaryDetailsResponse getBinaryDetails()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiGetBinaryDetailsRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiGetBinaryDetailsRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.getBinaryDetails(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseBinaryDetailsResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBinaryDieInfo

BaseResponseListDieMatch getBinaryDieInfo()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiGetBinaryDieInfoRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiGetBinaryDieInfoRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.getBinaryDieInfo(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseListDieMatch

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBinaryExternals

BaseResponseBinaryExternalsResponse getBinaryExternals()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiGetBinaryExternalsRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiGetBinaryExternalsRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.getBinaryExternals(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseBinaryExternalsResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBinaryRelatedStatus

BaseResponseBinariesRelatedStatusResponse getBinaryRelatedStatus()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiGetBinaryRelatedStatusRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiGetBinaryRelatedStatusRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.getBinaryRelatedStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseBinariesRelatedStatusResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRelatedBinaries

BaseResponseChildBinariesResponse getRelatedBinaries()

Example

import { createConfiguration, BinariesApi } from '@revengai/sdk';
import type { BinariesApiGetRelatedBinariesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new BinariesApi(configuration);

const request: BinariesApiGetRelatedBinariesRequest = {
  
  binaryId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

const data = await apiInstance.getRelatedBinaries(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
binaryId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseChildBinariesResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -
403 Forbidden -

[Back to top] [Back to API list] [Back to Model list] [Back to README]