Chapter 6. globalmessages

6.1. 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 required	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

Example command

curl -X POST "https://<quay-server.example.com>/api/v1/messages" \
    -H "Authorization: Bearer <access_token>" \
    -H "Content-Type: application/json" \
    -d '{

$ curl -X POST "https://<quay-server.example.com>/api/v1/messages" \
    -H "Authorization: Bearer <access_token>" \
    -H "Content-Type: application/json" \
    -d '{
        "message": {
            "content": "Hi",
            "media_type": "text/plain",
            "severity": "info"
        }
    }'

Copy to Clipboard

Toggle word wrap

6.2. 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

Example command

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

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

Copy to Clipboard

Toggle word wrap

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

Example command

curl -X DELETE "https://<quay-server.example.com>/api/v1/message/<uuid>" \
    -H "Authorization: Bearer <access_token>"

$ curl -X DELETE "https://<quay-server.example.com>/api/v1/message/<uuid>" \
    -H "Authorization: Bearer <access_token>"

Copy to Clipboard

Toggle word wrap

6.1. createGlobalMessage
Copy link

POST /api/v1/messages

Request body schema (application/json)

Responses

Example command

6.2. getGlobalMessages
Copy link

GET /api/v1/messages

Responses

Example command

6.3. deleteGlobalMessage
Copy link

DELETE /api/v1/message/{uuid}

Path parameters

Responses

Example command

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Chapter 6. globalmessages

6.1. createGlobalMessageCopy linkLink copied to clipboard!

POST /api/v1/messages

Request body schema (application/json)

Responses

Example command

6.2. getGlobalMessagesCopy linkLink copied to clipboard!

GET /api/v1/messages

Responses

Example command

6.3. deleteGlobalMessageCopy linkLink copied to clipboard!

DELETE /api/v1/message/{uuid}

Path parameters

Responses

Example command

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

6.1. createGlobalMessage
Copy link

6.2. getGlobalMessages
Copy link

6.3. deleteGlobalMessage
Copy link