Skip to content
Artbucket

Usage and limits

GET
/api/v1/usage
curl --request GET \
  --url http://localhost:3000/api/v1/usage \
  --header 'Authorization: Bearer <token>'

What the organization uses, the limits its server’s operator set, and 30 days of delivery traffic. Admin on the organization.

Any caller; the scope needed is checked on what it acts on.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Usage

Media typeapplication/json
object
data
required
object
limits
required

Set by whoever runs the server; never by the organization

object
storage
required

Bytes of assets; null: no limit

number | null
editors
required

People with write or admin, invitations included; null: no limit

number | null
projects
required

Projects; null: no limit

number | null
brands
required

Brands, over all projects; null: no limit

number | null
domains
required

Custom domains, the app’s and its portals’; null: no limit

number | null
emails
required

Emails a day: invitations, share links, tests; null: no limit

number | null
features
required
Any of:
Array<string>
Allowed values: agents shares sso
readOnly
required
boolean
suspended
required

Suspended by whoever runs the server, and why: its portals, links, listings and public files are unavailable (451), and it is read-only; null: not

string | null
billing
required
Any of:
string format: uri
used
required
object
storage
required
number
editors
required
integer
>= -9007199254740991 <= 9007199254740991
projects
required
integer
>= -9007199254740991 <= 9007199254740991
brands
required
integer
>= -9007199254740991 <= 9007199254740991
domains
required
integer
>= -9007199254740991 <= 9007199254740991
traffic
required

What /a/{id} served: originals, renditions and downloads

object
days
required

How far back

integer
>= -9007199254740991 <= 9007199254740991
projects
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
storage
required
number
requests
required
integer
>= -9007199254740991 <= 9007199254740991
bytes
required
number
daily
required
Array<object>
object
day
required
string
requests
required
integer
>= -9007199254740991 <= 9007199254740991
bytes
required
number
Example
{
  "data": {
    "limits": {
      "features": [
        "agents"
      ]
    }
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}