Skip to content

Files

Latest commit

 

History

History
60 lines (43 loc) · 1.41 KB

api-robot-createOrgRobot.adoc

File metadata and controls

60 lines (43 loc) · 1.41 KB

createOrgRobot

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

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

Name Description Schema

description
optional

Optional text description for the robot

string

unstructured_metadata
optional

Optional unstructured metadata for the robot

object

Responses

HTTP Code Description Schema

201

Successful invocation

400

Bad Request

401

Session required

403

Unauthorized access

404

Not found

Example command

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