Skip to content

Latest commit

 

History

History
1823 lines (1168 loc) · 71.2 KB

ObjectStorageAPI.md

File metadata and controls

1823 lines (1168 loc) · 71.2 KB

\ObjectStorageAPI

All URIs are relative to https://api.linode.com

Method HTTP request Description
DeleteObjectStorageBucket Delete /{apiVersion}/object-storage/buckets/{regionId}/{bucket} Remove an Object Storage bucket
DeleteObjectStorageKey Delete /{apiVersion}/object-storage/keys/{keyId} Revoke an Object Storage key
DeleteObjectStorageSsl Delete /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/ssl Delete an Object Storage TLS/SSL certificate
GetObjectStorageBucket Get /{apiVersion}/object-storage/buckets/{regionId}/{bucket} Get an Object Storage bucket
GetObjectStorageBucketAcl Get /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-acl Get an Object Storage object ACL config
GetObjectStorageBucketContent Get /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-list List Object Storage bucket contents
GetObjectStorageBucketinCluster Get /{apiVersion}/object-storage/buckets/{regionId} List Object Storage buckets per region
GetObjectStorageBuckets Get /{apiVersion}/object-storage/buckets List Object Storage buckets
GetObjectStorageCluster Get /{apiVersion}/object-storage/clusters/{clusterId} Get a cluster
GetObjectStorageClusters Get /{apiVersion}/object-storage/clusters List clusters
GetObjectStorageKey Get /{apiVersion}/object-storage/keys/{keyId} Get an Object Storage key
GetObjectStorageKeys Get /{apiVersion}/object-storage/keys List Object Storage keys
GetObjectStorageSsl Get /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/ssl Get an Object Storage TLS/SSL certificate
GetObjectStorageTransfer Get /{apiVersion}/object-storage/transfer Get Object Storage transfer data
GetObjectStorageTypes Get /{apiVersion}/object-storage/types List Object Storage types
PostCancelObjectStorage Post /{apiVersion}/object-storage/cancel Cancel Object Storage
PostObjectStorageBucket Post /{apiVersion}/object-storage/buckets Create an Object Storage bucket
PostObjectStorageBucketAccess Post /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/access Modify access to an Object Storage bucket
PostObjectStorageKeys Post /{apiVersion}/object-storage/keys Create an Object Storage key
PostObjectStorageObjectUrl Post /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-url Create a URL for an object
PostObjectStorageSsl Post /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/ssl Upload an Object Storage TLS/SSL certificate
PutObjectStorageBucketAcl Put /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-acl Update an object's ACL config
PutObjectStorageKey Put /{apiVersion}/object-storage/keys/{keyId} Update an Object Storage key
PutStorageBucketAccess Put /{apiVersion}/object-storage/buckets/{regionId}/{bucket}/access Update access to an Object Storage bucket

DeleteObjectStorageBucket

map[string]interface{} DeleteObjectStorageBucket(ctx, apiVersion, regionId, bucket).Execute()

Remove an Object Storage bucket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.DeleteObjectStorageBucket(context.Background(), apiVersion, regionId, bucket).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.DeleteObjectStorageBucket``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteObjectStorageBucket`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.DeleteObjectStorageBucket`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteObjectStorageBucketRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DeleteObjectStorageKey

map[string]interface{} DeleteObjectStorageKey(ctx, apiVersion, keyId).Execute()

Revoke an Object Storage key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	keyId := int32(56) // int32 | The key to look up.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.DeleteObjectStorageKey(context.Background(), apiVersion, keyId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.DeleteObjectStorageKey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteObjectStorageKey`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.DeleteObjectStorageKey`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
keyId int32 The key to look up.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteObjectStorageKeyRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DeleteObjectStorageSsl

map[string]interface{} DeleteObjectStorageSsl(ctx, apiVersion, regionId, bucket).Execute()

Delete an Object Storage TLS/SSL certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.DeleteObjectStorageSsl(context.Background(), apiVersion, regionId, bucket).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.DeleteObjectStorageSsl``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteObjectStorageSsl`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.DeleteObjectStorageSsl`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteObjectStorageSslRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageBucket

GetObjectStorageBuckets200ResponseDataInner GetObjectStorageBucket(ctx, apiVersion, regionId, bucket).Execute()

Get an Object Storage bucket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageBucket(context.Background(), apiVersion, regionId, bucket).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageBucket``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageBucket`: GetObjectStorageBuckets200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageBucket`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageBucketRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageBuckets200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageBucketAcl

GetObjectStorageBucketAcl200Response GetObjectStorageBucketAcl(ctx, apiVersion, regionId, bucket).Name(name).Execute()

Get an Object Storage object ACL config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.
	name := "name_example" // string | The `name` of the object for which to retrieve its Access Control List (ACL). Run the [List Object Storage bucket contents](https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-content) operation to access all object names in a bucket.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageBucketAcl(context.Background(), apiVersion, regionId, bucket).Name(name).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageBucketAcl``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageBucketAcl`: GetObjectStorageBucketAcl200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageBucketAcl`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageBucketAclRequest struct via the builder pattern

Name Type Description Notes

name | string | The `name` of the object for which to retrieve its Access Control List (ACL). Run the List Object Storage bucket contents operation to access all object names in a bucket. |

Return type

GetObjectStorageBucketAcl200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageBucketContent

GetObjectStorageBucketContent200Response GetObjectStorageBucketContent(ctx, apiVersion, regionId, bucket).Marker(marker).Delimiter(delimiter).Prefix(prefix).PageSize(pageSize).Execute()

List Object Storage bucket contents

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.
	marker := "marker_example" // string | The \"marker\" for this request, which can be used to paginate through large buckets. Its value should be the value of the `next_marker` property returned with the last page. Listing bucket contents _does not_ support arbitrary page access. See the `next_marker` property in the responses section for more details. (optional)
	delimiter := "delimiter_example" // string | The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the `/` character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with `prefix` to see object names past the first occurrence of the delimiter. (optional)
	prefix := "prefix_example" // string | Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with `delimiter` to allow transversal of bucket contents in a manner similar to a filesystem. (optional)
	pageSize := int32(56) // int32 | The number of items to return per page. (optional) (default to 100)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageBucketContent(context.Background(), apiVersion, regionId, bucket).Marker(marker).Delimiter(delimiter).Prefix(prefix).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageBucketContent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageBucketContent`: GetObjectStorageBucketContent200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageBucketContent`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageBucketContentRequest struct via the builder pattern

Name Type Description Notes

marker | string | The "marker" for this request, which can be used to paginate through large buckets. Its value should be the value of the `next_marker` property returned with the last page. Listing bucket contents does not support arbitrary page access. See the `next_marker` property in the responses section for more details. | delimiter | string | The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the `/` character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with `prefix` to see object names past the first occurrence of the delimiter. | prefix | string | Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with `delimiter` to allow transversal of bucket contents in a manner similar to a filesystem. | pageSize | int32 | The number of items to return per page. | [default to 100]

Return type

GetObjectStorageBucketContent200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageBucketinCluster

GetObjectStorageBuckets200Response GetObjectStorageBucketinCluster(ctx, apiVersion, regionId).Execute()

List Object Storage buckets per region

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageBucketinCluster(context.Background(), apiVersion, regionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageBucketinCluster``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageBucketinCluster`: GetObjectStorageBuckets200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageBucketinCluster`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageBucketinClusterRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageBuckets200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageBuckets

GetObjectStorageBuckets200Response GetObjectStorageBuckets(ctx, apiVersion).Execute()

List Object Storage buckets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageBuckets(context.Background(), apiVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageBuckets``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageBuckets`: GetObjectStorageBuckets200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageBuckets`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageBucketsRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageBuckets200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageCluster

GetObjectStorageClusters200ResponseDataInner GetObjectStorageCluster(ctx, apiVersion, clusterId).Execute()

Get a cluster

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	clusterId := "us-east-1" // string | Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API.  > 📘 > > You can use the applicable `regionId`, for example `us-west`, in place of the `clusterId`, for example, `us-west-1`. Run [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) to see all regions.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageCluster(context.Background(), apiVersion, clusterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageCluster``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageCluster`: GetObjectStorageClusters200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageCluster`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
clusterId string Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API. > 📘 > > You can use the applicable `regionId`, for example `us-west`, in place of the `clusterId`, for example, `us-west-1`. Run List regions to see all regions.

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageClusterRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageClusters200ResponseDataInner

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageClusters

GetObjectStorageClusters200Response GetObjectStorageClusters(ctx, apiVersion).Execute()

List clusters

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageClusters(context.Background(), apiVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageClusters``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageClusters`: GetObjectStorageClusters200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageClusters`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageClustersRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageClusters200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageKey

GetObjectStorageKeys200ResponseDataInner GetObjectStorageKey(ctx, apiVersion, keyId).Execute()

Get an Object Storage key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	keyId := int32(56) // int32 | The key to look up.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageKey(context.Background(), apiVersion, keyId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageKey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageKey`: GetObjectStorageKeys200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageKey`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
keyId int32 The key to look up.

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageKeyRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageKeys200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageKeys

GetObjectStorageKeys200Response GetObjectStorageKeys(ctx, apiVersion).Execute()

List Object Storage keys

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageKeys(context.Background(), apiVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageKeys``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageKeys`: GetObjectStorageKeys200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageKeys`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageKeysRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageKeys200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageSsl

GetObjectStorageSsl200Response GetObjectStorageSsl(ctx, apiVersion, regionId, bucket).Execute()

Get an Object Storage TLS/SSL certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageSsl(context.Background(), apiVersion, regionId, bucket).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageSsl``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageSsl`: GetObjectStorageSsl200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageSsl`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageSslRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageSsl200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageTransfer

GetObjectStorageTransfer200Response GetObjectStorageTransfer(ctx, apiVersion).Execute()

Get Object Storage transfer data

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageTransfer(context.Background(), apiVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageTransfer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageTransfer`: GetObjectStorageTransfer200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageTransfer`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageTransferRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageTransfer200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetObjectStorageTypes

GetObjectStorageTypes200Response GetObjectStorageTypes(ctx, apiVersion).Execute()

List Object Storage types

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.GetObjectStorageTypes(context.Background(), apiVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.GetObjectStorageTypes``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetObjectStorageTypes`: GetObjectStorageTypes200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.GetObjectStorageTypes`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiGetObjectStorageTypesRequest struct via the builder pattern

Name Type Description Notes

Return type

GetObjectStorageTypes200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

PostCancelObjectStorage

map[string]interface{} PostCancelObjectStorage(ctx, apiVersion).Execute()

Cancel Object Storage

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PostCancelObjectStorage(context.Background(), apiVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PostCancelObjectStorage``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostCancelObjectStorage`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PostCancelObjectStorage`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiPostCancelObjectStorageRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

PostObjectStorageBucket

GetObjectStorageBuckets200ResponseDataInner PostObjectStorageBucket(ctx, apiVersion).PostObjectStorageBucketRequest(postObjectStorageBucketRequest).Execute()

Create an Object Storage bucket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postObjectStorageBucketRequest := *openapiclient.NewPostObjectStorageBucketRequest("example-bucket") // PostObjectStorageBucketRequest | Information about the bucket you want to create. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PostObjectStorageBucket(context.Background(), apiVersion).PostObjectStorageBucketRequest(postObjectStorageBucketRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PostObjectStorageBucket``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostObjectStorageBucket`: GetObjectStorageBuckets200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PostObjectStorageBucket`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiPostObjectStorageBucketRequest struct via the builder pattern

Name Type Description Notes

postObjectStorageBucketRequest | PostObjectStorageBucketRequest | Information about the bucket you want to create. |

Return type

GetObjectStorageBuckets200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

PostObjectStorageBucketAccess

map[string]interface{} PostObjectStorageBucketAccess(ctx, apiVersion, regionId, bucket).PutStorageBucketAccessRequest(putStorageBucketAccessRequest).Execute()

Modify access to an Object Storage bucket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.
	putStorageBucketAccessRequest := *openapiclient.NewPutStorageBucketAccessRequest() // PutStorageBucketAccessRequest | The changes to make to the bucket's access controls. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PostObjectStorageBucketAccess(context.Background(), apiVersion, regionId, bucket).PutStorageBucketAccessRequest(putStorageBucketAccessRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PostObjectStorageBucketAccess``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostObjectStorageBucketAccess`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PostObjectStorageBucketAccess`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiPostObjectStorageBucketAccessRequest struct via the builder pattern

Name Type Description Notes

putStorageBucketAccessRequest | PutStorageBucketAccessRequest | The changes to make to the bucket's access controls. |

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

PostObjectStorageKeys

GetObjectStorageKeys200ResponseDataInner PostObjectStorageKeys(ctx, apiVersion).PostObjectStorageKeysRequest(postObjectStorageKeysRequest).Execute()

Create an Object Storage key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postObjectStorageKeysRequest := *openapiclient.NewPostObjectStorageKeysRequest() // PostObjectStorageKeysRequest | The settings necessary to create a new key. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PostObjectStorageKeys(context.Background(), apiVersion).PostObjectStorageKeysRequest(postObjectStorageKeysRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PostObjectStorageKeys``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostObjectStorageKeys`: GetObjectStorageKeys200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PostObjectStorageKeys`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiPostObjectStorageKeysRequest struct via the builder pattern

Name Type Description Notes

postObjectStorageKeysRequest | PostObjectStorageKeysRequest | The settings necessary to create a new key. |

Return type

GetObjectStorageKeys200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

PostObjectStorageObjectUrl

PostObjectStorageObjectUrl200Response PostObjectStorageObjectUrl(ctx, apiVersion, regionId, bucket).PostObjectStorageObjectUrlRequest(postObjectStorageObjectUrlRequest).Execute()

Create a URL for an object

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.
	postObjectStorageObjectUrlRequest := *openapiclient.NewPostObjectStorageObjectUrlRequest("GET", "example") // PostObjectStorageObjectUrlRequest | Information about the request to sign. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PostObjectStorageObjectUrl(context.Background(), apiVersion, regionId, bucket).PostObjectStorageObjectUrlRequest(postObjectStorageObjectUrlRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PostObjectStorageObjectUrl``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostObjectStorageObjectUrl`: PostObjectStorageObjectUrl200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PostObjectStorageObjectUrl`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiPostObjectStorageObjectUrlRequest struct via the builder pattern

Name Type Description Notes

postObjectStorageObjectUrlRequest | PostObjectStorageObjectUrlRequest | Information about the request to sign. |

Return type

PostObjectStorageObjectUrl200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

PostObjectStorageSsl

GetObjectStorageSsl200Response PostObjectStorageSsl(ctx, apiVersion, regionId, bucket).PostObjectStorageSslRequest(postObjectStorageSslRequest).Execute()

Upload an Object Storage TLS/SSL certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.
	postObjectStorageSslRequest := *openapiclient.NewPostObjectStorageSslRequest("-----BEGIN CERTIFICATE-----
CERTIFICATE_INFORMATION
-----END CERTIFICATE-----", "-----BEGIN PRIVATE KEY-----
PRIVATE_KEY_INFORMATION
-----END PRIVATE KEY-----") // PostObjectStorageSslRequest | Upload this TLS/SSL certificate with its corresponding secret key. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PostObjectStorageSsl(context.Background(), apiVersion, regionId, bucket).PostObjectStorageSslRequest(postObjectStorageSslRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PostObjectStorageSsl``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostObjectStorageSsl`: GetObjectStorageSsl200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PostObjectStorageSsl`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiPostObjectStorageSslRequest struct via the builder pattern

Name Type Description Notes

postObjectStorageSslRequest | PostObjectStorageSslRequest | Upload this TLS/SSL certificate with its corresponding secret key. |

Return type

GetObjectStorageSsl200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

PutObjectStorageBucketAcl

GetObjectStorageBucketAcl200Response PutObjectStorageBucketAcl(ctx, apiVersion, regionId, bucket).PutObjectStorageBucketAclRequest(putObjectStorageBucketAclRequest).Execute()

Update an object's ACL config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.
	putObjectStorageBucketAclRequest := *openapiclient.NewPutObjectStorageBucketAclRequest("public-read", "Name_example") // PutObjectStorageBucketAclRequest | The changes to make to this Object's access controls. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PutObjectStorageBucketAcl(context.Background(), apiVersion, regionId, bucket).PutObjectStorageBucketAclRequest(putObjectStorageBucketAclRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PutObjectStorageBucketAcl``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutObjectStorageBucketAcl`: GetObjectStorageBucketAcl200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PutObjectStorageBucketAcl`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiPutObjectStorageBucketAclRequest struct via the builder pattern

Name Type Description Notes

putObjectStorageBucketAclRequest | PutObjectStorageBucketAclRequest | The changes to make to this Object's access controls. |

Return type

GetObjectStorageBucketAcl200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

PutObjectStorageKey

PutObjectStorageKey200Response PutObjectStorageKey(ctx, apiVersion, keyId).PutObjectStorageKeyRequest(putObjectStorageKeyRequest).Execute()

Update an Object Storage key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	keyId := int32(56) // int32 | The key to look up.
	putObjectStorageKeyRequest := *openapiclient.NewPutObjectStorageKeyRequest() // PutObjectStorageKeyRequest | The fields to update. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PutObjectStorageKey(context.Background(), apiVersion, keyId).PutObjectStorageKeyRequest(putObjectStorageKeyRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PutObjectStorageKey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutObjectStorageKey`: PutObjectStorageKey200Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PutObjectStorageKey`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
keyId int32 The key to look up.

Other Parameters

Other parameters are passed through a pointer to a apiPutObjectStorageKeyRequest struct via the builder pattern

Name Type Description Notes

putObjectStorageKeyRequest | PutObjectStorageKeyRequest | The fields to update. |

Return type

PutObjectStorageKey200Response

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

PutStorageBucketAccess

map[string]interface{} PutStorageBucketAccess(ctx, apiVersion, regionId, bucket).PutStorageBucketAccessRequest(putStorageBucketAccessRequest).Execute()

Update access to an Object Storage bucket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	regionId := "regionId_example" // string | Identifies a region where this bucket lives.  > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.
	bucket := "bucket_example" // string | The bucket name.
	putStorageBucketAccessRequest := *openapiclient.NewPutStorageBucketAccessRequest() // PutStorageBucketAccessRequest | The changes to make to the bucket's access controls. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectStorageAPI.PutStorageBucketAccess(context.Background(), apiVersion, regionId, bucket).PutStorageBucketAccessRequest(putStorageBucketAccessRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectStorageAPI.PutStorageBucketAccess``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutStorageBucketAccess`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `ObjectStorageAPI.PutStorageBucketAccess`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
regionId string Identifies a region where this bucket lives. > 📘 > > You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster `id`.
bucket string The bucket name.

Other Parameters

Other parameters are passed through a pointer to a apiPutStorageBucketAccessRequest struct via the builder pattern

Name Type Description Notes

putStorageBucketAccessRequest | PutStorageBucketAccessRequest | The changes to make to the bucket's access controls. |

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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