Chapter 20. robot

20.1. getUserRobots
Copiar enlace

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>"

20.2. getOrgRobotPermissions
Copiar enlace

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"

20.3. regenerateOrgRobotToken
Copiar enlace

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"

20.4. getUserRobotPermissions
Copiar enlace

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"

20.5. regenerateUserRobotToken
Copiar enlace

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"

20.6. getOrgRobot
Copiar enlace

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>"

20.7. createOrgRobot
Copiar enlace

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>"

20.8. deleteOrgRobot
Copiar enlace

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>"

20.9. getOrgRobots
Copiar enlace

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"

20.10. getUserRobot
Copiar enlace

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>"

20.11. createUserRobot
Copiar enlace

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>"

20.12. deleteUserRobot
Copiar enlace

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>"

20.13. Auth Federated Robot Token
Copiar enlace

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>"

20.14. createOrgRobotFederation
Copiar enlace

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"

Este contenido no está disponible en el idioma seleccionado.

20.1. getUserRobotsCopiar enlaceEnlace copiado en el portapapeles!

GET /api/v1/user/robots

Query parameters

Responses

Example command

20.2. getOrgRobotPermissionsCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.3. regenerateOrgRobotTokenCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.4. getUserRobotPermissionsCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.5. regenerateUserRobotTokenCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.6. getOrgRobotCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.7. createOrgRobotCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Request body schema (application/json)

Responses

Example command

20.8. deleteOrgRobotCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.9. getOrgRobotsCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Query parameters

Responses

Example command

20.10. getUserRobotCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.11. createUserRobotCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Request body schema (application/json)

Responses

Example command

20.12. deleteUserRobotCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

20.13. Auth Federated Robot TokenCopiar enlaceEnlace copiado en el portapapeles!

GET oauth2/federation/robot/token

Responses

Request Body

Example command

20.14. createOrgRobotFederationCopiar enlaceEnlace copiado en el portapapeles!

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

Path parameters

Responses

Example command

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Hacer que el código abierto sea más inclusivo

20.1. getUserRobots
Copiar enlace

20.2. getOrgRobotPermissions
Copiar enlace

20.3. regenerateOrgRobotToken
Copiar enlace

20.4. getUserRobotPermissions
Copiar enlace

20.5. regenerateUserRobotToken
Copiar enlace

20.6. getOrgRobot
Copiar enlace

20.7. createOrgRobot
Copiar enlace

20.8. deleteOrgRobot
Copiar enlace

20.9. getOrgRobots
Copiar enlace

20.10. getUserRobot
Copiar enlace

20.11. createUserRobot
Copiar enlace

20.12. deleteUserRobot
Copiar enlace

20.13. Auth Federated Robot Token
Copiar enlace

20.14. createOrgRobotFederation
Copiar enlace