Language:
Format:

Chapter 2. Appendix A: Red Hat Quay Application Programming Interface (API)

This API allows you to perform many of the operations required to work with Red Hat Quay repositories, users, and organizations.

2.1. get /api/v1/plans/

2.1.1. Implementation Notes

List the available plans.

2.1.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.2. build : Create, list, cancel and get status/logs of repository builds.

2.2.1. get /api/v1/repository/{repository}/build/

2.2.1.1. Implementation Notes

Get the list of repository builds.

2.2.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string
since		Returns all builds since the given unix timecode	query	integer
limit		The maximum number of builds to return	query	integer

2.2.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.2.2. post /api/v1/repository/{repository}/build/

2.2.2.1. Implementation Notes

Request that a repository be built and pushed from the specified input.

2.2.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "subdirectory": "string", "archive_url": "string", "docker_tags": [ "string" ], "pull_robot": "string", "file_id": "string", "context": "string", "dockerfile_path": "string" }

2.2.2.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.2.3. get /api/v1/repository/{repository}/build/{build_uuid}/status

2.2.3.1. Implementation Notes

Return the status for the builds specified by the build uuids.

2.2.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
build_uuid	required	The UUID of the build	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.2.3.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.2.4. delete /api/v1/repository/{repository}/build/{build_uuid}

2.2.4.1. Implementation Notes

Cancels a repository build.

2.2.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
build_uuid	required	The UUID of the build	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.2.4.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title":Successful invocation "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.2.5. get /api/v1/repository/{repository}/build/{build_uuid}

2.2.5.1. Implementation Notes

Returns information about a build.

2.2.5.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
build_uuid	required	The UUID of the build	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.2.5.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.2.6. get /api/v1/repository/{repository}/build/{build_uuid}/logs

2.2.6.1. Implementation Notes

Return the build logs for the build specified by the build uuid.

2.2.6.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
build_uuid	required	The UUID of the build	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.2.6.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.3. discovery : API discovery information.

2.3.1. get /api/v1/discovery

2.3.1.1. Implementation Notes

List all of the API endpoints available in the swagger API format.

2.3.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
internal	true / false	Whether to include internal APIs.	query	boolean

2.3.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.4. error : Error details API

2.4.1. get /api/v1/error/{error_type}

2.4.1.1. Implementation Notes

Get a detailed description of the error

2.4.1.2. Response Class (Status 200)

Model: Model Schema

{
  "type": "string",
  "description": "string",
  "title": "downstream_issue"
}

2.4.1.3. Response Content Type: application/json

2.4.1.4. Parameters

Parameter	Value	Description	Parameter Type	Data Type
error_type	required	The error code identifying the type of error.	path	string

2.4.1.5. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.5. globalmessages : Messages API.

2.5.1. get /api/v1/messages

2.5.1.1. Implementation Notes

Return a super user’s messages

2.5.1.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.5.1.3. post /api/v1/messages

2.5.1.4. Implementation Notes

Create a message

2.5.1.5. Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "message": { "content": "string", "media_type": "text/plain", "severity": "info" } }

2.5.1.6. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.6. image : List and lookup repository images

2.6.1. get /api/v1/repository/{repository}/image/

2.6.1.1. Implementation Notes

List the images for the specified repository.

2.6.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.6.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.6.2. get /api/v1/repository/{repository}/image/{image_id}

2.6.2.1. Implementation Notes

Get the information available for the specified image.

2.6.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
image_id	required	The Docker image ID	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.6.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.7. logs : Access usage logs for organizations or repositories.

2.7.1. get /api/v1/organization/{orgname}/logs

2.7.1.1. Implementation Notes

List the logs for the specified organization.

2.7.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
next_page		The page token for the next page	path	string
performer		Username for which to filter logs.	path	string
endtime		Latest time for logs. Format: "%m/%d/%Y" in UTC.	path	string
starttime		Earliest time for logs. Format: "%m/%d/%Y" in UTC.	path	string

2.7.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.7.2. get /api/v1/repository/{repository}/logs

2.7.2.1. Implementation Notes

List the logs for the specified repository.

2.7.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string
next_page		The page token for the next page	path	string
performer		Username for which to filter logs.	path	string
endtime		Latest time for logs. Format: "%m/%d/%Y" in UTC.	path	string
starttime		Earliest time for logs. Format: "%m/%d/%Y" in UTC.	path	string

2.7.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.7.3. get /api/v1/user/logs

2.7.3.1. Implementation Notes

List the logs for the current user.

2.7.3.2. Parameters

Parameter	Description	Parameter Type	Data Type
next_page	The page token for the next page	path	string
performer	Username for which to filter logs.	path	string
endtime	Latest time for logs. Format: "%m/%d/%Y" in UTC.	path	string
starttime	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	path	string

2.7.3.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.8. manifest : Manage the manifests of a repository.

2.8.1. get /api/v1/repository/{repository}/manifest/{manifestref}/labels

2.8.1.1. Parameters

Parameter	Value	Description	Parameter Type	Data Type
manifestref	required	The digest of the manifest	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
filter		If specified, only labels matching the given prefix will be returned	query	string

2.8.1.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.8.2. post /api/v1/repository/{repository}/manifest/{manifestref}/labels

2.8.2.1. Implementation Notes

Adds a new label into the tag manifest.

2.8.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
manifestref	required	The digest of the manifest	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
body	required	request body contents.	body	Model: Model Schema { "media_type": "text/plain", "value": "string", "key": "string" }

2.8.2.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.8.3. delete /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}

2.8.3.1. Implementation Notes

Deletes an existing label from a manifest.

2.8.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
labelid	required	The ID of the label	path	string
manifestref	required	The digest of the manifest	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.8.3.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.8.4. get /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}

2.8.4.1. Implementation Notes

Retrieves the label with the specific ID under the manifest.

2.8.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
labelid	required	The ID of the label	path	string
manifestref	required	The digest of the manifest	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.8.4.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.8.5. get /api/v1/repository/{repository}/manifest/{manifestref}

2.8.5.1. Parameters

Parameter	Value	Description	Parameter Type	Data Type
manifestref	required	The digest of the manifest	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.8.5.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9. organization : Manage organizations, members and OAuth applications.

2.9.1. delete /api/v1/organization/{orgname}/members/{membername}

2.9.1.1. Implementation Notes

Removes a member from an organization, revoking all its repository priviledges and removing it from all teams in the organization.

2.9.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
membername	required	The username of the organization member	path	string

2.9.1.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.2. get /api/v1/organization/{orgname}/members/{membername}

2.9.2.1. Implementation Notes

Retrieves the details of a member of the organization.

2.9.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
membername	required	The username of the organization member	path	string

2.9.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.3. delete /api/v1/organization/{orgname}

2.9.3.1. Implementation Notes

Deletes the specified organization.

2.9.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string

2.9.3.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.4. get /api/v1/organization/{orgname}

2.9.4.1. Implementation Notes

Get the details for the specified organization

2.9.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string

2.9.4.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.5. put /api/v1/organization/{orgname}

2.9.5.1. Implementation Notes

Change the details for the specified organization.

2.9.5.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "invoice_email": true, "email": "string", "tag_expiration_s": 0 }

2.9.5.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.6. get /api/v1/organization/{orgname}/collaborators

2.9.6.1. Implementation Notes

List outside collaborators of the specified organization.

2.9.6.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string

2.9.6.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.7. delete /api/v1/organization/{orgname}/applications/{client_id}

2.9.7.1. Implementation Notes

Deletes the application under this organization.

2.9.7.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
client_id	required	The OAuth client ID	path	string

2.9.7.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.8. get /api/v1/organization/{orgname}/applications/{client_id}

2.9.8.1. Implementation Notes

Retrieves the application with the specified client_id under the specified organization

2.9.8.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
client_id	required	The OAuth client ID	path	string

2.9.8.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.9. put /api/v1/organization/{orgname}/applications/{client_id}

2.9.9.1. Implementation Notes

Updates an application under this organization.

2.9.9.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
client_id	required	The OAuth client ID	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "redirect_uri": "string", "avatar_email": "string", "name": "string", "application_uri": "string", "description": "string" }

2.9.9.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.10. post /api/v1/organization/

2.9.10.1. Implementation Notes

Create a new organization.

2.9.10.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "recaptcha_response": "string", "name": "string", "email": "string" }

2.9.10.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.11. get /api/v1/app/{client_id}

2.9.11.1. Implementation Notes

Get information on the specified application.

2.9.11.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
client_id	required	The OAuth client ID	path	string

2.9.11.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.12. get /api/v1/organization/{orgname}/applications

2.9.12.1. Implementation Notes

List the applications for the specified organization

2.9.12.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
orgname	required	The name of the organization	path	string

2.9.12.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "Deletedstring"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.13. post /api/v1/organization/{orgname}/applications

2.9.13.1. Implementation Notes

Creates a new application under this organization.

2.9.13.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "redirect_uri": "string", "avatar_email": "string", "name": "string", "application_uri": "string", "description": "string" }

2.9.13.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.9.14. get /api/v1/organization/{orgname}/members

2.9.14.1. Implementation Notes

List the human members of the specified organization.

2.9.14.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string

2.9.14.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10. permission : Manage repository permissions.

2.10.1. delete /api/v1/repository/{repository}/permissions/team/{teamname}

2.10.1.1. Implementation Notes

Delete the permission for the specified team.

2.10.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
teamname	required	The name of the team to which the permission applies	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.10.1.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.2. get /api/v1/repository/{repository}/permissions/team/{teamname}

2.10.2.1. Implementation Notes

Fetch the permission for the specified team.

2.10.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
teamname	required	The name of the team to which the permission applies	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.10.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.3. put /api/v1/repository/{repository}/permissions/team/{teamname}

2.10.3.1. Implementation Notes

Update the existing team permission.

2.10.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
teamname	required	The name of the team to which the permission applies	path	string
repository	required	The full path of the repository, e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "role": "read" }

2.10.3.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.4. get /api/v1/repository/{repository}/permissions/user/

2.10.4.1. Implementation Notes

List all user permissions.

2.10.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.10.4.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.5. get /api/v1/repository/{repository}/permissions/team/

2.10.5.1. Implementation Notes

List all team permission.

2.10.5.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.10.5.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.6. delete /api/v1/repository/{repository}/permissions/user/{username}

2.10.6.1. Implementation Notes

Delete the permission for the user.

2.10.6.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
username	required	The username of the user to which the permission applies	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.10.6.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.7. get /api/v1/repository/{repository}/permissions/user/{username}

2.10.7.1. Implementation Notes

Get the permission for the specified user.

2.10.7.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
username	required	The username of the user to which the permission applies	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.10.7.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.8. put /api/v1/repository/{repository}/permissions/user/{username}

2.10.8.1. Implementation Notes

Update the perimssions for an existing repository.

2.10.8.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "role": "read" }

2.10.8.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.10.9. get /api/v1/repository/{repository}/permissions/user/{username}/transitive

2.10.9.1. Implementation Notes

Get the fetch the permission for the specified user.

2.10.9.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
username	required	The name of the user to which the permissions apply	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string

2.10.9.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.11. prototype : Manage default permissions added to repositories.

2.11.1. get /api/v1/organization/{orgname}/prototypes

2.11.1.1. Implementation Notes

List the existing prototypes for this organization.

2.11.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string

2.11.1.3. Response Messages

HTTP Status Code	Reason	Response Model	Headers
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0,	orgname
required	The name of the organization	path	string "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
	404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.11.2. post /api/v1/organization/{orgname}/prototypes

2.11.2.1. Implementation Notes

Create a new permission prototype.

2.11.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "activating_user": { "name": "string" }, "role": "read", "delegate": { "kind": "user", "name": "string" } }

2.11.2.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.11.3. delete /api/v1/organization/{orgname}/prototypes/{prototypeid}

2.11.3.1. Implementation Notes

Delete an existing permission prototype.

2.11.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
prototypeid	required	The ID of the prototype	path	string

2.11.3.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.11.4. put /api/v1/organization/{orgname}/prototypes/{prototypeid}

2.11.4.1. Implementation Notes

Update the role of an existing permission prototype.

2.11.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
prototypeid	required	The ID of the prototype	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "role": "read" }

2.11.4.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.12. repository : List, create and manage repositories.

2.12.1. post /api/v1/repository/{repository}/changetrust

2.12.1.1. Implementation Notes

Change the visibility of a repository.

2.12.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "trust_enabled": true }

2.12.1.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.12.2. get /api/v1/repository

2.12.2.1. Implementation Notes

Fetch the list of repositories visible to the current user under a variety of situations.

2.12.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
next_page		The page token for the next page	path	string
repo_kind		The kind of repositories to return	path	string
popularity	true / false	Whether to include the repository’s popularity metric.	query	boolean
last_modified	true / false	Whether to include when the repository was last modified.	query	boolean
public	true / false	Adds any repositories visible to the user by virtue of being public	query	boolean
starred	true / false	Filters the repositories returned to those starred by the user	query	boolean
namespace		Filters the repositories returned to this namespace	query	string

2.12.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.12.3. post /api/v1/repository

2.12.3.1. Implementation Notes

Create a new repository.

2.12.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "repo_kind": "image", "namespace": "string", "visibility": "public", "repository": "string", "description": "string" }

2.12.3.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.12.4. post /api/v1/repository/{repository}/changevisibility

2.12.4.1. Implementation Notes

Change the visibility of a repository.

2.12.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "repo_kind": "image", "namespace": "string", "visibility": "public", "repository": "string", "description": "string" }

2.12.4.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.12.5. delete /api/v1/repository/{repository}

2.12.5.1. Implementation Notes

Delete a repository.

2.12.5.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string

2.12.5.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.12.6. get /api/v1/repository/{repository}

2.12.6.1. Implementation Notes

Fetch the specified repository.

2.12.6.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string
includeTags	true / false	Whether to include repository tags	query	boolean
includeStats	true / false	Whether to include action statistics	query	boolean

2.12.6.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.12.7. put /api/v1/repository/{repository}

2.12.7.1. Implementation Notes

Update the description in the specified repository.

2.12.7.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "description": "string" }

2.12.7.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.13. repositorynotification : List, create and manage repository events/notifications.

2.13.1. post /api/v1/repository/{repository}/notification/{uuid}/test

2.13.1.1. Implementation Notes

Queues a test notification for this repository.

2.13.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
uuid	required	The UUID of the notification	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string

2.13.1.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.13.2. delete /api/v1/repository/{repository}/notification/{uuid}

2.13.2.1. Implementation Notes

Deletes the specified notification.

2.13.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
uuid	required	The UUID of the notification	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string

2.13.2.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.13.3. get /api/v1/repository/{repository}/notification/{uuid}

2.13.3.1. Implementation Notes

Get information for the specified notification.

Parameter	Value	Description	Parameter Type	Data Type
uuid	required	The UUID of the notification	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string

2.13.3.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.13.4. post /api/v1/repository/{repository}/notification/{uuid}

2.13.4.1. Implementation Notes

Resets repository notification to 0 failures.

Parameter	Value	Description	Parameter Type	Data Type
uuid	required	The UUID of the notification	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string

2.13.4.2. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.13.5. get /api/v1/repository/{repository}/notification/

2.13.5.1. Implementation Notes

List the notifications for the specified repository.

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string

2.13.5.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.13.6. post /api/v1/repository/{repository}/notification/

2.13.6.1. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "eventConfig": {}, "title": "string", "config": {}, "event": "string", "method": "string" }

2.13.6.2. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14. repotoken : Manage repository access tokens (DEPRECATED).

2.14.1. get /api/v1/repository/{repository}/tokens/

2.14.1.1. Implementation Notes

List the tokens for the specified repository.

2.14.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string

2.14.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.2. post /api/v1/repository/{repository}/tokens/

2.14.2.1. Implementation Notes

Create a new repository token.

2.14.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "friendlyName": "string" }

2.14.2.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.3. delete /api/v1/repository/{repository}/tokens/{code}

2.14.3.1. Implementation Notes

Delete the repository token.

2.14.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
code	required	The token code	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string

2.14.3.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.4. get /api/v1/repository/{repository}/tokens/{code}

2.14.4.1. Implementation Notes

Fetch the specified repository token information.

2.14.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
code	required	The token code	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string

2.14.4.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.5. put /api/v1/repository/{repository}/tokens/{code}

2.14.5.1. Implementation Notes

Update the permissions for the specified repository token.

2.14.5.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
code	required	The token code	path	string
repository	required	The full path of the repository e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "role": "read" }

2.14.5.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.6. get /api/v1/user/robots

2.14.6.1. Implementation Notes

List the available robots for the user.

2.14.6.2. Parameters

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

2.14.6.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.7. get /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions

2.14.7.1. Implementation Notes

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

2.14.7.2. Parameters

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

2.14.7.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.8. post /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate

2.14.8.1. Implementation Notes

Regenerates the token for an organization robot.

2.14.8.2. Parameters

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

2.14.8.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.9. get /api/v1/organization/{orgname}/robots

2.14.9.1. Implementation Notes

List the organization’s robots.

2.14.9.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
limit		If specified, the number of robots to return	query	integer
token	true / false	If false, the robot’s token is not returned.	query	boolean
permission	true / false	Whether to include repostories and teams in which the robots have permission.	query	boolean

2.14.9.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.10. get /api/v1/user/robots/{robot_shortname}/permissions

2.14.10.1. Implementation Notes

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

2.14.10.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
robot_shortname	required	The short name for the robot, without any user or organization prefix	path	string

2.14.10.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.11. post /api/v1/user/robots/{robot_shortname}/regenerate

2.14.11.1. Implementation Notes

Regenerates the token for a user’s robot.

2.14.11.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
robot_shortname	required	The short name for the robot, without any user or organization prefix	path	string

2.14.11.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.12. delete /api/v1/organization/{orgname}/robots/{robot_shortname}

2.14.12.1. Implementation Notes

Delete an existing organization robot.

2.14.12.2. Parameters

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

2.14.12.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.13. get /api/v1/organization/{orgname}/robots/{robot_shortname}

2.14.13.1. Implementation Notes

Returns the organization’s robot with the specified name.

2.14.13.2. Parameters

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

2.14.13.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.14. put /api/v1/organization/{orgname}/robots/{robot_shortname}

2.14.14.1. Implementation Notes

Create a new robot in the organization.

2.14.14.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
robot_shortname	required	The short name for the robot, without any user or organization prefix	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "unstructured_metadata": {}, "description": "string" }

2.14.14.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.15. delete /api/v1/user/robots/{robot_shortname}

2.14.15.1. Implementation Notes

Delete an existing robot.

2.14.15.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
robot_shortname	required	The short name for the robot, without any user or organization prefix	path	string

2.14.15.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.16. get /api/v1/user/robots/{robot_shortname}

2.14.16.1. Implementation Notes

Returns the user’s robot with the specified name.

2.14.16.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
robot_shortname	required	The short name for the robot, without any user or organization prefix	path	string

2.14.16.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.14.17. put /api/v1/user/robots/{robot_shortname}

2.14.17.1. Implementation Notes

Create a new user robot with the specified name.

2.14.17.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
robot_shortname	required	The short name for the robot, without any user or organization prefix	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "unstructured_metadata": {}, "description": "string" }

2.14.17.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.15. search : Conduct searches against all registry context.

2.15.1. get /api/v1/find/all

2.15.1.1. Implementation Notes

Get a list of entities and resources that match the specified query.

2.15.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
query		The search query.	query	string

2.15.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.15.2. get /api/v1/find/repositories

2.15.2.1. Implementation Notes

Get a list of apps and repositories that match the specified query.

2.15.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
page		The page.	query	integer
query		The search query	query	string

2.15.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.15.3. get /api/v1/entities/{prefix}

2.15.3.1. Implementation Notes

Get a list of entities that match the specified prefix.

2.15.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
prefix	required		path	string
includeOrgs	true / false	Whether to include orgs names.	query	boolean
includeTeams	true / false	Whether to include orgs names.	query	boolean
namespace		Namespace to use when querying for org entities.	query	string

2.15.3.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.16. secscan : List and manage repository vulnerabilities and other security information.

2.16.1. get /api/v1/repository/{repository}/manifest/{manifestref}/security

2.16.1.1. Parameters

Parameter	Value	Description	Parameter Type	Data Type
mainifestref	required	The digest of the manifest	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
vulnerabilities	true / false	Include vulnerabilities	query	boolean

2.16.1.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.16.2. get /api/v1/repository/{repository}/image/{imageid}/security

2.16.2.1. Implementation Notes

Fetches the features and vulnerabilities (if any) for a repository image.

2.16.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string
imageid	required	The image ID	path	string
vulnerabilities	true / false	Include vulnerabilities	query	boolean

2.16.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.17. signing : List and manage repository signing information

2.17.1. get /api/v1/repository/{repository}/signatures

2.17.1.1. Implementation Notes

Fetches the list of signed tags for the repository.

2.17.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.17.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.18. tag : Manage the tags of a repository.

2.18.1. get /api/v1/repository/{repository}/tag/{tag}/images

2.18.1.1. Implementation Notes

List the images for the specified repository tag.

2.18.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
tag	required	The name of the tag	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
Owned	true / false	If specified, only images wholely owned by this tag are returned.	query	boolean

2.18.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.18.2. post /api/v1/repository/{repository}/tag/{tag}/restore

2.18.2.1. Implementation Notes

Restores a repository tag back to a previous image in the repository.

2.18.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
tag	required	The name of the tag	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "image": "string", "manifest_digest": "string" }

2.18.2.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.18.3. delete /api/v1/repository/{repository}/tag/{tag}

2.18.3.1. Implementation Notes

Delete the specified repository tag.

2.18.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
tag	required	The name of the tag	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.18.3.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.18.4. put /api/v1/repository/{repository}/tag/{tag}

2.18.4.1. Implementation Notes

Change which image a tag points to or create a new tag.

2.18.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
tag	required	The name of the tag	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema {}

2.18.4.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.18.5. get /api/v1/repository/{repository}/tag/

2.18.5.1. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository. e.g. namespace/name	path	string
onlyActiveTags	true / false	Filter to only active tags.	query	boolean
page		Page index for the results. Default 1.	query	integer
limit		Limit to the number of results to return per page. Max 100.	query	integer
specificTag		Filters the tags to the specific tag.	query	string

2.18.5.2. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19. team : Create, list and manage an organization’s teams.

2.19.1. get /api/v1/organization/{orgname}/team/{teamname}/members

2.19.1.1. Implementation Notes

Retrieve the list of members for the specified team.

2.19.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
teamname	required	The name of the team	path	string
includePending	true / false	Whether to include pending members	query	boolean

2.19.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19.2. get /api/v1/organization/{orgname}/team/{teamname}/permissions

2.19.2.1. Implementation Notes

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

2.19.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
teamname	required	The name of the team	path	string

2.19.2.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19.3. delete /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

2.19.3.1. Implementation Notes

Delete an invite of an email address to join a team.

2.19.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required		path	string
email	required		path	string
teamname	required		path	string

2.19.3.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19.4. put /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

2.19.4.1. Implementation Notes

Invites an email address to an existing team.

2.19.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required		path	string
email	required		path	string
teamname	required		path	string

2.19.4.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19.5. delete /api/v1/organization/{orgname}/team/{teamname}

2.19.5.1. Implementation Notes

Delete the specified team.

2.19.5.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
teamname	required	The name of the team	path	string

2.19.5.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19.6. put /api/v1/organization/{orgname}/team/{teamname}

2.19.6.1. Implementation Notes

Update the org-wide permission for the specified team.

2.19.6.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
teamname	required	The name of the team	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "role": "member", "description": "string" }

2.19.6.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19.7. delete /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

2.19.7.1. Implementation Notes

Delete a member of a team. If the user is merely invited to join the team, then the invite is removed instead.

2.19.7.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
membername	required	The username of the team member	path	string
teamname	required	The name of the team	path	string

2.19.7.3. Response Messages

HTTP Status Code	Reason	Response Model
204	Deleted
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.19.8. put /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

2.19.8.1. Implementation Notes

Adds or invites a member to an existing team.

2.19.8.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
orgname	required	The name of the organization	path	string
membername	required	The username of the team member	path	string
teamname	required	The name of the team	path	string

2.19.8.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.20. trigger : Create, list and manage build triggers.

2.20.1. get /api/v1/repository/{repository}/trigger/

2.20.1.1. Implementation Notes

List the triggers for the specified repository.

2.20.1.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
repository	required	The full path of the repository e.g. namespace/name	path	string

2.20.1.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.20.2. post /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate

2.20.2.1. Implementation Notes

Activate the specified build trigger.

2.20.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
trigger_uuid	required	The UUID of the build trigger	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "pull_robot": "string", "config": {} }

2.20.2.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.20.3. post /api/v1/repository/{repository}/trigger/{trigger_uuid}/start

2.20.3.1. Implementation Notes

Manually start a build from the specified trigger.

2.20.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
trigger_uuid	required	The UUID of the build trigger	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "branch_name": "string", "commit_sha": "string" }

2.20.3.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.20.4. get /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds

2.20.4.1. Implementation Notes

List the builds started by the specified trigger.

2.20.4.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
trigger_uuid	required	The UUID of the build trigger	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
limit		The maximum number of builds to return	query	integer

2.20.4.3. Response Messages

HTTP Status Code	Reason	Response Model
201	Successful creation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.20.5. delete /api/v1/repository/{repository}/trigger/{trigger_uuid}

2.20.5.1. Implementation Notes

Delete the specified build trigger.

2.20.5.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
trigger_uuid	required	The UUID of the build trigger	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.20.5.3. Response Messages

HTTP Status Code	Reason	Headers
204	Deleted	400
Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"	401
Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }	403
Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }	404

2.20.6. get /api/v1/repository/{repository}/trigger/{trigger_uuid}

2.20.6.1. Implementation Notes

Get information for the specified build trigger.

2.20.6.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
trigger_uuid	required	The UUID of the build trigger	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string

2.20.6.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.20.7. put /api/v1/repository/{repository}/trigger/{trigger_uuid}

2.20.7.1. Implementation Notes

Updates the specified build trigger.

2.20.7.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
trigger_uuid	required	The UUID of the build trigger	path	string
repository	required	The full path of the repository. e.g. namespace/name	path	string
body	required (Parameter content type: application/json)	Request body contents.	body	Model: Model Schema { "enabled": true }

2.20.7.3. Response Messages

HTTP Status Code	Reason	Response Model
200	Successful invocation
400	Bad Request	Mode: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string"
401	Session required	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
403	Unauthorized access	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }
404	Not found	Model: Model Schema { "status": 0, "error_message": "string", "title": "string", "error_type": "string", "detail": "string", "type": "string" }

2.21. user : Manage the current user.

2.21.1. get /api/v1/user/

2.21.1.1. Implementation Notes

Get user information for the authenticated user.

2.21.1.2. Response Class (Status 200)