This document specifies how to use the API service for Anycloud Object Storage.
\nAnycloud Object Storage is a \"headless\" API-first broker, focused on creation and management of S3-comptabile storage offerings.
\nTo use the API service, you need to obtain an API user/pass directly from Anycloud via e-mail - reach out to us on support@anycloud.dk. You need the key to exchange it for a Bearer Token, which in turn is used to authorize all API calls.
\nThis documentation document is written using Postman. If you aren't already familiar with Postman, we recommend getting familiar, as it offers a rich API exploration experience.
\nWe will quickly run you through a few key features:
\n* In the \"documenter\" view for reading documentation, which you are most likely reading right now, you can select which programming-language you prefer for the examples with the menu above:
\n![](\"https://cdn.revirt365.com/anycloud/img/postman/languages.png\")
\n\n* Once you have an api key and feel ready to interactively explore the API, you can import the documentation as a Postman Collection using the button in the upper right corner:
\n![](\"https://cdn.revirt365.com/anycloud/img/postman/run.png\")
\n\nTo get started quickly, we recommend running postman from the browser. Once you have postman open with this api documentation imported as a collection, you will need to insert your api key into the collection variables like this:
\n![](\"https://cdn.revirt365.com/anycloud/img/postman/entercredential_anycloudobjectstorage.png\")
\n\nNote that there are two systems available. The demo system, where you can test out calls, and the live system, which is the real production environment. The demo system allows you to explore the API and perform tests. Once you are read to go live, simply switch the \"demo\" to \"live\" in the url. While both system are considered production environments, we will occationally clear the demo environment of all data, and we expect that you do not use the buckets in the demo. We recommend that you do not enter a live-API key into postman, as everything is saved on their servers.
\nAny property that is optional can either be left out completely or set to the null-value, if that's easier - it may be in static-typing languages. The API will interpret a missing property and a nulled property the same way.
\nSome endpoints will have a continuation pagination token field called \"getNextPageToken\" for cursor-based pagination. In the request body, the first page can be fetched by providing an empty string (\"\"), and subsequent pages can be fetched by providing the returned \"getNextPageToken\" value. The last page will provide a null \"getNextPageToken\" to make sure that erronious queries with this value won't lead to an infinite loop (as it would if null was used to get the first page, or if empty string was returned on the last page)
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7656257","collectionId":"e23625d4-39eb-4ad0-aa63-815e5a8ca186","publishedId":"2s9YeN1oGb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-01T11:00:23.000Z"},"item":[{"name":"Generate bearer token","event":[{"listen":"test","script":{"id":"263cca6a-e6f0-42b1-8df4-b0f1ccad173c","exec":["pm.collectionVariables.set(\"BearerToken\", JSON.parse(responseBody).data.bearerToken);"],"type":"text/javascript","packages":{}}}],"id":"1126464d-5259-4636-8f1d-2a63aea1a91b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"User"},{"key":"password","value":"Secret"}]},"isInherited":false},"method":"POST","header":[],"url":"https://staging-iamapi.azurewebsites.net/api_v1/bearer_token_v1/create_from_basic_authentication_v1","description":"First things first you must exchange your API credentials, username/password, for a bearer token such that you can call the following API endpoints.
\nThe request does not require a body, but must include a basic authorization header. Key: \"Authorization\" Value: \"Basic \" + ToBase64(\"Your username\" + \":\" + \"Your password\")
\nBearerToken (string): The actual BearerTokenBearerTokenId (uuid): The non-secret part of BearerToken.{\n \"BearerToken\": \"4819ec33-5584-4601-bb22-5cbdd68462ee:uhmdsszOblbmlQQ6u+KpkJXW1i7Bar6iqseulEF3LIY=\",\n \"BearerTokenId\": \"4819ec33-5584-4601-bb22-5cbdd68462ee\"\n}\n\nYou must provide the value from the BearerToken field to all subsequent API calls. The BearerToken should be provided in the header field. Key: \"Authorization\", Value: \"Bearer \" + BearerToken
\n","urlObject":{"protocol":"https","path":["api_v1","bearer_token_v1","create_from_basic_authentication_v1"],"host":["staging-iamapi.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"9efcb1a2-10bf-4e2d-8b2b-0171235899ba","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic dXNlcm5hbWU6cGFzc3dvcmQK","type":"text"},{"key":"","value":"","type":"text"}],"url":"https://demo.api.objectstorage.anycloud.dk/api_v1/bearer_token_v1/create_v1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"bearerToken\": \"4819ec33-5584-4601-bb22-5cbdd68462ee:uhmdsszOblbmlQQ6u+KpkJXW1i7Bar6iqseulEF3LIY=\",\r\n \"bearerTokenId\": \"4819ec33-5584-4601-bb22-5cbdd68462ee\"\r\n}"}],"_postman_id":"1126464d-5259-4636-8f1d-2a63aea1a91b"},{"name":"Delete bearer token","id":"d5d15bb5-7673-43c9-83cf-2e3a793507cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer BearerToken"}],"url":"https://staging-iamapi.azurewebsites.net/api_v1/bearer_token_v1/delete_v1","description":"Once you have finished what you came for, you can delete the bearer token such that it cannot be used any further. Regardless if you do this or not, it will expire 15 minutes after creation.
\nThe request does not require a body.
\nEmpty
\n","urlObject":{"protocol":"https","path":["api_v1","bearer_token_v1","delete_v1"],"host":["staging-iamapi.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"e08c6141-32e8-4457-a68c-4af1e7ace714","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 4819ec33-5584-4601-bb22-5cbdd68462ee:uhmdsszOblbmlQQ6u+KpkJXW1i7Bar6iqseulEF3LIY=","type":"text"}],"url":"https://demo.api.objectstorage.anycloud.dk/api_v1/bearer_token_v1/delete_v1"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d5d15bb5-7673-43c9-83cf-2e3a793507cb"},{"name":"Create storage account","id":"666b15db-9512-452f-b39d-eb8d515f5cc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer BearerToken","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"numberOfAccessKeySlots\": 3\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-ibmobjectstorage-api.azurewebsites.net/api_v1/storageAccount_v1/create_v1","description":"Before you can create a storage bucket, you must define an access boundary, called a storage account, to put the bucket inside. All access keys that are put into a storage account can acess all buckets put inside that storage account, and only the buckets inside that storage account.
\nnumberOfAccessKeySlots: (int, 1-5, required) The number of API keys that you can create to access the buckets under this storage account. One or two is recommended (read-only and read-write){\n \"numberOfAccessKeySlots\": 1\n}\n\nstorageAccountId: The id which you must use to reference the boundary from here on out.{\n \"storageAccountId\": \"f56c9bf2-37b8-4e7a-bf3c-c93394257657\"\n}\n\nPermanently delete the storage account, its access keys and its buckets.
\nstorageAccountId: (uuid, required) The previously given id.{\n \"storageAccountId\": \"f56c9bf2-37b8-4e7a-bf3c-c93394257657\"\n}\n\nEmpty
\n","urlObject":{"protocol":"https","path":["api_v1","storageAccount_v1","delete_v1"],"host":["staging-ibmobjectstorage-api.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"035ef8e0-1475-48f0-a4ea-da78668b919a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 4819ec33-5584-4601-bb22-5cbdd68462ee:uhmdsszOblbmlQQ6u+KpkJXW1i7Bar6iqseulEF3LIY=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"storageAccountId\": \"f56c9bf2-37b8-4e7a-bf3c-c93394257657\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.api.objectstorage.anycloud.dk/api_v1/storageAccount_v1/delete_v1"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fbc75afa-9cca-4a08-80d0-287451dd0695"},{"name":"Create Bucket","id":"a426d29e-6d3d-40bb-a6f4-aa4421955f42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer BearerToken","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"storageAccountId\": \"46cbcbfc-1ffd-440f-b313-7c73497cb3ee\",\r\n \"bucketName\": \"cjedevyetanothertest005\",\r\n \"region\": \"FRA\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-ibmobjectstorage-api.azurewebsites.net/api_v1/bucket_v1/create_v1","description":"Create a data-bucket inside a storage account. A bucket is a storage container that can be accessed with the S3 protocol. Note that an access key with the FullAccess permission can create their own buckets, they should not do this and instead use this API endpoint. That is because the storage type and data location cannot be properly set from within the S3 location the way it can be here. Buckets NOT may be subject to removal.
\nstorageAccountId (uuid, required): The ID of the storage account.bucketName (text, required): The name of the bucket. Only lowercase letters and numbers, 3-63 characters. Must be globally unique across the provider's catalogue of buckets.region (text, required): The 3-letter iata airport code for the region in which the bucket will be created. The valid options are:Upon successful creation of the bucket, the response will include:
\nbucketId: The id to reference this bucket within this system.endpoints: An object containing the public, private, and direct endpoints for accessing the newly created bucket. Public is the fallback if none of the other options work, and most likely the one you need. The private endpoint can be used if the calling client exists inside the provider's systems. The direct endpoint is used when the calling client exists within a network that has been teathered to the provider's network, eg. with Virtual Private Cloud (VPC) or Bring Your Own Ip (BYOIP) configurations.Example Response:
\n{\n \"endpoints\": {\n \"public\": \"s3.eu-de.cloud-object-storage.appdomain.cloud:443\",\n \"private\": \"s3.private.eu-de.cloud-object-storage.appdomain.cloud:443\",\n \"direct\": \"s3.direct.eu-de.cloud-object-storage.appdomain.cloud:443\"\n } \n}\n\nCreate a key inside a storage account, which can access all the buckets also inside that same storage account. The endpoint to log in is given when creating the bucket.
\nstorageAccountId (uuid, required): The ID of the storage account for the key.
permission (string): The permission level for the key. Can be ReadOnly or FullAccess, which is both read and write.
keyId: The id to reference this key in the future.credentials: The username and password to S3 log into a bucket (in the same storage account).Example:
\n{\n \"keyId\": \"01853a9e-e148-4bd7-9a00-33317ee2cad9\",\n \"credential\":\n {\n \"username\": \"3eptd9isd4po4l23rljwe9u3mkdfs\",\n \"password\": \"dfgpjoiw3rpkoewrjisxls43uhfsxodsxuh4wjlvkhekr32uhksposdh4\"\n }\n}\n\nDelete an access key.
\nstorageAccountId (uuid, required): The ID of the storage account for the key.
keyId (string, required): The ID of the key.
Empty
\n","urlObject":{"protocol":"https","path":["api_v1","key_v1","delete_v1"],"host":["staging-ibmobjectstorage-api.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"1b989a7b-38a4-4966-9147-e3cadc5c72fb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 4819ec33-5584-4601-bb22-5cbdd68462ee:uhmdsszOblbmlQQ6u+KpkJXW1i7Bar6iqseulEF3LIY=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"storageAccountId\": \"f56c9bf2-37b8-4e7a-bf3c-c93394257657\",\r\n \"keyId\": \"01853a9e-e148-4bd7-9a00-33317ee2cad9\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.api.objectstorage.anycloud.dk/api_v1/key_v1/delete_v1"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1720c3d9-16c1-438b-9305-8b6f32a97930"},{"name":"Get storage account get all","id":"eceed8ba-184e-4d59-b42c-0a54ec6c42ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer BearerToken","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"getNextPageToken\": \"\",\r\n \"pageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-ibmobjectstorage-api.azurewebsites.net/api_v1/storageaccount_v1/get_all_v1","urlObject":{"protocol":"https","path":["api_v1","storageaccount_v1","get_all_v1"],"host":["staging-ibmobjectstorage-api.azurewebsites.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"eceed8ba-184e-4d59-b42c-0a54ec6c42ee"},{"name":"Get storage account single","id":"6565e6a2-dc21-4bdd-a604-1a3c2625bd37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer BearerToken","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"storageAccountId\": \"a26ea613-5ec1-4165-956c-926a55fbe835\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-ibmobjectstorage-api.azurewebsites.net/api_v1/storageaccount_v1/get_one_v1","urlObject":{"protocol":"https","path":["api_v1","storageaccount_v1","get_one_v1"],"host":["staging-ibmobjectstorage-api.azurewebsites.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"6565e6a2-dc21-4bdd-a604-1a3c2625bd37"},{"name":"Get usage data","id":"6476bf23-429d-475a-9817-54f73e43e2ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer BearerToken","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"dateRange\": {\r\n \"from\": \"2024-02-19\",\r\n \"to\": \"2024-02-20\"\r\n },\r\n \"target\": {\r\n //optional:\r\n //\"storageAccountId\": \"3b50fd8d-4476-4ed8-9fbc-f9c3f1e50285\"\r\n },\r\n \"pagination\": {\r\n \"getNextPageToken\": \"\",\r\n \"pageSize\": 50\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-ibmobjectstorage-api.azurewebsites.net/api_v1/usage_v1/get_v1","description":"target.storageAccountId is optional. Without it all buckets within the api-key's owner are given for the dateRange.
\nmax pagination.pageSize is 50
\nSee the intro section \"Continuation Pagination token\" for info about the getNextPageToken
\n","urlObject":{"protocol":"https","path":["api_v1","usage_v1","get_v1"],"host":["staging-ibmobjectstorage-api.azurewebsites.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"6476bf23-429d-475a-9817-54f73e43e2ec"}],"event":[{"listen":"prerequest","script":{"id":"fff57f43-1b08-495d-ab2e-513a85c534e7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cda9acab-4154-4ece-87ed-d1f3fe724917","type":"text/javascript","exec":[""]}}],"variable":[{"key":"Host","value":"staging-ibmobjectstorage-api.azurewebsites.net","type":"string"},{"key":"IamHost","value":"staging-iamapi.azurewebsites.net","type":"string"},{"key":"Username","value":"User","type":"string"},{"key":"Password","value":"Secret","type":"string"},{"key":"BearerToken","value":"BearerToken","type":"string"}]}