Chapter 18. robot

18.1. getUserRobots
复制链接

List the available robots for the user.

GET /api/v1/user/robots

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

Type	Name	Description	Schema
query	limit optional	If specified, the number of robots to return.	integer
query	token optional	If false, the robot’s token is not returned.	boolean
query	permissions optional	Whether to include repositories and teams in which the robots have permission.	boolean

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET "https://quay-server.example.com/api/v1/user/robots?limit=10&token=false&permissions=true" \
  -H "Authorization: Bearer <your_access_token>"

$ curl -X GET "https://quay-server.example.com/api/v1/user/robots?limit=10&token=false&permissions=true" \
  -H "Authorization: Bearer <your_access_token>"

Copy to Clipboard

Toggle word wrap

18.2. getOrgRobotPermissions
复制链接

Returns the list of repository permissions for the org’s robot.

GET /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string
path	orgname required	The name of the organization	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/organization/<ORGNAME>/robots/<ROBOT_SHORTNAME>/permissions"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/organization/<ORGNAME>/robots/<ROBOT_SHORTNAME>/permissions"

Copy to Clipboard

Toggle word wrap

18.3. regenerateOrgRobotToken
复制链接

Regenerates the token for an organization robot.

POST /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string
path	orgname required	The name of the organization	string

Responses

Expand

HTTP Code	Description	Schema
201	Successful creation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"

Copy to Clipboard

Toggle word wrap

18.4. getUserRobotPermissions
复制链接

Returns the list of repository permissions for the user’s robot.

GET /api/v1/user/robots/{robot_shortname}/permissions

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/user/robots/<ROBOT_SHORTNAME>/permissions"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/user/robots/<ROBOT_SHORTNAME>/permissions"

Copy to Clipboard

Toggle word wrap

18.5. regenerateUserRobotToken
复制链接

Regenerates the token for a user’s robot.

POST /api/v1/user/robots/{robot_shortname}/regenerate

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string

Responses

Expand

HTTP Code	Description	Schema
201	Successful creation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>/regenerate"

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>/regenerate"

Copy to Clipboard

Toggle word wrap

18.6. getOrgRobot
复制链接

Returns the organization’s robot with the specified name.

GET /api/v1/organization/{orgname}/robots/{robot_shortname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string
path	orgname required	The name of the organization	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/organization/<ORGNAME>/robots/<ROBOT_SHORTNAME>"

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://quay-server.example.com/api/v1/organization/<ORGNAME>/robots/<ROBOT_SHORTNAME>"

Copy to Clipboard

Toggle word wrap

18.7. createOrgRobot
复制链接

Create a new robot in the organization.

PUT /api/v1/organization/{orgname}/robots/{robot_shortname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string
path	orgname required	The name of the organization	string

Request body schema (application/json)

Optional data for creating a robot

Expand

Name	Description	Schema
description optional	Optional text description for the robot	string
unstructured_metadata optional	Optional unstructured metadata for the robot	object

Responses

Expand

HTTP Code	Description	Schema
201	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X PUT   -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_name>"

$ curl -X PUT   -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_name>"

Copy to Clipboard

Toggle word wrap

18.8. deleteOrgRobot
复制链接

Delete an existing organization robot.

DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string
path	orgname required	The name of the organization	string

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_shortname>"

curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_shortname>"

Copy to Clipboard

Toggle word wrap

18.9. getOrgRobots
复制链接

List the organization’s robots.

GET /api/v1/organization/{orgname}/robots

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	string

Query parameters

Expand

Type	Name	Description	Schema
query	limit optional	If specified, the number of robots to return.	integer
query	token optional	If false, the robot’s token is not returned.	boolean
query	permissions optional	Whether to include repositories and teams in which the robots have permission.	boolean

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/organization/<organization_name>/robots"

$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/organization/<organization_name>/robots"

Copy to Clipboard

Toggle word wrap

18.10. getUserRobot
复制链接

Returns the user’s robot with the specified name.

GET /api/v1/user/robots/{robot_shortname}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

Copy to Clipboard

Toggle word wrap

18.11. createUserRobot
复制链接

Create a new user robot with the specified name.

PUT /api/v1/user/robots/{robot_shortname}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string

Request body schema (application/json)

Optional data for creating a robot

Expand

Name	Description	Schema
description optional	Optional text description for the robot	string
unstructured_metadata optional	Optional unstructured metadata for the robot	object

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X PUT   -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/user/robots/<robot_name>"

$ curl -X PUT   -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/user/robots/<robot_name>"

Copy to Clipboard

Toggle word wrap

18.12. deleteUserRobot
复制链接

Delete an existing robot.

DELETE /api/v1/user/robots/{robot_shortname}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	robot_shortname required	The short name for the robot, without any user or organization prefix	string

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

$ curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

Copy to Clipboard

Toggle word wrap

18.13. Auth Federated Robot Token
复制链接

Return an expiring robot token using the robot identity federation mechanism.

GET oauth2/federation/robot/token

Authorizations: oauth2_implicit (robot:auth)

Responses

Expand

HTTP Code	Description	Schema
200	Successful authentication and token generation	{ "token": "string" }
401	Unauthorized: missing or invalid authentication	{ "error": "string" }

Request Body

Expand

Type	Name	Description	Schema
body	auth_result required	The result of the authentication process, containing information about the robot identity.	{ "missing": "boolean", "error_message": "string", "context": { "robot": "RobotObject" } }

Example command

curl -X GET "https://quay-server.example.com/oauth2/federation/robot/token" \
  -H "Authorization: Bearer <your_access_token>"

$ curl -X GET "https://quay-server.example.com/oauth2/federation/robot/token" \
  -H "Authorization: Bearer <your_access_token>"

Copy to Clipboard

Toggle word wrap

18.14. createOrgRobotFederation
复制链接

Create a federation configuration for the specified organization robot.

POST /api/v1/organization/{orgname}/robots/{robot_shortname}/federation

Retrieve the federation configuration for the specified organization robot.

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname + robot_shortnamerequired	The name of the organization and the short name for the robot, without any user or organization prefix	string

Responses

Expand

HTTP Code	Description	Schema
201	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError

Example command

curl -X POST "https://quay-server.example.com/api/v1/organization/{orgname}/robots/{robot_shortname}/federation" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json"

$ curl -X POST "https://quay-server.example.com/api/v1/organization/{orgname}/robots/{robot_shortname}/federation" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json"

Copy to Clipboard

Toggle word wrap

此内容没有您所选择的语言版本。

18.1. getUserRobots复制链接链接已复制到粘贴板!

GET /api/v1/user/robots

Query parameters

Responses

Example command

18.2. getOrgRobotPermissions复制链接链接已复制到粘贴板!

GET /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions

Path parameters

Responses

Example command

18.3. regenerateOrgRobotToken复制链接链接已复制到粘贴板!

POST /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate

Path parameters

Responses

Example command

18.4. getUserRobotPermissions复制链接链接已复制到粘贴板!

GET /api/v1/user/robots/{robot_shortname}/permissions

Path parameters

Responses

Example command

18.5. regenerateUserRobotToken复制链接链接已复制到粘贴板!

POST /api/v1/user/robots/{robot_shortname}/regenerate

Path parameters

Responses

Example command

18.6. getOrgRobot复制链接链接已复制到粘贴板!

GET /api/v1/organization/{orgname}/robots/{robot_shortname}

Path parameters

Responses

Example command

18.7. createOrgRobot复制链接链接已复制到粘贴板!

PUT /api/v1/organization/{orgname}/robots/{robot_shortname}

Path parameters

Request body schema (application/json)

Responses

Example command

18.8. deleteOrgRobot复制链接链接已复制到粘贴板!

DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}

Path parameters

Responses

Example command

18.9. getOrgRobots复制链接链接已复制到粘贴板!

GET /api/v1/organization/{orgname}/robots

Path parameters

Query parameters

Responses

Example command

18.10. getUserRobot复制链接链接已复制到粘贴板!

GET /api/v1/user/robots/{robot_shortname}

Path parameters

Responses

Example command

18.11. createUserRobot复制链接链接已复制到粘贴板!

PUT /api/v1/user/robots/{robot_shortname}

Path parameters

Request body schema (application/json)

Responses

Example command

18.12. deleteUserRobot复制链接链接已复制到粘贴板!

DELETE /api/v1/user/robots/{robot_shortname}

Path parameters

Responses

Example command

18.13. Auth Federated Robot Token复制链接链接已复制到粘贴板!

GET oauth2/federation/robot/token

Responses

Request Body

Example command

18.14. createOrgRobotFederation复制链接链接已复制到粘贴板!

POST /api/v1/organization/{orgname}/robots/{robot_shortname}/federation

Path parameters

Responses

Example command

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

18.1. getUserRobots
复制链接

18.2. getOrgRobotPermissions
复制链接

18.3. regenerateOrgRobotToken
复制链接

18.4. getUserRobotPermissions
复制链接

18.5. regenerateUserRobotToken
复制链接

18.6. getOrgRobot
复制链接

18.7. createOrgRobot
复制链接

18.8. deleteOrgRobot
复制链接

18.9. getOrgRobots
复制链接

18.10. getUserRobot
复制链接

18.11. createUserRobot
复制链接

18.12. deleteUserRobot
复制链接

18.13. Auth Federated Robot Token
复制链接

18.14. createOrgRobotFederation
复制链接