Skip to content

canerd7u/hiveos-api-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
docs
docs
 
 
lib
lib
 
 
test
test
 
 
.php_cs
.php_cs
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

SwaggerClient-php

App API for Hive OS 2.0

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 2.1-beta
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
// Configure API key authorization: SecurityCode
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Security-Code', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Security-Code', 'Bearer');

$apiInstance = new Swagger\Client\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\AccountAccess(); // \Swagger\Client\Model\AccountAccess | 

try {
    $apiInstance->accountAccessPatch($body);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountAccessPatch: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api2.hiveos.farm/api/v2

Class Method HTTP request Description
AccountApi accountAccessPatch PATCH /account/access Update account access settings
AccountApi accountActivatePost POST /account/activate Activate registered account
AccountApi accountAnnouncementsAnnouncementIdHidePost POST /account/announcements/{announcementId}/hide Hide announcement (mark as read)
AccountApi accountAnnouncementsGet GET /account/announcements List of unread announcements
AccountApi accountDelete DELETE /account Delete account
AccountApi accountDepositAddressGet GET /account/deposit/address Get list of generated payment addresses
AccountApi accountDepositAddressPost POST /account/deposit/address Generate payment address for deposits
AccountApi accountDepositCoinpaymentsGet GET /account/deposit/coinpayments Get request data for submitting to coinpayments system
AccountApi accountEmailConfirmPost POST /account/email/confirm Confirm current email
AccountApi accountEmailConfirmationPost POST /account/email/confirmation Request an email confirmation token
AccountApi accountEventsGet GET /account/events Account events
AccountApi accountGet GET /account Get full account info
AccountApi accountMetaGet GET /account/meta Get all meta data from all namespaces
AccountApi accountMetaNamespaceDelete DELETE /account/meta/{namespace} Delete the whole meta data namespace
AccountApi accountMetaNamespaceGet GET /account/meta/{namespace} Get meta data from namespace
AccountApi accountMetaNamespacePatch PATCH /account/meta/{namespace} Merge existing meta in namespace with provided data
AccountApi accountMetaNamespacePut PUT /account/meta/{namespace} Replace the whole meta in namespace with provided data
AccountApi accountNotificationsChannelDelete DELETE /account/notifications/{channel} Unsubscribe from Hive Bot notifications
AccountApi accountNotificationsChannelPost POST /account/notifications/{channel} Subscribe to Hive Bot notifications
AccountApi accountNotificationsGet GET /account/notifications Get notifications settings
AccountApi accountNotificationsPatch PATCH /account/notifications Update notifications settings
AccountApi accountPasswordPut PUT /account/password Change password
AccountApi accountPasswordResetPost POST /account/password/reset Request password reset
AccountApi accountPasswordResetPut PUT /account/password/reset Reset password
AccountApi accountPaymentsGet GET /account/payments Account payments history
AccountApi accountPost POST /account Create account (registration)
AccountApi accountProfileGet GET /account/profile Get profile infirmation
AccountApi accountProfilePatch PATCH /account/profile Update profile
AccountApi accountReferralBalancesGet GET /account/referral/balances Get referral balances
AccountApi accountReferralPayoutAddressesGet GET /account/referral/payout_addresses Get payout addresses
AccountApi accountReferralPayoutAddressesPut PUT /account/referral/payout_addresses Update payout addresses
AccountApi accountReferralPayoutToAccountPost POST /account/referral/payout_to_account Make a payout to hive account
AccountApi accountReferralPromocodePut PUT /account/referral/promocode Update promo code
AccountApi accountSendMoneyPost POST /account/send_money Send money to another user
AccountApi accountTokensGet GET /account/tokens Get list of auth tokens
AccountApi accountTokensPost POST /account/tokens Create new personal auth token
AccountApi accountTokensSessionDelete DELETE /account/tokens/session Delete all session tokens except current.
AccountApi accountTokensTokenIdDelete DELETE /account/tokens/{tokenId} Delete auth token
AccountApi accountTokensTokenIdGet GET /account/tokens/{tokenId} Get auth token info
AccountApi accountTokensTokenIdPatch PATCH /account/tokens/{tokenId} Edit auth token
AccountApi accountTransactionsGet GET /account/transactions Account transactions history
AccountApi accountTwofaDelete DELETE /account/twofa Disable Two Factor Authentication (2FA)
AccountApi accountTwofaPost POST /account/twofa Enable Two Factor Authentication (2FA)
AccountApi accountTwofaSecretGet GET /account/twofa/secret Generate secret code to enable Two Factor Authentication (2FA)
AclApi farmsFarmIdAclAclIdDelete DELETE /farms/{farmId}/acl/{aclId} Revoke farm privileges
AclApi farmsFarmIdAclAclIdGet GET /farms/{farmId}/acl/{aclId} Farm privileges for single user
AclApi farmsFarmIdAclAclIdPatch PATCH /farms/{farmId}/acl/{aclId} Edit farm privileges
AclApi farmsFarmIdAclDelete DELETE /farms/{farmId}/acl Revoke multiple privileges
AclApi farmsFarmIdAclGet GET /farms/{farmId}/acl Farm privileges
AclApi farmsFarmIdAclMeDelete DELETE /farms/{farmId}/acl/me Remove my account from farm privileges
AclApi farmsFarmIdAclPost POST /farms/{farmId}/acl Grant farm privileges
AclApi farmsFarmIdAclSharePost POST /farms/{farmId}/acl/share Share access to farm for admins
AuthApi authCheckGet GET /auth/check Just check authentication status
AuthApi authConfirmationPost POST /auth/confirmation Request a security token
AuthApi authLoginConfirmationPost POST /auth/login/confirmation Request an security token for login request
AuthApi authLoginPost POST /auth/login Create auth token (sign in)
AuthApi authLogoutPost POST /auth/logout Invalidate auth token (sign out)
AuthApi authRefreshPost POST /auth/refresh Refresh auth token
BenchmarksApi farmsFarmIdBenchmarksBenchmarkIdDelete DELETE /farms/{farmId}/benchmarks/{benchmarkId} Delete benchmark
BenchmarksApi farmsFarmIdBenchmarksBenchmarkIdGet GET /farms/{farmId}/benchmarks/{benchmarkId} Benchmark info
BenchmarksApi farmsFarmIdBenchmarksDelete DELETE /farms/{farmId}/benchmarks Delete multiple benchmarks
BenchmarksApi farmsFarmIdBenchmarksGet GET /farms/{farmId}/benchmarks Get executed benchmarks
BenchmarksApi farmsFarmIdBenchmarksJobsGet GET /farms/{farmId}/benchmarks/jobs Get available bechmark jobs (algos) that can be run.
BenchmarksApi farmsFarmIdBenchmarksPost POST /farms/{farmId}/benchmarks Start new benchmark
CommonApi searchGet GET /search Search farms, workers, etc.
ContainersApi farmsFarmIdContainersContainerIdDelete DELETE /farms/{farmId}/containers/{containerId} Delete container
ContainersApi farmsFarmIdContainersContainerIdGet GET /farms/{farmId}/containers/{containerId} Container info
ContainersApi farmsFarmIdContainersContainerIdPatch PATCH /farms/{farmId}/containers/{containerId} Edit container
ContainersApi farmsFarmIdContainersDelete DELETE /farms/{farmId}/containers Delete multiple containers
ContainersApi farmsFarmIdContainersGet GET /farms/{farmId}/containers Farm containers list
ContainersApi farmsFarmIdContainersPost POST /farms/{farmId}/containers Create new container
FarmsApi farmsDelete DELETE /farms Delete multiple farms
FarmsApi farmsFarmIdConfigsConfigGet GET /farms/{farmId}/configs/{config} Get configuration file for farm
FarmsApi farmsFarmIdConfigsGet GET /farms/{farmId}/configs Get configuration files for farm
FarmsApi farmsFarmIdDelete DELETE /farms/{farmId} Delete farm
FarmsApi farmsFarmIdDepositAddressGet GET /farms/{farmId}/deposit/address Get list of generated payment addresses
FarmsApi farmsFarmIdDepositAddressPost POST /farms/{farmId}/deposit/address Generate payment address for deposits
FarmsApi farmsFarmIdDepositPost POST /farms/{farmId}/deposit Make deposit to the farm from account balance
FarmsApi farmsFarmIdEventsGet GET /farms/{farmId}/events Farm events
FarmsApi farmsFarmIdGet GET /farms/{farmId} Farm info
FarmsApi farmsFarmIdInvoiceGet GET /farms/{farmId}/invoice Generate invoice for specified period
FarmsApi farmsFarmIdMetricsGet GET /farms/{farmId}/metrics Farm metrics
FarmsApi farmsFarmIdNotificationsGet GET /farms/{farmId}/notifications Get notifications settings
FarmsApi farmsFarmIdNotificationsPatch PATCH /farms/{farmId}/notifications Update notifications settings
FarmsApi farmsFarmIdPatch PATCH /farms/{farmId} Edit farm
FarmsApi farmsFarmIdPayerDelete DELETE /farms/{farmId}/payer Unassign farm payer and restore default value
FarmsApi farmsFarmIdPersonalSettingsPatch PATCH /farms/{farmId}/personal_settings Update personal settings for the farm
FarmsApi farmsFarmIdPowerReportGet GET /farms/{farmId}/power_report Generate report about power consumption for specified period
FarmsApi farmsFarmIdSendMoneyPost POST /farms/{farmId}/send_money Send money to user
FarmsApi farmsFarmIdStatsGet GET /farms/{farmId}/stats Farm stats
FarmsApi farmsFarmIdTransactionsGet GET /farms/{farmId}/transactions Transactions history
FarmsApi farmsFarmIdTransferDelete DELETE /farms/{farmId}/transfer Cancel farm transfer request
FarmsApi farmsFarmIdTransferGet GET /farms/{farmId}/transfer Get active farm transfer request
FarmsApi farmsFarmIdTransferPost POST /farms/{farmId}/transfer Create farm transfer request
FarmsApi farmsGet GET /farms List of accessed farms
FarmsApi farmsIncomingConfirmPost POST /farms/incoming/confirm Confirm transfer request
FarmsApi farmsIncomingGet GET /farms/incoming Get incoming farm transfer requests
FarmsApi farmsIncomingRejectPost POST /farms/incoming/reject Reject transfer request
FarmsApi farmsPost POST /farms Create new farm
FarmsApi farmsTransfersGet GET /farms/transfers Get active transfers requests of all available farms
FsApi farmsFarmIdFsDelete DELETE /farms/{farmId}/fs Delete multiple flight sheets
FsApi farmsFarmIdFsFsIdDelete DELETE /farms/{farmId}/fs/{fsId} Delete flight sheet
FsApi farmsFarmIdFsFsIdGet GET /farms/{farmId}/fs/{fsId} Flight sheet info
FsApi farmsFarmIdFsFsIdPatch PATCH /farms/{farmId}/fs/{fsId} Edit flight sheet
FsApi farmsFarmIdFsGet GET /farms/{farmId}/fs Flight sheets list
FsApi farmsFarmIdFsPost POST /farms/{farmId}/fs Create new flight sheet
FsApi fsDelete DELETE /fs Delete multiple flight sheets
FsApi fsFsIdDelete DELETE /fs/{fsId} Delete flight sheet
FsApi fsFsIdGet GET /fs/{fsId} Flight sheet info
FsApi fsFsIdPatch PATCH /fs/{fsId} Edit flight sheet
FsApi fsGet GET /fs Flight sheets list
FsApi fsPost POST /fs Create new flight sheet
HiveApi hiveAlgosGet GET /hive/algos List of available algorithms
HiveApi hiveAsicFirmwaresGet GET /hive/asic_firmwares Get ASIC firmwares list
HiveApi hiveCoinsGet GET /hive/coins List of available coins
HiveApi hiveCurrenciesGet GET /hive/currencies Get list of currencies that are used in deposits and referral payments.
HiveApi hiveDepositAddressProvidersGet GET /hive/deposit_address_providers Get list of deposit address providers with options.
HiveApi hiveMinersGet GET /hive/miners List of available miners
HiveApi hiveMirrorUrlsGet GET /hive/mirror_urls List of mirror URLs
HiveApi hiveNotificationChannelsGet GET /hive/notification_channels Get list of supported notification channels
HiveApi hiveOverclocksGet GET /hive/overclocks Get popular overclock settings for different GPUs and algos. Result is sorted by rating.
HiveApi hivePricingGet GET /hive/pricing Get pricing information
HiveApi hiveStatsGet GET /hive/stats Get Hive statistics
HiveApi hiveVersionsGet GET /hive/versions Hive or Asic Hub changelog
HiveApi hiveVersionsSystemTypeVersionGet GET /hive/versions/{systemType}/{version} Hive version info
HiveApi hiveWalletSourcesGet GET /hive/wallet_sources List of supported wallet sources
KeysApi farmsFarmIdKeysDelete DELETE /farms/{farmId}/keys Delete multiple API keys
KeysApi farmsFarmIdKeysGet GET /farms/{farmId}/keys Get list of attached API keys
KeysApi farmsFarmIdKeysKeyIdDelete DELETE /farms/{farmId}/keys/{keyId} Detach API key
KeysApi farmsFarmIdKeysKeyIdGet GET /farms/{farmId}/keys/{keyId} Get attached API key info
KeysApi farmsFarmIdKeysKeyIdPatch PATCH /farms/{farmId}/keys/{keyId} Edit attached API key
KeysApi farmsFarmIdKeysPost POST /farms/{farmId}/keys Attach new API key
KeysApi keysDelete DELETE /keys Delete multiple API keys
KeysApi keysGet GET /keys Get list of attached API keys
KeysApi keysKeyIdDelete DELETE /keys/{keyId} Detach API key
KeysApi keysKeyIdGet GET /keys/{keyId} Get attached API key info
KeysApi keysKeyIdPatch PATCH /keys/{keyId} Edit attached API key
KeysApi keysPost POST /keys Attach new API key
OcApi farmsFarmIdOcDelete DELETE /farms/{farmId}/oc Delete multiple OC profiles
OcApi farmsFarmIdOcGet GET /farms/{farmId}/oc Farm OC list
OcApi farmsFarmIdOcOcIdDelete DELETE /farms/{farmId}/oc/{ocId} Delete OC
OcApi farmsFarmIdOcOcIdGet GET /farms/{farmId}/oc/{ocId} OC info
OcApi farmsFarmIdOcOcIdPatch PATCH /farms/{farmId}/oc/{ocId} Edit OC
OcApi farmsFarmIdOcPost POST /farms/{farmId}/oc Create new OC
OcApi ocDelete DELETE /oc Delete multiple OC profiles
OcApi ocGet GET /oc OC list
OcApi ocOcIdDelete DELETE /oc/{ocId} Delete OC
OcApi ocOcIdGet GET /oc/{ocId} OC info
OcApi ocOcIdPatch PATCH /oc/{ocId} Edit OC
OcApi ocPost POST /oc Create new OC
PoolsApi poolsByCoinCoinGet GET /pools/by_coin/{coin} Pool templates which suit coin name
PoolsApi poolsByNamePoolGet GET /pools/by_name/{pool} Pool templates
PoolsApi poolsGet GET /pools Available pools list and coins that we have in pools
RomsApi farmsFarmIdRomsDelete DELETE /farms/{farmId}/roms Delete multiple ROMs
RomsApi farmsFarmIdRomsGet GET /farms/{farmId}/roms ROMs list
RomsApi farmsFarmIdRomsPost POST /farms/{farmId}/roms Create new ROM
RomsApi farmsFarmIdRomsRomIdDelete DELETE /farms/{farmId}/roms/{romId} Delete ROM
RomsApi farmsFarmIdRomsRomIdGet GET /farms/{farmId}/roms/{romId} Get ROM with contents
RomsApi farmsFarmIdRomsRomIdPatch PATCH /farms/{farmId}/roms/{romId} Edit ROM
RomsApi romsDelete DELETE /roms Delete multiple ROMs
RomsApi romsGet GET /roms ROMs list
RomsApi romsPost POST /roms Create new ROM
RomsApi romsRomIdDelete DELETE /roms/{romId} Delete ROM
RomsApi romsRomIdGet GET /roms/{romId} Get ROM with contents
RomsApi romsRomIdPatch PATCH /roms/{romId} Edit ROM
SchedulesApi farmsFarmIdSchedulesDelete DELETE /farms/{farmId}/schedules Delete multiple Schedules
SchedulesApi farmsFarmIdSchedulesGet GET /farms/{farmId}/schedules Schedules list
SchedulesApi farmsFarmIdSchedulesPost POST /farms/{farmId}/schedules Create new Schedule
SchedulesApi farmsFarmIdSchedulesScheduleIdDelete DELETE /farms/{farmId}/schedules/{scheduleId} Delete Schedule
SchedulesApi farmsFarmIdSchedulesScheduleIdGet GET /farms/{farmId}/schedules/{scheduleId} Get Schedule
SchedulesApi farmsFarmIdSchedulesScheduleIdPatch PATCH /farms/{farmId}/schedules/{scheduleId} Edit Schedule
SchedulesApi schedulesDelete DELETE /schedules Delete multiple Schedules
SchedulesApi schedulesGet GET /schedules Schedules list
SchedulesApi schedulesPost POST /schedules Create new Schedule
SchedulesApi schedulesScheduleIdDelete DELETE /schedules/{scheduleId} Delete Schedule
SchedulesApi schedulesScheduleIdGet GET /schedules/{scheduleId} Get Schedule
SchedulesApi schedulesScheduleIdPatch PATCH /schedules/{scheduleId} Edit Schedule
TagsApi farmsFarmIdTagsDelete DELETE /farms/{farmId}/tags Delete multiple tags
TagsApi farmsFarmIdTagsGet GET /farms/{farmId}/tags Tags list
TagsApi farmsFarmIdTagsMultiPost POST /farms/{farmId}/tags/multi Create multiple tags
TagsApi farmsFarmIdTagsPatch PATCH /farms/{farmId}/tags Edit multiple tags
TagsApi farmsFarmIdTagsPost POST /farms/{farmId}/tags Create new tag
TagsApi farmsFarmIdTagsTagIdDelete DELETE /farms/{farmId}/tags/{tagId} Delete tag
TagsApi farmsFarmIdTagsTagIdGet GET /farms/{farmId}/tags/{tagId} Tag info
TagsApi farmsFarmIdTagsTagIdPatch PATCH /farms/{farmId}/tags/{tagId} Edit tag
TagsApi tagsDelete DELETE /tags Delete multiple tags
TagsApi tagsGet GET /tags Tags list
TagsApi tagsMultiPost POST /tags/multi Create multiple tags
TagsApi tagsPatch PATCH /tags Edit multiple tags
TagsApi tagsPost POST /tags Create new tag
TagsApi tagsTagIdDelete DELETE /tags/{tagId} Delete tag
TagsApi tagsTagIdGet GET /tags/{tagId} Tag info
TagsApi tagsTagIdPatch PATCH /tags/{tagId} Edit tag
WalletsApi farmsFarmIdWalletsDelete DELETE /farms/{farmId}/wallets Delete multiple wallets
WalletsApi farmsFarmIdWalletsGet GET /farms/{farmId}/wallets Wallets list
WalletsApi farmsFarmIdWalletsPost POST /farms/{farmId}/wallets Create new wallet
WalletsApi farmsFarmIdWalletsWalletIdDelete DELETE /farms/{farmId}/wallets/{walletId} Delete wallet
WalletsApi farmsFarmIdWalletsWalletIdGet GET /farms/{farmId}/wallets/{walletId} Wallet info
WalletsApi farmsFarmIdWalletsWalletIdPatch PATCH /farms/{farmId}/wallets/{walletId} Edit wallet
WalletsApi walletsDelete DELETE /wallets Delete multiple wallets
WalletsApi walletsGet GET /wallets Wallets list
WalletsApi walletsPost POST /wallets Create new wallet
WalletsApi walletsWalletIdDelete DELETE /wallets/{walletId} Delete wallet
WalletsApi walletsWalletIdGet GET /wallets/{walletId} Wallet info
WalletsApi walletsWalletIdPatch PATCH /wallets/{walletId} Edit wallet
WorkersApi farmsFarmIdWorkersCommandAmdUploadPost POST /farms/{farmId}/workers/command/amd_upload Extended version of &quot;amd_upload&quot; command
WorkersApi farmsFarmIdWorkersCommandNvidiaUploadPost POST /farms/{farmId}/workers/command/nvidia_upload Extended version of &quot;nvidia_upload&quot; command
WorkersApi farmsFarmIdWorkersCommandPost POST /farms/{farmId}/workers/command Execute command on multiple workers
WorkersApi farmsFarmIdWorkersDelete DELETE /farms/{farmId}/workers Delete multiple workers
WorkersApi farmsFarmIdWorkersFiltersGet GET /farms/{farmId}/workers/filters Available values for filters that are used in worker and GPU lists
WorkersApi farmsFarmIdWorkersFixAutoTagsPost POST /farms/{farmId}/workers/fix_auto_tags Synchronize auto-tags of all workers of the farm
WorkersApi farmsFarmIdWorkersGet GET /farms/{farmId}/workers Farm workers list
WorkersApi farmsFarmIdWorkersGpusGet GET /farms/{farmId}/workers/gpus Farm workers GPUs list
WorkersApi farmsFarmIdWorkersMessagesDelete DELETE /farms/{farmId}/workers/messages Delete all messages of all or provided workers
WorkersApi farmsFarmIdWorkersMessagesGet GET /farms/{farmId}/workers/messages Farm workers messages list
WorkersApi farmsFarmIdWorkersMultiPatch PATCH /farms/{farmId}/workers/multi Edit multiple workers
WorkersApi farmsFarmIdWorkersMultiPost POST /farms/{farmId}/workers/multi Create multiple workers
WorkersApi farmsFarmIdWorkersOverclockPost POST /farms/{farmId}/workers/overclock Extended overclocking
WorkersApi farmsFarmIdWorkersPatch PATCH /farms/{farmId}/workers Edit multiple workers at once
WorkersApi farmsFarmIdWorkersPost POST /farms/{farmId}/workers Create new worker
WorkersApi farmsFarmIdWorkersPreviewGet GET /farms/{farmId}/workers/preview Preview all workers of the farm
WorkersApi farmsFarmIdWorkersReloadPost POST /farms/{farmId}/workers/reload Reload multiple workers
WorkersApi farmsFarmIdWorkersTransferPost POST /farms/{farmId}/workers/transfer Transfer multiple workers to another farm
WorkersApi farmsFarmIdWorkersWorkerIdCommandPost POST /farms/{farmId}/workers/{workerId}/command Execute command
WorkersApi farmsFarmIdWorkersWorkerIdConfigsConfigGet GET /farms/{farmId}/workers/{workerId}/configs/{config} Get configuration file for worker
WorkersApi farmsFarmIdWorkersWorkerIdConfigsGet GET /farms/{farmId}/workers/{workerId}/configs Get configuration files for worker
WorkersApi farmsFarmIdWorkersWorkerIdDelete DELETE /farms/{farmId}/workers/{workerId} Delete worker
WorkersApi farmsFarmIdWorkersWorkerIdFixAutoTagsPost POST /farms/{farmId}/workers/{workerId}/fix_auto_tags Synchronize auto-tags of the worker
WorkersApi farmsFarmIdWorkersWorkerIdGet GET /farms/{farmId}/workers/{workerId} Worker info
WorkersApi farmsFarmIdWorkersWorkerIdMessagesDelete DELETE /farms/{farmId}/workers/{workerId}/messages Delete all worker messages
WorkersApi farmsFarmIdWorkersWorkerIdMessagesGet GET /farms/{farmId}/workers/{workerId}/messages Worker messages
WorkersApi farmsFarmIdWorkersWorkerIdMessagesMessageIdDelete DELETE /farms/{farmId}/workers/{workerId}/messages/{messageId} Delete message
WorkersApi farmsFarmIdWorkersWorkerIdMessagesMessageIdGet GET /farms/{farmId}/workers/{workerId}/messages/{messageId} Get worker message
WorkersApi farmsFarmIdWorkersWorkerIdMetricsGet GET /farms/{farmId}/workers/{workerId}/metrics Worker metrics
WorkersApi farmsFarmIdWorkersWorkerIdPasswordPut PUT /farms/{farmId}/workers/{workerId}/password Update worker password
WorkersApi farmsFarmIdWorkersWorkerIdPatch PATCH /farms/{farmId}/workers/{workerId} Edit worker
WorkersApi farmsFarmIdWorkersWorkerIdPersonalSettingsPatch PATCH /farms/{farmId}/workers/{workerId}/personal_settings Update personal settings for the worker
WorkersApi farmsFarmIdWorkersWorkerIdReloadPost POST /farms/{farmId}/workers/{workerId}/reload Reload worker
WorkersApi farmsFarmIdWorkersWorkerIdTransferPost POST /farms/{farmId}/workers/{workerId}/transfer Transfer worker to another farm

Documentation For Models

Documentation For Authorization

ApiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

SecurityCode

  • Type: API key
  • API key parameter name: X-Security-Code
  • Location: HTTP header

Author

[email protected]

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

2 stars

Watchers

1 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages