Home
Products
Red Hat Quay
3.6
Red Hat Quay API Guide

Red Hat Quay API Guide

Red Hat Quay 3.6

Red Hat Quay API Guide

Red Hat OpenShift Documentation Team

Abstract

Use the Red Hat Quay API

Preface
Copy link

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
Copy link

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. The next section lists and describes API endpoints.

1.1. Accessing the Quay API from Quay.io
Copy link

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/

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

Copy to Clipboard

Toggle word wrap

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
Copy link

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 Quay API from a web browser
Copy link

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.

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

Copy to Clipboard

Toggle word wrap

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>
sudo podman run -p 8888:8080 -e API_URL=https://$SERVER_HOSTNAME:8443/api/v1/discovery docker.io/swaggerapi/swagger-ui

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

Copy to Clipboard

Toggle word wrap

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

BROWSER_API_CALLS_XHR_ONLY: false

Copy to Clipboard

Toggle word wrap

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

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
Copy link

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

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

Copy to Clipboard

Toggle word wrap

For example:

curl -X GET -H "Authorization: Bearer mFCdgS7SAIoMcnTsHCGx23vcNsTgziAa4CmmHIsg" http://quay-server:8080/api/v1/superuser/users/ | jq

{
  "users": [
    {
      "kind": "user",
      "name": "quayadmin",
      "username": "quayadmin",
      "email": "quayadmin@example.com",
      "verified": true,
      "avatar": {
        "name": "quayadmin",
        "hash": "357a20e8c56e69d6f9734d23ef9517e8",
        "color": "#5254a3",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    }
  ]
}

$ curl -X GET -H "Authorization: Bearer mFCdgS7SAIoMcnTsHCGx23vcNsTgziAa4CmmHIsg" http://quay-server:8080/api/v1/superuser/users/ | jq

{
  "users": [
    {
      "kind": "user",
      "name": "quayadmin",
      "username": "quayadmin",
      "email": "quayadmin@example.com",
      "verified": true,
      "avatar": {
        "name": "quayadmin",
        "hash": "357a20e8c56e69d6f9734d23ef9517e8",
        "color": "#5254a3",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    }
  ]
}

Copy to Clipboard

Toggle word wrap

1.4.2. Creating a superuser using the API
Copy link

Configure a superuser name, as described in the Deploy Quay book:
- Use the configuration editor UI or
- Edit the config.yaml file directly, with the option of using the configuration API to validate (and download) the updated configuration bundle

Create the user account for the superuser name:

Obtain an authorization token as detailed above, and use curl to create the user:

curl -H "Content-Type: application/json"  -H "Authorization: Bearer Fava2kV9C92p1eXnMawBZx9vTqVnksvwNm0ckFKZ" -X POST --data '{
 "username": "quaysuper",
 "email": "quaysuper@example.com"
}'  http://quay-server:8080/api/v1/superuser/users/ | jq

$ curl -H "Content-Type: application/json"  -H "Authorization: Bearer Fava2kV9C92p1eXnMawBZx9vTqVnksvwNm0ckFKZ" -X POST --data '{
 "username": "quaysuper",
 "email": "quaysuper@example.com"
}'  http://quay-server:8080/api/v1/superuser/users/ | jq

Copy to Clipboard

Toggle word wrap

The returned content includes a generated password for the new user account:

{
  "username": "quaysuper",
  "email": "quaysuper@example.com",
  "password": "EH67NB3Y6PTBED8H0HC6UVHGGGA3ODSE",
  "encrypted_password": "fn37AZAUQH0PTsU+vlO9lS0QxPW9A/boXL4ovZjIFtlUPrBz9i4j9UDOqMjuxQ/0HTfy38goKEpG8zYXVeQh3lOFzuOjSvKic2Vq7xdtQsU="
}

{
  "username": "quaysuper",
  "email": "quaysuper@example.com",
  "password": "EH67NB3Y6PTBED8H0HC6UVHGGGA3ODSE",
  "encrypted_password": "fn37AZAUQH0PTsU+vlO9lS0QxPW9A/boXL4ovZjIFtlUPrBz9i4j9UDOqMjuxQ/0HTfy38goKEpG8zYXVeQh3lOFzuOjSvKic2Vq7xdtQsU="
}

Copy to Clipboard

Toggle word wrap

Now, when you request the list of users , it will show quaysuper as a superuser:

curl -X GET -H "Authorization: Bearer mFCdgS7SAIoMcnTsHCGx23vcNsTgziAa4CmmHIsg" http://quay-server:8080/api/v1/superuser/users/ | jq

{
  "users": [
  {
      "kind": "user",
      "name": "quayadmin",
      "username": "quayadmin",
      "email": "quayadmin@example.com",
      "verified": true,
      "avatar": {
        "name": "quayadmin",
        "hash": "357a20e8c56e69d6f9734d23ef9517e8",
        "color": "#5254a3",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    },
    {
      "kind": "user",
      "name": "quaysuper",
      "username": "quaysuper",
      "email": "quaysuper@example.com",
      "verified": true,
      "avatar": {
        "name": "quaysuper",
        "hash": "c0e0f155afcef68e58a42243b153df08",
        "color": "#969696",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    }
  ]
}

$ curl -X GET -H "Authorization: Bearer mFCdgS7SAIoMcnTsHCGx23vcNsTgziAa4CmmHIsg" http://quay-server:8080/api/v1/superuser/users/ | jq

{
  "users": [
  {
      "kind": "user",
      "name": "quayadmin",
      "username": "quayadmin",
      "email": "quayadmin@example.com",
      "verified": true,
      "avatar": {
        "name": "quayadmin",
        "hash": "357a20e8c56e69d6f9734d23ef9517e8",
        "color": "#5254a3",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    },
    {
      "kind": "user",
      "name": "quaysuper",
      "username": "quaysuper",
      "email": "quaysuper@example.com",
      "verified": true,
      "avatar": {
        "name": "quaysuper",
        "hash": "c0e0f155afcef68e58a42243b153df08",
        "color": "#969696",
        "kind": "user"
      },
      "super_user": true,
      "enabled": true
    }
  ]
}

Copy to Clipboard

Toggle word wrap

1.4.3. List usage logs
Copy link

An intrnal API, /api/v1/superuser/logs, is available to list the usage logs for the current system. The results are paginated, so in the following example, more than 20 repos were created to show how to use multiple invocations to access the entire result set.

1.4.3.1. Example for pagination
Copy link

First invocation

curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs | jq

$ curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs | jq

Copy to Clipboard

Toggle word wrap

Initial output

{
  "start_time": "Sun, 12 Dec 2021 11:41:55 -0000",
  "end_time": "Tue, 14 Dec 2021 11:41:55 -0000",
  "logs": [
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t21",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:41:16 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t20",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:41:05 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
...

   {
      "kind": "create_repo",
      "metadata": {
        "repo": "t2",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:25:17 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    }
  ],
  "next_page": "gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5"
}

{
  "start_time": "Sun, 12 Dec 2021 11:41:55 -0000",
  "end_time": "Tue, 14 Dec 2021 11:41:55 -0000",
  "logs": [
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t21",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:41:16 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t20",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:41:05 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
...

   {
      "kind": "create_repo",
      "metadata": {
        "repo": "t2",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:25:17 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    }
  ],
  "next_page": "gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5"
}

Copy to Clipboard

Toggle word wrap

Second invocation using next_page

curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs?next_page=gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5 | jq

$ curl -X GET -k -H "Authorization: Bearer qz9NZ2Np1f55CSZ3RVOvxjeUdkzYuCp0pKggABCD" https://example-registry-quay-quay-enterprise.apps.example.com/api/v1/superuser/logs?next_page=gAAAAABhtzGDsH38x7pjWhD8MJq1_2FAgqUw2X9S2LoCLNPH65QJqB4XAU2qAxYb6QqtlcWj9eI6DUiMN_q3e3I0agCvB2VPQ8rY75WeaiUzM3rQlMc4i6ElR78t8oUxVfNp1RMPIRQYYZyXP9h6E8LZZhqTMs0S-SedaQJ3kVFtkxZqJwHVjgt23Ts2DonVoYwtKgI3bCC5 | jq

Copy to Clipboard

Toggle word wrap

Output from second invocation

{
  "start_time": "Sun, 12 Dec 2021 11:42:46 -0000",
  "end_time": "Tue, 14 Dec 2021 11:42:46 -0000",
  "logs": [
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t1",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:25:07 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
    ...
  ]
}

{
  "start_time": "Sun, 12 Dec 2021 11:42:46 -0000",
  "end_time": "Tue, 14 Dec 2021 11:42:46 -0000",
  "logs": [
    {
      "kind": "create_repo",
      "metadata": {
        "repo": "t1",
        "namespace": "namespace1"
      },
      "ip": "10.131.0.13",
      "datetime": "Mon, 13 Dec 2021 11:25:07 -0000",
      "performer": {
        "kind": "user",
        "name": "user1",
        "is_robot": false,
        "avatar": {
          "name": "user1",
          "hash": "5d40b245471708144de9760f2f18113d75aa2488ec82e12435b9de34a6565f73",
          "color": "#ad494a",
          "kind": "user"
        }
      },
      "namespace": {
        "kind": "org",
        "name": "namespace1",
        "avatar": {
          "name": "namespace1",
          "hash": "6cf18b5c19217bfc6df0e7d788746ff7e8201a68cba333fca0437e42379b984f",
          "color": "#e377c2",
          "kind": "org"
        }
      }
    },
    ...
  ]
}

Copy to Clipboard

Toggle word wrap

1.4.4. Directory synchronization
Copy link

To enable directory synchronization for the team newteam in organization testadminorg, where the corresponding group name in LDAP is ldapgroup:

curl -X POST -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
       -H "Content-type: application/json" \
       -d '{"group_dn": "cn=ldapgroup,ou=Users"}' \
       http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing

$ curl -X POST -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
       -H "Content-type: application/json" \
       -d '{"group_dn": "cn=ldapgroup,ou=Users"}' \
       http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing

Copy to Clipboard

Toggle word wrap

To disable synchronization for the same team:

curl -X DELETE -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
       http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing

$ curl -X DELETE -H "Authorization: Bearer 9rJYBR3v3pXcj5XqIA2XX6Thkwk4gld4TCYLLWDF" \
       http://quay1-server:8080/api/v1/organization/testadminorg/team/newteam/syncing

Copy to Clipboard

Toggle word wrap

1.4.5. Create a repository build via API
Copy link

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

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

Copy to Clipboard

Toggle word wrap

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.6. Create an org robot
Copy link

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

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

Copy to Clipboard

Toggle word wrap

1.4.7. Trigger a build
Copy link

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

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

Copy to Clipboard

Toggle word wrap

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)

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)

Copy to Clipboard

Toggle word wrap

1.4.8. Create a private repository
Copy link

curl -X POST https://quay.io/api/v1/repository \
    -H 'Authorization: Bearer {token}' \
    -H 'Content-Type: application/json' \
    -d '{"namespace":"yournamespace", "repository":"yourreponame",
    "description":"descriptionofyourrepo", "visibility": "private"}' | jq

$ curl -X POST https://quay.io/api/v1/repository \
    -H 'Authorization: Bearer {token}' \
    -H 'Content-Type: application/json' \
    -d '{"namespace":"yournamespace", "repository":"yourreponame",
    "description":"descriptionofyourrepo", "visibility": "private"}' | jq

Copy to Clipboard

Toggle word wrap

Chapter 2. Red Hat Quay Application Programming Interface (API)
Copy link

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

2.1. Authorization
Copy link

oauth2_implicit

Scopes

The following scopes are used to control access to the API endpoints:

Expand

Scope	Description
repo:read	This application will be able to view and pull all repositories visible to the granting user or robot account
repo:write	This application will be able to view, push and pull to all repositories to which the granting user or robot account has write access
repo:admin	This application will have administrator access to all repositories to which the granting user or robot account has access
repo:create	This application will be able to create repositories in to any namespaces that the granting user or robot account is allowed to create repositories
user:read	This application will be able to read user information such as username and email address.
org:admin	This application will be able to administer your organizations including creating robots, creating teams, adjusting team membership, and changing billing settings. You should have absolute trust in the requesting application before granting this permission.
super:user	This application will be able to administer your installation including managing users, managing organizations and other features found in the superuser panel. You should have absolute trust in the requesting application before granting this permission.
user:admin	This application will be able to administer your account including creating robots and granting them permissions to your repositories. You should have absolute trust in the requesting application before granting this permission.

2.2. appspecifictokens
Copy link

Manages app specific tokens for the current user.

2.2.1. listAppTokens
Copy link

Lists the app specific tokens for the user.

GET /api/v1/user/apptoken

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

Type	Name	Description	Schema
query	expiring optional	If true, only returns those tokens expiring soon	boolean

Responses

Expand

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

2.2.2. createAppToken
Copy link

Create a new app specific token for user.

POST /api/v1/user/apptoken

Authorizations: oauth2_implicit (user:admin)

Request body schema (application/json)

Description of a new token.

Expand

Name	Description	Schema
friendlyName optional	Friendly name to help identify the token	string

Responses

Expand

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

2.2.3. revokeAppToken
Copy link

Revokes a specific app token for the user.

DELETE /api/v1/user/apptoken/{token_uuid}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	token_uuid required	The uuid of the app specific token	string

Responses

Expand

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

2.2.4. getAppToken
Copy link

Returns a specific app token for the user.

GET /api/v1/user/apptoken/{token_uuid}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	token_uuid required	The uuid of the app specific token	string

Responses

Expand

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

2.3. build
Copy link

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

2.3.1. getRepoBuildStatus
Copy link

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

GET /api/v1/repository/{repository}/build/{build_uuid}/status

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	build_uuid required	The UUID of the build	string

Responses

Expand

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

2.3.2. getRepoBuildLogs
Copy link

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

GET /api/v1/repository/{repository}/build/{build_uuid}/logs

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	build_uuid required	The UUID of the build	string

Responses

Expand

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

2.3.3. cancelRepoBuild
Copy link

Cancels a repository build.

DELETE /api/v1/repository/{repository}/build/{build_uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	build_uuid required	The UUID of the build	string

Responses

Expand

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

2.3.4. getRepoBuild
Copy link

Returns information about a build.

GET /api/v1/repository/{repository}/build/{build_uuid}

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	build_uuid required	The UUID of the build	string

Responses

Expand

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

2.3.5. getRepoBuilds
Copy link

Get the list of repository builds.

GET /api/v1/repository/{repository}/build/

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	since optional	Returns all builds since the given unix timecode	integer
query	limit optional	The maximum number of builds to return	integer

Responses

Expand

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

2.3.6. requestRepoBuild
Copy link

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

POST /api/v1/repository/{repository}/build/

Authorizations: oauth2_implicit (repo:write)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Description of a new repository build.

Expand

Name	Description	Schema
file_id optional	The file id that was generated when the build spec was uploaded	string
archive_url optional	The URL of the .tar.gz to build. Must start with "http" or "https".	string
subdirectory optional	Subdirectory in which the Dockerfile can be found. You can only specify this or dockerfile_path	string
dockerfile_path optional	Path to a dockerfile. You can only specify this or subdirectory.	string
context optional	Pass in the context for the dockerfile. This is optional.	string
pull_robot optional	Username of a Quay robot account to use as pull credentials	string
docker_tags optional	The tags to which the built images will be pushed. If none specified, "latest" is used.	array of string `non-empty` `unique`

Responses

Expand

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

2.4. discovery
Copy link

API discovery information.

2.4.1. discovery
Copy link

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

GET /api/v1/discovery

Authorizations:

Query parameters

Expand

Type	Name	Description	Schema
query	internal optional	Whether to include internal APIs.	boolean

Responses

Expand

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

2.5. error
Copy link

Error details API.

2.5.1. getErrorDescription
Copy link

Get a detailed description of the error.

GET /api/v1/error/{error_type}

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	error_type required	The error code identifying the type of error.	string

Responses

Expand

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

2.6. globalmessages
Copy link

Messages API.

2.6.1. getGlobalMessages
Copy link

Return a super users messages.

GET /api/v1/messages

Authorizations:

Responses

Expand

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

2.6.2. createGlobalMessage
Copy link

Create a message.

POST /api/v1/messages

Authorizations: oauth2_implicit (super:user)

Request body schema (application/json)

Create a new message

Expand

Name	Description	Schema
message optional	A single message	object

Responses

Expand

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

2.6.3. deleteGlobalMessage
Copy link

Delete a message.

DELETE /api/v1/message/{uuid}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	uuid required		string

Responses

Expand

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

2.7. image
Copy link

List and lookup repository images.

2.7.1. getImage
Copy link

Get the information available for the specified image.

GET /api/v1/repository/{repository}/image/{image_id}

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

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

Responses

Expand

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

2.7.2. listRepositoryImages
Copy link

List the images for the specified repository.

GET /api/v1/repository/{repository}/image/

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.8. logs
Copy link

Access usage logs for organizations or repositories.

2.8.1. getAggregateUserLogs
Copy link

Returns the aggregated logs for the current user.

GET /api/v1/user/aggregatelogs

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

Type	Name	Description	Schema
query	performer optional	Username for which to filter logs.	string
query	endtime optional	Latest time for logs. Format: "%m/%d/%Y" in UTC.	string
query	starttime optional	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	string

Responses

Expand

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

2.8.2. exportUserLogs
Copy link

Returns the aggregated logs for the current user.

POST /api/v1/user/exportlogs

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

Type	Name	Description	Schema
query	endtime optional	Latest time for logs. Format: "%m/%d/%Y" in UTC.	string
query	starttime optional	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	string

Request body schema (application/json)

Configuration for an export logs operation

Expand

Name	Description	Schema
callback_url optional	The callback URL to invoke with a link to the exported logs	string
callback_email optional	The e-mail address at which to e-mail a link to the exported logs	string

Responses

Expand

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

2.8.3. listUserLogs
Copy link

List the logs for the current user.

GET /api/v1/user/logs

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

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

Responses

Expand

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

2.8.4. getAggregateOrgLogs
Copy link

Gets the aggregated logs for the specified organization.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Query parameters

Expand

Type	Name	Description	Schema
query	performer optional	Username for which to filter logs.	string
query	endtime optional	Latest time for logs. Format: "%m/%d/%Y" in UTC.	string
query	starttime optional	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	string

Responses

Expand

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

2.8.5. exportOrgLogs
Copy link

Exports the logs for the specified organization.

POST /api/v1/organization/{orgname}/exportlogs

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Query parameters

Expand

Type	Name	Description	Schema
query	endtime optional	Latest time for logs. Format: "%m/%d/%Y" in UTC.	string
query	starttime optional	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	string

Request body schema (application/json)

Configuration for an export logs operation

Expand

Name	Description	Schema
callback_url optional	The callback URL to invoke with a link to the exported logs	string
callback_email optional	The e-mail address at which to e-mail a link to the exported logs	string

Responses

Expand

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

2.8.6. listOrgLogs
Copy link

List the logs for the specified organization.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Query parameters

Expand

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

Responses

Expand

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

2.8.7. getAggregateRepoLogs
Copy link

Returns the aggregated logs for the specified repository.

GET /api/v1/repository/{repository}/aggregatelogs

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	endtime optional	Latest time for logs. Format: "%m/%d/%Y" in UTC.	string
query	starttime optional	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	string

Responses

Expand

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

2.8.8. exportRepoLogs
Copy link

Queues an export of the logs for the specified repository.

POST /api/v1/repository/{repository}/exportlogs

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	endtime optional	Latest time for logs. Format: "%m/%d/%Y" in UTC.	string
query	starttime optional	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	string

Request body schema (application/json)

Configuration for an export logs operation

Expand

Name	Description	Schema
callback_url optional	The callback URL to invoke with a link to the exported logs	string
callback_email optional	The e-mail address at which to e-mail a link to the exported logs	string

Responses

Expand

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

2.8.9. listRepoLogs
Copy link

List the logs for the specified repository.

GET /api/v1/repository/{repository}/logs

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	next_page optional	The page token for the next page	string
query	endtime optional	Latest time for logs. Format: "%m/%d/%Y" in UTC.	string
query	starttime optional	Earliest time for logs. Format: "%m/%d/%Y" in UTC.	string

Responses

Expand

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

2.9. manifest
Copy link

Manage the manifests of a repository.

2.9.1. deleteManifestLabel
Copy link

Deletes an existing label from a manifest.

DELETE /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}

Authorizations: oauth2_implicit (repo:write)

Path parameters

Expand

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

Responses

Expand

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

2.9.2. getManifestLabel
Copy link

Retrieves the label with the specific ID under the manifest.

GET /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

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

Responses

Expand

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

2.9.3. listManifestLabels
Copy link

GET /api/v1/repository/{repository}/manifest/{manifestref}/labels

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	manifestref required	The digest of the manifest	string

Query parameters

Expand

Type	Name	Description	Schema
query	filter optional	If specified, only labels matching the given prefix will be returned	string

Responses

Expand

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

2.9.4. addManifestLabel
Copy link

Adds a new label into the tag manifest.

POST /api/v1/repository/{repository}/manifest/{manifestref}/labels

Authorizations: oauth2_implicit (repo:write)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	manifestref required	The digest of the manifest	string

Request body schema (application/json)

Adds a label to a manifest

Expand

Name	Description	Schema
key optional	The key for the label	string
value optional	The value for the label	string
media_type optional	The media type for this label

Responses

Expand

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

2.9.5. getRepoManifest
Copy link

GET /api/v1/repository/{repository}/manifest/{manifestref}

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	manifestref required	The digest of the manifest	string

Responses

Expand

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

2.10. mirror
Copy link

2.10.1. syncCancel
Copy link

Update the sync_status for a given Repository’s mirroring configuration.

POST /api/v1/repository/{repository}/mirror/sync-cancel

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.10.2. syncNow
Copy link

Update the sync_status for a given Repository’s mirroring configuration.

POST /api/v1/repository/{repository}/mirror/sync-now

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.10.3. getRepoMirrorConfig
Copy link

Return the Mirror configuration for a given Repository.

GET /api/v1/repository/{repository}/mirror

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.10.4. createRepoMirrorConfig
Copy link

Create a RepoMirrorConfig for a given Repository.

POST /api/v1/repository/{repository}/mirror

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Create the repository mirroring configuration.

Expand

Name	Description	Schema
is_enabled optional	Used to enable or disable synchronizations.	boolean
external_reference optional	Location of the external repository.	string
external_registry_username optional	Username used to authenticate with external registry.
external_registry_password optional	Password used to authenticate with external registry.
sync_start_date optional	Determines the next time this repository is ready for synchronization.	string
sync_interval optional	Number of seconds after next_start_date to begin synchronizing.	integer
robot_username optional	Username of robot which will be used for image pushes.	string
root_rule optional	A list of glob-patterns used to determine which tags should be synchronized.	object
external_registry_config optional		object

Responses

Expand

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

2.10.5. changeRepoMirrorConfig
Copy link

Allow users to modifying the repository’s mirroring configuration.

PUT /api/v1/repository/{repository}/mirror

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Update the repository mirroring configuration.

Expand

Name	Description	Schema
is_enabled optional	Used to enable or disable synchronizations.	boolean
external_reference optional	Location of the external repository.	string
external_registry_username optional	Username used to authenticate with external registry.
external_registry_password optional	Password used to authenticate with external registry.
sync_start_date optional	Determines the next time this repository is ready for synchronization.	string
sync_interval optional	Number of seconds after next_start_date to begin synchronizing.	integer
robot_username optional	Username of robot which will be used for image pushes.	string
root_rule optional	A list of glob-patterns used to determine which tags should be synchronized.	object
external_registry_config optional		object

Responses

Expand

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

2.11. organization
Copy link

Manage organizations, members and OAuth applications.

2.11.1. createOrganization
Copy link

Create a new organization.

POST /api/v1/organization/

Authorizations: oauth2_implicit (user:admin)

Request body schema (application/json)

Description of a new organization.

Expand

Name	Description	Schema
name optional	Organization username	string
email optional	Organization contact email	string
recaptcha_response optional	The (may be disabled) recaptcha response code for verification	string

Responses

Expand

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

2.11.2. getOrganizationCollaborators
Copy link

List outside collaborators of the specified organization.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.11.3. deleteOrganizationApplication
Copy link

Deletes the application under this organization.

DELETE /api/v1/organization/{orgname}/applications/{client_id}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	string
path	client_id required	The OAuth client ID	string

Responses

Expand

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

2.11.4. getOrganizationApplication
Copy link

Retrieves the application with the specified client_id under the specified organization.

GET /api/v1/organization/{orgname}/applications/{client_id}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	string
path	client_id required	The OAuth client ID	string

Responses

Expand

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

2.11.5. updateOrganizationApplication
Copy link

Updates an application under this organization.

PUT /api/v1/organization/{orgname}/applications/{client_id}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	string
path	client_id required	The OAuth client ID	string

Request body schema (application/json)

Description of an updated application.

Expand

Name	Description	Schema
name optional	The name of the application	string
redirect_uri optional	The URI for the application’s OAuth redirect	string
application_uri optional	The URI for the application’s homepage	string
description optional	The human-readable description for the application	string
avatar_email optional	The e-mail address of the avatar to use for the application	string

Responses

Expand

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

2.11.6. getOrganizationApplications
Copy link

List the applications for the specified organization.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.11.7. createOrganizationApplication
Copy link

Creates a new application under this organization.

POST /api/v1/organization/{orgname}/applications

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Request body schema (application/json)

Description of a new organization application.

Expand

Name	Description	Schema
name optional	The name of the application	string
redirect_uri optional	The URI for the application’s OAuth redirect	string
application_uri optional	The URI for the application’s homepage	string
description optional	The human-readable description for the application	string
avatar_email optional	The e-mail address of the avatar to use for the application	string

Responses

Expand

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

2.11.8. removeOrganizationMember
Copy link

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

DELETE /api/v1/organization/{orgname}/members/{membername}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.11.9. getOrganizationMember
Copy link

Retrieves the details of a member of the organization.

GET /api/v1/organization/{orgname}/members/{membername}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.11.10. getOrganizationMembers
Copy link

List the human members of the specified organization.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.11.11. deleteAdminedOrganization
Copy link

Deletes the specified organization.

DELETE /api/v1/organization/{orgname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.11.12. getOrganization
Copy link

Get the details for the specified organization.

GET /api/v1/organization/{orgname}

Authorizations:

Path parameters

Expand

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

Responses

Expand

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

2.11.13. changeOrganizationDetails
Copy link

Change the details for the specified organization.

PUT /api/v1/organization/{orgname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Request body schema (application/json)

Description of updates for an existing organization

Expand

Name	Description	Schema
email optional	Organization contact email	string
invoice_email optional	Whether the organization desires to receive emails for invoices	boolean
invoice_email_address optional	The email address at which to receive invoices
tag_expiration_s optional	The number of seconds for tag expiration	integer

Responses

Expand

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

2.11.14. getApplicationInformation
Copy link

Get information on the specified application.

GET /api/v1/app/{client_id}

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	client_id required	The OAuth client ID	string

Responses

Expand

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

2.12. permission
Copy link

Manage repository permissions.

2.12.1. getUserTransitivePermission
Copy link

Get the fetch the permission for the specified user.

GET /api/v1/repository/{repository}/permissions/user/{username}/transitive

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Responses

Expand

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

2.12.2. deleteUserPermissions
Copy link

Delete the permission for the user.

DELETE /api/v1/repository/{repository}/permissions/user/{username}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Responses

Expand

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

2.12.3. getUserPermissions
Copy link

Get the permission for the specified user.

GET /api/v1/repository/{repository}/permissions/user/{username}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Responses

Expand

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

2.12.4. changeUserPermissions
Copy link

Update the perimssions for an existing repository.

PUT /api/v1/repository/{repository}/permissions/user/{username}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Request body schema (application/json)

Description of a user permission.

Expand

Name	Description	Schema
role optional	Role to use for the user	string

Responses

Expand

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

2.12.5. deleteTeamPermissions
Copy link

Delete the permission for the specified team.

DELETE /api/v1/repository/{repository}/permissions/team/{teamname}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Responses

Expand

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

2.12.6. getTeamPermissions
Copy link

Fetch the permission for the specified team.

GET /api/v1/repository/{repository}/permissions/team/{teamname}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Responses

Expand

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

2.12.7. changeTeamPermissions
Copy link

Update the existing team permission.

PUT /api/v1/repository/{repository}/permissions/team/{teamname}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Request body schema (application/json)

Description of a team permission.

Expand

Name	Description	Schema
role optional	Role to use for the team	string

Responses

Expand

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

2.12.8. listRepoTeamPermissions
Copy link

List all team permission.

GET /api/v1/repository/{repository}/permissions/team/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.12.9. listRepoUserPermissions
Copy link

List all user permissions.

GET /api/v1/repository/{repository}/permissions/user/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.13. prototype
Copy link

Manage default permissions added to repositories.

2.13.1. deleteOrganizationPrototypePermission
Copy link

Delete an existing permission prototype.

DELETE /api/v1/organization/{orgname}/prototypes/{prototypeid}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.13.2. updateOrganizationPrototypePermission
Copy link

Update the role of an existing permission prototype.

PUT /api/v1/organization/{orgname}/prototypes/{prototypeid}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Request body schema (application/json)

Description of a the new prototype role

Expand

Name	Description	Schema
role optional	Role that should be applied to the permission	string

Responses

Expand

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

2.13.3. getOrganizationPrototypePermissions
Copy link

List the existing prototypes for this organization.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.13.4. createOrganizationPrototypePermission
Copy link

Create a new permission prototype.

POST /api/v1/organization/{orgname}/prototypes

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Request body schema (application/json)

Description of a new prototype

Expand

Name	Description	Schema
role optional	Role that should be applied to the delegate	string
activating_user optional	Repository creating user to whom the rule should apply	object
delegate optional	Information about the user or team to which the rule grants access	object

Responses

Expand

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

2.14. repository
Copy link

List, create and manage repositories.

2.14.1. listRepos
Copy link

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

GET /api/v1/repository

Authorizations: oauth2_implicit (repo:read)

Query parameters

Expand

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

Responses

Expand

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

2.14.2. createRepo
Copy link

Create a new repository.

POST /api/v1/repository

Authorizations: oauth2_implicit (repo:create)

Request body schema (application/json)

Description of a new repository

Expand

Name	Description	Schema
repository optional	Repository name	string
visibility optional	Visibility which the repository will start with	string
namespace optional	Namespace in which the repository should be created. If omitted, the username of the caller is used	string
description optional	Markdown encoded description for the repository	string
repo_kind optional	The kind of repository

Responses

Expand

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

2.14.3. changeRepoVisibility
Copy link

Change the visibility of a repository.

POST /api/v1/repository/{repository}/changevisibility

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Change the visibility for the repository.

Expand

Name	Description	Schema
visibility optional	Visibility which the repository will start with	string

Responses

Expand

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

2.14.4. changeRepoState
Copy link

Change the state of a repository.

PUT /api/v1/repository/{repository}/changestate

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Change the state of the repository.

Expand

Name	Description	Schema
state optional	Determines whether pushes are allowed.	string

Responses

Expand

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

2.14.5. deleteRepository
Copy link

Delete a repository.

DELETE /api/v1/repository/{repository}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.14.6. getRepo
Copy link

Fetch the specified repository.

GET /api/v1/repository/{repository}

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	includeTags optional	Whether to include repository tags	boolean
query	includeStats optional	Whether to include action statistics	boolean

Responses

Expand

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

2.14.7. updateRepo
Copy link

Update the description in the specified repository.

PUT /api/v1/repository/{repository}

Authorizations: oauth2_implicit (repo:write)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Fields which can be updated in a repository.

Expand

Name	Description	Schema
description optional	Markdown encoded description for the repository	string

Responses

Expand

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

2.15. repositorynotification
Copy link

List, create and manage repository events/notifications.

2.15.1. testRepoNotification
Copy link

Queues a test notification for this repository.

POST /api/v1/repository/{repository}/notification/{uuid}/test

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	uuid required	The UUID of the notification	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.15.2. deleteRepoNotification
Copy link

Deletes the specified notification.

DELETE /api/v1/repository/{repository}/notification/{uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	uuid required	The UUID of the notification	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.15.3. getRepoNotification
Copy link

Get information for the specified notification.

GET /api/v1/repository/{repository}/notification/{uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	uuid required	The UUID of the notification	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.15.4. resetRepositoryNotificationFailures
Copy link

Resets repository notification to 0 failures.

POST /api/v1/repository/{repository}/notification/{uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	uuid required	The UUID of the notification	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.15.5. listRepoNotifications
Copy link

List the notifications for the specified repository.

GET /api/v1/repository/{repository}/notification/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.15.6. createRepoNotification
Copy link

POST /api/v1/repository/{repository}/notification/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Information for creating a notification on a repository

Expand

Name	Description	Schema
event optional	The event on which the notification will respond	string
method optional	The method of notification (such as email or web callback)	string
config optional	JSON config information for the specific method of notification	object
eventConfig optional	JSON config information for the specific event of notification	object
title optional	The human-readable title of the notification	string

Responses

Expand

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

2.16. repotoken
Copy link

Manage repository access tokens (DEPRECATED).

2.16.1. deleteToken
Copy link

Delete the repository token.

DELETE /api/v1/repository/{repository}/tokens/{code}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	code required	The token code	string

Responses

Expand

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

2.16.2. getTokens
Copy link

Fetch the specified repository token information.

GET /api/v1/repository/{repository}/tokens/{code}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	code required	The token code	string

Responses

Expand

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

2.16.3. changeToken
Copy link

Update the permissions for the specified repository token.

PUT /api/v1/repository/{repository}/tokens/{code}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	code required	The token code	string

Request body schema (application/json)

Description of a token permission

Expand

Name	Description	Schema
role optional	Role to use for the token	string

Responses

Expand

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

2.16.4. listRepoTokens
Copy link

List the tokens for the specified repository.

GET /api/v1/repository/{repository}/tokens/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.16.5. createToken
Copy link

Create a new repository token.

POST /api/v1/repository/{repository}/tokens/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

Description of a new token.

Expand

Name	Description	Schema
friendlyName optional	Friendly name to help identify the token	string

Responses

Expand

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

2.17. robot
Copy link

Manage user and organization robot accounts.

2.17.1. getUserRobots
Copy link

List the available robots for the user.

GET /api/v1/user/robots

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

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

Responses

Expand

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

2.17.2. getOrgRobotPermissions
Copy link

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

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

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.3. regenerateOrgRobotToken
Copy link

Regenerates the token for an organization robot.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.4. getUserRobotPermissions
Copy link

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

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

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.5. regenerateUserRobotToken
Copy link

Regenerates the token for a user’s robot.

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

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.6. deleteOrgRobot
Copy link

Delete an existing organization robot.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.7. getOrgRobot
Copy link

Returns the organization’s robot with the specified name.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.8. createOrgRobot
Copy link

Create a new robot in the organization.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Request body schema (application/json)

Optional data for creating a robot

Expand

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

Responses

Expand

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

2.17.9. getOrgRobots
Copy link

List the organization’s robots.

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Query parameters

Expand

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

Responses

Expand

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

2.17.10. deleteUserRobot
Copy link

Delete an existing robot.

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

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.11. getUserRobot
Copy link

Returns the user’s robot with the specified name.

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

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

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

Responses

Expand

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

2.17.12. createUserRobot
Copy link

Create a new user robot with the specified name.

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

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

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

Request body schema (application/json)

Optional data for creating a robot

Expand

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

Responses

Expand

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

2.18. search
Copy link

Conduct searches against all registry context.

2.18.1. conductRepoSearch
Copy link

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

GET /api/v1/find/repositories

Authorizations:

Query parameters

Expand

Type	Name	Description	Schema
query	includeUsage optional	Whether to include usage metadata	boolean
query	page optional	The page.	integer
query	query optional	The search query.	string

Responses

Expand

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

2.18.2. conductSearch
Copy link

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

GET /api/v1/find/all

Authorizations: oauth2_implicit (repo:read)

Query parameters

Expand

Type	Name	Description	Schema
query	query optional	The search query.	string

Responses

Expand

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

2.18.3. getMatchingEntities
Copy link

Get a list of entities that match the specified prefix.

GET /api/v1/entities/{prefix}

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	prefix required		string

Query parameters

Expand

Type	Name	Description	Schema
query	includeOrgs optional	Whether to include orgs names.	boolean
query	includeTeams optional	Whether to include team names.	boolean
query	namespace optional	Namespace to use when querying for org entities.	string

Responses

Expand

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

2.19. secscan
Copy link

List and manage repository vulnerabilities and other security information.

2.19.1. getRepoManifestSecurity
Copy link

GET /api/v1/repository/{repository}/manifest/{manifestref}/security

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	manifestref required	The digest of the manifest	string

Query parameters

Expand

Type	Name	Description	Schema
query	vulnerabilities optional	Include vulnerabilities informations	boolean

Responses

Expand

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

2.19.2. getRepoImageSecurity
Copy link

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

GET /api/v1/repository/{repository}/image/{imageid}/security

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	imageid required	The image ID	string
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	vulnerabilities optional	Include vulnerabilities information	boolean

Responses

Expand

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

2.20. superuser
Copy link

Superuser API.

2.20.1. listAllUsers
Copy link

Returns a list of all users in the system.

GET /api/v1/superuser/users/

Authorizations: oauth2_implicit (super:user)

Query parameters

Expand

Type	Name	Description	Schema
query	disabled optional	If false, only enabled users will be returned.	boolean

Responses

Expand

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

2.20.2. createInstallUser
Copy link

Creates a new user.

POST /api/v1/superuser/users/

Authorizations: oauth2_implicit (super:user)

Request body schema (application/json)

Data for creating a user

Expand

Name	Description	Schema
username optional	The username of the user being created	string
email optional	The email address of the user being created	string

Responses

Expand

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

2.20.3. listAllLogs
Copy link

List the usage logs for the current system.

GET /api/v1/superuser/logs

Authorizations: oauth2_implicit (super:user)

Query parameters

Expand

Type	Name	Description	Schema
query	next_page optional	The page token for the next page	string
query	page optional	The page number for the logs	integer
query	endtime optional	Latest time to which to get logs (%m/%d/%Y %Z)	string
query	starttime optional	Earliest time from which to get logs (%m/%d/%Y %Z)	string

Responses

Expand

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

2.20.4. listServiceKeys
Copy link

GET /api/v1/superuser/keys

Authorizations: oauth2_implicit (super:user)

Responses

Expand

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

2.20.5. createServiceKey
Copy link

POST /api/v1/superuser/keys

Authorizations: oauth2_implicit (super:user)

Request body schema (application/json)

Description of creation of a service key

Expand

Name	Description	Schema
service optional	The service authenticating with this key	string
name optional	The friendly name of a service key	string
metadata optional	The key/value pairs of this key’s metadata	object
notes optional	If specified, the extra notes for the key	string
expiration optional	The expiration date as a unix timestamp

Responses

Expand

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

2.20.6. deleteOrganization
Copy link

Deletes the specified organization.

DELETE /api/v1/superuser/organizations/{name}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	name required	The name of the organizaton being managed	string

Responses

Expand

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

2.20.7. changeOrganization
Copy link

Updates information about the specified user.

PUT /api/v1/superuser/organizations/{name}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	name required	The name of the organizaton being managed	string

Request body schema (application/json)

Description of updates for an existing organization

Expand

Name	Description	Schema
email optional	Organization contact email	string
invoice_email optional	Whether the organization desires to receive emails for invoices	boolean
invoice_email_address optional	The email address at which to receive invoices
tag_expiration_s optional	The number of seconds for tag expiration	integer

Responses

Expand

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

2.20.8. approveServiceKey
Copy link

POST /api/v1/superuser/approvedkeys/{kid}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	kid required	The unique identifier for a service key	string

Request body schema (application/json)

Information for approving service keys

Expand

Name	Description	Schema
notes optional	Optional approval notes	string

Responses

Expand

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

2.20.9. deleteServiceKey
Copy link

DELETE /api/v1/superuser/keys/{kid}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	kid required	The unique identifier for a service key	string

Responses

Expand

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

2.20.10. getServiceKey
Copy link

GET /api/v1/superuser/keys/{kid}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	kid required	The unique identifier for a service key	string

Responses

Expand

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

2.20.11. updateServiceKey
Copy link

PUT /api/v1/superuser/keys/{kid}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	kid required	The unique identifier for a service key	string

Request body schema (application/json)

Description of updates for a service key

Expand

Name	Description	Schema
name optional	The friendly name of a service key	string
metadata optional	The key/value pairs of this key’s metadata	object
expiration optional	The expiration date as a unix timestamp

Responses

Expand

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

2.20.12. getRepoBuildStatusSuperUser
Copy link

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

GET /api/v1/superuser/{build_uuid}/status

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	build_uuid required	The UUID of the build	string

Responses

Expand

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

2.20.13. getRepoBuildSuperUser
Copy link

Returns information about a build.

GET /api/v1/superuser/{build_uuid}/build

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	build_uuid required	The UUID of the build	string

Responses

Expand

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

2.20.14. getRepoBuildLogsSuperUser
Copy link

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

GET /api/v1/superuser/{build_uuid}/logs

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	build_uuid required	The UUID of the build	string

Responses

Expand

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

2.21. tag
Copy link

Manage the tags of a repository.

2.21.1. restoreTag
Copy link

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

POST /api/v1/repository/{repository}/tag/{tag}/restore

Authorizations: oauth2_implicit (repo:write)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	tag required	The name of the tag	string

Request body schema (application/json)

Restores a tag to a specific image

Expand

Name	Description	Schema
image optional	(Deprecated: use `manifest_digest`) Image to which the tag should point	string
manifest_digest optional	If specified, the manifest digest that should be used	string

Responses

Expand

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

2.21.2. listTagImages
Copy link

List the images for the specified repository tag.

GET /api/v1/repository/{repository}/tag/{tag}/images

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	tag required	The name of the tag	string

Query parameters

Expand

Type	Name	Description	Schema
query	owned optional	If specified, only images wholely owned by this tag are returned.	boolean

Responses

Expand

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

2.21.3. deleteFullTag
Copy link

Delete the specified repository tag.

DELETE /api/v1/repository/{repository}/tag/{tag}

Authorizations: oauth2_implicit (repo:write)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	tag required	The name of the tag	string

Responses

Expand

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

2.21.4. changeTag
Copy link

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

PUT /api/v1/repository/{repository}/tag/{tag}

Authorizations: oauth2_implicit (repo:write)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string
path	tag required	The name of the tag	string

Request body schema (application/json)

Makes changes to a specific tag

Expand

Name	Description	Schema
image optional	(Deprecated: Use `manifest_digest`) Image to which the tag should point.
manifest_digest optional	(If specified) The manifest digest to which the tag should point
expiration optional	(If specified) The expiration for the image

Responses

Expand

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

2.21.5. listRepoTags
Copy link

GET /api/v1/repository/{repository}/tag/

Authorizations: oauth2_implicit (repo:read)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Query parameters

Expand

Type	Name	Description	Schema
query	onlyActiveTags optional	Filter to only active tags.	boolean
query	page optional	Page index for the results. Default 1.	integer
query	limit optional	Limit to the number of results to return per page. Max 100.	integer
query	specificTag optional	Filters the tags to the specific tag.	string

Responses

Expand

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

2.22. team
Copy link

Create, list and manage an organization’s teams.

2.22.1. getOrganizationTeamPermissions
Copy link

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

GET /api/v1/organization/{orgname}/team/{teamname}/permissions

Authorizations:

Path parameters

Expand

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

Responses

Expand

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

2.22.2. deleteOrganizationTeamMember
Copy link

Delete a member of a team.

If the user is merely invited to join the team, then the invite is removed instead.

If the user is merely invited to join the team, then the invite is removed instead.

Copy to Clipboard

Toggle word wrap

DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	string
path	membername required	The username of the team member	string
path	teamname required	The name of the team	string

Responses

Expand

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

2.22.3. updateOrganizationTeamMember
Copy link

Adds or invites a member to an existing team.

PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	string
path	membername required	The username of the team member	string
path	teamname required	The name of the team	string

Responses

Expand

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

2.22.4. getOrganizationTeamMembers
Copy link

Retrieve the list of members for the specified team.

GET /api/v1/organization/{orgname}/team/{teamname}/members

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Query parameters

Expand

Type	Name	Description	Schema
query	includePending optional	Whether to include pending members	boolean

Responses

Expand

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

2.22.5. deleteOrganizationTeam
Copy link

Delete the specified team.

DELETE /api/v1/organization/{orgname}/team/{teamname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

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

2.22.6. updateOrganizationTeam
Copy link

Update the org-wide permission for the specified team.

PUT /api/v1/organization/{orgname}/team/{teamname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Request body schema (application/json)

Description of a team

Expand

Name	Description	Schema
role optional	Org wide permissions that should apply to the team	string
description optional	Markdown description for the team	string

Responses

Expand

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

2.23. trigger
Copy link

Create, list and manage build triggers.

2.23.1. activateBuildTrigger
Copy link

Activate the specified build trigger.

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Request body schema (application/json)

Expand

Name	Description	Schema
config optional	Arbitrary json.	object
pull_robot optional	The name of the robot that will be used to pull images.	string

Responses

Expand

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

2.23.2. listTriggerRecentBuilds
Copy link

List the builds started by the specified trigger.

GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Query parameters

Expand

Type	Name	Description	Schema
query	limit optional	The maximum number of builds to return	integer

Responses

Expand

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

2.23.3. manuallyStartBuildTrigger
Copy link

Manually start a build from the specified trigger.

POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Request body schema (application/json)

Optional run parameters for activating the build trigger

Expand

Name	Description	Schema
branch_name optional	(SCM only) If specified, the name of the branch to build.	string
commit_sha optional	(Custom Only) If specified, the ref/SHA1 used to checkout a git repository.	string
refs optional	(SCM Only) If specified, the ref to build.

Responses

Expand

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

2.23.4. deleteBuildTrigger
Copy link

Delete the specified build trigger.

DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Responses

Expand

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

2.23.5. getBuildTrigger
Copy link

Get information for the specified build trigger.

GET /api/v1/repository/{repository}/trigger/{trigger_uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Responses

Expand

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

2.23.6. updateBuildTrigger
Copy link

Updates the specified build trigger.

PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Request body schema (application/json)

Options for updating a build trigger

Expand

Name	Description	Schema
enabled optional	Whether the build trigger is enabled	boolean

Responses

Expand

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

2.23.7. listBuildTriggers
Copy link

List the triggers for the specified repository.

GET /api/v1/repository/{repository}/trigger/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.24. user
Copy link

Manage the current user.

2.24.1. listStarredRepos
Copy link

List all starred repositories.

GET /api/v1/user/starred

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

Type	Name	Description	Schema
query	next_page optional	The page token for the next page	string

Responses

Expand

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

2.24.2. createStar
Copy link

Star a repository.

POST /api/v1/user/starred

Authorizations: oauth2_implicit (repo:read)

Request body schema (application/json)

Expand

Name	Description	Schema
namespace optional	Namespace in which the repository belongs	string
repository optional	Repository name	string

Responses

Expand

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

2.24.3. getLoggedInUser
Copy link

Get user information for the authenticated user.

GET /api/v1/user/

Authorizations: oauth2_implicit (user:read)

Responses

Expand

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

2.24.4. deleteStar
Copy link

Removes a star from a repository.

DELETE /api/v1/user/starred/{repository}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Responses

Expand

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

2.24.5. getUserInformation
Copy link

Get user information for the specified user.

GET /api/v1/users/{username}

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	username required		string

Responses

Expand

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

2.25. Definitions
Copy link

2.25.1. ApiError
Copy link

Expand

Name	Description	Schema
status optional	Status code of the response.	integer
type optional	Reference to the type of the error.	string
detail optional	Details about the specific instance of the error.	string
title optional	Unique error code to identify the type of error.	string
error_message optional	Deprecated; alias for detail	string
error_type optional	Deprecated; alias for detail	string

2.25.2. UserView
Copy link

Expand

Name	Description	Schema
verified optional	Whether the user’s email address has been verified	boolean
anonymous optional	true if this user data represents a guest user	boolean
email optional	The user’s email address	string
avatar optional	Avatar data representing the user’s icon	object
organizations optional	Information about the organizations in which the user is a member	array of object
logins optional	The list of external login providers against which the user has authenticated	array of object
can_create_repo optional	Whether the user has permission to create repositories	boolean
preferred_namespace optional	If true, the user’s namespace is the preferred namespace to display	boolean

2.25.3. ViewMirrorConfig
Copy link

Expand

Name	Description	Schema
is_enabled optional	Used to enable or disable synchronizations.	boolean
external_reference optional	Location of the external repository.	string
external_registry_username optional	Username used to authenticate with external registry.
external_registry_password optional	Password used to authenticate with external registry.
sync_start_date optional	Determines the next time this repository is ready for synchronization.	string
sync_interval optional	Number of seconds after next_start_date to begin synchronizing.	integer
robot_username optional	Username of robot which will be used for image pushes.	string
root_rule optional	A list of glob-patterns used to determine which tags should be synchronized.	object
external_registry_config optional		object

2.25.4. ApiErrorDescription
Copy link

Expand

Name	Description	Schema
type optional	A reference to the error type resource	string
title optional	The title of the error. Can be used to uniquely identify the kind of error.	string
description optional	A more detailed description of the error that may include help for fixing the issue.	string

Legal Notice
Copy link

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.

Red Hat Quay API Guide

Red Hat Quay API Guide

PrefaceCopy linkLink copied to clipboard!

Chapter 1. Using the Red Hat Quay APICopy linkLink copied to clipboard!

1.1. Accessing the Quay API from Quay.ioCopy linkLink copied to clipboard!

1.2. Create OAuth access tokenCopy linkLink copied to clipboard!

1.3. Accessing your Quay API from a web browserCopy linkLink copied to clipboard!

1.4. Accessing the Red Hat Quay API from the command lineCopy linkLink copied to clipboard!

1.4.1. Get superuser informationCopy linkLink copied to clipboard!

1.4.2. Creating a superuser using the APICopy linkLink copied to clipboard!

1.4.3. List usage logsCopy linkLink copied to clipboard!

1.4.3.1. Example for paginationCopy linkLink copied to clipboard!

1.4.4. Directory synchronizationCopy linkLink copied to clipboard!

1.4.5. Create a repository build via APICopy linkLink copied to clipboard!

1.4.6. Create an org robotCopy linkLink copied to clipboard!

1.4.7. Trigger a buildCopy linkLink copied to clipboard!

1.4.8. Create a private repositoryCopy linkLink copied to clipboard!

Chapter 2. Red Hat Quay Application Programming Interface (API)Copy linkLink copied to clipboard!

2.1. AuthorizationCopy linkLink copied to clipboard!

Scopes

2.2. appspecifictokensCopy linkLink copied to clipboard!

2.2.1. listAppTokensCopy linkLink copied to clipboard!

GET /api/v1/user/apptoken

Query parameters

Responses

2.2.2. createAppTokenCopy linkLink copied to clipboard!

POST /api/v1/user/apptoken

Request body schema (application/json)

Responses

2.2.3. revokeAppTokenCopy linkLink copied to clipboard!

DELETE /api/v1/user/apptoken/{token_uuid}

Path parameters

Responses

2.2.4. getAppTokenCopy linkLink copied to clipboard!

GET /api/v1/user/apptoken/{token_uuid}

Path parameters

Responses

2.3. buildCopy linkLink copied to clipboard!

2.3.1. getRepoBuildStatusCopy linkLink copied to clipboard!

GET /api/v1/repository/{repository}/build/{build_uuid}/status

Path parameters

Responses

2.3.2. getRepoBuildLogsCopy linkLink copied to clipboard!

GET /api/v1/repository/{repository}/build/{build_uuid}/logs

Path parameters

Responses

2.3.3. cancelRepoBuildCopy linkLink copied to clipboard!

DELETE /api/v1/repository/{repository}/build/{build_uuid}

Path parameters

Responses

2.3.4. getRepoBuildCopy linkLink copied to clipboard!

GET /api/v1/repository/{repository}/build/{build_uuid}

Path parameters

Responses

2.3.5. getRepoBuildsCopy linkLink copied to clipboard!

GET /api/v1/repository/{repository}/build/

Path parameters

Query parameters

Responses

2.3.6. requestRepoBuildCopy linkLink copied to clipboard!

POST /api/v1/repository/{repository}/build/

Path parameters

Request body schema (application/json)

Responses

2.4. discoveryCopy linkLink copied to clipboard!

2.4.1. discoveryCopy linkLink copied to clipboard!

GET /api/v1/discovery

Query parameters

Responses

2.5. errorCopy linkLink copied to clipboard!

2.5.1. getErrorDescriptionCopy linkLink copied to clipboard!

GET /api/v1/error/{error_type}

Path parameters

Responses

2.6. globalmessagesCopy linkLink copied to clipboard!

2.6.1. getGlobalMessagesCopy linkLink copied to clipboard!

GET /api/v1/messages

Responses

2.6.2. createGlobalMessageCopy linkLink copied to clipboard!

POST /api/v1/messages

Preface
Copy link

Chapter 1. Using the Red Hat Quay API
Copy link

1.1. Accessing the Quay API from Quay.io
Copy link

1.2. Create OAuth access token
Copy link

1.3. Accessing your Quay API from a web browser
Copy link

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

1.4.1. Get superuser information
Copy link

1.4.2. Creating a superuser using the API
Copy link

1.4.3. List usage logs
Copy link

1.4.3.1. Example for pagination
Copy link

1.4.4. Directory synchronization
Copy link

1.4.5. Create a repository build via API
Copy link

1.4.6. Create an org robot
Copy link

1.4.7. Trigger a build
Copy link

1.4.8. Create a private repository
Copy link

Chapter 2. Red Hat Quay Application Programming Interface (API)
Copy link

2.1. Authorization
Copy link

2.2. appspecifictokens
Copy link

2.2.1. listAppTokens
Copy link

2.2.2. createAppToken
Copy link

2.2.3. revokeAppToken
Copy link

2.2.4. getAppToken
Copy link

2.3. build
Copy link

2.3.1. getRepoBuildStatus
Copy link

2.3.2. getRepoBuildLogs
Copy link

2.3.3. cancelRepoBuild
Copy link

2.3.4. getRepoBuild
Copy link

2.3.5. getRepoBuilds
Copy link

2.3.6. requestRepoBuild
Copy link

2.4. discovery
Copy link

2.4.1. discovery
Copy link

2.5. error
Copy link

2.5.1. getErrorDescription
Copy link

2.6. globalmessages
Copy link

2.6.1. getGlobalMessages
Copy link

2.6.2. createGlobalMessage
Copy link

2.6.3. deleteGlobalMessage
Copy link

2.7. image
Copy link

2.7.1. getImage
Copy link

2.7.2. listRepositoryImages
Copy link

2.8. logs
Copy link

2.8.1. getAggregateUserLogs
Copy link

2.8.2. exportUserLogs
Copy link

2.8.3. listUserLogs
Copy link

2.8.4. getAggregateOrgLogs
Copy link

2.8.5. exportOrgLogs
Copy link

2.8.6. listOrgLogs
Copy link

2.8.7. getAggregateRepoLogs
Copy link

2.8.8. exportRepoLogs
Copy link

2.8.9. listRepoLogs
Copy link

2.9. manifest
Copy link

2.9.1. deleteManifestLabel
Copy link

2.9.2. getManifestLabel
Copy link