SMsmokeball
Plugins

Get a plugin

Returns the plugin.

get/plugins/{pluginId}

Request

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

Path parameters

pluginIdstring uuid required

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
externalIdstring nullable

Optional id provided by the external system that owns this plugin.

application'Native' | 'Web' | 'Archie'

The application that the plugin should be rendered in.

type'Button' | 'Tab'

The type of component the plugin should represent.

lastUpdatedinteger

Last updated timestamp.

createdDatestring date-time

Plugin created date in UTC.

lastUpdatedDatestring date-time

Plugin last updated date in UTC.

keystring nullable

Signing key of the plugin to verify integrity of requesting secure URLs.

additionalDataobject nullable

Collection of plugin meta data as KeyValuePair(string, object).

Example response

{
  "version": {
    "createdDate": "2020-02-15T00:00:00Z",
    "lastUpdatedDate": "2020-02-15T00:00:00Z"
  },
  "lastUpdated": 637847425252027400,
  "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.