Skip to Content

Registries

Package registries, their logins and their repositories.

OperationKindHTTP
registries.listcallGET /v1/registries
registries.savecallPUT /v1/registries/{name}
registries.removecallDELETE /v1/registries/{name}
registries.renamecallPOST /v1/registries/{name}/rename
registries.checkcallPOST /v1/registries/{name}/check

registries.list

The registries.

Needs the role admin.

Result

FieldTypeDescription
registriesmap of anyBy name: its id, type (nexus, npm, raw or docker), url, username and, for a Nexus server, its repositories. The id is rookery's, and is left out of what is saved.
Request
{
  "id": 1,
  "op": "registries.list"
}
Reply
{
  "id": 1,
  "result": {
    "registries": {}
  }
}

registries.save

Add a registry, or change one.

Needs the role admin.

Arguments

NameWhereRequiredDescription
namepathyesThe registry's name here, or the id of one there is

Input

type, url, and optionally username and repositories

Result

FieldTypeDescription
okboolean

Errors

StatusWhen
400Not a registry
Request
{
  "id": 1,
  "op": "registries.save",
  "args": {
    "name": "status"
  },
  "data": {
    "columns": 2
  }
}
Reply
{
  "id": 1,
  "result": {
    "ok": true
  }
}

registries.remove

Remove a registry with its stored login.

Needs the role admin.

Arguments

NameWhereRequiredDescription
namepathyesA registry, by its name or its id (bare or as reg_ID)

Result

FieldTypeDescription
okboolean

Errors

StatusWhen
404No such registry
Request
{
  "id": 1,
  "op": "registries.remove",
  "args": {
    "name": "status"
  }
}
Reply
{
  "id": 1,
  "result": {
    "ok": true
  }
}

registries.rename

Give a registry another name.

Needs the role admin.

Arguments

NameWhereRequiredDescription
namepathyesThe registry, by its name or its id (bare or as reg_ID)

Input

The new name

FieldTypeDescription
namestring

Result

FieldTypeDescription
okboolean

Errors

StatusWhen
400Not a name for a registry
404No such registry
409The name is taken
Request
{
  "id": 1,
  "op": "registries.rename",
  "args": {
    "name": "status"
  },
  "data": {
    "name": "status"
  }
}
Reply
{
  "id": 1,
  "result": {
    "ok": true
  }
}

registries.check

Whether a registry answers and takes its login.

Needs the role admin.

Arguments

NameWhereRequiredDescription
namepathyesA registry, by its name or its id (bare or as reg_ID)

Result

FieldTypeDescription
linesstring[]One line per thing checked, starting with ✓, ! or ✗.

Errors

StatusWhen
404No such registry
Request
{
  "id": 1,
  "op": "registries.check",
  "args": {
    "name": "status"
  }
}
Reply
{
  "id": 1,
  "result": {
    "lines": [
      "text"
    ]
  }
}

On this page