Get a plugin

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

import requests

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

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}', 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}",
  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}"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "externalId": "<string>",
  "application": "Native",
  "type": "Button",
  "version": {
    "id": "<string>",
    "pluginId": "<string>",
    "versionNumber": 123,
    "name": "<string>",
    "description": "<string>",
    "placement": "<string>",
    "requestEndpointUrl": "<string>",
    "attributes": {
      "text": "<string>",
      "icon": "<string>",
      "color": "<string>",
      "tooltip": "<string>",
      "page": {
        "title": "<string>",
        "width": 123,
        "height": 123,
        "useDefaultBrowser": true
      }
    },
    "availability": {
      "matterTypeIds": [
        "<string>"
      ]
    },
    "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",
  "key": "<string>",
  "additionalData": {}
}

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

GET

plugins

{pluginId}

Get a plugin

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

import requests

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

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}', 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}",
  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}"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "externalId": "<string>",
  "application": "Native",
  "type": "Button",
  "version": {
    "id": "<string>",
    "pluginId": "<string>",
    "versionNumber": 123,
    "name": "<string>",
    "description": "<string>",
    "placement": "<string>",
    "requestEndpointUrl": "<string>",
    "attributes": {
      "text": "<string>",
      "icon": "<string>",
      "color": "<string>",
      "tooltip": "<string>",
      "page": {
        "title": "<string>",
        "width": 123,
        "height": 123,
        "useDefaultBrowser": true
      }
    },
    "availability": {
      "matterTypeIds": [
        "<string>"
      ]
    },
    "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",
  "key": "<string>",
  "additionalData": {}
}

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

Response

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

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object | null

Show child attributes

externalId

string | null

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

application

enum<string>

The application that the plugin should be rendered in.

Available options:

Native,

Web,

Archie

type

enum<string>

The type of component the plugin should represent.

Available options:

Button,

Tab

version

object | null

Current version of the plugin.

Show child attributes

lastUpdated

integer<int64>

Last updated timestamp.

Example:

637847425252027400

createdDate

string<date-time>

Plugin created date in UTC.

Example:

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

lastUpdatedDate

string<date-time>

Plugin last updated date in UTC.

Example:

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

key

string | null

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

additionalData

object | null

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

Show child attributes

Documentation

Tutorials

APIs

Get a plugin

Authorizations

Path Parameters

Response