Registries
Package registries, their logins and their repositories.
| Operation | Kind | HTTP |
|---|---|---|
registries.list | call | GET /v1/registries |
registries.save | call | PUT /v1/registries/{name} |
registries.remove | call | DELETE /v1/registries/{name} |
registries.rename | call | POST /v1/registries/{name}/rename |
registries.check | call | POST /v1/registries/{name}/check |
registries.list
The registries.
Needs the role admin.
Result
| Field | Type | Description |
|---|---|---|
registries | map of any | By 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. |
{
"id": 1,
"op": "registries.list"
}{
"id": 1,
"result": {
"registries": {}
}
}registries.save
Add a registry, or change one.
Needs the role admin.
Arguments
| Name | Where | Required | Description |
|---|---|---|---|
name | path | yes | The registry's name here, or the id of one there is |
Input
type, url, and optionally username and repositories
Result
| Field | Type | Description |
|---|---|---|
ok | boolean |
Errors
| Status | When |
|---|---|
| 400 | Not a registry |
{
"id": 1,
"op": "registries.save",
"args": {
"name": "status"
},
"data": {
"columns": 2
}
}{
"id": 1,
"result": {
"ok": true
}
}registries.remove
Remove a registry with its stored login.
Needs the role admin.
Arguments
| Name | Where | Required | Description |
|---|---|---|---|
name | path | yes | A registry, by its name or its id (bare or as reg_ID) |
Result
| Field | Type | Description |
|---|---|---|
ok | boolean |
Errors
| Status | When |
|---|---|
| 404 | No such registry |
{
"id": 1,
"op": "registries.remove",
"args": {
"name": "status"
}
}{
"id": 1,
"result": {
"ok": true
}
}registries.rename
Give a registry another name.
Needs the role admin.
Arguments
| Name | Where | Required | Description |
|---|---|---|---|
name | path | yes | The registry, by its name or its id (bare or as reg_ID) |
Input
The new name
| Field | Type | Description |
|---|---|---|
name | string |
Result
| Field | Type | Description |
|---|---|---|
ok | boolean |
Errors
| Status | When |
|---|---|
| 400 | Not a name for a registry |
| 404 | No such registry |
| 409 | The name is taken |
{
"id": 1,
"op": "registries.rename",
"args": {
"name": "status"
},
"data": {
"name": "status"
}
}{
"id": 1,
"result": {
"ok": true
}
}registries.check
Whether a registry answers and takes its login.
Needs the role admin.
Arguments
| Name | Where | Required | Description |
|---|---|---|---|
name | path | yes | A registry, by its name or its id (bare or as reg_ID) |
Result
| Field | Type | Description |
|---|---|---|
lines | string[] | One line per thing checked, starting with ✓, ! or ✗. |
Errors
| Status | When |
|---|---|
| 404 | No such registry |
{
"id": 1,
"op": "registries.check",
"args": {
"name": "status"
}
}{
"id": 1,
"result": {
"lines": [
"text"
]
}
}