OSDB REST API v1 API

by openlinksw.com

Overview

An OpenAPI description of the OpenLink Smart Data Bot REST API v1

OSDB REST API v1 is a development API from openlinksw.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 10 endpoints.

At a glance

Authentication: No auth
HTTPS: Yes
CORS: Unknown
Category: Development
Base URL: https://osdb.openlinksw.com/osdb
Version: 1.0.0
Endpoints: 10
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://osdb.openlinksw.com/osdb/api/v1/login" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("https://osdb.openlinksw.com/osdb/api/v1/login", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://osdb.openlinksw.com/osdb/api/v1/login",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/api/v1/actions/{serviceId}`	List actions
GET	`/api/v1/actions/{serviceId}/{actionId}`	Describe action
POST	`/api/v1/actions/{serviceId}/{actionId}/exec`	Execute action
GET	`/api/v1/actions/{serviceId}/{actionId}/help`	Action help
GET	`/api/v1/login`	Login
GET	`/api/v1/logout`	Logout
GET	`/api/v1/services`	List services
POST	`/api/v1/services`	Load service
GET	`/api/v1/services/{serviceId}`	Describe service
DELETE	`/api/v1/services/{serviceId}`	Unload service