Order Object Storage
Choose a home region and an optional first bucket, create a pay as you go service at no charge, then set a budget or cancel it on the Billing tab.
You order Object Storage on its own page in the dashboard, with a home region and, if you want, a first bucket. Ordering costs nothing and needs no card. Each month, we bill what the service used above your account's free amounts on its renewal invoice (How Object Storage is billed). Setup takes under a minute.
Before you begin
Section titled Before you begin- Sign in to the dashboard.
- Choose a home region close to the machines and people that use the data. Each bucket answers only at its own region's endpoint. You can create buckets in other regions later.
- You need no credit and no card to order. The usage invoices that follow are paid like any other invoice, from your credit first (When you are billed).
- One service holds up to 25 buckets. The free amounts each month are your account's, so a second service adds room for buckets and no free use (Free each month).
- A team member working in your account needs the Technical or Admin role to order, and the Billing or Admin role to set a budget (Roles).
Place the order
Section titled Place the orderOpen the order page in one of these ways:
- In the sidebar, select Object Storage, then Create Object Storage. With no service yet, the same button is in the middle of the page (Find your Object Storage services).
- In a service's panel, open the menu in its header and select Create Object Storage.
- On Order a service, select the Object Storage card under Storage.
The page has no plan or billing cycle to choose. The Pricing card at the top lists the rates and what is free each month. The summary under Your order sits beside the sections. On a phone the summary follows them, and Review order at the bottom of the screen takes you to it.
- Under Region, choose the home region. Each card shows the region's name and its code, such as
Frankfurtandfra · Germany. The page lists only the regions that can take a bucket right now, and it starts with one near you when there is one. - To create a bucket straight away, type its name in Bucket name under First bucket, such as
assets. We put your account namespace in front, and the hint shows the full name, such asWe create it as u7-assets.Leave the field empty to create buckets later. Bucket names gives the rules. - Check the summary. It lists the region and any first bucket, with Change beside each to go back to its section. The Total reads Pay as you go, and under it
Nothing is due today. We bill what you use above the free amounts once a month.On a phone, the bar at the bottom of the screen readsNothing due todayand has the same button. - If you have a promo code, enter it in Promo code. We check it as you type, and the message under the field says whether it applies.
- Complete the verification check in the summary, if the page shows one.
- Select Place order. Nothing is due, so one click places the order. While something is missing, the button is greyed out and the line under it names what, such as
Choose a region.orComplete the verification check., and selecting it takes you to the section that fixes it.
If we refuse the order, the reason appears under the button and your choices stay as they were. We never place an order twice.
Result
Section titled ResultOnce you place the order, its own page opens. It shows Nothing to pay now, with This order is free. The page follows the setup and updates on its own. Its title becomes Your order is ready when the service is active, and its button then opens the service. We email you when it is ready.
The new service appears on the Object Storage page as a card. Its status is pending or provisioning while we set it up, and active when it is ready. That page does not refresh on its own, so select Refresh or reload the page to see the change. Until the service is ready, its panel shows Setting up.
When setup finishes, the Activity table on the service's Billing tab lists it with a line such as Pay as you go object storage ready in Frankfurt. Bucket u7-assets created.
Next, create an access key on the Access keys tab and connect an S3 client.
The storage your plan includes
Section titled The storage your plan includesYour account plan sets how much Object Storage your account uses free each month, and every pay as you go service draws on it (Free each month). To use it, order Object Storage at no charge, as Place the order describes. There is no separate free service to create.
The dashboard used to create an Object Storage service from your plan. If you have one, it is pay as you go like any other service (Storage from your account plan). The API can still create one (Set up the services your plan includes).
Manage the service on the Billing tab
Section titled Manage the service on the Billing tabOpen the service and select the Billing tab. From the top, it shows:
- The rates the service is billed at, and what your account uses free each month.
- This month's use for each meter: what the service used, what the free amounts covered, what is billed and its amount. The figures leave out the last two or three hours, which we have not rated yet (The month so far).
- Budget, the monthly amount that sends alerts (Set a budget).
- Download usage, a month's use as a CSV file (Download a month's usage).
Under them are the cards every service has:
- Current plan
- The Product, Plan, Price, Status, Next renewal date, the date the service was Set up, and its Service ID. On pay as you go, the price is $0, and the invoice for the renewal on Next renewal carries the month's usage lines.
- Activity
- Setup, renewals, plan changes and other events, each with When, Event, Details and By.
- Cancel service
- Ends the service, as Cancel the service describes.
A team member whose role cannot change billing sees the budget and the download without their controls, and the card names the role that can.
Set a budget
Section titled Set a budgetA budget emails you as this month's charges grow (Budgets).
- On the Billing tab, under Budget, type the amount in Monthly budget, in US dollars from 1 to 1,000,000, such as
25. - Select Save budget.
The card then shows this month's charges against the budget, such as $3.00 of $25.00 and 12% of this month's budget. When the charges reach 50%, 80% and 100% of the budget, we email the account's owner and its team members with the Billing or Admin role. The card reminds you that A budget sends alerts. It does not stop uploads.
To change the amount, type a new one and select Save budget again. The alerts then start over for the new amount. To stop the alerts, select Remove budget. One account can save or remove budgets 30 times an hour, across all its services.
Download a month's usage
Section titled Download a month's usage- On the Billing tab, under Download usage, choose the month in Month. The list starts with this month and goes back to the month the service began, 12 months at most.
- Select Download usage.
Your browser saves a CSV file with a row for each bucket and day. Download usage explains the columns.
Switch to pay as you go
Section titled Switch to pay as you goA service on a plan that is no longer sold, such as Object Storage 250 GB, can move to pay as you go. A team member needs the Technical or Admin role to switch it. Other roles see which roles can, in place of the button.
- On the service's Billing tab, select Switch to pay as you go under This plan is no longer sold, in the Your plan card. The same button in the This month card on the Overview tab goes to the same place. The Switch to pay as you go page opens. Its address is
/dashboard/storage/<service id>/billing/switch. - Read What pay as you go costs, which lists the pay as you go rates with what is free each month, and Your plan today. In the Switching card, check Credit for the unused plan and Due now, which is
$0.00. - Select Switch to pay as you go. The Billing tab opens again, with the pay as you go rates in place of the plan. Cancel and the Billing link at the top of the page return to the tab without switching.
Switched to pay as you go. appears, and the tab shows the rates and this month's use for each meter. The switch applies at once, and you cannot undo it. We add Credit for the unused plan to your credit balance: the whole days left in the term you paid for, less one day by default (How the credit is worked out). The service keeps its buckets, objects, access keys and renewal date, and from then on draws on the account's free amounts.
A pay as you go service has one plan, so its Current plan card says No other plan to switch to.
Cancel the service
Section titled Cancel the service- On the Cancel service card, select Cancel service….
- Under When, choose At the end of the current term or Immediately.
- Type
canceland select Cancel service.
Cancel a service explains both choices and what happens to unpaid invoices. Once we rate the service's last hours, what it used and was not yet billed for goes on a final invoice of its own (When you are billed).
When the service ends, its access keys stop working within a couple of minutes, and it leaves the Object Storage page. We keep the objects in its buckets for 7 more days and then delete them. The dashboard and the service's keys cannot reach the objects in that time, and the bucket names stay taken until we delete them.
Caution
Cancelling deletes every object in the service's buckets 7 days after the service ends, and you cannot undo it. Copy out anything you need before the service ends.
Object Lock does not keep a version past the end of the service. We delete locked versions with everything else (Protect objects with Object Lock).
About a minute after the service ends, the public URLs and custom domains of its buckets answer 404. When we delete the buckets 7 days later, we unlink their custom domains, and you can link each one to another bucket.
Troubleshooting
Section titled Troubleshooting- Could not load the regions
- The list of regions did not load. The message under it gives the reason. Reload the page.
- No region offers Object Storage right now
- No region can take a bucket at the moment, so you cannot order Object Storage. Try again later, or contact support.
Object Storage is not available in that region right now. Choose another region.- The region you chose has no storage gateway open yet. Coritan refuses the order before it takes any payment. Choose another region. The API answers
422withcodeset toout_of_stock, and thestorage_regionslist ofGET /availabilitynames the regions where storage is open. Complete the verification check.orThe verification check did not pass. Complete it and try again.- The check under the summary has not finished, or it expired or failed. Complete it, then select Place order again.
No Object Storage plans on sale- Coritan does not sell Object Storage to your account right now. Select Contact support if you expected it, or See all products to choose another product.
- Could not load the plans
- The order page could not load the product. Select Try again, or reload the page.
Fix the bucket name, or leave it empty.- The name in Bucket name breaks a rule, and the message under the field says which one, such as
Use lowercase letters, digits, hyphens and dots, and start and end with a letter or digit.Correct the name, or clear the field and create the bucket later. - The Activity line ends with
The first bucket was not created:and a reason - The service works, but we could not create the bucket you named. The reason says why, such as
Bucket names are 3 to 63 characters including the account prefix. Create the bucket on the Buckets tab (Create and delete buckets). - The first bucket is missing, and the Activity line does not mention it
- Your account already has a bucket with that name, or had one that you deleted in the last 7 days, so we skipped the name. Create a bucket with another name on the Buckets tab.
- The status says
failed - Setup did not finish. The Activity table gives the reason, such as
That region does not offer object storage. Contact support with the service ID. - The budget and the download have no controls
- Your role in the account's team cannot change billing, and the card names the role that can. A member needs the Billing or Admin role to set a budget (Roles).
- Could not save the budget or Could not remove the budget
- We refused the change, and the message gives the reason.
Too many requests for this action. Try again later.means your account saved or removed budgets 30 times in the last hour. Each change stops counting an hour after you made it, so try again later. - Could not work out the credit or Could not switch the plan
- The page could not preview or apply the switch, and the message gives the reason.
Service is not activemeans the service is suspended or still being set up. Pay its open invoice to lift a suspension, then try again. No other plan to switch to- A pay as you go service has one plan, and you pay for what it uses. A service on a plan that is no longer sold moves with Switch to pay as you go (Switch to pay as you go).
Related
Section titled Related- How Object Storage is billed
- Create and delete buckets
- Create and revoke access keys
- Order a service
- Cancel a service
With the API
Section titled With the APIObject Storage is one product in the catalogue, Object Storage, whose module_name is object_storage. List the catalogue with GET /products/, which needs no authentication. The product's id is the product_id to order, and its one pricing entry, monthly at a price of 0, has the pricing_id. The product's metadata holds billing_model, which is payg, and the rates.
curl "https://api.coritan.com/api/v1/products/?per_page=200"
List the regions that can take a bucket with GET /api/v1/client/object-storage/regions:
curl https://api.coritan.com/api/v1/client/object-storage/regions \
-H "Authorization: Bearer $CORITAN_TOKEN"
{
"regions": [
{
"id": 1,
"code": "fra",
"name": "Frankfurt",
"country_code": "DE",
"endpoint": "https://s3.fra.coritan.com:7337"
}
]
}
id is the location_id to order with. The list changes as regions gain or lose storage, so read it before each order. An empty list means you cannot order Object Storage right now.
Place the order with POST /api/v1/services/order. An order that costs nothing needs a turnstile_token while the verification check is on, which only the check on a web page produces (The verification check):
curl -X POST https://api.coritan.com/api/v1/services/order \
-H "Authorization: Bearer $CORITAN_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"product_id": 58,
"pricing_id": 171,
"turnstile_token": "the-widget-answer",
"config": {
"location_id": 1,
"bucket_name": "assets"
}
}'
config.location_id- Required. The
idof a region from the list above. config.bucket_name- Optional. The first bucket's name, with or without your prefix. We change it to lowercase and add the prefix when it is missing.
hostname- Optional. The name the dashboard lists the service under, up to 100 characters. Without it, the service takes the product's name.
Object Storage takes no add-ons. An order with addons answers 422 with Object Storage does not take add-ons. Order each product on its own.
A new order answers 201. There is no invoice, and setup starts at once:
{
"service": {"id": 1207, "status": "pending", "billing_cycle": "monthly", "amount": 0.0, "hostname": null},
"addons": [],
"invoice_id": null,
"requires_payment": false,
"checkout_available": false,
"amount_due": null,
"message": "Provisioning started"
}
Order a service lists the other values of message, including Order already submitted for a repeat of the same order within two minutes.
A config that fails the checks answers 422 with {"detail": {"errors": [...]}}. The errors are location_id is required and must be an integer, location_id must be a positive integer, or a bucket name rule such as Bucket names use lowercase letters, digits, hyphens and dots, and start and end with a letter or digit. A plan that is no longer sold, such as Object Storage 250 GB, answers 422 with Object Storage 250 GB is no longer sold. Services already on it keep running and renewing.
The order does not check that the location has storage. An order for a location that is not in the regions list is accepted, then fails during setup with That region does not offer object storage, and the service's status becomes failed.
Set a budget, download a month's usage and switch a fixed plan through the API as How Object Storage is billed shows. To cancel, follow Cancel a service with the service ID.
API operations on this page
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/client/object-storage/regions | Regions with a gateway to put a bucket in, with each one's endpoint |
POST | /api/v1/services/order | Order a platform service, and any add-ons bought with it |
PUT | /api/v1/billing/object-storage/{service_id}/budget | Set the service's monthly budget, or change it |
DELETE | /api/v1/billing/object-storage/{service_id}/budget | Remove the service's monthly budget, and with it the alerts |
GET | /api/v1/billing/object-storage/{service_id}/usage.csv | Object storage usage CSV |