Skip to content

FirmwareApi.md

Latest commit

 

History

History
141 lines (85 loc) · 3.98 KB

FirmwareApi.md

File metadata and controls

141 lines (85 loc) · 3.98 KB

.FirmwareApi

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

Method HTTP request Description
getBinariesForFirmwareTask GET /v2/firmware/get-binaries/{task_id} Upload firmware for unpacking
uploadFirmware POST /v2/firmware Upload firmware for unpacking

getBinariesForFirmwareTask

any getBinariesForFirmwareTask()

Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Example

import { createConfiguration, FirmwareApi } from '@revengai/sdk';
import type { FirmwareApiGetBinariesForFirmwareTaskRequest } from '@revengai/sdk';

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

const request: FirmwareApiGetBinariesForFirmwareTaskRequest = {
  
  taskId: "task_id_example",
};

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

Parameters

Name Type Description Notes
taskId [string] defaults to undefined

Return type

any

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]

uploadFirmware

any uploadFirmware()

Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Example

import { createConfiguration, FirmwareApi } from '@revengai/sdk';
import type { FirmwareApiUploadFirmwareRequest } from '@revengai/sdk';

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

const request: FirmwareApiUploadFirmwareRequest = {
  
  file: "file_example",
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
  
  password: "password_example",
};

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

Parameters

Name Type Description Notes
file [string] 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
password [string] (optional) defaults to undefined

Return type

any

Authorization

APIKey

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Unprocessable Entity -
500 Internal Server Error -

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