Skip to content

Latest commit

 

History

History
154 lines (106 loc) · 2.97 KB

ObjectStorageAccessKeysApi.md

File metadata and controls

154 lines (106 loc) · 2.97 KB

Fastly.ObjectStorageAccessKeysApi

const apiInstance = new Fastly.ObjectStorageAccessKeysApi();

Methods

Note

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

Method HTTP request Description
createAccessKey POST /resources/object-storage/access-keys Create an access key
deleteAccessKey DELETE /resources/object-storage/access-keys/{access_key} Delete an access key
getAccessKey GET /resources/object-storage/access-keys/{access_key} Get an access key
listAccessKeys GET /resources/object-storage/access-keys List access keys

createAccessKey

createAccessKey({ , [access_key] })

Create an access key.

Example

const options = {
  access_key: new Fastly.AccessKey(),
};

apiInstance.createAccessKey(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
access_key AccessKey [optional]

Return type

AccessKeyResponse

deleteAccessKey

deleteAccessKey({ access_key })

Delete an access key.

Example

const options = {
  access_key: "access_key_example", // required
};

apiInstance.deleteAccessKey(options)
  .then(() => {
    console.log('API called successfully.');
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
access_key String

Return type

null (empty response body)

getAccessKey

getAccessKey({ access_key })

Get an access key by its identifier.

Example

const options = {
  access_key: "access_key_example", // required
};

apiInstance.getAccessKey(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
access_key String

Return type

AccessKey

listAccessKeys

listAccessKeys()

List access keys.

Example

apiInstance.listAccessKeys()
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

This endpoint does not need any parameters.

Return type

AccessKeyResponse

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