Skip to main content

SwaggerClient-php

This is the API for the Estuary application.

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

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_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@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: bearerAuth
$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');

$apiInstance = new Swagger\Client\Api\AdminApi(
// 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 = array(new \Swagger\Client\Model\string[]()); // string[] | Peer ids

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

?>

Documentation for API Endpoints

All URIs are relative to https://api.estuary.tech

ClassMethodHTTP requestDescription
AdminApiadminPeeringPeersDeleteDELETE /admin/peering/peersRemove peers on Peering Service
AdminApiadminPeeringPeersGetGET /admin/peering/peersList all Peering peers
AdminApiadminPeeringPeersPostPOST /admin/peering/peersAdd peers on Peering Service
AdminApiadminPeeringStartPostPOST /admin/peering/startStart Peering
AdminApiadminPeeringStatusGetGET /admin/peering/statusCheck Peering Status
AdminApiadminPeeringStopPostPOST /admin/peering/stopStop Peering
AdminApiadminSystemConfigGetGET /admin/system/configGet systems(estuary/shuttle) config
AdminApiadminUsersGetGET /admin/usersGet all users
AutoretrieveApiadminAutoretrieveInitPostPOST /admin/autoretrieve/initRegister autoretrieve server
AutoretrieveApiadminAutoretrieveListGetGET /admin/autoretrieve/listList autoretrieve servers
AutoretrieveApiautoretrieveHeartbeatPostPOST /autoretrieve/heartbeatMarks autoretrieve server as up
CollectionsApicollectionsColuuidCommitPostPOST /collections/{coluuid}/commitProduce a CID of the collection contents
CollectionsApicollectionsColuuidContentsDeleteDELETE /collections/{coluuid}/contentsDeletes a content from a collection
CollectionsApicollectionsColuuidDeleteDELETE /collections/{coluuid}Deletes a collection
CollectionsApicollectionsColuuidGetGET /collections/{coluuid}Get contents in a collection
CollectionsApicollectionsColuuidPostPOST /collections/{coluuid}Add contents to a collection
CollectionsApicollectionsFsAddPostPOST /collections/fs/addAdd a file to a collection
CollectionsApicollectionsGetGET /collections/List all collections
CollectionsApicollectionsPostPOST /collections/Create a new collection
ContentApicontentAddCarPostPOST /content/add-carAdd Car object
ContentApicontentAddIpfsPostPOST /content/add-ipfsAdd IPFS object
ContentApicontentAddPostPOST /content/addAdd new content
ContentApicontentAggregatedContentGetGET /content/aggregated/{content}Get aggregated content stats
ContentApicontentAllDealsGetGET /content/all-dealsGet all deals for a user
ContentApicontentBwUsageContentGetGET /content/bw-usage/{content}Get content bandwidth
ContentApicontentCreatePostPOST /content/createAdd a new content
ContentApicontentDealsGetGET /content/dealsContent with deals
ContentApicontentEnsureReplicationDatacidGetGET /content/ensure-replication/{datacid}Ensure Replication
ContentApicontentFailuresContentGetGET /content/failures/{content}List all failures for a content
ContentApicontentIdGetGET /content/{id}Content
ContentApicontentImportdealPostPOST /content/importdealImport a deal
ContentApicontentListGetGET /content/listList all pinned content
ContentApicontentReadContGetGET /content/read/{cont}Read content
ContentApicontentStagingZonesGetGET /content/staging-zonesGet staging zone for user
ContentApicontentStatsGetGET /content/statsGet content statistics
ContentApicontentStatusIdGetGET /content/status/{id}Content Status
DealsApidealEstimatePostPOST /deal/estimateEstimate the cost of a deal
DealsApidealInfoDealidGetGET /deal/info/{dealid}Get Deal Info
DealsApidealProposalPropcidGetGET /deal/proposal/{propcid}Get Proposal
DealsApidealQueryMinerGetGET /deal/query/{miner}Query Ask
DealsApidealStatusByProposalPropcidGetGET /deal/status-by-proposal/{propcid}Get Deal Status by PropCid
DealsApidealStatusMinerPropcidGetGET /deal/status/{miner}/{propcid}Deal Status
DealsApidealTransferInProgressGetGET /deal/transfer/in-progressTransfer In Progress
DealsApidealsFailuresGetGET /deals/failuresGet storage failures for user
DealsApidealsMakeMinerPostPOST /deals/make/{miner}Make Deal
DealsApidealsStatusDealGetGET /deals/status/{deal}Get Deal Status
DealsApipublicDealsFailuresGetGET /public/deals/failuresGet storage failures
DealsApipublicMinersStorageQueryMinerGetGET /public/miners/storage/query/{miner}Query Ask
DefaultApidealTransferStatusPostPOST /deal/transfer/status
MetricsApipublicMetricsDealsOnChainGetGET /public/metrics/deals-on-chainGet deal metrics
MinerApipublicMinersDealsMinerGetGET /public/miners/deals/{miner}Get all miners deals
MinerApipublicMinersStatsMinerGetGET /public/miners/stats/{miner}Get miner stats
NetApinetAddrsGetGET /net/addrsNet Addrs
NetApipublicMinersFailuresMinerGetGET /public/miners/failures/{miner}Get all miners
NetApipublicMinersGetGET /public/minersGet all miners
NetApipublicNetAddrsGetGET /public/net/addrsNet Addrs
NetApipublicNetPeersGetGET /public/net/peersNet Peers
PeeringApiadminPeeringPeersDeleteDELETE /admin/peering/peersRemove peers on Peering Service
PeeringApiadminPeeringPeersGetGET /admin/peering/peersList all Peering peers
PeeringApiadminPeeringPeersPostPOST /admin/peering/peersAdd peers on Peering Service
PeeringApiadminPeeringStartPostPOST /admin/peering/startStart Peering
PeeringApiadminPeeringStatusGetGET /admin/peering/statusCheck Peering Status
PeeringApiadminPeeringStopPostPOST /admin/peering/stopStop Peering
PeersApiadminPeeringPeersDeleteDELETE /admin/peering/peersRemove peers on Peering Service
PeersApiadminPeeringPeersGetGET /admin/peering/peersList all Peering peers
PeersApiadminPeeringPeersPostPOST /admin/peering/peersAdd peers on Peering Service
PeersApiadminPeeringStartPostPOST /admin/peering/startStart Peering
PeersApiadminPeeringStatusGetGET /admin/peering/statusCheck Peering Status
PeersApiadminPeeringStopPostPOST /admin/peering/stopStop Peering
PinningApipinningPinsGetGET /pinning/pinsList all pin status objects
PinningApipinningPinsPinidDeleteDELETE /pinning/pins/{pinid}Delete a pinned object
PinningApipinningPinsPinidGetGET /pinning/pins/{pinid}Get a pin status object
PinningApipinningPinsPinidPostPOST /pinning/pins/{pinid}Replace a pinned object
PinningApipinningPinsPostPOST /pinning/pinsAdd and pin object
PublicApipublicByCidCidGetGET /public/by-cid/{cid}Get Content by Cid
PublicApipublicInfoGetGET /public/infoGet public node info
PublicApipublicMetricsDealsOnChainGetGET /public/metrics/deals-on-chainGet deal metrics
PublicApipublicMinersDealsMinerGetGET /public/miners/deals/{miner}Get all miners deals
PublicApipublicMinersFailuresMinerGetGET /public/miners/failures/{miner}Get all miners
PublicApipublicMinersGetGET /public/minersGet all miners
PublicApipublicMinersStatsMinerGetGET /public/miners/stats/{miner}Get miner stats
PublicApipublicNetAddrsGetGET /public/net/addrsNet Addrs
PublicApipublicNetPeersGetGET /public/net/peersNet Peers
PublicApipublicStatsGetGET /public/statsPublic stats
UserApiuserApiKeysGetGET /user/api-keysGet API keys for a user
UserApiuserApiKeysKeyDeleteDELETE /user/api-keys/{key}Revoke a User API Key.
UserApiuserApiKeysPostPOST /user/api-keysCreate API keys for a user
UserApiuserExportGetGET /user/exportExport user data
UserApiuserStatsGetGET /user/statsCreate API keys for a user

Documentation For Models

Documentation For Authorization

bearerAuth

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

Author