Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.87 KB

IconApi.md

File metadata and controls

62 lines (44 loc) · 1.87 KB
Raw

harbor.IconApi

All URIs are relative to http://localhost/api/v2.0

Method HTTP request Description
get_icon GET /icons/{digest} Get artifact icon

get_icon

Icon get_icon(digest, x_request_id=x_request_id)

Get artifact icon

Get the artifact icon with the specified digest. As the original icon image is resized and encoded before returning, the parameter "digest" in the path doesn't match the hash of the returned content

Example

from __future__ import print_function
import time
import harbor
from harbor.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = harbor.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor.IconApi(harbor.ApiClient(configuration))
digest = 'digest_example' # str | The digest of the resource
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)

try:
    # Get artifact icon
    api_response = api_instance.get_icon(digest, x_request_id=x_request_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IconApi->get_icon: %s\n" % e)

Parameters

Name Type Description Notes
digest str The digest of the resource
x_request_id str An unique ID for the request [optional]

Return type

Icon

Authorization

basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]