Local Repos API

Local repositories management via REST API.

Create

POST /api/repos

Create empty local repository with specified parameters (see also aptly repo create).

JSON body params:

HTTP Errors:

Example:

$ curl -X POST -H 'Content-Type: application/json' --data '{"Name": "aptly-repo"}' http://localhost:8080/api/repos
{"Name":"aptly-repo","Comment":"","DefaultDistribution":"","DefaultComponent":""}

Show

GET /api/repos/:name

Returns basic information about local repository.

HTTP Errors:

Response:

Example:

$ curl http://localhost:8080/api/repos/aptly-repo
{"Name":"aptly-repo","Comment":"","DefaultDistribution":"","DefaultComponent":""}

Show packages/search

GET /api/repos/:name/packages

List all packages in local repository or perform search on repository contents and return result.

Query params:

Example:

$ curl http://localhost:8080/api/repos/aptly-repo/packages
["Pi386 aptly 0.8 966561016b44ed80"]

$ curl http://localhost:8080/api/repos/aptly-repo/packages?q=aptly
["Pi386 aptly 0.8 966561016b44ed80"]

$ curl http://localhost:8080/api/repos/aptly-repo/packages?format=details
[{"Architecture":"i386","Description":" Debian repository management tool\n","Filename":"aptly_0.8_i386.deb","FilesHash":"966561016b44ed80","Homepage":"http://www.aptly.info/","Installed-Size":"11084","Key":"Pi386 aptly 0.8 966561016b44ed80","License":"MIT","MD5sum":"b9be9ed873f1a05da103406cc0a6b9d1","Maintainer":"Andrey Smirnov \u003cme@smira.ru\u003e","Package":"aptly","Priority":"extra","Recommends":"bzip2","SHA1":" 257ab261adcf5dd5bda800976ae606fedb882679","SHA256":" 6342804c7f6bd8cb004ca9d19a7e27f492b7e07843b935a4f96a07a254ae6312","Section":"default","ShortKey":"Pi386 aptly 0.8","Size":"3510032","Vendor":"Andrey Smirnov \u003cme@smira.ru\u003e","Version":"0.8"}]

Edit

PUT /api/repos/:name

Update local repository meta information.

JSON body params:

HTTP Errors:

Response is the same as for GET /api/repos/:name API.

Example:

$ curl -X PUT -H 'Content-Type: application/json' --data '{"DefaultDistribution": "trusty"}' http://localhost:8080/api/repos/local1
{"Name":"local1","Comment":"","DefaultDistribution":"trusty","DefaultComponent":"main"}

List

GET /api/repos

Show list of currently available local repositories. Each repository is returned as in “show” API.

Example:

$ curl http://localhost:8080/api/repos
[{"Name":"aptly-repo","Comment":"","DefaultDistribution":"","DefaultComponent":""}]

Delete

DELETE /api/repos/:name

Delete local repository.

Local repository can’t be deleted if it is published. If local repository has snapshots, aptly would refuse to delete it by default, but that can be overridden with force flag.

Query params:

HTTP Errors:

Add packages from uploaded file/directory

POST /api/repos/:name/file/:dir

POST /api/repos/:name/file/:dir/:file

Import packages from files (uploaded using File Upload API) to the local repository. If directory specified, aptly would discover package files automatically.

Adding same package to local repository is not an error.

By default aptly would try to remove every successfully processed file and directory :dir (if it becomes empty after import).

Query params:

HTTP Errors:

Response:

Report structure:

Example (file upload, add package to repo):

$ curl -X POST -F file=@aptly_0.9~dev+217+ge5d646c_i386.deb http://localhost:8080/api/files/aptly-0.9
["aptly-0.9/aptly_0.9~dev+217+ge5d646c_i386.deb"]

$ curl -X POST http://localhost:8080/api/repos/repo1/file/aptly-0.9
{"FailedFiles":[],"Report":{"Warnings":[],"Added":["aptly_0.9~dev+217+ge5d646c_i386 added"],"Removed":[]}}

Include packages from uploaded file/directory

POST /api/repos/:name/include/:dir

POST /api/repos/:name/include/:dir/:file

New in 1.4.0

Allows automatic processing of .changes file controlling package upload (uploaded using File Upload API) to the local repository. Exposes repo include command in api.

Query params:

Response:

Report structure:

Example (file upload, include changes files in repo):

$ curl -X POST -F file=@hardlink_0.2.1_amd64.changes http://localhost:8080/api/files/hardlink
["file=@hardlink_0.2.1_amd64.changes"]

$ # upload any other files referenced in .changes file...

$ curl -X POST http://localhost:8080/api/repos/repo1/include/hardlink
{"FailedFiles":[],"Report":{"Warnings":[],"Added":["hardlink_0.2.1_source added"],"Removed":[]}}

Add packages by key

POST /api/repos/:name/packages

Add packages to local repository by package keys.

Any package could be added, it should be part of aptly database (it could come from any mirror, snapshot, other local repository). This API combined with package list (search) APIs allows to implement importing, copying, moving packages around.

API verifies that packages actually exist in aptly database and checks constraint that conflicting packages can’t be part of the same local repository.

JSON body params:

HTTP Errors:

Response is the same as for GET /api/repos/:name API.

Example:

$ curl -X POST -H 'Content-Type: application/json' --data '{"PackageRefs": ["Psource pyspi 0.6.1-1.4 f8f1daa806004e89","Pi386 libboost-program-options-dev 1.49.0.1 918d2f433384e378"]}' http://localhost:8080/api/repos/repo2/packages
{"Name":"repo2","Comment":"","DefaultDistribution":"","DefaultComponent":"main"}

Delete packages by key

DELETE /api/repos/:name/packages

Remove packages from local repository by package keys.

Any package(s) could be removed from local repository. List package references in local repository could be retrieved with GET /repos/:name/packages.

JSON body params:

HTTP Errors:

Response is the same as for GET /api/repos/:name API.

Example:

$ curl -X DELETE -H 'Content-Type: application/json' --data '{"PackageRefs": ["Pi386 libboost-program-options-dev 1.49.0.1 918d2f433384e378"]}' http://localhost:8080/api/repos/repo2/packages
{"Name":"repo2","Comment":"","DefaultDistribution":"","DefaultComponent":"main"}