Create plugin
curl --request POST \
--url https://api.example.com/v1/plugins \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"components": [
{
"input": {
"rawSourceText": "<string>",
"normalizedPayloadJson": {},
"parserMode": "<string>",
"schemaVersion": "<string>",
"metadata": {}
}
}
],
"orgWide": true,
"marketplaceId": "<string>"
}
'import requests
url = "https://api.example.com/v1/plugins"
payload = {
"name": "<string>",
"description": "<string>",
"components": [{ "input": {
"rawSourceText": "<string>",
"normalizedPayloadJson": {},
"parserMode": "<string>",
"schemaVersion": "<string>",
"metadata": {}
} }],
"orgWide": True,
"marketplaceId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
components: [
{
input: {
rawSourceText: '<string>',
normalizedPayloadJson: {},
parserMode: '<string>',
schemaVersion: '<string>',
metadata: {}
}
}
],
orgWide: true,
marketplaceId: '<string>'
})
};
fetch('https://api.example.com/v1/plugins', 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.example.com/v1/plugins",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'components' => [
[
'input' => [
'rawSourceText' => '<string>',
'normalizedPayloadJson' => [
],
'parserMode' => '<string>',
'schemaVersion' => '<string>',
'metadata' => [
]
]
]
],
'orgWide' => true,
'marketplaceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/plugins"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"components\": [\n {\n \"input\": {\n \"rawSourceText\": \"<string>\",\n \"normalizedPayloadJson\": {},\n \"parserMode\": \"<string>\",\n \"schemaVersion\": \"<string>\",\n \"metadata\": {}\n }\n }\n ],\n \"orgWide\": true,\n \"marketplaceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/plugins")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"components\": [\n {\n \"input\": {\n \"rawSourceText\": \"<string>\",\n \"normalizedPayloadJson\": {},\n \"parserMode\": \"<string>\",\n \"schemaVersion\": \"<string>\",\n \"metadata\": {}\n }\n }\n ],\n \"orgWide\": true,\n \"marketplaceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/plugins")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"components\": [\n {\n \"input\": {\n \"rawSourceText\": \"<string>\",\n \"normalizedPayloadJson\": {},\n \"parserMode\": \"<string>\",\n \"schemaVersion\": \"<string>\",\n \"metadata\": {}\n }\n }\n ],\n \"orgWide\": true,\n \"marketplaceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"item": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"createdByOrgMembershipId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"memberCount": 4503599627370495,
"marketplaces": [
{
"id": "<string>",
"name": "<string>"
}
],
"extension": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"manifest": {
"schemaVersion": 123,
"id": "<string>",
"name": "<string>",
"description": "<string>",
"source": {
"trusted": true,
"reference": "<string>"
},
"resources": [
{}
],
"contributions": [
{}
],
"setup": {},
"lifecycle": {}
}
}
}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Plugins
Create plugin
Creates a plugin and can also create components, share org-wide, and publish to a marketplace in one request.
POST
/
v1
/
plugins
Create plugin
curl --request POST \
--url https://api.example.com/v1/plugins \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"components": [
{
"input": {
"rawSourceText": "<string>",
"normalizedPayloadJson": {},
"parserMode": "<string>",
"schemaVersion": "<string>",
"metadata": {}
}
}
],
"orgWide": true,
"marketplaceId": "<string>"
}
'import requests
url = "https://api.example.com/v1/plugins"
payload = {
"name": "<string>",
"description": "<string>",
"components": [{ "input": {
"rawSourceText": "<string>",
"normalizedPayloadJson": {},
"parserMode": "<string>",
"schemaVersion": "<string>",
"metadata": {}
} }],
"orgWide": True,
"marketplaceId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
components: [
{
input: {
rawSourceText: '<string>',
normalizedPayloadJson: {},
parserMode: '<string>',
schemaVersion: '<string>',
metadata: {}
}
}
],
orgWide: true,
marketplaceId: '<string>'
})
};
fetch('https://api.example.com/v1/plugins', 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.example.com/v1/plugins",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'components' => [
[
'input' => [
'rawSourceText' => '<string>',
'normalizedPayloadJson' => [
],
'parserMode' => '<string>',
'schemaVersion' => '<string>',
'metadata' => [
]
]
]
],
'orgWide' => true,
'marketplaceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/plugins"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"components\": [\n {\n \"input\": {\n \"rawSourceText\": \"<string>\",\n \"normalizedPayloadJson\": {},\n \"parserMode\": \"<string>\",\n \"schemaVersion\": \"<string>\",\n \"metadata\": {}\n }\n }\n ],\n \"orgWide\": true,\n \"marketplaceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/plugins")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"components\": [\n {\n \"input\": {\n \"rawSourceText\": \"<string>\",\n \"normalizedPayloadJson\": {},\n \"parserMode\": \"<string>\",\n \"schemaVersion\": \"<string>\",\n \"metadata\": {}\n }\n }\n ],\n \"orgWide\": true,\n \"marketplaceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/plugins")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"components\": [\n {\n \"input\": {\n \"rawSourceText\": \"<string>\",\n \"normalizedPayloadJson\": {},\n \"parserMode\": \"<string>\",\n \"schemaVersion\": \"<string>\",\n \"metadata\": {}\n }\n }\n ],\n \"orgWide\": true,\n \"marketplaceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"item": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"createdByOrgMembershipId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"memberCount": 4503599627370495,
"marketplaces": [
{
"id": "<string>",
"name": "<string>"
}
],
"extension": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"manifest": {
"schemaVersion": 123,
"id": "<string>",
"name": "<string>",
"description": "<string>",
"source": {
"trusted": true,
"reference": "<string>"
},
"resources": [
{}
],
"contributions": [
{}
],
"setup": {},
"lifecycle": {}
}
}
}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Body
application/json
Required string length:
1 - 255Minimum string length:
1Maximum array length:
100Show child attributes
Show child attributes
Den TypeID with 'mkt_' prefix and a 26-character base32 suffix.
Required string length:
30Pattern:
^mkt_.*Was this page helpful?
⌘I