Chapter 16. repository

16.1. createRepo
Copiar o 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 required	Repository name	string
visibility required	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 required	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

Example command

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "repository": "<new_repository_name>",
    "visibility": "<public>",
    "description": "<This is a description of the new repository>."
  }' \
  "https://quay-server.example.com/api/v1/repository"

Copy to Clipboard

Toggle word wrap

16.2. listRepos
Copiar o 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 required	Adds any repositories visible to the user by virtue of being public	boolean
query	starred required	Filters the repositories returned to those starred by the user	boolean
query	namespace required	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

Example command

curl -X GET \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  "https://quay-server.example.com/api/v1/repository?public=true&starred=false&namespace=<NAMESPACE>"

$ curl -X GET \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  "https://quay-server.example.com/api/v1/repository?public=true&starred=false&namespace=<NAMESPACE>"

Copy to Clipboard

Toggle word wrap

16.3. changeRepoVisibility
Copiar o 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 required	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

Example Command

curl -X POST \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{

$ curl -X POST \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "visibility": "private"
      }' \
  "https://quay-server.example.com/api/v1/repository/<NAMESPACE>/<REPO_NAME>/changevisibility"

Copy to Clipboard

Toggle word wrap

16.4. changeRepoState
Copiar o 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 required	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

Example command

16.5. getRepo
Copiar o 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

Example command

curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

$ curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

Copy to Clipboard

Toggle word wrap

16.6. updateRepo
Copiar o 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 required	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

Example command

curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{

$ curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "description": "This is an updated description for the repository."
      }' \
  "https://quay-server.example.com/api/v1/repository/<NAMESPACE>/<REPOSITORY>"

Copy to Clipboard

Toggle word wrap

16.7. deleteRepository
Copiar o 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

Example command

curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

$ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

Copy to Clipboard

Toggle word wrap

Este conteúdo não está disponível no idioma selecionado.

16.1. createRepoCopiar o linkLink copiado para a área de transferência!

POST /api/v1/repository

Request body schema (application/json)

Responses

Example command

16.2. listReposCopiar o linkLink copiado para a área de transferência!

GET /api/v1/repository

Query parameters

Responses

Example command

16.3. changeRepoVisibilityCopiar o linkLink copiado para a área de transferência!

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

Path parameters

Request body schema (application/json)

Responses

Example Command

16.4. changeRepoStateCopiar o linkLink copiado para a área de transferência!

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

Path parameters

Request body schema (application/json)

Responses

Example command

16.5. getRepoCopiar o linkLink copiado para a área de transferência!

GET /api/v1/repository/{repository}

Path parameters

Query parameters

Responses

Example command

16.6. updateRepoCopiar o linkLink copiado para a área de transferência!

PUT /api/v1/repository/{repository}

Path parameters

Request body schema (application/json)

Responses

Example command

16.7. deleteRepositoryCopiar o linkLink copiado para a área de transferência!

DELETE /api/v1/repository/{repository}

Path parameters

Responses

Example command

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Tornando o open source mais inclusivo

Sobre a Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

16.1. createRepo
Copiar o link

16.2. listRepos
Copiar o link

16.3. changeRepoVisibility
Copiar o link

16.4. changeRepoState
Copiar o link

16.5. getRepo
Copiar o link

16.6. updateRepo
Copiar o link

16.7. deleteRepository
Copiar o link