Frequently asked questions

Have a different question and can't find the answer you're looking for?
Ping me on Twitter. Or send an email here

What is Statebin.io?

Statebin.io is a stateful API that provides an interface for creating and managing atomic counters, locks, and buckets.

What are some common use cases for Statebin.io?

Some common use cases include tracking GitHub profile views, keeping a record of link clicks, managing build numbers in CI pipelines, storing user preferences, and maintaining coverage SVG files, among others.

Can I use Statebin.io in my CI/CD pipelines?

Absolutely! Statebin.io is designed to be used programmatically and fits perfectly in CI/CD pipelines. You can track build numbers, store artifacts, and ensure that only one job runs at a time using locks.

How do I use atomic counters?

You can create an atomic counter by simply making a PUT request to
/counter/countername
or
/counter/namespace/countername
To check the status of a lock or to release it, make a GET or DELETE request to the same path, respectively.

How do I reset a counter?

You can reset a counter by making a DELETE request to your counter e.g.
/counter/countername

How do I use locks?

You can create a lock by making a PUT request to
/lock/lockname
or
/lock/namespace/lockname
To check the status of a lock or to release it, make a GET or DELETE request to the same path, respectively.

What is the maximum depth for a counter / lock / bucket path?

The depth of a counter or lock path is limited to three levels. If an attempt is made to access a path with more depth, an error will be returned. Buckets have a maximum depth of 10 levels.

What happens if a lock is not released?

Each lock has a Time-To-Live (TTL) of 60 minutes. If it is not released within this period, it will be released automatically.

How do I manage a bucket?

You can upload a file by making a PUT request to /bucket/namespace/path/to/file.ext
To retrieve or delete the file, make a GET or DELETE request to the same path.

What is the maximum file size I can upload to a bucket?

The maximum file size is 100MB. If you need to upload larger files, please reach out.