SMsmokeball
Plugins

Get a plugin subscription

Returns the plugin subscription.

get/plugins/{pluginId}/subscriptions/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/plugins/{pluginId}/subscriptions/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

pluginIdstring uuid required
idstring uuid required

Response

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

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the subscription.

pluginIdstring nullable

Unique identifier of the plugin.

pluginVersionIdstring nullable

Unique identifier of the plugin version. Can be null.

createdDatestring date-time

Plugin subscription created date in UTC.

lastUpdatedDatestring date-time

Plugin subscription last updated date in UTC.

isDisabledboolean

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

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 15 revisions of this API.