Chapter 17. repositorynotification

17.1. testRepoNotification
Link kopieren

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	repository required	The full path of the repository. e.g. namespace/name	string
path	uuid required	The UUID 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

Example command

curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>/test

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>/test

Copy to Clipboard

Toggle word wrap

17.2. getRepoNotification
Link kopieren

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	repository required	The full path of the repository. e.g. namespace/name	string
path	uuid required	The UUID of the notification	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 POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

Copy to Clipboard

Toggle word wrap

17.3. deleteRepoNotification
Link kopieren

Deletes the specified notification.

DELETE /api/v1/repository/{repository}/notification/{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	uuid required	The UUID of the notification	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>" \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/<uuid>

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

Copy to Clipboard

Toggle word wrap

17.4. resetRepositoryNotificationFailures
Link kopieren

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	repository required	The full path of the repository. e.g. namespace/name	string
path	uuid required	The UUID of the notification	string

Responses

Expand

HTTP Code	Description	Schema
204	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>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

Copy to Clipboard

Toggle word wrap

17.5. createRepoNotification
Link kopieren

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 required	The event on which the notification will respond	string
method required	The method of notification (such as email or web callback)	string
config required	JSON config information for the specific method of notification	object
eventConfig required	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

Example command

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

$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  --data '{
    "event": "<event>",
    "method": "<method>",
    "config": {
      "<config_key>": "<config_value>"
    },
    "eventConfig": {
      "<eventConfig_key>": "<eventConfig_value>"
    }
  }' \
  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/

Copy to Clipboard

Toggle word wrap

17.6. listRepoNotifications
Link kopieren

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

Example command

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

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

Copy to Clipboard

Toggle word wrap

Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.

17.1. testRepoNotificationLink kopierenLink in die Zwischenablage kopiert!

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

Path parameters

Responses

Example command

17.2. getRepoNotificationLink kopierenLink in die Zwischenablage kopiert!

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

Path parameters

Responses

Example command

17.3. deleteRepoNotificationLink kopierenLink in die Zwischenablage kopiert!

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

Path parameters

Responses

Example command

17.4. resetRepositoryNotificationFailuresLink kopierenLink in die Zwischenablage kopiert!

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

Path parameters

Responses

Example command

17.5. createRepoNotificationLink kopierenLink in die Zwischenablage kopiert!

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

Path parameters

Request body schema (application/json)

Responses

Example command

17.6. listRepoNotificationsLink kopierenLink in die Zwischenablage kopiert!

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

Path parameters

Responses

Example command

Lernen

Testen, kaufen und verkaufen

Communitys

Über Red Hat Dokumentation

Mehr Inklusion in Open Source

Über Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

17.1. testRepoNotification
Link kopieren

17.2. getRepoNotification
Link kopieren

17.3. deleteRepoNotification
Link kopieren

17.4. resetRepositoryNotificationFailures
Link kopieren

17.5. createRepoNotification
Link kopieren

17.6. listRepoNotifications
Link kopieren