Rest api
Artipie provides Rest API to manage repositories, users
and storages aliases. API is self-documented with Swagger
interface, Swagger documentation pages are available on URLs http://{host}:{api}/api/index.html.
In Swagger documentation have three definitions - Repositories, Users and Auth Token. You can switch between the definitions with the help of "Select a definition" listbox.
All Rest API endpoints require JWT authentication token to be passed in Authentification header.
The token can be issued with the help of POST /api/v1/oauth/token request on the "Auth Token"
definition page in Swagger. Once token is received, copy it, open another definition, press
"Authorize" button and paste the token. Swagger will add the token to any request you perform.
Rest API allows to manage repository settings: read, create, update and remove operations are supported. Note, that jsons, accepted by Rest endpoints, are equivalents of the YAML repository settings. Which means, that API accepts all the repository specific settings fields which are applicable to the repository. Choose repository you are interested in from this table to learn all the details.
Rest API provides method to rename repository PUT /api/v1/{repo_name}/move ({repo_name} is the
name of the repository) and move all the data
from repository with the {repo_name} to repository with new name (new name is provided in json
request body, check Swagger docs to learn the format). Response is returned immediately, but data
manipulation is performed in asynchronous mode, so to make sure data transfer is complete,
call HEAD /api/v1/{repo_name} and verify status 404 NOT FOUND is returned.
Storage aliases can also be managed with Rest API, there are methods to read, create, update and remove aliases. Note, that concrete storage settings depends on storage type, Rest API accepts all the parameters in json format equivalent to the YAML storages setting.
Use Rest API to obtain list of the users, check user info, add, update, remove or deactivate user. Also, it's
possible to change password by calling POST /api/v1/{username}/alter/password method providing
old and new password in json request body.
Users API is available if either artipie credentials type or artipie policy is used.
Rest API endpoint allow to create or update, obtain roles list or single role info details,
deactivate or remove roles. Roles API endpoints are available if artipie policy is used.
Check policy section to learn more about users or roles info format.