Create Integrations

curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "externalId": "my.integrations.id",
      "extractor": {
        "externalId": "cognite-opcua",
        "version": "1.2.3"
      },
      "name": "<string>",
      "description": "<string>",
      "documentation": "<string>",
      "metadata": {},
      "allowedNotSeenMinutes": 1440
    }
  ]
}
'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations"

payload = { "items": [
        {
            "externalId": "my.integrations.id",
            "extractor": {
                "externalId": "cognite-opcua",
                "version": "1.2.3"
            },
            "name": "<string>",
            "description": "<string>",
            "documentation": "<string>",
            "metadata": {},
            "allowedNotSeenMinutes": 1440
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        externalId: 'my.integrations.id',
        extractor: {externalId: 'cognite-opcua', version: '1.2.3'},
        name: '<string>',
        description: '<string>',
        documentation: '<string>',
        metadata: {},
        allowedNotSeenMinutes: 1440
      }
    ]
  })
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations', 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://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations",
  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([
    'items' => [
        [
                'externalId' => 'my.integrations.id',
                'extractor' => [
                                'externalId' => 'cognite-opcua',
                                'version' => '1.2.3'
                ],
                'name' => '<string>',
                'description' => '<string>',
                'documentation' => '<string>',
                'metadata' => [
                                
                ],
                'allowedNotSeenMinutes' => 1440
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"externalId\": \"my.integrations.id\",\n      \"extractor\": {\n        \"externalId\": \"cognite-opcua\",\n        \"version\": \"1.2.3\"\n      },\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"documentation\": \"<string>\",\n      \"metadata\": {},\n      \"allowedNotSeenMinutes\": 1440\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"externalId\": \"my.integrations.id\",\n      \"extractor\": {\n        \"externalId\": \"cognite-opcua\",\n        \"version\": \"1.2.3\"\n      },\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"documentation\": \"<string>\",\n      \"metadata\": {},\n      \"allowedNotSeenMinutes\": 1440\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"externalId\": \"my.integrations.id\",\n      \"extractor\": {\n        \"externalId\": \"cognite-opcua\",\n        \"version\": \"1.2.3\"\n      },\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"documentation\": \"<string>\",\n      \"metadata\": {},\n      \"allowedNotSeenMinutes\": 1440\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "externalId": "my.integrations.id",
      "extractor": {
        "externalId": "cognite-opcua",
        "version": "1.2.3"
      },
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "name": "<string>",
      "description": "<string>",
      "documentation": "<string>",
      "metadata": {},
      "allowedNotSeenMinutes": 1440,
      "lastSeen": 1730204346000,
      "lastConfigRevision": 123,
      "activeConfigRevision": 123,
      "tasks": [
        {
          "type": "continuous",
          "name": "<string>",
          "action": false,
          "description": "<string>",
          "sources": [
            "<string>"
          ],
          "targets": [
            "<string>"
          ]
        }
      ]
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": "`null` values aren't allowed."
  }
}

{
  "error": {
    "code": 422,
    "message": "Extra inputs are not permitted: type"
  }
}