Get a plugin subscription

Returns the plugin subscription.

GET /plugins/{pluginId}/subscriptions/{id}

Get a plugin subscription

cURL

curl --request GET \
  --url https://api.smokeball.com/plugins/{pluginId}/subscriptions/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/plugins/{pluginId}/subscriptions/{id}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/plugins/{pluginId}/subscriptions/{id}', 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://api.smokeball.com/plugins/{pluginId}/subscriptions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$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://api.smokeball.com/plugins/{pluginId}/subscriptions/{id}"

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/plugins/{pluginId}/subscriptions/{id}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/plugins/{pluginId}/subscriptions/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

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

200

{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "pluginId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "pluginVersionId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "createdDate": "2020-02-15T00:00:00Z",
  "lastUpdatedDate": "2020-02-15T00:00:00Z",
  "isDisabled": true
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

pluginId · string<uuid> · required

id · string<uuid> · required

Response

200

application/json

When request is successful. Returns a 'PluginSubscription' object.

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

id · string | null

Unique identifier of the subscription.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

pluginId · string | null

Unique identifier of the plugin.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

pluginVersionId · string | null

Unique identifier of the plugin version. Can be null.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

createdDate · string<date-time>

Plugin subscription created date in UTC.

Example:

"2020-02-15T00:00:00Z"

lastUpdatedDate · string<date-time>

Plugin subscription last updated date in UTC.

Example:

"2020-02-15T00:00:00Z"

isDisabled · boolean

True when the subscription is disabled (the plugin will not function for the user).