Chapter 9. mirror

9.1. syncCancel
复制链接

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

Example command

curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-cancel" \

$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-cancel" \

Copy to Clipboard

Toggle word wrap

9.2. syncNow
复制链接

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

Example command

curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-now" \
     -H "Authorization: Bearer <access_token>"

$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-now" \
     -H "Authorization: Bearer <access_token>"

Copy to Clipboard

Toggle word wrap

9.3. getRepoMirrorConfig
复制链接

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

Example command

curl -X GET "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
     -H "Authorization: Bearer <access_token>"

$ curl -X GET "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
     -H "Authorization: Bearer <access_token>"

Copy to Clipboard

Toggle word wrap

9.4. changeRepoMirrorConfig
复制链接

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
skopeo_timeout_interval required	Number of seconds mirroring job will run before timing out.	Integer

Responses

Expand

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

Example command

curl -X PUT "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
    -H "Authorization: Bearer <access_token>" \
    -H "Content-Type: application/json" \
    -d '{
        "is_enabled": <false>,
        "external_reference": "<external_reference>",
        "external_registry_username": "<external_registry_username>",
        "external_registry_password": "<external_registry_password>",
        "sync_start_date": "<sync_start_date>",
        "sync_interval": <sync_interval>,
        "robot_username": "<robot_username>",
        "skopeo_timeout_interval": 600,
        "root_rule": {
            "rule": "<rule>",
            "rule_type": "<rule_type>"
        }
    }'

$ curl -X PUT "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
    -H "Authorization: Bearer <access_token>" \
    -H "Content-Type: application/json" \
    -d '{
        "is_enabled": <false>,

1


        "external_reference": "<external_reference>",
        "external_registry_username": "<external_registry_username>",
        "external_registry_password": "<external_registry_password>",
        "sync_start_date": "<sync_start_date>",
        "sync_interval": <sync_interval>,
        "robot_username": "<robot_username>",
        "skopeo_timeout_interval": 600,
        "root_rule": {
            "rule": "<rule>",
            "rule_type": "<rule_type>"
        }
    }'

Copy to Clipboard

Toggle word wrap

1: Disables automatic synchronization.

9.5. createRepoMirrorConfig
复制链接

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 required	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 required	Determines the next time this repository is ready for synchronization.	string
sync_interval required	Number of seconds after next_start_date to begin synchronizing.	integer
robot_username required	Username of robot which will be used for image pushes.	string
root_rule required	A list of glob-patterns used to determine which tags should be synchronized.	object
external_registry_config optional		object
skopeo_timeout_interval required	Number of seconds mirroring job will run before timing out.	Integer

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 "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
    -H "Authorization: Bearer <access_token>" \
    -H "Content-Type: application/json" \
    -d '{
        "is_enabled": <is_enabled>,
        "external_reference": "<external_reference>",
        "external_registry_username": "<external_registry_username>",
        "external_registry_password": "<external_registry_password>",
        "sync_start_date": "<sync_start_date>",
        "sync_interval": <sync_interval>,
        "robot_username": "<robot_username>",
        "skopeo_timeout_interval": 600,
        "root_rule": {
            "rule": "<rule>",
            "rule_type": "<rule_type>"
        }
    }'

$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
    -H "Authorization: Bearer <access_token>" \
    -H "Content-Type: application/json" \
    -d '{
        "is_enabled": <is_enabled>,
        "external_reference": "<external_reference>",
        "external_registry_username": "<external_registry_username>",
        "external_registry_password": "<external_registry_password>",
        "sync_start_date": "<sync_start_date>",
        "sync_interval": <sync_interval>,
        "robot_username": "<robot_username>",
        "skopeo_timeout_interval": 600,
        "root_rule": {
            "rule": "<rule>",
            "rule_type": "<rule_type>"
        }
    }'

Copy to Clipboard

Toggle word wrap

此内容没有您所选择的语言版本。

9.1. syncCancel
复制链接

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

Path parameters

Responses

Example command

9.2. syncNow
复制链接

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

Path parameters

Responses

Example command

9.3. getRepoMirrorConfig
复制链接

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

Path parameters

Responses

Example command

9.4. changeRepoMirrorConfig
复制链接

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

Path parameters

Request body schema (application/json)

Responses

Example command

9.5. createRepoMirrorConfig
复制链接

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

Path parameters

Request body schema (application/json)

Responses

Example command

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

此内容没有您所选择的语言版本。

Chapter 9. mirror

9.1. syncCancel复制链接链接已复制到粘贴板!

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

Path parameters

Responses

Example command

9.2. syncNow复制链接链接已复制到粘贴板!

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

Path parameters

Responses

Example command

9.3. getRepoMirrorConfig复制链接链接已复制到粘贴板!

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

Path parameters

Responses

Example command

9.4. changeRepoMirrorConfig复制链接链接已复制到粘贴板!

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

Path parameters

Request body schema (application/json)

Responses

Example command

9.5. createRepoMirrorConfig复制链接链接已复制到粘贴板!

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

Path parameters

Request body schema (application/json)

Responses

Example command

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

9.1. syncCancel
复制链接

9.2. syncNow
复制链接

9.3. getRepoMirrorConfig
复制链接

9.4. changeRepoMirrorConfig
复制链接

9.5. createRepoMirrorConfig
复制链接