Skip to content

Repositories ​

The repositories a caller may see and the details of one.

Operations of this group with their access rule, retry rule, parameters and answers. Every request carries a key: Authorization: Bearer <key> (see Authentication).

Operations ​

List the repositories you can access ​

GET HEAD /api/v1/repositories

Access: Repositories the caller may see (repository.read) · Retry: Safe to repeat (read)

Lists, ordered by name, the repositories in which the caller holds a permission, each with its formats (upack, assets) and the caller's own permissions there; a managed service key sees only those where it holds repository.read. A repository is the scope of the caller's grants, not an entry of a server-wide registry. Pages hold limit cards (1–100, default 50); continue with after set to next.

Parameters

NameInTypeRequiredRules
afterquerystringnomatches ^[a-z0-9][a-z0-9_-]{0,63}$; Exclusive repository ID boundary; authorization is rechecked on every page.
limitqueryintegerno1–100; default 50

Response 200

FieldTypeRequiredRules
itemsarray of objectyesup to 100 items
items[].idstringyesmatches ^[a-z0-9][a-z0-9_-]{0,63}$
items[].formatsarray of stringyes2–2 items; no repeated items; each: one of upack, assets
items[].permissionsarray of stringyes1–24 items; no repeated items; each: one of repository.read, storage.read, storage.manage, diagnostics.read, artifact.read, artifact.list, artifact.delete, artifact.promote, content.read, upload.create, upload.read, upload.write, upload.complete, upload.cancel, job.read, package.read, package.publish, asset.read, asset.write, asset.restore, annotation.read, annotation.write, reference.write, audit.read
nextstringyesmatches ^[a-z0-9][a-z0-9_-]{0,63}$; may be null

Responses: 200, 400, 401, 403, 404, 409, 422, 503, 507

Example

bash
curl -X GET "$ARKVORY_URL/api/v1/repositories" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Get a repository card ​

GET HEAD /api/v1/repositories/{repository}

Access: Repositories the caller may see (repository.read) · Retry: Safe to repeat (read)

Returns the caller's card of one repository: its formats and the caller's permissions in it. A repository the caller cannot see answers 404, exactly like one that does not exist; HEAD makes this a cheap access check. Seeing a repository grants no access to its content or settings.

Parameters

NameInTypeRequiredRules
repositorypathstringyesmatches ^[a-z0-9][a-z0-9_-]{0,63}$

Response 200

FieldTypeRequiredRules
idstringyesmatches ^[a-z0-9][a-z0-9_-]{0,63}$
formatsarray of stringyes2–2 items; no repeated items; each: one of upack, assets
permissionsarray of stringyes1–24 items; no repeated items; each: one of repository.read, storage.read, storage.manage, diagnostics.read, artifact.read, artifact.list, artifact.delete, artifact.promote, content.read, upload.create, upload.read, upload.write, upload.complete, upload.cancel, job.read, package.read, package.publish, asset.read, asset.write, asset.restore, annotation.read, annotation.write, reference.write, audit.read

Responses: 200, 400, 401, 403, 404, 409, 422, 503, 507

Example

bash
curl -X GET "$ARKVORY_URL/api/v1/repositories/$REPOSITORY" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Arkvory · ProAnimaStudio