import requests
url = "https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/held-platform-updates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/held-platform-updates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/held-platform-updates \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"severity": "critical",
"title": "<string>",
"state": "open",
"created_at": "2023-11-07T05:31:56Z",
"audience": "organisation",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"body": "<string>",
"dedupe_key": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"route_hint": {},
"data": {},
"recurrence_count": 123,
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"read_at": "2023-11-07T05:31:56Z",
"dismissed_at": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"center_view": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}List held platform updates
Lists the platform updates Ankra is holding for a cluster: its live platform_component_update_held notifications. On a cluster that is production, or that nobody has confirmed is not production, Ankra holds every platform add-on version or image update and raises one of these cards instead of applying it. Each item carries the card’s id and, under data, its fingerprint and the held moves (pin_moves_held): send that id and fingerprint to POST /api/v1/org/clusters/{cluster_id}/held-platform-updates/{notification_id}/take to take the update. This is the cluster notification feed the portal reads, narrowed to held updates that can still be taken, so a card you dismissed or muted is left out. Requires clusters.read on the cluster.
import requests
url = "https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/held-platform-updates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/held-platform-updates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/clusters/{cluster_id}/held-platform-updates \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"severity": "critical",
"title": "<string>",
"state": "open",
"created_at": "2023-11-07T05:31:56Z",
"audience": "organisation",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"body": "<string>",
"dedupe_key": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"route_hint": {},
"data": {},
"recurrence_count": 123,
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"read_at": "2023-11-07T05:31:56Z",
"dismissed_at": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"center_view": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
PAT organisation override.
Path Parameters
Query Parameters
The page to return, from 1.
x >= 1How many cards a page holds.
1 <= x <= 100