| Server IP : 79.136.114.73 / Your IP : 18.191.73.161 Web Server : Apache/2.4.7 (Ubuntu) PHP/5.5.9-1ubuntu4.29 OpenSSL/1.0.1f System : Linux b8009 3.13.0-170-generic #220-Ubuntu SMP Thu May 9 12:40:49 UTC 2019 x86_64 User : www-data ( 33) PHP Version : 5.5.9-1ubuntu4.29 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority, MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /var/www/appsrv.astacus.se/forge/forge-api-nodejs-client/docs/ |
Upload File : |
# ForgeSdk.BucketsApi
All URIs are relative to *https://developer.api.autodesk.com/*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createBucket**](BucketsApi.md#createBucket) | **POST** /oss/v2/buckets |
[**deleteBucket**](BucketsApi.md#deleteBucket) | **DELETE** /oss/v2/buckets/{bucketKey} |
[**getBucketDetails**](BucketsApi.md#getBucketDetails) | **GET** /oss/v2/buckets/{bucketKey}/details |
[**getBuckets**](BucketsApi.md#getBuckets) | **GET** /oss/v2/buckets |
<a name="createBucket"></a>
# **createBucket**
> Bucket createBucket(postBuckets, opts, oauth2client, credentials)
Use this endpoint to create a bucket. Buckets are arbitrary spaces created and owned by applications. Bucket keys are globally unique across all regions, regardless of where they were created, and they cannot be changed. The application creating the bucket is the owner of the bucket.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**postBuckets** | [**PostBucketsPayload**](PostBucketsPayload.md)| Body Structure |
**xAdsRegion** | **String**| The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` | [optional] [default to US]
### Return type
[**Bucket**](Bucket.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="deleteBucket"></a>
# **deleteBucket**
> deleteBucket(bucketKey, oauth2client, credentials)
This endpoint will delete a bucket.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bucketKey** | **String**| URL-encoded bucket key |
### Return type
null (empty response body)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="getBucketDetails"></a>
# **getBucketDetails**
> Bucket getBucketDetails(bucketKey, oauth2client, credentials)
This endpoint will return the buckets owned by the application. This endpoint supports pagination.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bucketKey** | **String**| URL-encoded bucket key |
### Return type
[**Bucket**](Bucket.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json
<a name="getBuckets"></a>
# **getBuckets**
> Buckets getBuckets(opts, oauth2client, credentials)
This endpoint will return the buckets owned by the application. This endpoint supports pagination.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**region** | **String**| The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` | [optional] [default to US]
**limit** | **Integer**| Limit to the response size, Acceptable values: 1-100 Default = 10 | [optional] [default to 10]
**startAt** | **String**| Key to use as an offset to continue pagination This is typically the last bucket key found in a preceding GET buckets response | [optional]
### Return type
[**Buckets**](Buckets.md)
### Authorization
[oauth2_application](../README.md#authentication)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/vnd.api+json, application/json