Get registry storage

import requests

url = "https://platform.ankra.app/api/v1/org/registry-storage"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/registry-storage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "organisation_id": "<string>",
  "limit_bytes": 123,
  "default_limit_bytes": 123,
  "source": "default",
  "reason": "<string>",
  "updated_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "used_bytes": 123,
  "usage_status": "complete",
  "projects": [
    {
      "name": "<string>",
      "project": "<string>",
      "limit_bytes": 123,
      "used_bytes": 123,
      "status": "ok"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Credentials

Get registry storage

Read the organisation’s registry storage: the storage limit each of its registry projects carries, whether that limit is the platform default or one set for the organisation (and why), and how much each project holds. usage_status says whether the figures are complete, a lower bound (partial), unknown (the registry could not be read; used_bytes is then absent, never zero) or not_provisioned (no registry project yet). A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication).

GET

/

api

/

v1

/

org

/

registry-storage

Get registry storage

import requests

url = "https://platform.ankra.app/api/v1/org/registry-storage"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/registry-storage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "organisation_id": "<string>",
  "limit_bytes": 123,
  "default_limit_bytes": 123,
  "source": "default",
  "reason": "<string>",
  "updated_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "used_bytes": 123,
  "usage_status": "complete",
  "projects": [
    {
      "name": "<string>",
      "project": "<string>",
      "limit_bytes": 123,
      "used_bytes": 123,
      "status": "ok"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization

string | null

x-ankra-organisation-id

string | null

Response

Successful Response

organisation_id

string

required

limit_bytes

integer

required

The storage limit in force for each of the organisation's registry projects, in bytes; -1 is no limit.

default_limit_bytes

integer

required

The platform default an organisation with no limit of its own carries.

source

enum<string>

required

Available options:

default,

organisation

reason

string | null

required

updated_by

string | null

required

updated_at

string<date-time>

required

used_bytes

integer | null

required

What the organisation's projects hold; absent when no project could be read, a lower bound when usage_status is partial.

usage_status

enum<string>

required

Available options:

complete,

partial,

unknown,

not_provisioned

projects

RegistryStorageProject · object[]

required

Show child attributes