List subscriptions for a platform

Returns a list of existing platform-specific subscriptions. Filters:

• type → all | global | owner
• owner (admin only) → list another user’s private subs with type=owner
• subscriptionRef → return a single subscription by ID.

GET /subscriptions/{platformType}

List subscriptions for a platform

cURL

curl --request GET \
  --url https://{host}/subscriptions/{platformType}

import requests

url = "https://{host}/subscriptions/{platformType}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://{host}/subscriptions/{platformType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/subscriptions/{platformType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/subscriptions/{platformType}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{host}/subscriptions/{platformType}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/subscriptions/{platformType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

[
  {
    "subscriptionRef": "<string>",
    "subscriptionName": "<string>",
    "description": "<string>",
    "owner": "<string>",
    "outputType": "<string>",
    "webhook": {
      "uri": "<string>",
      "authType": "<string>",
      "authValue": "<string>"
    },
    "propertyReferences": [
      {
        "propertyID": "<string>",
        "operator": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "tagReferences": [
      {
        "tagID": "<string>",
        "operator": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "suppressionReferences": [
      {
        "suppressionID": "<string>",
        "operator": "<string>",
        "values": [
          "<string>"
        ],
        "revokeBy": "<string>"
      }
    ],
    "returnStructure": {
      "showAliases": false,
      "fields": [
        "<string>"
      ]
    },
    "schedule": {
      "frequency": "<string>",
      "at": "<string>"
    },
    "webhookStatus": "<string>",
    "lastTriggered": "<string>",
    "message": "<string>",
    "status": 123
  }
]

Path Parameters

platformType · enum<string> · required

Technology platform (cloud or containers).

Available options: cloud, containers

Query Parameters

type · enum<string>

Which subscriptions to list:

• all (default): global + your private (admins see all)
• global: all global
• owner: user-specific; combine with owner= (admin can query any user)

Available options: all, global, owner

owner · string

Kubex username to scope type=owner queries (admins only for others).

subscriptionRef · string

Return details for a single subscription by ID.

Response

200

application/json

Array of subscriptions

subscriptionRef · string · required

Unique ID assigned to the subscription.

subscriptionName · string · required

description · string

owner · string

Empty for global; username for private.

outputType · string

active · enum<string>

Available options: true, false

webhook · object

Webhook destination for delivering subscription notifications.

Show child attributes

propertyReferences · object[]

Show child attributes

tagReferences · object[]

Show child attributes

suppressionReferences · object[]

Show child attributes

returnStructure · object

Show child attributes

schedule · object

If omitted, notifications typically trigger nightly after analysis/reporting.

Show child attributes

webhookStatus · string

Success | Failure of last push to webhook (with timestamp).

lastTriggered · string

On-Demand Success/Failure or Scheduled Success/Failure with timestamp.

message · string

Error/status message (on error).

status · integer

HTTP-like status code (200, 204, 400, 401, 404, 415, 500).