Red Hat Quay API Guide

Red Hat Quay 3.3

Red Hat Quay API Guide

Red Hat OpenShift Documentation Team

Abstract

Use the Red Hat Quay API

Preface

The Red Hat Quay application programming interface (API) is an OAuth 2 RESTful API that consists of a set of endpoints for adding, displaying, changing and deleting features for Red Hat Quay. This guide describes those endpoints and shows command and browser-based examples for accessing them.

Chapter 1. Using the Red Hat Quay API

Red Hat Quay provides a full OAuth 2, RESTful API that:

Is available from endpoints of each Red Hat Quay instance from the URL https://<yourquayhost>/api/v1
Lets you connect to endpoints, via a browser, to get, delete, post, and put Red Hat Quay settings by enabling the Swagger UI
Can be accessed by applications that make API calls and use OAuth tokens
Sends and receives data as JSON

The following text describes how to access the Red Hat Quay API and use it to view and modify setting in your Red Hat Quay cluster. Appendix A lists and describes API endpoints.

1.1. Accessing the Red Hat Quay API from Quay.io

If you don’t have your own Red Hat Quay cluster running yet, you can explore the Red Hat Quay API available from Quay.io from your web browser:

https://docs.quay.io/api/swagger/

The API Explorer that appears shows Quay.io API endpoints. You will not see superuser API endpoints or endpoints for Red Hat Quay features that are not enabled on Quay.io (such as Repository Mirroring).

From API Explorer, you can get, and sometimes change, information on:

Billing, subscriptions, and plans
Repository builds and build triggers
Error messages and global messages
Repository images, manifests, permissions, notifications, vulnerabilities, and image signing
Usage logs
Organizations, members and OAuth applications
User and robot accounts
and more…

Select to open an endpoint to view the Model Schema for each part of the endpoint. Open an endpoint, enter any required parameters (such as a repository name or image), then select the Try it out! button to query or change settings associated with a Quay.io endpoint.

1.2. Create OAuth access token

To create an OAuth access token so you can access the API for your organization:

Log in to Red Hat Quay and select your Organization (or create a new one).
Select the Applications icon from the left navigation.
Select Create New Application and give the new application a name when prompted.
Select the new application.
Select Generate Token from the left navigation.
Select the checkboxes to set the scope of the token and select Generate Access Token.
Review the permissions you are allowing and select Authorize Application to approve it.
Copy the newly generated token to use to access the API.

1.3. Accessing your Red Hat Quay API from a web browser

By enabling Swagger, you can access the API for your own Red Hat Quay instance through a web browser. This URL exposes the Red Hat Quay API explorer via the Swagger UI and this URL:

https://<yourquayhost>/api/v1/discovery.

That way of accessing the API does not include superuser endpoints that are available on Red Hat Quay installations. Here is an example of accessing a Red Hat Quay API interface running on the local system by running the swagger-ui container image:

# export SERVER_HOSTNAME=<yourhostname>
# podman run -p 8888:8080 -e API_URL=https://$SERVER_HOSTNAME:8443/api/v1/discovery docker.io/swaggerapi/swagger-ui

With the swagger-ui container running, open your web browser to localhost port 8888 to view API endpoints via the swagger-ui container.

To avoid errors in the log such as "API calls must be invoked with an X-Requested-With header if called from a browser," add the following line to the config.yaml on all nodes in the cluster and restart Red Hat Quay:

BROWSER_API_CALLS_XHR_ONLY: false

1.4. Accessing the Red Hat Quay API from the command line

You can use the curl command to GET, PUT, POST, or DELETE settings via the API for your Red Hat Quay cluster. Replace <token> with the OAuth access token you created earlier to get or change settings in the following examples.

1.4.1. Get superuser information

$ curl -X GET -H "Authorization: Bearer <token_here>" \
    "https://<yourquayhost>/api/v1/superuser/users/"

1.4.2. Create a repository build via API

In order to build a repository from the specified input and tag the build with custom tags, users can use requestRepoBuild endpoint. It takes the following data:

{
"docker_tags": [
   "string"
],
"pull_robot": "string",
"subdirectory": "string",
"archive_url": "string"
}

The archive_url parameter should point to a tar or zip archive that includes the Dockerfile and other required files for the build. The file_id parameter was apart of our older build system. It cannot be used anymore. If Dockerfile is in a sub-directory it needs to be specified as well.

The archive should be publicly accessible. OAuth app should have "Administer Organization" scope because only organization admins have access to the robots' account tokens. Otherwise, someone could get robot permissions by simply granting a build access to a robot (without having access themselves), and use it to grab the image contents. In case of errors, check the json block returned and ensure the archive location, pull robot, and other parameters are being passed correctly. Click "Download logs" on the top-right of the individual build’s page to check the logs for more verbose messaging.

1.4.3. Create an org robot

$ curl -X PUT https://quay.io/api/v1/organization/{orgname}/robots/{robot shortname} \
   -H 'Authorization: Bearer <token>''

1.4.4. Trigger a build

$ curl -X POST https://quay.io/api/v1/repository/YOURORGNAME/YOURREPONAME/build/ \
   -H 'Authorization: Bearer <token>'

Python with requests

import requests
r = requests.post('https://quay.io/api/v1/repository/example/example/image', headers={'content-type': 'application/json', 'Authorization': 'Bearer <redacted>'}, data={[<request-body-contents>})
print(r.text)

1.4.5. Create a private repository

$ curl -X POST https://quay.io/api/v1/repository \
   -d '{"namespace":"yournamespace","name":"reponame","description":"description of your repo","visibility":"private"}' -H 'Authorization: Bearer {token}'

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)

Model: Model Schema

{
  "organizations": [
{}
  ],
  "verified": true,
  "avatar": {},
  "anonymous": true,
  "logins": [
{}
  ],
  "can_create_repo": true,
  "preferred_namespace": true,
  "email": "string"
}

Response Content Type: application/json

2.21.1.3. Response Messages

HTTP Status Code	Reason	Response Model
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.2. get /api/v1/users/{username}

2.21.2.1. Implementation Notes

Get user information for the specified user.

2.21.2.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
username	required		path	string

2.21.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.21.3. get /api/v1/user/starred

2.21.3.1. Implementation Notes

List all starred repositories.

2.21.3.2. Parameters

Parameter	Value	Description	Parameter Type	Data Type
next_page	required	The page token for the next page	path	string

2.21.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.21.4. post /api/v1/user/starred

2.21.4.1. Implementation Notes

2.21.4.2. Parameters

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

2.21.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.21.5. delete /api/v1/user/starred/{repository}

2.21.5.1. Implementation Notes

Removes a star from a repository.

2.21.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.21.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" }

Additional resources

Legal Notice

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.