API Docs

Install Plug-in

Imports a plug-in into Kintone.

MethodPOST
URLhttps://{subdomain}.kintone.com/k/v1/plugin.json
Authentication Password Authentication , Session Authentication
Content-Typeapplication/json

Contents

Permissions

  • Only Kintone Administrators can use this API.

Request Parameters

Parameter Type Required Description
fileKey String Yes The fileKey representing an uploaded file. Use the following API to upload the file and retrieve the fileKey:
Upload File

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'fileKey': 'c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6'
};

kintone.api(kintone.api.url('/k/v1/plugin.json', true), 'POST', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

curl Sample

1
2
3
4
5
6

curl -X POST 'https://{subdomain}.kintone.com/k/v1/plugin.json' \
  -H 'X-Cybozu-Authorization:{AuthorizationCode}' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
  }'

Response Parameters

Parameter Type Description
id String The installed plug-in ID.
version String The version number of the plug-in.

Sample Response

1
2
3
4

{
  "id": "djmhffjhfgmebgnmcggopedaofckljlj",
  "version": "1.0.0"
}