Skip to content

ObjectStorageAccessKeysApi.md

Latest commit

 

History

History
163 lines (116 loc) · 3.71 KB

ObjectStorageAccessKeysApi.md

File metadata and controls

163 lines (116 loc) · 3.71 KB

Fastly::ObjectStorageAccessKeysApi

require 'fastly'
api_instance = Fastly::ObjectStorageAccessKeysApi.new

Methods

Note

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

Method HTTP request Description
create_access_key POST /resources/object-storage/access-keys Create an access key
delete_access_key DELETE /resources/object-storage/access-keys/{access_key} Delete an access key
get_access_key GET /resources/object-storage/access-keys/{access_key} Get an access key
list_access_keys GET /resources/object-storage/access-keys List access keys

create_access_key()

create_access_key(opts): <AccessKeyResponse> # Create an access key

Create an access key.

Examples

api_instance = Fastly::ObjectStorageAccessKeysApi.new
opts = {
    access_key: Fastly::AccessKey.new({description: 'description_example', permission: 'permission_example'}), # AccessKey | 
}

begin
  # Create an access key
  result = api_instance.create_access_key(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling ObjectStorageAccessKeysApi->create_access_key: #{e}"
end

Options

Name Type Description Notes
access_key AccessKey [optional]

Return type

AccessKeyResponse

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

delete_access_key()

delete_access_key(opts) # Delete an access key

Delete an access key.

Examples

api_instance = Fastly::ObjectStorageAccessKeysApi.new
opts = {
    access_key: 'access_key_example', # String | 
}

begin
  # Delete an access key
  api_instance.delete_access_key(opts)
rescue Fastly::ApiError => e
  puts "Error when calling ObjectStorageAccessKeysApi->delete_access_key: #{e}"
end

Options

Name Type Description Notes
access_key String

Return type

nil (empty response body)

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

get_access_key()

get_access_key(opts): <AccessKey> # Get an access key

Get an access key by its identifier.

Examples

api_instance = Fastly::ObjectStorageAccessKeysApi.new
opts = {
    access_key: 'access_key_example', # String | 
}

begin
  # Get an access key
  result = api_instance.get_access_key(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling ObjectStorageAccessKeysApi->get_access_key: #{e}"
end

Options

Name Type Description Notes
access_key String

Return type

AccessKey

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

list_access_keys()

list_access_keys: <AccessKeyResponse> # List access keys

List access keys.

Examples

api_instance = Fastly::ObjectStorageAccessKeysApi.new

begin
  # List access keys
  result = api_instance.list_access_keys
  p result
rescue Fastly::ApiError => e
  puts "Error when calling ObjectStorageAccessKeysApi->list_access_keys: #{e}"
end

Options

This endpoint does not need any parameter.

Return type

AccessKeyResponse

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