README

The Nodeum API makes it easy to tap into the digital data mesh that runs across your organisation. Make requests to our API endpoints and we’ll give you everything you need to interconnect your business workflows with your storage.

All production API requests are made to:

http://nodeumhostname/api/

The current production version of the API is v1.

REST The Nodeum API is a RESTful API. This means that the API is designed to allow you to get, create, update, & delete objects with the HTTP verbs GET, POST, PUT, PATCH, & DELETE.

JSON The Nodeum API speaks exclusively in JSON. This means that you should always set the Content-Type header to application/json to ensure that your requests are properly accepted and processed by the API.

Authentication All API calls require user-password authentication.

Cross-Origin Resource Sharing The Nodeum API supports CORS for communicating from Javascript for these endpoints. You will need to specify an Origin URI when creating your application to allow for CORS to be whitelisted for your domain.

Pagination Some endpoints such as File Listing return a potentially lengthy array of objects. In order to keep the response sizes manageable the API will take advantage of pagination. Pagination is a mechanism for returning a subset of the results for a request and allowing for subsequent requests to “page” through the rest of the results until the end is reached. Paginated endpoints follow a standard interface that accepts two query parameters, limit and offset, and return a payload that follows a standard form. These parameters names and their behavior are borrowed from SQL LIMIT and OFFSET keywords.

Versioning The Nodeum API is constantly being worked on to add features, make improvements, and fix bugs. This means that you should expect changes to be introduced and documented.

However, there are some changes or additions that are considered backwards-compatible and your applications should be flexible enough to handle them. These include:

Adding new endpoints to the API
Adding new attributes to the response of an existing endpoint
Changing the order of attributes of responses (JSON by definition is an object of unordered key/value pairs)

Filter parameters When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix:

= value is equal. Default operator, may be omitted
!= value is different
> greater than
>= greater than or equal
< lower than
>= lower than or equal
>< included in list, items should be separated by |
!>< not included in list, items should be separated by |
~ pattern matching, may include % (any characters) and _ (one character)
!~ pattern not matching, may include % (any characters) and _ (one character)

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.1.0
Package version: 1.88.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen For more information, please visit https://www.nodeum.io/

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/nodeum-io/nodeum-sdk-php.git"
    }
  ],
  "require": {
    "nodeum-io/nodeum-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/NodeumSDK/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 HTTP basic authorization: BasicAuth
$config = NodeumSDK\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

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


$apiInstance = new NodeumSDK\Client\Api\CloudBucketsApi(
    // 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
);
$limit = 56; // int | The number of items to display for pagination.
$offset = 56; // int | The number of items to skip for pagination.
$sort_by = array('sort_by_example'); // string[] | Sort results by attribute.  Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
$id = 'id_example'; // string | Filter on id
$cloud_connector_id = 'cloud_connector_id_example'; // string | Filter on cloud connector id
$pool_id = 'pool_id_example'; // string | Filter on a pool id
$name = 'name_example'; // string | Filter on name
$location = 'location_example'; // string | Filter on location
$price = 'price_example'; // string | Filter on price

try {
    $result = $apiInstance->indexCloudBuckets($limit, $offset, $sort_by, $id, $cloud_connector_id, $pool_id, $name, $location, $price);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudBucketsApi->indexCloudBuckets: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v2

Class	Method	HTTP request	Description
CloudBucketsApi	indexCloudBuckets	GET /cloud_buckets	Lists all cloud buckets.
CloudBucketsApi	indexCloudBucketsByCloudConnector	GET /cloud_connectors/{cloud_connector_id}/cloud_buckets	Lists all cloud buckets.
CloudBucketsApi	indexCloudBucketsByPool	GET /pools/{pool_id}/cloud_buckets	Lists all cloud buckets from pool.
CloudBucketsApi	mountStatusCloudBucket	GET /cloud_buckets/{cloud_bucket_id}/mount	Get mount status of Cloud bucket.
CloudBucketsApi	mountStatusCloudBucketByCloudConnector	GET /cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}/mount	Get mount status of Cloud bucket.
CloudBucketsApi	mountStatusCloudBucketByPool	GET /pools/{pool_id}/cloud_buckets/{cloud_bucket_id}/mount	Get mount status of Cloud bucket.
CloudBucketsApi	showCloudBucket	GET /cloud_buckets/{cloud_bucket_id}	Displays a specific cloud bucket.
CloudBucketsApi	showCloudBucketByCloudConnector	GET /cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}	Displays a specific cloud bucket.
CloudBucketsApi	showCloudBucketByPool	GET /pools/{pool_id}/cloud_buckets/{cloud_bucket_id}	Displays a specific cloud bucket.
CloudBucketsApi	syncCloudBuckets	PUT /cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync	Synchronize internal cloud buckets with their remote equivalent.
CloudBucketsApi	syncResultCloudBuckets	GET /cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync	Check result of cloud connector sync job.
CloudBucketsApi	updateCloudBucket	PUT /cloud_buckets/{cloud_bucket_id}	Updates a specific cloud bucket.
CloudBucketsApi	updateCloudBucketByCloudConnector	PUT /cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}	Updates a specific cloud bucket.
CloudBucketsApi	updateCloudBucketByPool	PUT /pools/{pool_id}/cloud_buckets/{cloud_bucket_id}	Updates a specific cloud bucket.
CloudBucketsApi	updateConfigFileCloudBucket	PUT /cloud_buckets/{cloud_bucket_id}/config_file	Updates a specific cloud bucket.
CloudConnectorsApi	createCloudConnector	POST /cloud_connectors	Creates a new cloud connector.
CloudConnectorsApi	destroyCloudConnector	DELETE /cloud_connectors/{cloud_connector_id}	Destroys a specific cloud connector.
CloudConnectorsApi	indexCloudConnectors	GET /cloud_connectors	Lists all cloud connectors.
CloudConnectorsApi	showCloudConnector	GET /cloud_connectors/{cloud_connector_id}	Displays a specific cloud connector.
CloudConnectorsApi	testCloudConnector	PUT /cloud_connectors/-/test	Test an unsaved cloud connector.
CloudConnectorsApi	testResultCloudConnector	GET /cloud_connectors/-/test	Check result of cloud connector test job.
CloudConnectorsApi	updateCloudConnector	PUT /cloud_connectors/{cloud_connector_id}	Updates a specific cloud connector.
ContainersApi	createContainer	POST /containers	Creates a new container.
ContainersApi	createContainerPrivilege	POST /containers/{container_id}/container_privileges	Creates a new privilege on the container.
ContainersApi	destroyContainer	DELETE /containers/{container_id}	Destroys a specific container.
ContainersApi	destroyContainerPrivilege	DELETE /containers/{container_id}/container_privileges/{container_privilege_id}	Destroys a specific privilege.
ContainersApi	indexContainerPrivileges	GET /containers/{container_id}/container_privileges	Lists all privilege on the container.
ContainersApi	indexContainers	GET /containers	Lists all containers.
ContainersApi	showContainer	GET /containers/{container_id}	Displays a specific container.
ContainersApi	showContainerPrivilege	GET /containers/{container_id}/container_privileges/{container_privilege_id}	Displays a specific privilege.
ContainersApi	updateContainer	PUT /containers/{container_id}	Updates a specific container.
ContainersApi	updateContainerPrivilege	PUT /containers/{container_id}/container_privileges/{container_privilege_id}	Updates a specific privilege.
FilesApi	filesChildren	GET /files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	filesChildrenByContainer	GET /containers/{container_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	filesChildrenByPool	GET /pools/{pool_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	filesChildrenByTask	GET /tasks/{task_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	filesChildrenByTaskExecution	GET /task_executions/{task_execution_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	filesChildrenByTaskExecutionByTask	GET /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_parent_id}/children	Lists files under a specific folder.
FilesApi	importFilesChildrenByPool	GET /pools/{pool_id}/import_files/{file_parent_id}/children	Lists files under a specific folder on tape of pools, specific for Data Exchange.
FilesApi	indexFiles	GET /files	Lists files on root.
FilesApi	indexFilesByContainer	GET /containers/{container_id}/files	Lists files on root.
FilesApi	indexFilesByPool	GET /pools/{pool_id}/files	Lists files on root.
FilesApi	indexFilesByTask	GET /tasks/{task_id}/files	Lists files on root.
FilesApi	indexFilesByTaskExecution	GET /task_executions/{task_execution_id}/files	Lists files on root.
FilesApi	indexFilesByTaskExecutionByTask	GET /tasks/{task_id}/task_executions/{task_execution_id}/files	Lists files on root.
FilesApi	indexImportFilesByPool	GET /pools/{pool_id}/import_files	Lists files on root of tape of pools, specific for Data Exchange.
FilesApi	indexOnTapesFilesByPool	GET /pools/{pool_id}/on_tapes_files	Lists files on root of tape of pools, specific for Active and Offline.
FilesApi	indexTapesByFileByPool	GET /pools/{pool_id}/files/{file_id}/tapes	Displays tapes containing specific file, related to the specific pool.
FilesApi	indexTapesByFileByTask	GET /tasks/{task_id}/files/{file_id}/tapes	Displays tapes containing specific file, related to the specific task.
FilesApi	indexTapesByFileByTaskExecution	GET /task_executions/{task_execution_id}/files/{file_id}/tapes	Displays tapes containing specific file, related to the specific task.
FilesApi	indexTapesByFileByTaskExecutionByTask	GET /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}/tapes	Displays tapes containing specific file, related to the specific task.
FilesApi	onTapesFilesChildrenByPool	GET /pools/{pool_id}/on_tapes_files/{file_parent_id}/children	Lists files under a specific folder on tape of pools, specific for Active and Offline.
FilesApi	showFile	GET /files/{file_id}	Displays a specific file.
FilesApi	showFileByContainer	GET /containers/{container_id}/files/{file_id}	Displays a specific file.
FilesApi	showFileByPool	GET /pools/{pool_id}/files/{file_id}	Displays a specific file.
FilesApi	showFileByTask	GET /tasks/{task_id}/files/{file_id}	Displays a specific file.
FilesApi	showFileByTaskExecution	GET /task_executions/{task_execution_id}/files/{file_id}	Displays a specific file.
FilesApi	showFileByTaskExecutionByTask	GET /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}	Displays a specific file.
FilesApi	showImportFileByPool	GET /pools/{pool_id}/import_files/{file_id}	Displays a specific file on tape of pools, specific for Data Exchange.
FilesApi	showOnTapeFileByPool	GET /pools/{pool_id}/on_tapes_files/{file_id}	Displays a specific file on tape of pools, specific for Active and Offline.
MetadataApi	indexFileMetadataDefinitions	GET /file_metadata_definitions	List file metadata definitions
MetadataApi	indexTaskMetadataDefinitions	GET /task_metadata_definitions	List task metadata definitions
MetadataApi	showFileMetadataDefinition	GET /file_metadata_definitions/{metadata_definition_id}	Displays a specific task metadata definition.
MetadataApi	showTaskMetadataDefinition	GET /task_metadata_definitions/{metadata_definition_id}	Displays a specific task metadata definition.
MountsApi	indexMounts	GET /mounts	List all mounted storages.
NasApi	createNas	POST /nas	Creates a new NAS.
NasApi	destroyNas	DELETE /nas/{nas_id}	Destroys a specific NAS.
NasApi	indexNas	GET /nas	Lists all NAS.
NasApi	showNas	GET /nas/{nas_id}	Displays a specific NAS.
NasApi	updateNas	PUT /nas/{nas_id}	Updates a specific NAS.
NasSharesApi	createNasShareByNas	POST /nas/{nas_id}/nas_shares	Creates a new NAS share.
NasSharesApi	destroyNasShare	DELETE /nas_shares/{nas_share_id}	Destroys a specific NAS share.
NasSharesApi	destroyNasShareByNas	DELETE /nas/{nas_id}/nas_shares/{nas_share_id}	Destroys a specific NAS share.
NasSharesApi	destroyNasShareByPool	DELETE /pools/{pool_id}/nas_shares/{nas_share_id}	Destroys a specific NAS share.
NasSharesApi	indexNasShares	GET /nas_shares	Lists all NAS shares.
NasSharesApi	indexNasSharesByNas	GET /nas/{nas_id}/nas_shares	Lists all NAS shares.
NasSharesApi	indexNasSharesByPool	GET /pools/{pool_id}/nas_shares	Lists all NAS shares from pool.
NasSharesApi	mountStatusNasShare	GET /nas_shares/{nas_share_id}/mount	Get mount status of NAS Share.
NasSharesApi	mountStatusNasShareByNas	GET /nas/{nas_id}/nas_shares/{nas_share_id}/mount	Get mount status of NAS Share.
NasSharesApi	mountStatusNasShareByPool	GET /pools/{pool_id}/nas_shares/{nas_share_id}/mount	Get mount status of NAS Share.
NasSharesApi	showNasShare	GET /nas_shares/{nas_share_id}	Displays a specific NAS share.
NasSharesApi	showNasShareByNas	GET /nas/{nas_id}/nas_shares/{nas_share_id}	Displays a specific NAS share.
NasSharesApi	showNasShareByPool	GET /pools/{pool_id}/nas_shares/{nas_share_id}	Displays a specific NAS share.
NasSharesApi	testNasShare	PUT /nas/{nas_id}/nas_shares/-/test	Test an unsaved NAS Share.
NasSharesApi	testResultNasShare	GET /nas/{nas_id}/nas_shares/-/test	Check result of a NAS Share test job.
NasSharesApi	updateNasShare	PUT /nas_shares/{nas_share_id}	Updates a specific NAS share.
NasSharesApi	updateNasShareByNas	PUT /nas/{nas_id}/nas_shares/{nas_share_id}	Updates a specific NAS share.
NasSharesApi	updateNasShareByPool	PUT /pools/{pool_id}/nas_shares/{nas_share_id}	Updates a specific NAS share.
PoolsApi	createPool	POST /pools	Creates a new pool.
PoolsApi	createPrimaryScan	POST /pools/{pool_id}/primary_scan	Set a new primary pool scan option.
PoolsApi	destroyPool	DELETE /pools/{pool_id}	Destroys a specific tape pool.
PoolsApi	destroyPrimaryScan	DELETE /pools/{pool_id}/primary_scan	Disable the primary pool scan.
PoolsApi	indexPools	GET /pools	Lists all pools.
PoolsApi	mountPool	PUT /pools/{pool_id}/mount	Mount Pool.
PoolsApi	mountStatusPool	GET /pools/{pool_id}/mount	Get mount status of Pool.
PoolsApi	showPool	GET /pools/{pool_id}	Displays a specific pool.
PoolsApi	showPrimaryScan	GET /pools/{pool_id}/primary_scan	Displays the primary pool scan status.
PoolsApi	syncPrimaryPool	POST /pools/{pool_id}/sync	Synchronize a primary after a scan (for internal use only).
PoolsApi	unmountPool	DELETE /pools/{pool_id}/mount	Unmount Pool.
PoolsApi	updatePool	PUT /pools/{pool_id}	Updates a specific pool.
PoolsApi	updatePrimaryScan	PUT /pools/{pool_id}/primary_scan	Updates the existing primary pool scan option.
StatisticsApi	statisticsByDate	GET /statistics/by_date	Get statistics about files, grouped by date
StatisticsApi	statisticsByFileExtension	GET /statistics/by_file_extension	Get statistics about files, grouped by file extension
StatisticsApi	statisticsByGroupOwner	GET /statistics/by_group_owner	Get statistics about files, grouped by owner (group)
StatisticsApi	statisticsByMetadata	GET /statistics/by_metadata	Get statistics about files, grouped by metadata
StatisticsApi	statisticsByPrimaryCloud	GET /statistics/by_primary_cloud	Get statistics about files, grouped by primary Cloud
StatisticsApi	statisticsByPrimaryName	GET /statistics/by_primary_name	Get statistics about files, grouped by primary storages
StatisticsApi	statisticsByPrimaryNas	GET /statistics/by_primary_nas	Get statistics about files, grouped by primary NAS
StatisticsApi	statisticsByPrimaryStorage	GET /statistics/by_primary_storage	Get statistics about files, grouped by primary storage
StatisticsApi	statisticsBySecondaryCloud	GET /statistics/by_secondary_cloud	Get statistics about files, grouped by secondary Cloud
StatisticsApi	statisticsBySecondaryNas	GET /statistics/by_secondary_nas	Get statistics about files, grouped by secondary NAS
StatisticsApi	statisticsBySecondaryStorage	GET /statistics/by_secondary_storage	Get statistics about files, grouped by secondary storage
StatisticsApi	statisticsBySecondaryTape	GET /statistics/by_secondary_tape	Get statistics about files, grouped by secondary Tape
StatisticsApi	statisticsBySize	GET /statistics/by_size	Get statistics about files, grouped by size
StatisticsApi	statisticsByUserOwner	GET /statistics/by_user_owner	Get statistics about files, grouped by owner (user)
StatisticsApi	statisticsStorage	GET /statistics/storage	Get statistics about storages, grouped by types
StatisticsApi	statisticsTaskByMetadata	GET /statistics/task_by_metadata	Get statistics about tasks executions, grouped by metadata
StatisticsApi	statisticsTaskByStatus	GET /statistics/task_by_status	Get statistics about tasks executions, grouped by status
StatisticsApi	statisticsTaskByStorage	GET /statistics/task_by_storage	Get statistics about tasks executions, grouped by source and destination
StatisticsApi	statisticsTaskByWorkflow	GET /statistics/task_by_workflow	Get statistics about tasks executions, grouped by workflow
SystemsApi	downloadResetVars	POST /systems/reset/generate_vars	Creates a YAML file with selected tables and downloads it
SystemsApi	resultDownloadTraces	GET /systems/download_traces	Check result of a download traces job.
SystemsApi	triggerDownloadTraces	PUT /systems/download_traces	Trigger a download traces request.
TapeDrivesApi	createTapeDriveByTapeLibrary	POST /tape_libraries/{tape_library_id}/tape_drives	Creates a new tape drive.
TapeDrivesApi	destroyTapeDrive	DELETE /tape_drives/{tape_drive_id}	Destroys a specific tape drive.
TapeDrivesApi	destroyTapeDriveByTapeLibrary	DELETE /tape_libraries/{tape_library_id}/tape_drives/{tape_drive_id}	Destroys a specific tape drive.
TapeDrivesApi	indexTapeDriveDevices	GET /tape_libraries/{tape_library_id}/tape_drives/-/devices	Lists tape drives devices.
TapeDrivesApi	indexTapeDrives	GET /tape_drives	Lists all tape drives.
TapeDrivesApi	indexTapeDrivesByTapeLibrary	GET /tape_libraries/{tape_library_id}/tape_drives	Lists all tape drives.
TapeDrivesApi	showTapeDrive	GET /tape_drives/{tape_drive_id}	Displays a specific tape drive.
TapeDrivesApi	showTapeDriveByTapeLibrary	GET /tape_libraries/{tape_library_id}/tape_drives/{tape_drive_id}	Displays a specific tape drive.
TapeDrivesApi	updateTapeDrive	PUT /tape_drives/{tape_drive_id}	Updates a specific tape drive.
TapeDrivesApi	updateTapeDriveByTapeLibrary	PUT /tape_libraries/{tape_library_id}/tape_drives/{tape_drive_id}	Updates a specific tape drive.
TapeLibrariesApi	createTapeLibrary	POST /tape_libraries	Creates a new tape library.
TapeLibrariesApi	destroyTapeLibrary	DELETE /tape_libraries/{tape_library_id}	Destroys a specific tape library.
TapeLibrariesApi	indexTapeLibraries	GET /tape_libraries	Lists all tape libraries.
TapeLibrariesApi	indexTapeLibraryDevices	GET /tape_libraries/-/devices	Lists tape libraries devices.
TapeLibrariesApi	showTapeLibrary	GET /tape_libraries/{tape_library_id}	Displays a specific tape library.
TapeLibrariesApi	updateTapeLibrary	PUT /tape_libraries/{tape_library_id}	Updates a specific tape library.
TapesApi	destroyTape	DELETE /tapes/{tape_id}	Destroys a specific tape. Only when it's an orphan.
TapesApi	indexTapeStats	GET /tape_stats	List all tape statistics.
TapesApi	indexTapes	GET /tapes	Lists all tapes.
TapesApi	indexTapesByPool	GET /pools/{pool_id}/tapes	Lists all tapes.
TapesApi	indexTapesByTapeLibrary	GET /tape_libraries/{tape_library_id}/tapes	Lists all tapes.
TapesApi	mountStatusTape	GET /tapes/{tape_id}/mount	Get mount status of Tape.
TapesApi	mountStatusTapeByPool	GET /pools/{pool_id}/tapes/{tape_id}/mount	Get mount status of Tape.
TapesApi	mountStatusTapeByTapeLibrary	GET /tape_libraries/{tape_library_id}/tapes/{tape_id}/mount	Get mount status of Tape.
TapesApi	showTape	GET /tapes/{tape_id}	Displays a specific tape.
TapesApi	showTapeByPool	GET /pools/{pool_id}/tapes/{tape_id}	Displays a specific tape.
TapesApi	showTapeByTapeLibrary	GET /tape_libraries/{tape_library_id}/tapes/{tape_id}	Displays a specific tape.
TapesApi	showTapeStat	GET /tapes/{tape_id}/tape_stat	Display statistic for a specific tape.
TapesApi	showTapeStatByPool	GET /pools/{pool_id}/tapes/{tape_id}/tape_stat	Display statistic for a specific tape.
TapesApi	showTapeStatByTapeLibrary	GET /tape_libraries/{tape_library_id}/tapes/{tape_id}/tape_stat	Display statistic for a specific tape.
TaskCallbacksApi	createTaskCallback	POST /tasks/{task_id}/task_callbacks	Creates a new task callback.
TaskCallbacksApi	destroyTaskCallback	DELETE /tasks/{task_id}/task_callbacks/{task_callback_id}	Destroys a specific task callback.
TaskCallbacksApi	indexTaskCallbacks	GET /tasks/{task_id}/task_callbacks	Lists all task callbacks.
TaskCallbacksApi	showTaskCallback	GET /tasks/{task_id}/task_callbacks/{task_callback_id}	Displays a specific task callback.
TaskCallbacksApi	updateTaskCallback	PUT /tasks/{task_id}/task_callbacks/{task_callback_id}	Updates a specific task callback.
TaskDestinationsApi	createTaskDestination	POST /tasks/{task_id}/task_destinations	Creates a new task destination.
TaskDestinationsApi	destroyTaskDestination	DELETE /tasks/{task_id}/task_destinations/{task_destination_id}	Destroys a specific task destination.
TaskDestinationsApi	indexTaskDestinations	GET /tasks/{task_id}/task_destinations	Lists all task destinations.
TaskDestinationsApi	showTaskDestination	GET /tasks/{task_id}/task_destinations/{task_destination_id}	Displays a specific task destination.
TaskDestinationsApi	updateTaskDestination	PUT /tasks/{task_id}/task_destinations/{task_destination_id}	Updates a specific task destination.
TaskExecutionsApi	indexTaskExecutions	GET /task_executions	Lists all task executions.
TaskExecutionsApi	indexTaskExecutionsByTask	GET /tasks/{task_id}/task_executions	Lists all task executions.
TaskExecutionsApi	showTaskExecution	GET /task_executions/{task_execution_id}	Displays a specific task execution.
TaskExecutionsApi	showTaskExecutionByTask	GET /tasks/{task_id}/task_executions/{task_execution_id}	Displays a specific task execution.
TaskMetadataApi	createTaskMetadatum	POST /tasks/{task_id}/task_metadata	Creates a new task metadatum.
TaskMetadataApi	destroyTaskMetadatum	DELETE /tasks/{task_id}/task_metadata/{task_metadatum_id}	Destroys a specific task metadatum.
TaskMetadataApi	indexTaskMetadata	GET /tasks/{task_id}/task_metadata	Lists all task metadata.
TaskMetadataApi	showTaskMetadatum	GET /tasks/{task_id}/task_metadata/{task_metadatum_id}	Displays a specific task metadatum.
TaskMetadataApi	updateTaskMetadatum	PUT /tasks/{task_id}/task_metadata/{task_metadatum_id}	Updates a specific task metadatum.
TaskOptionsApi	createTaskOption	POST /tasks/{task_id}/task_options	Creates a new task option.
TaskOptionsApi	destroyTaskOption	DELETE /tasks/{task_id}/task_options/{task_option_id}	Destroys a specific task option.
TaskOptionsApi	indexTaskOptions	GET /tasks/{task_id}/task_options	Lists all task options.
TaskOptionsApi	showTaskOption	GET /tasks/{task_id}/task_options/{task_option_id}	Displays a specific task option.
TaskOptionsApi	updateTaskOption	PUT /tasks/{task_id}/task_options/{task_option_id}	Updates a specific task option.
TaskSchedulesApi	createTaskSchedule	POST /tasks/{task_id}/task_schedule	Creates a new task schedule. Only one should be created.
TaskSchedulesApi	destroyTaskSchedule	DELETE /tasks/{task_id}/task_schedule	Destroys the task schedule.
TaskSchedulesApi	indexTaskSchedules	GET /task_schedules	Lists all task schedules.
TaskSchedulesApi	showTaskSchedule	GET /tasks/{task_id}/task_schedule	Displays the task schedule.
TaskSchedulesApi	updateTaskSchedule	PUT /tasks/{task_id}/task_schedule	Updates the existing task schedule.
TaskSourcesApi	createTaskSource	POST /tasks/{task_id}/task_sources	Creates a new task source.
TaskSourcesApi	destroyTaskSource	DELETE /tasks/{task_id}/task_sources/{task_source_id}	Destroys a specific task source.
TaskSourcesApi	indexTaskSources	GET /tasks/{task_id}/task_sources	Lists all task sources.
TaskSourcesApi	showTaskSource	GET /tasks/{task_id}/task_sources/{task_source_id}	Displays a specific task source.
TaskSourcesApi	updateTaskSource	PUT /tasks/{task_id}/task_sources/{task_source_id}	Updates a specific task source.
TasksApi	createTask	POST /tasks	Creates a new task.
TasksApi	destroyTask	DELETE /tasks/{task_id}	Destroys a specific task.
TasksApi	indexTasks	GET /tasks	Lists all tasks.
TasksApi	pauseTask	PUT /tasks/{task_id}/action/pause	Pause a task.
TasksApi	pauseTaskResult	GET /tasks/{task_id}/action/pause	Check result of a task pause request.
TasksApi	resumeTask	PUT /tasks/{task_id}/action/resume	Resume a task.
TasksApi	resumeTaskResult	GET /tasks/{task_id}/action/resume	Check result of a task resume request.
TasksApi	runTask	PUT /tasks/{task_id}/action/run	Run a task.
TasksApi	runTaskResult	GET /tasks/{task_id}/action/run	Check result of a task run request.
TasksApi	showTask	GET /tasks/{task_id}	Displays a specific task.
TasksApi	stopTask	PUT /tasks/{task_id}/action/stop	Stop a task.
TasksApi	stopTaskResult	GET /tasks/{task_id}/action/stop	Check result of a task stop request.
TasksApi	updateTask	PUT /tasks/{task_id}	Updates a specific task.
UsersApi	createApiKey	POST /users/me/api_keys	Creates a new API Key for current user.
UsersApi	createConfiguration	POST /users/me/configurations	Creates a new configuration value for current user.
UsersApi	destroyApiKey	DELETE /users/me/api_keys/{api_key_id}	Destroys a specific API Key.
UsersApi	destroyConfiguration	DELETE /users/me/configurations/{configuration_id}	Destroys a specific configuration value.
UsersApi	indexApiKeys	GET /users/me/api_keys	Lists all API keys of current user.
UsersApi	indexConfigurations	GET /users/me/configurations	Lists all configurations of current user.
UsersApi	indexSystemGroups	GET /groups/-/systems	List all system groups.
UsersApi	indexSystemUsers	GET /users/-/systems	List all system users.
UsersApi	showApiKey	GET /users/me/api_keys/{api_key_id}	Displays a specific API Key with its scopes.
UsersApi	showConfiguration	GET /users/me/configurations/{configuration_id}	Displays a specific configuration value.
UsersApi	updateApiKey	PUT /users/me/api_keys/{api_key_id}	Updates a specific API Key.
UsersApi	updateConfiguration	PUT /users/me/configurations/{configuration_id}	Updates a specific configuration value.

Documentation For Models

Documentation For Authorization

BasicAuth

Type: HTTP basic authentication

BearerAuth

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

Author

info@nodeum.io

nodeum-io / nodeum-sdk-php

Maintainers

Details