APIs

Bizfly Container Registry supports users to manage their images through Restful API

API Endpoint: https://manage.bizflycloud.vn/container-registry/api/

Authentication

Guide to authentication here

Error code

HTTP error code Description
200 Success
401 Authenticated failure
403 Access is blocked due to the expiry date of testing, overdue payment or other reasons
404 The resource does not exist or the address is incorrect
422 Error occurs, see details in response body

APIs path

GET /_/ # get repositories
Request body example
none
Response body example
{
  "repositories": [
    {
      "name": "string",
      "last_push": "2021-12-17T08:53:16.568Z",
      "pulls": 0,
      "public": true,
      "created_at": "2021-12-17T08:53:16.568Z"
    }
  ]
}

POST /_/ # create repository
Request body example
{
  "name": "string",
  "public": false
}
Response body example
none

DELETE /_/{repository_name} # delete repository
Request body example
none
Response body example
none

GET /_/{repository_name} # get repository tags
Request body example
none
Response body example
{
  "repository": {
    "name": "string",
    "last_push": "2021-12-17T09:00:07.103Z",
    "pulls": 0,
    "public": true,
    "created_at": "2021-12-17T09:00:07.103Z"
  },
  "tags": [
    {
      "name": "string",
      "author": "string",
      "last_updated": "2021-12-17T09:00:07.103Z",
      "size": 0,
      "created_at": "2021-12-17T09:00:07.103Z",
      "last_scan": "2021-12-17T09:00:07.103Z",
      "scan_status": "string",
      "vulnerabilities": 0,
      "fixes": 0
    }
  ]
}

PATCH /_/{repository_name} # edit repository
Request body example
{
  "public": true
}
Response body example
none

DELETE /_/{repository_name}/tag/{tag_name} # delete image tag
Request body example
none
Response body example
none

GET /_/{repository_name}/tag/{tag_name} # get image info
Request body example
none
Response body example
{
  "repository": {
    "name": "string",
    "last_push": "2021-12-17T09:00:59.421Z",
    "pulls": 0,
    "public": true,
    "created_at": "2021-12-17T09:00:59.421Z"
  },
  "tag": {
    "name": "string",
    "author": "string",
    "last_updated": "2021-12-17T09:00:59.421Z",
    "size": 0,
    "created_at": "2021-12-17T09:00:59.421Z",
    "last_scan": "2021-12-17T09:00:59.421Z",
    "scan_status": "string",
    "vulnerabilities": 0,
    "fixes": 0
  },
  "vulnerabilities": [
    {
      "package": "string",
      "name": "string",
      "namespace": "string",
      "description": "string",
      "link": "string",
      "severity": "string",
      "fixed_by": "string"
    }
  ]
}