API

Here is the Admiral API documentation.

Returns

In this documentation, endpoints have returns values. Here are these values descriptions:

Value Description
200 OK Everything worked as expected
401 Unauthorized You are not authorized to access the given resource
404 Not Found The resource you are trying to get does not exist
409 Conflict The resource you are trying to add already exists

Non-authenticated calls

URI Method Description Body Returns
/ GET Health check endpoint 200 OK
/events POST Docker Registry events endpoint 200 OK
/v1/version GET Get admiral version 200 OK
/v1/user PUT Create a new user 
{"username":"", "password":""}
  • 200 OK
  • 409 Conflict

Authenticated calls

Authenticated calls need the user to use HTTP basic authentication system in order to do these calls.

Login

URI Method Description Parameters Returns
/v1/login GET Check if the user is able to login
  • 200 OK
  • 401 Unauthorized

Images

URI Method Description Parameters Returns
/v1/images GET Return the user's images
  • 200 OK
  • 401 Unauthorized
/v1/image/*image GET Return the image The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
/v1/image/*image DELETE Remove the given image with all its tags The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
/v1/image/public/*image PATCH Set the given image as public The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
/v1/image/private/*image PATCH Set the given image as public The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found

Token

URI Method Description Parameters Returns
/v1/token GET Get a bearer token for the asked resource
  • 200 OK
  • 401 Unauthorized

Admin

URI Method Description Parameters Returns
/v1/admin/login GET Check if the admin is able to login
  • 200 OK
  • 401 Unauthorized
/v1/admin/images GET Return all images
  • 200 OK
  • 401 Unauthorized
/v1/admin/image/*image GET Return the image The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
/v1/admin/image/*image DELETE Remove the given image with all its tags The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
/v1/admin/image/public/*image PATCH Set the given image as public The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
/v1/admin/image/private/*image PATCH Set the given image as public The image name
  • 200 OK
  • 401 Unauthorized
  • 404 Not Found