harbor_client.RobotApi

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

MethodHTTP requestDescription
create_robotPOST /robotsCreate a robot account
delete_robotDELETE /robots/{robot_id}Delete a robot account
get_robot_by_idGET /robots/{robot_id}Get a robot account
list_robotGET /robotsGet robot account
refresh_secPATCH /robots/{robot_id}Refresh the robot secret
update_robotPUT /robots/{robot_id}Update a robot account

create_robot

Signature

create_robot(robot: RobotCreate, x_request_id: Optional[str])-> RobotCreated

Create a robot account

Create a robot account

Example

from __future__ import print_function
import time
import harbor_client
from harbor_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = harbor_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor_client.RobotApi(harbor_client.ApiClient(configuration))
robot = harbor_client.RobotCreate() # RobotCreate | The JSON object of a robot account.
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)

try:
    # Create a robot account
    api_response = api_instance.create_robot(robot, x_request_id=x_request_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RobotApi->create_robot: %s\n" % e)

Parameters

NameTypeDescriptionNotes
robotRobotCreateThe JSON object of a robot account.
x_request_idstrAn unique ID for the request[optional]

Return type

RobotCreated

Authorization

basic

HTTP request headers

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

[Back to top]

delete_robot

Signature

delete_robot(robot_id: int, x_request_id: Optional[str])-> None

Delete a robot account

This endpoint deletes specific robot account information by robot ID.

Example

from __future__ import print_function
import time
import harbor_client
from harbor_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = harbor_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor_client.RobotApi(harbor_client.ApiClient(configuration))
robot_id = 56 # int | Robot ID
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)

try:
    # Delete a robot account
    api_instance.delete_robot(robot_id, x_request_id=x_request_id)
except ApiException as e:
    print("Exception when calling RobotApi->delete_robot: %s\n" % e)

Parameters

NameTypeDescriptionNotes
robot_idintRobot ID
x_request_idstrAn unique ID for the request[optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

[Back to top]

get_robot_by_id

Signature

get_robot_by_id(robot_id: int, x_request_id: Optional[str])-> Robot

Get a robot account

This endpoint returns specific robot account information by robot ID.

Example

from __future__ import print_function
import time
import harbor_client
from harbor_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = harbor_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor_client.RobotApi(harbor_client.ApiClient(configuration))
robot_id = 56 # int | Robot ID
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)

try:
    # Get a robot account
    api_response = api_instance.get_robot_by_id(robot_id, x_request_id=x_request_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RobotApi->get_robot_by_id: %s\n" % e)

Parameters

NameTypeDescriptionNotes
robot_idintRobot ID
x_request_idstrAn unique ID for the request[optional]

Return type

Robot

Authorization

basic

HTTP request headers

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

[Back to top]

list_robot

Signature

list_robot(x_request_id: Optional[str], q: Optional[str], sort: Optional[str], page: Optional[int], page_size: Optional[int])-> list[Robot]

Get robot account

List the robot accounts with the specified level and project.

Example

from __future__ import print_function
import time
import harbor_client
from harbor_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = harbor_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor_client.RobotApi(harbor_client.ApiClient(configuration))
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)
q = 'q_example' # str | Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max] (optional)
sort = 'sort_example' # str | Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\" (optional)
page = 1 # int | The page number (optional) (default to 1)
page_size = 10 # int | The size of per page (optional) (default to 10)

try:
    # Get robot account
    api_response = api_instance.list_robot(x_request_id=x_request_id, q=q, sort=sort, page=page, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RobotApi->list_robot: %s\n" % e)

Parameters

NameTypeDescriptionNotes
x_request_idstrAn unique ID for the request[optional]
qstrQuery string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=~v)", "range(k=[min~max])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=~v2,k3=[min~max][optional]
sortstrSort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with "sort=field1,-field2"[optional]
pageintThe page number[optional] [default to 1]
page_sizeintThe size of per page[optional] [default to 10]

Return type

list[Robot]

Authorization

basic

HTTP request headers

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

[Back to top]

refresh_sec

Signature

refresh_sec(robot_id: int, robot_sec: RobotSec, x_request_id: Optional[str])-> RobotSec

Refresh the robot secret

Refresh the robot secret

Example

from __future__ import print_function
import time
import harbor_client
from harbor_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = harbor_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor_client.RobotApi(harbor_client.ApiClient(configuration))
robot_id = 56 # int | Robot ID
robot_sec = harbor_client.RobotSec() # RobotSec | The JSON object of a robot account.
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)

try:
    # Refresh the robot secret
    api_response = api_instance.refresh_sec(robot_id, robot_sec, x_request_id=x_request_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RobotApi->refresh_sec: %s\n" % e)

Parameters

NameTypeDescriptionNotes
robot_idintRobot ID
robot_secRobotSecThe JSON object of a robot account.
x_request_idstrAn unique ID for the request[optional]

Return type

RobotSec

Authorization

basic

HTTP request headers

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

[Back to top]

update_robot

Signature

update_robot(robot_id: int, robot: Robot, x_request_id: Optional[str])-> None

Update a robot account

This endpoint updates specific robot account information by robot ID.

Example

from __future__ import print_function
import time
import harbor_client
from harbor_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = harbor_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = harbor_client.RobotApi(harbor_client.ApiClient(configuration))
robot_id = 56 # int | Robot ID
robot = harbor_client.Robot() # Robot | The JSON object of a robot account.
x_request_id = 'x_request_id_example' # str | An unique ID for the request (optional)

try:
    # Update a robot account
    api_instance.update_robot(robot_id, robot, x_request_id=x_request_id)
except ApiException as e:
    print("Exception when calling RobotApi->update_robot: %s\n" % e)

Parameters

NameTypeDescriptionNotes
robot_idintRobot ID
robotRobotThe JSON object of a robot account.
x_request_idstrAn unique ID for the request[optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

[Back to top]