IBM Db2 on Cloud REST API | IBM Cloud API Docs

Introduction

Last updated: 2020-05-12

Use the Db2 on Cloud API to access data, view and create database objects, administer, and monitor your Db2 on Cloud service.

Java developers can use this SDK to interact with Db2 on Cloud.

Node (Javascript) developers can use this SDK to interact with Db2 on Cloud.

Python developers can use this SDK to interact with Db2 on Cloud.

Go developers can use this SDK to interact with Db2 on Cloud.

Github

https://github.com/ibmdb/java-db2

Github

https://github.com/ibmdb/node-ibm_db

Github

https://github.com/ibmdb/python-ibmdb

Github

https://github.com/ibmdb/go_ibm_db

Root URL

The context root for the Db2 on Cloud API is /dbapi/v4/.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response is some sort of failure.

Security

Every request must include the Authorization HTTP header with the value Bearer [access_token]. An access token can be obtained in one of three ways:

Using the /auth/tokens endpoint
Creating an IAM access token
Generating an IBM Cloud IAM oauth-token

The token is used by Db2 on Cloud to identify who you are.

Every request must include the X-Deployment-Id HTTP header with the value of your Db2 on Cloud tenant deployment ID (The id starts with crn).

Some API methods (for example: /schemas and /sql_jobs) also support direct access to the database using HTTP headers.

For example:

X-DB-Userid:[database_user],
X-DB-Password:[database_password],
X-DB-URL:jdbc:db2://[host]:[port]/[database]:[property] for Db2 data sources
add dataservertype (DB2LUW, DB2Z) in property, if dataservertype key
for Db2 data source is not specified, the default is DB2LUW.

Db2 on Cloud negotiates SSL connections using the TLS v1.2 protocol.

If you are using the latest version of cURL, protocol negotiation will happen automatically using TLS v1.2. If you are using an older version of cURL, you will need to specify the --tlsv1.2 option in your cURL commands.

Security scheme

Authentication to this API's methods uses one of the following security schemes.

authToken

Authorize using Bearer [access_token]. The access token can be obtained by authenticating with the /auth/tokens endpoint or use the API key to generate an IAM Bearer Token.

Attribute

Value

Type
API Key
In
Header
Name
Authorization

deploymentId

The deployment id of the service, which can be obtained after provision. When providing the deployment id in the header, use URL encoding. For example, ":" should be escaped as "%3A", and "/" should be escaped as "%2F".

Attribute

Value

Type
API Key
In
Header
Name
X-Deployment-Id

Third-party libraries

You can optionally use the okhttp jquery httpclientthird-party library to make requests to the console API.

Authenticates the user credentials and returns an access token that can be used when invoking the operations.

POST /auth/tokens

Request

Request Body

Required*

UserCredentials

User credentials

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/auth/tokens"

	payload := strings.NewReader("{\"userid\":\"<ADD STRING VALUE>\",\"password\":\"<ADD STRING VALUE>\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"userid\":\"<ADD STRING VALUE>\",\"password\":\"<ADD STRING VALUE>\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/auth/tokens")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/auth/tokens",
  "headers": {
    "content-type": "application/json",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ userid: '<ADD STRING VALUE>', password: '<ADD STRING VALUE>' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"userid\":\"<ADD STRING VALUE>\",\"password\":\"<ADD STRING VALUE>\"}"

headers = {
    'content-type': "application/json",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/auth/tokens", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/auth/tokens   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"userid":"<ADD STRING VALUE>","password":"<ADD STRING VALUE>"}'

Response

Response Body

AuthenticationToken

Token generated after successful authentication.

Status Code

200
Authentication token
401
Invalid credentials
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns public key of Json Web Token.

GET /auth/token/publickey

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/auth/token/publickey"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/auth/token/publickey")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/auth/token/publickey",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/auth/token/publickey", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/auth/token/publickey   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AuthenticationTokenPublicKey

Public key of token.

Status Code

200
Token public key and key id.

No Sample Response

This method does not specify any sample responses.

Sets a new password using the dswebToken obtained from /auth/reset.

PUT /auth/password

Request

Request Body

Required*

UserPasswordReset

New password and dswebToken

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/auth/password"

	payload := strings.NewReader("{\"password\":\"<ADD STRING VALUE>\",\"dswebToken\":\"<ADD STRING VALUE>\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"password\":\"<ADD STRING VALUE>\",\"dswebToken\":\"<ADD STRING VALUE>\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/auth/password")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/auth/password",
  "headers": {
    "content-type": "application/json",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ password: '<ADD STRING VALUE>', dswebToken: '<ADD STRING VALUE>' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"password\":\"<ADD STRING VALUE>\",\"dswebToken\":\"<ADD STRING VALUE>\"}"

headers = {
    'content-type': "application/json",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/auth/password", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/auth/password   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"password":"<ADD STRING VALUE>","dswebToken":"<ADD STRING VALUE>"}'

Response

Response Body

UserPasswordResetResponse

Status Code

200
Password changed
400
Invalid or missing new password
403
If dswebToken is missing or invalid
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get details of all currently available backups

GET /backups

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/backups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/backups")
  .get()
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/backups",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/backups", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/backups   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessBackupsListResponse

Status Code

200
The list of backups
400
Bad request
401
Unauthorized
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Restore to a particular backup or perform a point-in-time restore.

POST /backups/restore

Request

Request Body

Required*

object

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/backups/restore"

	payload := strings.NewReader("{\"ts\":\"<ADD STRING VALUE>\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\"}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ts\":\"<ADD STRING VALUE>\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/backups/restore")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/backups/restore",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  ts: '<ADD STRING VALUE>',
  backup_id: 'crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712'
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"ts\":\"<ADD STRING VALUE>\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\"}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/backups/restore", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/backups/restore   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"ts":"<ADD STRING VALUE>","backup_id":"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712"}'

Response

Response Body

SuccessBackupRestoreResponse

Status Code

200
Task detail of the restore job
400
Bad request
401
Unauthorized
500
Unauthorized

No Sample Response

This method does not specify any sample responses.

Create a backup

POST /backups/backup

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/backups/backup"

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/backups/backup")
  .post(null)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/backups/backup",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/backups/backup", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/backups/backup   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessBackupResponse

Status Code

200
OK
400
Bad request
401
Unauthorized
500
Unexpected error

No Sample Response

This method does not specify any sample responses.

Get backup setting for scheduled time and retention policy

GET /backups/setting

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/backups/setting"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/backups/setting")
  .get()
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/backups/setting",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/backups/setting", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/backups/setting   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessBackupSettingResponse

Status Code

200
OK
500
Unexpected error

No Sample Response

This method does not specify any sample responses.

update backup setting for scheduled backup time

POST /backups/setting

Request

Request Body

object

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/backups/setting"

	payload := strings.NewReader("{\"backup_time\":\"08:05\"}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"backup_time\":\"08:05\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/backups/setting")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/backups/setting",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ backup_time: '08:05' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"backup_time\":\"08:05\"}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/backups/setting", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/backups/setting   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"backup_time":"08:05"}'

Response

Response Body

SuccessBackupSettingResponse

Status Code

200
OK
400
Bad request
401
Unauthorized
500
Unexpected error

No Sample Response

This method does not specify any sample responses.

Provision new database by copy from current database

POST /manage/copy_db

Request

Request Body

CopyDatabaseRequest

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/manage/copy_db"

	payload := strings.NewReader("{\"name\":\"clone-instance-namw\",\"target\":\"us-south\",\"resource_plan_id\":\"DashStandard\",\"high_availability\":true,\"resource_group\":\"ea345q3-ddfe34q-sdfdaasd\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\",\"key_protect_key\":\"default\",\"members_disk_allocation_mb\":\"20480\",\"tags\":[\"<ADD STRING VALUE>\"]}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"clone-instance-namw\",\"target\":\"us-south\",\"resource_plan_id\":\"DashStandard\",\"high_availability\":true,\"resource_group\":\"ea345q3-ddfe34q-sdfdaasd\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\",\"key_protect_key\":\"default\",\"members_disk_allocation_mb\":\"20480\",\"tags\":[\"<ADD STRING VALUE>\"]}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/manage/copy_db")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/manage/copy_db",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  name: 'clone-instance-namw',
  target: 'us-south',
  resource_plan_id: 'DashStandard',
  high_availability: true,
  resource_group: 'ea345q3-ddfe34q-sdfdaasd',
  backup_id: 'crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712',
  key_protect_key: 'default',
  members_disk_allocation_mb: '20480',
  tags: [ '<ADD STRING VALUE>' ]
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"name\":\"clone-instance-namw\",\"target\":\"us-south\",\"resource_plan_id\":\"DashStandard\",\"high_availability\":true,\"resource_group\":\"ea345q3-ddfe34q-sdfdaasd\",\"backup_id\":\"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712\",\"key_protect_key\":\"default\",\"members_disk_allocation_mb\":\"20480\",\"tags\":[\"<ADD STRING VALUE>\"]}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/manage/copy_db", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/manage/copy_db   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"name":"clone-instance-namw","target":"us-south","resource_plan_id":"DashStandard","high_availability":true,"resource_group":"ea345q3-ddfe34q-sdfdaasd","backup_id":"crn:v1:ibm:local:database:us-south:a/c5555555580015ebfde430a819fa4bb3:console-dev01:backup:ac9555b1-df50-4ecb-88ef-34b650eff712","key_protect_key":"default","members_disk_allocation_mb":"20480","tags":["<ADD STRING VALUE>"]}'

Response

Response Body

SuccessCopyDBResponse

Status Code

201
Copy db successfully
400
Bad request
500
Error

No Sample Response

This method does not specify any sample responses.

GET /connectioninfo/{DEPLOYMENT_ID}

Request

Path Parameters

DEPLOYMENT_ID
Required*
string
Encoded deployment id

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/connectioninfo/{DEPLOYMENT_ID}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessConnectionInfo

Status Code

200
Get connection info
default
Error payload

No Sample Response

This method does not specify any sample responses.

Lists all data load jobs for the user.

GET /load_jobs

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/load_jobs",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/load_jobs", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DataLoadJobInfo[]

Information about a data load job

Status Code

200
Data load jobs
default
Error payload

No Sample Response

This method does not specify any sample responses.

Creates a data load job.

POST /load_jobs

Request

Request Body

Required*

DataLoadJobRequest

Data load job details

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs"

	payload := strings.NewReader("{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"cloud_source\":{\"endpoint\":\"<ADD STRING VALUE>\",\"path\":\"<ADD STRING VALUE>\",\"auth_id\":\"<ADD STRING VALUE>\",\"auth_secret\":\"<ADD STRING VALUE>\"},\"server_source\":{\"file_path\":\"<ADD STRING VALUE>\"},\"file_options\":{\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"date_format\":\"YYYY-MM-DD\",\"time_format\":\"HH:MM:SS\",\"timestamp_format\":\"YYYY-MM-DD HH:MM:SS\"}}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"cloud_source\":{\"endpoint\":\"<ADD STRING VALUE>\",\"path\":\"<ADD STRING VALUE>\",\"auth_id\":\"<ADD STRING VALUE>\",\"auth_secret\":\"<ADD STRING VALUE>\"},\"server_source\":{\"file_path\":\"<ADD STRING VALUE>\"},\"file_options\":{\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"date_format\":\"YYYY-MM-DD\",\"time_format\":\"HH:MM:SS\",\"timestamp_format\":\"YYYY-MM-DD HH:MM:SS\"}}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/load_jobs",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  load_source: 'SERVER',
  load_action: 'INSERT',
  schema: '<ADD STRING VALUE>',
  table: '<ADD STRING VALUE>',
  max_row_count: 0,
  max_warning_count: 1000,
  cloud_source: {
    endpoint: '<ADD STRING VALUE>',
    path: '<ADD STRING VALUE>',
    auth_id: '<ADD STRING VALUE>',
    auth_secret: '<ADD STRING VALUE>'
  },
  server_source: { file_path: '<ADD STRING VALUE>' },
  file_options: {
    code_page: '<ADD STRING VALUE>',
    has_header_row: 'no',
    column_delimiter: ',',
    date_format: 'YYYY-MM-DD',
    time_format: 'HH:MM:SS',
    timestamp_format: 'YYYY-MM-DD HH:MM:SS'
  }
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"cloud_source\":{\"endpoint\":\"<ADD STRING VALUE>\",\"path\":\"<ADD STRING VALUE>\",\"auth_id\":\"<ADD STRING VALUE>\",\"auth_secret\":\"<ADD STRING VALUE>\"},\"server_source\":{\"file_path\":\"<ADD STRING VALUE>\"},\"file_options\":{\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"date_format\":\"YYYY-MM-DD\",\"time_format\":\"HH:MM:SS\",\"timestamp_format\":\"YYYY-MM-DD HH:MM:SS\"}}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/load_jobs", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"load_source":"SERVER","load_action":"INSERT","schema":"<ADD STRING VALUE>","table":"<ADD STRING VALUE>","max_row_count":0,"max_warning_count":1000,"cloud_source":{"endpoint":"<ADD STRING VALUE>","path":"<ADD STRING VALUE>","auth_id":"<ADD STRING VALUE>","auth_secret":"<ADD STRING VALUE>"},"server_source":{"file_path":"<ADD STRING VALUE>"},"file_options":{"code_page":"<ADD STRING VALUE>","has_header_row":"no","column_delimiter":",","date_format":"YYYY-MM-DD","time_format":"HH:MM:SS","timestamp_format":"YYYY-MM-DD HH:MM:SS"}}'

Response

Response Body

DataLoadJobCreated[]

Confirmation of load job created

Status Code

201
load jobs.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns details about a load job including its progress.

GET /load_jobs/{id}

Request

Path Parameters

id
Required*
string
Load job ID

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{id}")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/load_jobs/{id}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/load_jobs/{id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DataLoadJobInfo

Information about a data load job

Status Code

200
Data load job
403
Not authorized to access load job
404
Job not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Removes a data load job from history. This operation has no effect on the data already loaded. In-progress jobs cannot be deleted.

DELETE /load_jobs/{id}

Request

Path Parameters

id
Required*
string
Load job ID

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{id}")
  .delete(null)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/load_jobs/{id}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/load_jobs/{id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

object

Status Code

200
Load job deleted
403
Not authorized to delete load job
404
Job not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Downloads log file for a data load job

GET /load_jobs/{log_path}/log

Request

Path Parameters

log_path
Required*
string
Base64 encode and URL encode with ([deployment id]/[log file name]) the log file name we can get from /load_jobs/{id}

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{log_path}/log"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "file")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{log_path}/log")
  .get()
  .addHeader("content-type", "file")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/load_jobs/{log_path}/log",
  "headers": {
    "content-type": "file",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "file",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/load_jobs/{log_path}/log", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/load_jobs/{log_path}/log   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: file'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

file

Status Code

200
Log file
403
Not authorized to access load log
404
Log not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

GET /db_update

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/db_update"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/db_update")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/db_update",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/db_update", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/db_update   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessCheckUpdateResponse

Status Code

200
Returns the available Db2 database update.
400
Bad request
500
Error

No Sample Response

This method does not specify any sample responses.

POST /db_update

Request

Request Body

object

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/db_update"

	payload := strings.NewReader("{\"scheduled_timestamp\":\"<ADD STRING VALUE>\",\"target_version\":\"1.9.1\"}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"scheduled_timestamp\":\"<ADD STRING VALUE>\",\"target_version\":\"1.9.1\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/db_update")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/db_update",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ scheduled_timestamp: '<ADD STRING VALUE>', target_version: '1.9.1' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"scheduled_timestamp\":\"<ADD STRING VALUE>\",\"target_version\":\"1.9.1\"}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/db_update", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/db_update   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"scheduled_timestamp":"<ADD STRING VALUE>","target_version":"1.9.1"}'

Response

Response Body

SuccessTriggerUpdateResponse

Status Code

200
Db2 database update was triggered successfully.
400
Bad request
500
Error

No Sample Response

This method does not specify any sample responses.

List available regions that can be used for disaster recovery.

GET /manage/dr

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/manage/dr",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/manage/dr", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessDREnablementDetailsResponse

Status Code

200
List disaster recovery enablement information successfully.
400
Bad request
401
Unauthorized
500
Error

No Sample Response

This method does not specify any sample responses.

Enable disaster recovery.

POST /manage/dr

Request

Request Body

EnableDRRequest

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr"

	payload := strings.NewReader("{\"name\":\"<ADD STRING VALUE>\",\"region\":\"<ADD STRING VALUE>\"}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"<ADD STRING VALUE>\",\"region\":\"<ADD STRING VALUE>\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/manage/dr",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ name: '<ADD STRING VALUE>', region: '<ADD STRING VALUE>' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"name\":\"<ADD STRING VALUE>\",\"region\":\"<ADD STRING VALUE>\"}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/manage/dr", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"name":"<ADD STRING VALUE>","region":"<ADD STRING VALUE>"}'

Response

Response Body

SuccessEnableDRResponse

Status Code

200
Disaster recovery enabled successfully.
400
Bad request
401
Unauthorized
500
Error

No Sample Response

This method does not specify any sample responses.

List disaster recovery remotes pair information

GET /manage/dr/remotes/status

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/remotes/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/remotes/status")
  .get()
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/manage/dr/remotes/status",
  "headers": {
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/manage/dr/remotes/status", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/remotes/status   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessDRRemotesDetailResponse

Status Code

200
Disaster recovery remotes status was returned successfully.
400
Bad request
401
Unauthorized
500
Error

No Sample Response

This method does not specify any sample responses.

Perform take over on current instance to switch from standby node to primary node. This API requires current instance is standby.

POST /manage/dr/takeover

Request

Request Body

TakeOverDRRequest

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/takeover"

	payload := strings.NewReader("{\"force\":false}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"force\":false}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/takeover")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/manage/dr/takeover",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ force: false }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"force\":false}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/manage/dr/takeover", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/takeover   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"force":false}'

Response

Response Body

SuccessTakeoverDRResponse

Status Code

200
Takeover has ran successfully on current instance.
400
Bad request
401
Unauthorized
500
Error

No Sample Response

This method does not specify any sample responses.

Reconnect a broken or disconnected standby node

POST /manage/dr/resync

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/resync"

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/resync")
  .post(null)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/manage/dr/resync",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/manage/dr/resync", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/resync   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessResyncDRResponse

Status Code

200
Disaster recovery resync request completed successfully.
400
Bad request
401
Unauthorized
500
Error

No Sample Response

This method does not specify any sample responses.

Check if there is an ongoing resync request

GET /manage/dr/resync/status

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/resync/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/resync/status")
  .get()
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/manage/dr/resync/status",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/manage/dr/resync/status", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/manage/dr/resync/status   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessResyncDRStatusResponse

Status Code

200
Check disaster recovery resync status successfully.
400
Bad request
401
Unauthorized
500
Error

No Sample Response

This method does not specify any sample responses.

Deletes a file in the Db2 temporary cloud object storage.

DELETE /home/{path}

Request

Path Parameters

path
Required*
string
File path

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/home/{path}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/home/{path}")
  .delete(null)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/home/{path}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/home/{path}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/home/{path}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

object

Status Code

200
File deleted
default
Error payload

No Sample Response

This method does not specify any sample responses.

Download file from Db2 temporary cloud object storage.

GET /home_content/{path}

Request

Custom Headers

Accept
string
Allowable values: [application/json,application/octet-stream]

Path Parameters

path
Required*
string
File path

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/home_content/{path}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/home_content/{path}")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/home_content/{path}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/home_content/{path}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/home_content/{path}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

FileFolderMetadata

Describes a file or folder.

Status Code

200
Metadata about a file or folder
404
File not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Uploads a file to Db2 temporary cloud object storage.

POST /home_content/{path}

Request

Path Parameters

path
Required*
string
Target folder

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/home_content/{path}"

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/home_content/{path}")
  .post(null)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/home_content/{path}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/home_content/{path}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/home_content/{path}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

FileFolderMetadata[]

Describes a file or folder.

Status Code

201
Files successfully uploaded
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns overall status of system components.

GET /monitor

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/monitor"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/monitor")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/monitor",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/monitor", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/monitor   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ServiceStatus[]

Services status

Status Code

200
System status
403
Operation is only available to administrators
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of active database connections.

GET /monitor/connections

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/monitor/connections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/monitor/connections")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/monitor/connections",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/monitor/connections", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/monitor/connections   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DatabaseConnections

Collection of active database connections

Status Code

200
Active connections
403
Operation is only available to administrators
default
Error payload

No Sample Response

This method does not specify any sample responses.

Terminates an active database connection.

DELETE /monitor/connections/{application_handle}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

application_handle
Required*
string
Application handle name

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/monitor/connections/{application_handle}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/monitor/connections/{application_handle}")
  .delete(null)
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/monitor/connections/{application_handle}",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/monitor/connections/{application_handle}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/monitor/connections/{application_handle}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

object

Status Code

200
Connection terminated
403
Operation is only available to administrators
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns current storage usage.

GET /monitor/storage

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/monitor/storage",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/monitor/storage", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SystemStorage

Status Code

200
Storage usage
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of storage usage daily stats. Currenlty the history of the last seven days is returned.

GET /monitor/storage/history

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/history"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/history")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/monitor/storage/history",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/monitor/storage/history", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/history   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SystemStorageList

Collection of system storage stats

Status Code

200
Storage usage history
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list where each element represents a schema and its corresponding logical and physical sizes. Physical size is the amount of storage in disk allocated to objects in the schema. Logical size is the actual object size, which might be less than the physical size (e.g. in the case of a logical table truncation).

GET /monitor/storage/by_schema

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/by_schema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/by_schema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/monitor/storage/by_schema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/monitor/storage/by_schema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/by_schema   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DatabaseStorageSchemas

Collection of schema's storage usage data

Status Code

200
Storage usage by schema
403
Operation is only available to administrators
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns logical and physical sizes for one schema. Physical size is the amount of storage in disk allocated to objects in the schema. Logical size is the actual object size, which might be less than the physical size (e.g. in the case of a logical table truncation).

GET /monitor/storage/by_schema/{schema_name}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

schema_name
Required*
string
Schema name

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/by_schema/{schema_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/by_schema/{schema_name}")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/monitor/storage/by_schema/{schema_name}",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/monitor/storage/by_schema/{schema_name}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/monitor/storage/by_schema/{schema_name}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DatabaseStorageSchema[]

Status Code

200
Storage usage for a schema
403
Operation is only available to administrators
404
Schema does not exist
default
Error payload

No Sample Response

This method does not specify any sample responses.

Return the number of statements for a specified time frame.

GET /metrics/statements_count

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements_count?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

HistogramsDataSummary

Number of statements.

Status Code

200
Return the number of statements for a specified time frame.
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the histogram of response time for a specified time frame.

GET /metrics/response_time_histograms

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/response_time_histograms?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/response_time_histograms?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/response_time_histograms?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/response_time_histograms?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/response_time_histograms?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

HistogramsDataList

A list of histogram data.

Status Code

200
Return the histogram of response time for a specified time frame
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the average response time for a specified time frame.

GET /metrics/average_response_time

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_response_time?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_response_time?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/average_response_time?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/average_response_time?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_response_time?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AverageResponseTime

Event monitor stats top.

Status Code

200
Return the average response time for a specified time frame.
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the list of average response time for a specified time frame.

GET /metrics/response_time

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/response_time?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/response_time?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/response_time?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/response_time?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/response_time?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AverageResponseTimeList

A list of AverageResponseTime.

Status Code

200
Return the list of average response time for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the average number of statements executed every minutes for a specified time frame.

GET /metrics/average_statements_rate

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_statements_rate?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AvgSQLRate

SQL rate(sql/min).

Status Code

200
Return the average number of statements executed every minutes for a specified time frame
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return numbers of statements executed every minutes for a specified time frame.

GET /metrics/statements_rate

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements_rate?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AvgSQLRateList

A list of SQL rate(sql/min).

Status Code

200
Return numbers of statements executed every minutes for a specified time frame
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the average number of rows read(rows/min) for a specified time frame.

GET /metrics/average_rows_read

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_rows_read?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_rows_read?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/average_rows_read?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/average_rows_read?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/average_rows_read?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AvgRowsRead

Rows read(rows/min).

Status Code

200
Return the average number of rows read(rows/min) for a specified time frame.
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the numbers of rows read(rows/min) for a specified time frame.

GET /metrics/rows_read

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/rows_read?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/rows_read?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/rows_read?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/rows_read?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/rows_read?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AvgRowsReadList

A list of rows read(rows/min).

Status Code

200
Return the numbers of rows read(rows/min) for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum number of concurrent connections for a specified time frame

GET /metrics/max_connections_count

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_connections_count?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_connections_count?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/max_connections_count?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/max_connections_count?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_connections_count?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MaxConnectionsCount

The maximum connections count.

Status Code

200
Return the maximum number of concurrent connections for a specified time frame end
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return maximum numbers of concurrent connections for a specified time frame.

GET /metrics/connections_count

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/connections_count?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/connections_count?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/connections_count?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/connections_count?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/connections_count?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ConnectionsCountList

A list of connection count.

Status Code

200
Return maximum numbers of concurrent connections for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum lockwaits per minute for a specified time frame.

GET /metrics/max_lockwaits_rate

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_lockwaits_rate?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_lockwaits_rate?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/max_lockwaits_rate?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/max_lockwaits_rate?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_lockwaits_rate?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MaxLockWaitsRate

The maximum lockwaits rate(lockwaits/min).

Status Code

200
Return the maximum lockwaits per minute for a specified time frame
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum lockwaits per minute for a specified time frame.

GET /metrics/lockwaits_rate

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/lockwaits_rate?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/lockwaits_rate?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/lockwaits_rate?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/lockwaits_rate?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/lockwaits_rate?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

LockWaitsRateList

A list of lockwaits rate(lockwaits/min).

Status Code

200
Return the maximum lockwaits per minute for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum usage percentage of logs for a specified time frame.

GET /metrics/max_log_space

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_log_space?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_log_space?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/max_log_space?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/max_log_space?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_log_space?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MaxLogSpace

The maximum log space.

Status Code

200
Return the maximum usage percentage of logs for a specified time frame.
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum usage percentages of logs for a specified time frame.

GET /metrics/log_space

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/log_space?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/log_space?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/log_space?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/log_space?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/log_space?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

LogSpaceList

A list of LogSpace.

Status Code

200
Return the maximum usage percentages of logs in for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum percent of node CPU usage for a specified time frame.

GET /metrics/max_cpu

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_cpu?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_cpu?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/max_cpu?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/max_cpu?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_cpu?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MaxCPU

A list of CPU.

Status Code

200
Return the maximum percent of node CPU usage for a specified time frame.
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the percent of node CPU usage for a specified time frame.

GET /metrics/cpu_summary

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/cpu_summary?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/cpu_summary?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/cpu_summary?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/cpu_summary?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/cpu_summary?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

CPUList

A list of CPU.

Status Code

200
Return the percent of node CPU usage for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum percent of node memory usage for a specified time frame.

GET /metrics/max_memory

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_memory?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_memory?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/max_memory?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/max_memory?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_memory?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MaxMemory

A list of Memory.

Status Code

200
Return the maximum percent of node memory usage for a specified time frame.
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the percent of node memory usage for a specified time frame.

GET /metrics/memory_summary

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/memory_summary?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/memory_summary?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/memory_summary?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/memory_summary?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/memory_summary?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MemoryList

A list of Memory.

Status Code

200
Return the percent of memory usage in each node for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum usage percent of storage for a specified time frame.

GET /metrics/max_storage

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/max_storage?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MaxStorage

A list of Storage.

Status Code

200
Return the maximum usage percent of storage for a specified time frame.
403
Operation is only available to administrators.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the usage percent of storage for a specified time frame.

GET /metrics/storage

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

StorageList

A list of Storage.

Status Code

200
Return the usage percent of storage for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return the time spent in each operation for a specified time frame.

GET /metrics/timespent

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/timespent?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/timespent?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/timespent?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/timespent?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/timespent?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

Timespent

Timespent.

Status Code

200
Return the time spent in each operation for a specified time frame.
404
Database profile not found.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Return a table storage usage in a time range.

GET /metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

tabname
Required*
string
Tabname
tabschema
Required*
string
Tabschema

Query Parameters

end
int64
end
start
int64
start

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json;charset=utf-8")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE")
  .get()
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE",
  "headers": {
    "content-type": "application/json;charset=utf-8",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json;charset=utf-8",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries?end=SOME_INTEGER_VALUE&start=SOME_INTEGER_VALUE'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json;charset=utf-8'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseTimeSeriesListTableStorageCombineForFrontV2

Status Code

200
OK
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list for tables storage. Only returns the last collected data between start and end.

GET /metrics/tables/storage

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if includes system tables in the return list

Default: false
limit
integer
The amount of return records. Limit and offset should be set together.

Default: 100
offset
integer
The starting position of return records. Limit and offset should be set together

Default: 0
tabschema
string
Used to filter by schema
tabname
string
Used to filter by tabname
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/storage?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&tabname=SOME_STRING_VALUE&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseRealTimeListTableStorageCombineForFrontTable

A list of table storage data.

Status Code

200
Returns a list for tables storage
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a table storage. Only returns the last collected data between start and end.

GET /metrics/schemas/{tabschema}/tables/{tabname}/storage

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

tabschema
Required*
string
Used to filter by schema
tabname
Required*
string
Used to filter by tabname

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{tabschema}/tables/{tabname}/storage?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseRealTimeListTableStorageCombineForFrontSchema

A list of schemas storage data.

Status Code

200
Returns the list for tables storage
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list for schemas storage. Only returns the last collected data between start and end.

GET /metrics/storage/schemas

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if includes system schemas in the return list

Default: false
limit
integer
The amount of return records. Limit and offset should be set together.

Default: 100
offset
integer
The starting position of return records. Limit and offset should be set together

Default: 0
tabschema
string
Used to filter by schema
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&tabschema=SOME_STRING_VALUE&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseRealTimeListTableStorageCombineForFrontSchema

A list of schemas storage data.

Status Code

200
Returns a list for schemas storage
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Return a schema used storage in a time range.

GET /metrics/storage/schemas/{tabschema}/timeseries

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

tabschema
Required*
string
Used to filter by schema

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json;charset=utf-8")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json;charset=utf-8",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json;charset=utf-8",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}/timeseries?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json;charset=utf-8'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseTimeSeriesListTableStorageCombineForFront

Status Code

200
OK
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a schema storage. Only returns the last collected data between start and end.

GET /metrics/storage/schemas/{tabschema}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

tabschema
Required*
string
Used to filter by schema

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/storage/schemas/{tabschema}?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseRealTimeListTableStorageCombineForFront

Status Code

200
Returns the list for schema storage
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Runs asynchronously a tables storage collection. Only allow one thread to run at the same time. If there is already a thread running, the new request will not kick off a new one. The returned handle will be the already running one. If there is no thread running, a new handle will be returned.

POST /metrics/tables/storage/collector

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/storage/collector"

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/storage/collector")
  .post(null)
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/tables/storage/collector",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/metrics/tables/storage/collector", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/storage/collector   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

storagecollector

Status Code

202
Runs a tables storage collection
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of inflight executions.Only returns the same statement once and the last collected one between start and end.

GET /metrics/statements/inflight_executions

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if include system statements in the return list

Default: false
limit
integer
The amount of return records. Limit and offset should be set together.

Default: 100
offset
integer
The starting position of return records. Limit and offset should be set together

Default: 0
client_ipaddr
string
Used to filter by IP address
stmt_text
string
Used to filter by statement text
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseHistoryListInflightStatementCacheForFront

Collection of in flight execution data

Status Code

200
Returns a list of inflight executions name
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of current inflight executions

GET /metrics/statements/inflight_executions/current/list

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

include_sys
string
Field to set if include system statements in the return list

Default: false
limit
integer
The amount of return records. Limit and offset should be set together.

Default: 100
offset
integer
The starting position of return records. Limit and offset should be set together

Default: 0
client_ipaddr
string
Used to filter by IP address
stmt_text
string
Used to filter by statement text
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/statements/inflight_executions/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&stmt_text=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-entry_time'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ResponseRealTimeListInflightStatementCacheForFront

Collection of in flight execution data

Status Code

200
Returns a list of current inflight executions
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a infight execution detail. Only returns the last one between start and end

GET /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

application_handle
Required*
integer
A system-wide unique ID for the application.
uow_id
Required*
integer
The unit of work identifier.
activity_id
Required*
integer
Counter which uniquely identifies an activity for an application within a given unit of work.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

inflightExecutionDetails

inflight statement Execution details

Status Code

200
Returns a infight execution detail
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Terminates a statement

DELETE /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

application_handle
Required*
integer
A system-wide unique ID for the application.
uow_id
Required*
integer
The unit of work identifier.
activity_id
Required*
integer
Counter which uniquely identifies an activity for an application within a given unit of work.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}")
  .delete(null)
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

object

Status Code

200
Connection terminated
403
Operation is only available to administrators
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of connections. Each connection represents a row. If there are multiple collections. They'll been aggregated averagely.

GET /metrics/applications/connections

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if include system statements in the return list

Default: false
limit
integer
The amount of return records. Limit and offset should be set together.

Default: 100
offset
integer
The starting position of return records. Limit and offset should be set together

Default: 0
client_ipaddr
string
Used to filter by IP address
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/applications/connections?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/applications/connections?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

applicationConnectionsList

a list of application connections

Status Code

200
Returns Connections with the specific profile name
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of current connections. Only return the last collected connections. The values are calculated based on the last collected and privious collection rows to get rate like values.

GET /metrics/applications/connections/current/list

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

include_sys
string
Field to set if include system statements in the return list

Default: false
limit
integer
The amount of return records. Limit and offset should be set together.

Default: 100
offset
integer
The starting position of return records. Limit and offset should be set together

Default: 0
client_ipaddr
string
Used to filter by IP address
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/applications/connections/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/applications/connections/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/current/list?include_sys=false&limit=100&offset=0&client_ipaddr=SOME_STRING_VALUE&application_name=SOME_STRING_VALUE&session_auth_id=SOME_STRING_VALUE&sort=-application_handle'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

currentApplicationConnectionsList

a list of application connections

Status Code

200
Returns Connections with the specific profile name
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a connection detail

GET /metrics/applications/connections/{application_handle}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

application_handle
Required*
int64
A system-wide unique ID for the application.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/applications/connections/{application_handle}?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/applications/connections/{application_handle}?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

applicationConnectionsDetails

application connections

Status Code

200
Returns connection details with the specific profile name and specific application handle
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Terminates an active database connection.

DELETE /metrics/applications/connections/{application_handle}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

application_handle
Required*
integer
Application handle name

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}")
  .delete(null)
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/applications/connections/{application_handle}",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/metrics/applications/connections/{application_handle}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

object

Status Code

200
Connection terminated
403
Operation is only available to administrators
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of timeseries of a connection. The values are calculated based on the last collected and privious collection rows to get rate like values.

GET /metrics/applications/connections/{application_handle}/timeseries

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

application_handle
Required*
int64
A system-wide unique ID for the application.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}/timeseries?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}/timeseries?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/applications/connections/{application_handle}/timeseries?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/applications/connections/{application_handle}/timeseries?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/applications/connections/{application_handle}/timeseries?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

applicationConnectionsConnectionTimeseries

a list of application connections

Status Code

200
Returns connection details of timeseries with the specific profile name and specific application handle
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics for schemas. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/schemas

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if include system schemas in the return list

Default: false
limit
string
Field to set the amount of return records

Default: 100
offset
string
Field to set the starting position of return records.

Default: 0
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

schemaPerfList

a list of Sechmas

Status Code

200
returns performance of schemas
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns current performance metrics for schemas.

GET /metrics/schemas/current/list

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

include_sys
string
Field to set if include system schemas in the return list

Default: false
limit
string
Field to set the amount of return records

Default: 100
offset
string
Field to set the starting position of return records.

Default: 0
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

currentSchemaPerfList

a list of Sechmas

Status Code

200
returns performance of schemas
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics for one schema. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/schemas/{schema_name}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

schema_name
Required*
string
Schema name

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

schemaPerf

Schema Perf

Status Code

200
Returns performance metrics for one schema
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics on all members for one schema. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/schemas/{schema_name}/members

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

schema_name
Required*
string
Schema name

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/members?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

schemaPerfByMemberList

Schema Perf list

Status Code

200
Returns performance metrics on all members for one schema
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics timeseries for one schema.

GET /metrics/schemas/{schema_name}/timeseries

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

schema_name
Required*
string
Schema name

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/timeseries?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

schemaPerfTimeseriesList

Schema Perf Timeseries list

Status Code

200
Returns performance metrics timeseries for one schema
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance of tables. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/tables

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if include system tables in the return list

Default: false
limit
string
Field to set the amount of return records

Default: 100
offset
string
Field to set the starting position of return records.

Default: 0
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

tablePerfList

A list of tables

Status Code

200
Returns performance of tables
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns current performance of tables.

GET /metrics/tables/current/list

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

include_sys
string
Field to set if include system tables in the return list

Default: false
limit
string
Field to set the amount of return records

Default: 100
offset
string
Field to set the starting position of return records.

Default: 0
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tables/current/list?include_sys=false&limit=100&offset=0&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

currentTablePerfList

A list of tables

Status Code

200
Returns performance of tables
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance of one table. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/schemas/{schema_name}/tables/{table_name}

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

schema_name
Required*
string
Schema name
table_name
Required*
string
Table name

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

tablePerf

Table performance

Status Code

200
Returns performance of one table
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance on all members for one table. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/schemas/{schema_name}/tables/{table_name}/members

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

schema_name
Required*
string
Schema name
table_name
Required*
string
Table name

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/members?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

tablePerfByMemberList

Table performance list

Status Code

200
Returns performance on all members for one table
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance timeseries for one table.

GET /metrics/schemas/{schema_name}/tables/{table_name}/timeseries

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Path Parameters

schema_name
Required*
string
Schema name
table_name
Required*
string
Table name

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/schemas/{schema_name}/tables/{table_name}/timeseries?start=1546272000000&end=1546272300000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

tablePerfTimeseriesList

Table performance timeseries list

Status Code

200
Returns performance timeseries for one table
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance of tables and schemas. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/tableperformance

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if include system tables in the return list

Default: false
limit
string
Field to set the amount of return records

Default: 100
offset
string
Field to set the starting position of return records.

Default: 0
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tableperformance?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

tableperformance-result

Result of tables and schemas

Status Code

200
Returns performance of tables
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns current performance of tables and schemas. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/tableperformance/current/list

Request

Custom Headers

X-DB-Profile
Required*
string
Database profile name.

Query Parameters

start
Required*
integer
Start timestamp.
end
Required*
integer
End timestamp.
include_sys
string
Field to set if include system tables in the return list

Default: false
limit
string
Field to set the amount of return records

Default: 100
offset
string
Field to set the starting position of return records.

Default: 0
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tableperformance/current/list?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("x-db-profile", "SOME_STRING_VALUE")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tableperformance/current/list?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("x-db-profile", "SOME_STRING_VALUE")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/metrics/tableperformance/current/list?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema",
  "headers": {
    "content-type": "application/json",
    "x-db-profile": "SOME_STRING_VALUE",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'x-db-profile': "SOME_STRING_VALUE",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/metrics/tableperformance/current/list?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/metrics/tableperformance/current/list?include_sys=false&start=1546272000000&end=1546272300000&limit=100&offset=0&sort=-tabschema'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

tableperformance-realtime-result

Result of current tables and schemas

Status Code

200
Returns performance of tables
403
Current user does not have permission to access this database
404
Database profile not found
default
Error payload

No Sample Response

This method does not specify any sample responses.

Executes one or more SQL statements as a background job. This endpoint returns a job ID that can be used to retrieve the results.

POST /sql_jobs

Request

Request Body

Required*

SQLJobCreate

SQL script and execution options

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/sql_jobs"

	payload := strings.NewReader("{\"commands\":\"select TABNAME, TABSCHEMA, OWNER from syscat.tables fetch first 5 rows only;select * from INVALID_TABLE fetch first 5 rows only;\",\"limit\":10,\"separator\":\";\",\"stop_on_error\":\"no\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"commands\":\"select TABNAME, TABSCHEMA, OWNER from syscat.tables fetch first 5 rows only;select * from INVALID_TABLE fetch first 5 rows only;\",\"limit\":10,\"separator\":\";\",\"stop_on_error\":\"no\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/sql_jobs")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/sql_jobs",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  commands: 'select TABNAME, TABSCHEMA, OWNER from syscat.tables fetch first 5 rows only;select * from INVALID_TABLE fetch first 5 rows only;',
  limit: 10,
  separator: ';',
  stop_on_error: 'no'
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"commands\":\"select TABNAME, TABSCHEMA, OWNER from syscat.tables fetch first 5 rows only;select * from INVALID_TABLE fetch first 5 rows only;\",\"limit\":10,\"separator\":\";\",\"stop_on_error\":\"no\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/sql_jobs", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/sql_jobs   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"commands":"select TABNAME, TABSCHEMA, OWNER from syscat.tables fetch first 5 rows only;select * from INVALID_TABLE fetch first 5 rows only;","limit":10,"separator":";","stop_on_error":"no"}'

Response

Response Body

SQLJobSummary

Status Code

201
SQL execution job
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns the current status of a SQL job execution along with any results of SQL statements that have already been executed. Clients are supposed to poll this endpoint until the status returned is either 'completed', which indicates all SQL statements have completed executing, or 'failed', which indicates the job failed to execute and therefore is considered terminated. The returned list of results is not cumulative. That means, results that were fetched in a previous call will not be returned again, only new results (i.e. that were not fetched yet) will be included. For example, assuming a job with 10 SQL statements, the first call returns status "running" and 6 results, the second call returns status "running" and an empty list of results, a third call status "completed" and 4 results. Any subsequent calls would return status "completed" and an empty list of results.

GET /sql_jobs/{id}

Request

Path Parameters

id
Required*
string
ID of the SQL execution job

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/sql_jobs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/sql_jobs/{id}")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/sql_jobs/{id}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/sql_jobs/{id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/sql_jobs/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SQLJobResults

Contains the results of executing the SQL statements associated with a SQL execution job

Status Code

200
Result of a SQL job
default
Error payload

No Sample Response

This method does not specify any sample responses.

Executes the specified SQL query and returns the data as a CSV file.

POST /sql_query_export

Request

Request Body

Required*

SQLStatement

The SQL query to be executed

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/sql_query_export"

	payload := strings.NewReader("{\"command\":\"<ADD STRING VALUE>\"}")

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

	req.Header.Add("content-type", "text/csv")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"command\":\"<ADD STRING VALUE>\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/sql_query_export")
  .post(body)
  .addHeader("content-type", "text/csv")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/sql_query_export",
  "headers": {
    "content-type": "text/csv",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ command: '<ADD STRING VALUE>' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"command\":\"<ADD STRING VALUE>\"}"

headers = {
    'content-type': "text/csv",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/sql_query_export", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/sql_query_export   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: text/csv'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"command":"<ADD STRING VALUE>"}'

Response

Response Body

file

Status Code

200
CSV file containing query results
default
Error payload

No Sample Response

This method does not specify any sample responses.

Scale the amount of storage and cpu cores for your instance.

POST /scaling/request

Request

Request Body

object

The number of cores and the amount of storage to scale.

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/scaling/request"

	payload := strings.NewReader("{\"total_cores\":4,\"total_storage\":20480}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"total_cores\":4,\"total_storage\":20480}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/scaling/request")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/scaling/request",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ total_cores: 4, total_storage: 20480 }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"total_cores\":4,\"total_storage\":20480}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/scaling/request", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/scaling/request   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"total_cores":4,"total_storage":20480}'

Response

Response Body

SuccessScalingRequestResponse

Status Code

200
The scaling request was successful. Returns the task ID used to scale the deployment.
400
Bad request
401
Unauthorized
500
Internal server error

No Sample Response

This method does not specify any sample responses.

View the allocated storage and cpu size at the time of the request. This request will also return the supported scaling ranges for this Db2 on Cloud service.

GET /scaling/resources/info

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/scaling/resources/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/scaling/resources/info")
  .get()
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/scaling/resources/info",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/scaling/resources/info", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/scaling/resources/info   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessResourcesInfoResponse

Status Code

200
Details for supported scaling ranges and current allocated resources.
400
Bad request
401
Unauthorized
500
Unexpected error

No Sample Response

This method does not specify any sample responses.

View scaling historical data.

GET /scaling/history

Request

Query Parameters

start
integer
end
integer
search
string
sort_column
string
sort_order
string
activity_type
string

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/scaling/history?start=SOME_INTEGER_VALUE&end=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sort_column=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&activity_type=SOME_STRING_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/scaling/history?start=SOME_INTEGER_VALUE&end=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sort_column=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&activity_type=SOME_STRING_VALUE")
  .get()
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/scaling/history?start=SOME_INTEGER_VALUE&end=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sort_column=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&activity_type=SOME_STRING_VALUE",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/scaling/history?start=SOME_INTEGER_VALUE&end=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sort_column=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&activity_type=SOME_STRING_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/scaling/history?start=SOME_INTEGER_VALUE&end=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sort_column=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE&activity_type=SOME_STRING_VALUE'   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessScalingHistoryResponse

Status Code

200
View scaling history
400
Bad request
401
Unauthorized
500
Internal server error

No Sample Response

This method does not specify any sample responses.

GET /about

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/about"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/about")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/about",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/about", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/about   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessAboutInfo

Status Code

200
Get system information
default
Error payload

No Sample Response

This method does not specify any sample responses.

GET /tasks/status

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/tasks/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/tasks/status")
  .get()
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/tasks/status",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/tasks/status", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/tasks/status   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SuccessTasksStatusResponse

Status Code

200
contain tasks status for scaling ,restore etc.
400
Bad request
401
Unauthorized
500
Error

No Sample Response

This method does not specify any sample responses.

Schema discovery analyzes data in CSV format and returns a list of suggested data types that can be used when creating a table to store the CSV data.

POST /schema_discovery

Request

Request Body

Required*

SchemaDiscoveryCSVRequest

Data to analyze

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/schema_discovery"

	payload := strings.NewReader("{\"column_separator\":\"<ADD STRING VALUE>\",\"includes_header\":\"<ADD STRING VALUE>\",\"data\":\"<ADD STRING VALUE>\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"column_separator\":\"<ADD STRING VALUE>\",\"includes_header\":\"<ADD STRING VALUE>\",\"data\":\"<ADD STRING VALUE>\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/schema_discovery")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/schema_discovery",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  column_separator: '<ADD STRING VALUE>',
  includes_header: '<ADD STRING VALUE>',
  data: '<ADD STRING VALUE>'
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"column_separator\":\"<ADD STRING VALUE>\",\"includes_header\":\"<ADD STRING VALUE>\",\"data\":\"<ADD STRING VALUE>\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/schema_discovery", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/schema_discovery   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"column_separator":"<ADD STRING VALUE>","includes_header":"<ADD STRING VALUE>","data":"<ADD STRING VALUE>"}'

Response

Response Body

SchemaDiscoveryResponse

Result of running schema discovery.

Status Code

200
Suggested table schema
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query the list of object schemas.

GET /admin/schemas/obj_type/{obj_type}

Request

Path Parameters

obj_type
Required*
string
Object type.

Allowable values: [table,hadooptable,view,mqt,alias,sequence,procedure,nickname,udt,function]

Query Parameters

search_name
string
Object type.
show_systems
string
Whether to show system objects.

Allowable values: [true,false]
rows_return
string
The amount of return records.

Default: 500

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/obj_type/table?search_name=SYSIBM&show_systems=true&rows_return=50'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ObjectSchemaProperty[]

Status Code

200
Query the list of object schemas.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Creates a new schema. Any user with enough database authority can create schemas using dbapi directly. Regular users can create new schemas indirectly by creating a new table or other database object and specifying the name of the new schema where the object will be placed.

POST /admin/schemas

Request

Request Body

Required*

CreateSchemaReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas"

	payload := strings.NewReader("{\"name\":\"TESTSCHEMA\",\"authorization\":\"SYSIBM\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"TESTSCHEMA\",\"authorization\":\"SYSIBM\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ name: 'TESTSCHEMA', authorization: 'SYSIBM' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"name\":\"TESTSCHEMA\",\"authorization\":\"SYSIBM\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/schemas", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"name":"TESTSCHEMA","authorization":"SYSIBM"}'

Response

Response Body

Schema

Status Code

201
Schema created.
400
Invalid parameters or schema already exists
403
Only administrators can create schemas directly.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drops an empty schema. An error is returned if the schema contains any objects.

DELETE /admin/schemas

Request

Request Body

Required*

DropSchemaReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas"

	payload := strings.NewReader("[{\"name\":\"TESTSCHEMA\"}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"name\":\"TESTSCHEMA\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas")
  .delete(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { name: 'TESTSCHEMA' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"name\":\"TESTSCHEMA\"}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/schemas", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"name":"TESTSCHEMA"}]'

Response

Response Body

StatusSuccess

Status Code

200
The schema was dropped successfully.
400
Invalid parameters.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get single object privilege.

GET /admin/privileges

Request

Query Parameters

obj_type
Required*
string
Object type.

Allowable values: [TABLE,VIEW,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,SCHEMA,UDT]
schema
string
Schema name of the object. For table and database, this parameter is not required.
obj_name
string
Name of the object. For database, this parameter is not required.
rows_return
string
The amount of return records.

Default: 1000

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges?obj_type=VIEW&schema=SYSCAT&obj_name=VIEWS&rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

PrivilegeObjectRsp[]

Status Code

200
Get object privilege.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Privilege list of selected objects.

POST /admin/privileges

Request

Request Body

Required*

privilegsReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges"

	payload := strings.NewReader("{\"obj_type\":\"VIEW\",\"rows_return\":10,\"filter\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\"}]}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"obj_type\":\"VIEW\",\"rows_return\":10,\"filter\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\"}]}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  obj_type: 'VIEW',
  rows_return: 10,
  filter: [ { schema: 'SYSCAT', obj_name: 'TABLES' } ]
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"obj_type\":\"VIEW\",\"rows_return\":10,\"filter\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\"}]}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/privileges", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"obj_type":"VIEW","rows_return":10,"filter":[{"schema":"SYSCAT","obj_name":"TABLES"}]}'

Response

Response Body

privilegsResBody_Array[]

Status Code

200
Privilege list of selected objects
400
Get error when search authid
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revoke privileges

PUT /admin/privileges

Request

Request Body

Required*

privilegesChangeReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges"

	payload := strings.NewReader("{\"stop_on_error\":true,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"stop_on_error\":true,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  stop_on_error: true,
  privileges: [
    {
      schema: 'SYSCAT',
      obj_name: 'TABLES',
      obj_type: 'VIEW',
      grantee: { authid: 'PUBLIC', authid_type: 'GROUP' },
      grant: [ 'select' ],
      revoke: [ 'insert' ]
    }
  ]
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"stop_on_error\":true,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/admin/privileges", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"stop_on_error":true,"privileges":[{"schema":"SYSCAT","obj_name":"TABLES","obj_type":"VIEW","grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["select"],"revoke":["insert"]}]}'

Response

Response Body

privilegeRunSuccessResBody

Status Code

200
The status of grant or revoke
400
Get error when grant or revoke
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Create a new table.

PUT /admin/tables

Request

Request Body

Required*

CreateAlterTableReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables"

	payload := strings.NewReader("{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/tables",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  schema: 'TABLE_SCHEMA',
  table: 'TABLE_NAME',
  column_info: [
    {
      data_type: 'DECIMAL',
      length: 5,
      scale: {},
      column_name: 'COL_NAME',
      nullable: true
    }
  ]
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/admin/tables", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"schema":"TABLE_SCHEMA","table":"TABLE_NAME","column_info":[{"data_type":"DECIMAL","length":5,"scale":{},"column_name":"COL_NAME","nullable":true}]}'

Response

Response Body

StatusSuccess

Status Code

201
The table was created successfully.
400
Invalid parameters.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drop table.

DELETE /admin/tables

Request

Request Body

Required*

DropTableReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables"

	payload := strings.NewReader("[{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\"}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables")
  .delete(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/tables",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'TABLE_SCHEMA', table: 'TABLE_NAME' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\"}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/tables", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"TABLE_SCHEMA","table":"TABLE_NAME"}]'

Response

Response Body

StatusSuccess

Status Code

200
The alias was dropped successfully.
400
Invalid parameters.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get table definition.

GET /admin/schemas/{schema_name}/tables/{table_name}/definition

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
table_name
Required*
string
Table name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

TableDefinition

Status Code

200
Get table definition.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Fetches the table data up to a maximum of 100,000 rows. Currently it's not possible to retrieve data from tables that contain CLOB, BLOB or DBCLOB values.

GET /admin/schemas/{schema_name}/tables/{table_name}/data

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
table_name
Required*
string
Table name.

Query Parameters

rows_return
integer
The amount of return records.

Default: 1000

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

TableData

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get column detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/columns/{column_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
table_name
Required*
string
Table name.
column_name
Required*
string
Column name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ColumnProperty

Status Code

200
Get column detail properties.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the metadata type.

GET /admin/tables/meta/datatype

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables/meta/datatype"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables/meta/datatype")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/tables/meta/datatype",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/tables/meta/datatype", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables/meta/datatype   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MetaDataType[]

Status Code

200
Get the metadata type.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Generate table DDL.

POST /admin/tables/ddl

Request

Query Parameters

action
Required*
string
Type of operation.

Allowable values: [create,alter]

Request Body

Required*

CreateAlterTableReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create"

	payload := strings.NewReader("{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/tables/ddl?action=create",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  schema: 'TABLE_SCHEMA',
  table: 'TABLE_NAME',
  column_info: [
    {
      data_type: 'DECIMAL',
      length: 5,
      scale: {},
      column_name: 'COL_NAME',
      nullable: true
    }
  ]
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}]}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/tables/ddl?action=create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"schema":"TABLE_SCHEMA","table":"TABLE_NAME","column_info":[{"data_type":"DECIMAL","length":5,"scale":{},"column_name":"COL_NAME","nullable":true}]}'

Response

Response Body

SQLCommand

Status Code

200
Generate table DDL.
400
Invalid parameters.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get distributin keys.

GET /admin/schemas/{schema_name}/tables/{table_name}/distribution_keys

Request

Path Parameters

schema_name
Required*
string
Schema name of the table.
table_name
Required*
string
Name of the table.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DistributionKeysRspBody

Status Code

200
Get distributin keys.
400
Invalid parameters.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get data distributin property.

GET /admin/schemas/{schema_name}/tables/{table_name}/distributions/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the table.
table_name
Required*
string
Name of the table.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DataDistributionPropertyRspBody

Status Code

200
Get data distributin property.
400
Invalid parameters.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get partition expressions.

GET /admin/schemas/{schema_name}/tables/{table_name}/partitions/expressions

Request

Path Parameters

schema_name
Required*
string
Schema name of the table.
table_name
Required*
string
Name of the table.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

PartitionExpression[]

Status Code

200
Get partition expressions.
400
Invalid parameters.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get data partitions.

GET /admin/schemas/{schema_name}/tables/{table_name}/partitions

Request

Path Parameters

schema_name
Required*
string
Schema name of the table.
table_name
Required*
string
Name of the table.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DataPartition[]

Status Code

200
Get data partitions.
400
Invalid parameters.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query view detail properties.

GET /admin/schemas/{schema_name}/views/{view_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the view.
view_name
Required*
string
Name of the view.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ViewProperty

Status Code

200
Query view detail properties.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drop views.

DELETE /admin/views

Request

Request Body

Required*

DropViewReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/views"

	payload := strings.NewReader("[{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/views")
  .delete(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/views",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'VIEW_SCHEMA', view: 'VIEW_NAME' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/views", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/views   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"VIEW_SCHEMA","view":"VIEW_NAME"}]'

Response

Response Body

StatusSuccess

Status Code

200
The alias was dropped successfully.
400
Run sql exception.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query view data.

GET /admin/schemas/{schema_name}/views/{view_name}/data

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
view_name
Required*
string
View name.

Query Parameters

rows_return
integer
The amount of return records.

Default: 1000

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ViewData

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get view definition.

GET /admin/schemas/{schema_name}/views/{view_name}/definition

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
view_name
Required*
string
View name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ViewDefinition

Status Code

200
Get View definition.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Generate view DDL.

POST /admin/views/ddl

Request

Query Parameters

action
Required*
string
Type of operation.

Allowable values: [create,alter]

Request Body

Required*

CreateAlterViewReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/views/ddl?action=create"

	payload := strings.NewReader("{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/views/ddl?action=create")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/views/ddl?action=create",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ schema: 'VIEW_SCHEMA', view: 'VIEW_NAME' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/views/ddl?action=create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/views/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"schema":"VIEW_SCHEMA","view":"VIEW_NAME"}'

Response

Response Body

SQLCommand

Status Code

200
Generate view DDL.
400
Invalid parameters.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the dependencies of the object.

GET /admin/schemas/{schema_name}/{obj_type}/{object_name}/dependencies

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
obj_type
Required*
string
Type of object.

Allowable values: [tables,views,nicknames,sequences,aliases,mqts,procedures,functions,udts]
object_name
Required*
string
Name of the object.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

DependenciesReferences

Status Code

200
Get the dependencies of the object.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query bufferpool detail properties.

GET /admin/bufferpools/{bufferpool_name}/properties

Request

Path Parameters

bufferpool_name
Required*
string
Name of the object.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

BufferpoolProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query constraint detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
table_name
Required*
string
Table name.
constraint_name
Required*
string
Name of the constraint.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ConstraintProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query index detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
table_name
Required*
string
Table name.
index_name
Required*
string
Name of the index.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

IndexProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query trigger detail properties.

GET /admin/schemas/{schema_name}/triggers/{trigger_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
trigger_name
Required*
string
Name of the trigger.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

TriggerProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query MQT detail properties.

GET /admin/schemas/{schema_name}/mqts/{mqt_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
mqt_name
Required*
string
Name of the MQT.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

MQTProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query UDF detail properties.

GET /admin/schemas/{schema_name}/functions/{specific_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
specific_name
Required*
string
Name of the UDF.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

UDFProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query tablespace detail properties.

GET /admin/tablespaces/{table_space}/properties

Request

Path Parameters

table_space
Required*
string
Tablespace name of the object.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/tablespaces/{table_space}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/tablespaces/{table_space}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

TablespaceProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query procedure detail properties.

GET /admin/schemas/{schema_name}/procedures/{specific_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
specific_name
Required*
string
Name of the procedure.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ProcedureProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query sequence detail properties.

GET /admin/schemas/{schema_name}/sequences/{sequence_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
sequence_name
Required*
string
Name of the sequence.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

SequenceProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query package detail properties.

GET /admin/schemas/{schema_name}/packages/{package_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
package_name
Required*
string
Name of the package.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

PackageProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query UDT detail properties.

GET /admin/schemas/{schema_name}/udts/{type_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
type_name
Required*
string
Name of the user-defined type.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

UDTProperty

Status Code

200
Returned result was successful.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query alias detail properties.

GET /admin/schemas/{schema_name}/aliases/{alias_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
alias_name
Required*
string
Alias name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AliasProperty

Status Code

200
Query alias detail properties.
403
Not authorized.
404
Schema or alias not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get table detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/properties

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
table_name
Required*
string
Table name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

TableProperty

Status Code

200
Get table detail properties.
403
Not authorized.
404
Object not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Create alias.

PUT /admin/aliases

Request

Request Body

Required*

AliasObject

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases"

	payload := strings.NewReader("{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/aliases",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  base_obj_schema: 'SYSCAT',
  base_obj_name: 'TABLES',
  alias_name: 'ALIAS_NAME',
  alias_schema: 'ALIAS_SCHEMA'
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/admin/aliases", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"base_obj_schema":"SYSCAT","base_obj_name":"TABLES","alias_name":"ALIAS_NAME","alias_schema":"ALIAS_SCHEMA"}'

Response

Response Body

StatusSuccess

Status Code

200
The alias was created successfully.
400
Invalid parameters.
403
Not authorized.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drop alias.

DELETE /admin/aliases

Request

Request Body

Required*

DropAliasArray

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases"

	payload := strings.NewReader("[{\"schema\":\"ALIAS_SCHEMA\",\"alias\":\"ALIAS_NAME\"}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"ALIAS_SCHEMA\",\"alias\":\"ALIAS_NAME\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases")
  .delete(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/aliases",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'ALIAS_SCHEMA', alias: 'ALIAS_NAME' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"ALIAS_SCHEMA\",\"alias\":\"ALIAS_NAME\"}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/aliases", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"ALIAS_SCHEMA","alias":"ALIAS_NAME"}]'

Response

Response Body

StatusSuccess

Status Code

200
The alias was dropped successfully.
400
Invalid parameters or run sql exception.
403
Not authorized.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Generate Alias DDL.

POST /admin/aliases/ddl

Request

Query Parameters

action
Required*
string
Type of operation.

Allowable values: [create]

Request Body

Required*

AliasObject

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create"

	payload := strings.NewReader("{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/aliases/ddl?action=create",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  base_obj_schema: 'SYSCAT',
  base_obj_name: 'TABLES',
  alias_name: 'ALIAS_NAME',
  alias_schema: 'ALIAS_SCHEMA'
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/aliases/ddl?action=create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"base_obj_schema":"SYSCAT","base_obj_name":"TABLES","alias_name":"ALIAS_NAME","alias_schema":"ALIAS_SCHEMA"}'

Response

Response Body

SQLCommand

Status Code

200
Generate Alias DDL.
400
Invalid parameters.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Query alias data.

GET /admin/schemas/{schema_name}/aliases/{alias_name}/data

Request

Path Parameters

schema_name
Required*
string
Schema name of the object.
alias_name
Required*
string
Alias name.

Query Parameters

rows_return
integer
The amount of return records.

Default: 1000

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

AliasData

Status Code

200
Returned result was successful.
403
Not authorized.
404
Schema or alias not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the SQL statement template for creating MQT table.

POST /admin/mqts/ddl

Request

Query Parameters

action
Required*
string
Allowable values: [create]

Request Body

Required*

adminSchema

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE"

	payload := strings.NewReader("{\"schema\":\"schemaName\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"schemaName\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ schema: 'schemaName' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"schema\":\"schemaName\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"schema":"schemaName"}'

Response

Response Body

sqlStatementResBody

Status Code

200
the SQL statement of creating MQT table
400
Get error when create MQT table
default
Error payload

No Sample Response

This method does not specify any sample responses.

Delete mqt tables.

DELETE /admin/mqts

Request

Request Body

Required*

deleteMqtReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/mqts"

	payload := strings.NewReader("[{\"schema\":\"schemaName\",\"mqt\":\"mqtName\"}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"schemaName\",\"mqt\":\"mqtName\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/mqts")
  .delete(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/mqts",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'schemaName', mqt: 'mqtName' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"schemaName\",\"mqt\":\"mqtName\"}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/mqts", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/mqts   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"schemaName","mqt":"mqtName"}]'

Response

Response Body

adminRunSuccessResBody

Status Code

200
The status of deleting MQT tables
400
Error payload
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the definition of MQT table.

GET /admin/schemas/{schema_name}/mqts/{mqt_name}/definition

Request

Path Parameters

schema_name
Required*
string
schema name
mqt_name
Required*
string
mqt name

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

mqtDefinitionResBody

Status Code

200
Definition of MTQ table
400
Error information when get mqt definition
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the data of specified mqt table.

GET /admin/schemas/{schema_name}/mqts/{mqt_name}/data

Request

Path Parameters

schema_name
Required*
string
mqt_name
Required*
string

Query Parameters

rows_return
integer
Default: 1000

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/data?rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

mqtDataResBody

Status Code

200
Get the data of MQT table,include table columns information and data
400
Error information when get mqt data
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get authentications through the authid filter

GET /admin/privileges/authentications

Request

Query Parameters

authid
Required*
string
rows_return
integer
0 means return all query results

Default: 0

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

getAuthenticationsResBody_Array[]

Status Code

200
The list of authid and authid type
400
Get error when search authid
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the privieles of auth id

GET /admin/privileges/{authid_type}/{authid}/{obj_type}

Request

Path Parameters

authid_type
Required*
string
authid type

Allowable values: [GROUP,USER,ROLE]
authid
Required*
string
Authorization id.
obj_type
Required*
string
Type of object

Allowable values: [VIEW,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME]

Query Parameters

rows_return
integer
Default: 1000

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

privilegsResBody_Array[]

Status Code

200
Returned result was successful.
400
Get error when get privileges
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get SQL statement of grant or revoke privileges

POST /admin/privileges/dcl

Request

Request Body

Required*

privilegesChangeDclReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/dcl"

	payload := strings.NewReader("[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/dcl")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/dcl",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([
  {
    schema: 'SYSCAT',
    obj_name: 'TABLES',
    obj_type: 'VIEW',
    grantee: { authid: 'PUBLIC', authid_type: 'GROUP' },
    grant: [ 'select' ],
    revoke: [ 'insert' ]
  }
]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/privileges/dcl", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"SYSCAT","obj_name":"TABLES","obj_type":"VIEW","grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["select"],"revoke":["insert"]}]'

Response

Response Body

sqlStatementResBody

Status Code

201
SQL statement for grant or revoke privileges
400
Get error when get privileges
default
Error payload

No Sample Response

This method does not specify any sample responses.

Add new role

POST /admin/privileges/roles

Request

Request Body

Required*

rolesReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles"

	payload := strings.NewReader("{\"authid\":\"authid\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"authid\":\"authid\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/roles",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ authid: 'authid' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"authid\":\"authid\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/privileges/roles", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"authid":"authid"}'

Response

Response Body

privilegeRunSuccessResBody

Status Code

201
The status of adding new role
400
Get error when add new roles
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revoke the privilges of role

PUT /admin/privileges/roles

Request

Request Body

privilegesChangeRoleReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles"

	payload := strings.NewReader("{\"stop_on_error\":false,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"stop_on_error\":false,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/roles",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  stop_on_error: false,
  privileges: [
    {
      schema: 'SYSCAT',
      obj_name: 'TABLES',
      obj_type: 'VIEW',
      grantee: { authid: 'PUBLIC', authid_type: 'GROUP' },
      grant: [ 'select' ],
      revoke: [ 'insert' ]
    }
  ]
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"stop_on_error\":false,\"privileges\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"obj_type\":\"VIEW\",\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"select\"],\"revoke\":[\"insert\"]}]}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/admin/privileges/roles", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"stop_on_error":false,"privileges":[{"schema":"SYSCAT","obj_name":"TABLES","obj_type":"VIEW","grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["select"],"revoke":["insert"]}]}'

Response

Response Body

privilegeRunSuccessResBody

Status Code

200
The status of grant or revoke the role's privileges
400
Error payload
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Delete one role

DELETE /admin/privileges/roles/{role_name}

Request

Path Parameters

role_name
Required*
string

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName")
  .delete(null)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/roles/roleName",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/privileges/roles/roleName", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

privilegeRunSuccessResBody

Status Code

200
The status of deleting one role
400
Error payload
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the membership of authid

GET /admin/privileges/roles/{authid_type}/{authid}

Request

Path Parameters

authid_type
Required*
string
authid type

Allowable values: [USER,GROUP,ROLE]
authid
Required*
string
authid

Query Parameters

rows_return
Required*
integer

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

privilegesMembershipResBody_Array[]

Status Code

200
The membership of one auth
400
Error payload
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get SQL statement of grant or revoke role

POST /admin/privileges/roles/dcl

Request

Request Body

Required*

privilegesChangeRoleDclReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl"

	payload := strings.NewReader("[{\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"<ADD STRING VALUE>\"],\"revoke\":[\"<ADD STRING VALUE>\"]}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"<ADD STRING VALUE>\"],\"revoke\":[\"<ADD STRING VALUE>\"]}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/roles/dcl",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([
  {
    grantee: { authid: 'PUBLIC', authid_type: 'GROUP' },
    grant: [ '<ADD STRING VALUE>' ],
    revoke: [ '<ADD STRING VALUE>' ]
  }
]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"grantee\":{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"},\"grant\":[\"<ADD STRING VALUE>\"],\"revoke\":[\"<ADD STRING VALUE>\"]}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/privileges/roles/dcl", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["<ADD STRING VALUE>"],"revoke":["<ADD STRING VALUE>"]}]'

Response

Response Body

sqlStatementResBody

Status Code

201
The SQL statement of grant or revoke role
400
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get SQL statement for grant or revoke privileges

POST /admin/privileges/multiple_objtypes/dcl

Request

Request Body

PrivilegesMultipleObjectTypeChangeDclReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl"

	payload := strings.NewReader("{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}]}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}]}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/multiple_objtypes/dcl",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  grantee: [ { authid: 'PUBLIC', authid_type: 'GROUP' } ],
  privileges: [
    {
      obj_type: 'VIEW',
      grant: [ 'select' ],
      objects: [
        {
          schema: 'SYSCAT',
          obj_name: 'TABLES',
          specific_name: '<ADD STRING VALUE>'
        }
      ]
    }
  ]
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}]}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/privileges/multiple_objtypes/dcl", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"privileges":[{"obj_type":"VIEW","grant":["select"],"objects":[{"schema":"SYSCAT","obj_name":"TABLES","specific_name":"<ADD STRING VALUE>"}]}]}'

Response

Response Body

sqlStatementResBody

Status Code

201
The SQL statement for grant or revoke privileges
400
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revole privileges for multiple objects and objects type

PUT /admin/privileges/multiple_objtypes

Request

Request Body

Required*

PrivilegesMultipleObjectTypeChangeReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes"

	payload := strings.NewReader("{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}],\"stop_on_error\":false}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}],\"stop_on_error\":false}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/multiple_objtypes",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  grantee: [ { authid: 'PUBLIC', authid_type: 'GROUP' } ],
  privileges: [
    {
      obj_type: 'VIEW',
      grant: [ 'select' ],
      objects: [
        {
          schema: 'SYSCAT',
          obj_name: 'TABLES',
          specific_name: '<ADD STRING VALUE>'
        }
      ]
    }
  ],
  stop_on_error: false
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"privileges\":[{\"obj_type\":\"VIEW\",\"grant\":[\"select\"],\"objects\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\",\"specific_name\":\"<ADD STRING VALUE>\"}]}],\"stop_on_error\":false}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/admin/privileges/multiple_objtypes", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"privileges":[{"obj_type":"VIEW","grant":["select"],"objects":[{"schema":"SYSCAT","obj_name":"TABLES","specific_name":"<ADD STRING VALUE>"}]}],"stop_on_error":false}'

Response

Response Body

privilegeRunSuccessResBody

Status Code

200
The status of grant or revoke privileges
400
Error payload
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get the SQL statement for grant or revoke multiple roles

POST /admin/privileges/multiple_roles/dcl

Request

Request Body

privilegesMultipleRolesChangeDclReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl"

	payload := strings.NewReader("[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/multiple_roles/dcl",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([
  {
    grantee: [ { authid: 'PUBLIC', authid_type: 'GROUP' } ],
    grant: [ 'SYSTS_USR' ],
    revoke: [ 'SYSTS_USR' ]
  }
]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/privileges/multiple_roles/dcl", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"grant":["SYSTS_USR"],"revoke":["SYSTS_USR"]}]'

Response

Response Body

sqlStatementResBody

Status Code

201
The SQL statement for grant or revoke multiple roles
400
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revoke multiple roles

PUT /admin/privileges/multiple_roles

Request

Request Body

privilegesMultipleRolesChangeReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles"

	payload := strings.NewReader("{\"privileges\":[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}],\"stop_on_error\":false}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"privileges\":[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}],\"stop_on_error\":false}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/privileges/multiple_roles",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  privileges: [
    {
      grantee: [ { authid: 'PUBLIC', authid_type: 'GROUP' } ],
      grant: [ 'SYSTS_USR' ],
      revoke: [ 'SYSTS_USR' ]
    }
  ],
  stop_on_error: false
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"privileges\":[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}],\"stop_on_error\":false}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/admin/privileges/multiple_roles", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"privileges":[{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"grant":["SYSTS_USR"],"revoke":["SYSTS_USR"]}],"stop_on_error":false}'

Response

Response Body

privilegeRunSuccessResBody

Status Code

200
The status of grant or revoke roles
400
Error payload
403
Error payload
404
Error payload
default
Error payload

No Sample Response

This method does not specify any sample responses.

Generate workload DDL.

POST /admin/workloads/ddl

Request

Query Parameters

action
Required*
string
Type of operation.

Allowable values: [create]

Request Body

Required*

CreateWorkloadsReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create"

	payload := strings.NewReader("{\"categorization\":\"GetWorkloadDDLTemplate\",\"enable_coll_act_data\":true}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"categorization\":\"GetWorkloadDDLTemplate\",\"enable_coll_act_data\":true}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/workloads/ddl?action=create",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  categorization: 'GetWorkloadDDLTemplate',
  enable_coll_act_data: true
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"categorization\":\"GetWorkloadDDLTemplate\",\"enable_coll_act_data\":true}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/workloads/ddl?action=create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"categorization":"GetWorkloadDDLTemplate","enable_coll_act_data":true}'

Response

Response Body

SQLCommand

Status Code

200
Return the ddl of creating workloads.
400
Invalid parameters or miss some parameters
default
Error payload

No Sample Response

This method does not specify any sample responses.

Returns the list of workloads.

GET /admin/workloads

Request

Query Parameters

rows_return
string
The amount of return records.

Default: 1000
search_name
string
Workload name.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ListWorkloadsRspBody_Array[]

Status Code

200
Return the list of workloads
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drop sequences

DELETE /admin/sequences

Request

Request Body

Required*

sequencesDropList

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/sequences"

	payload := strings.NewReader("[{\"schema\":\"SEQUENCE_SCHEMA\",\"sequence\":\"SEQUENCE_NAME\"}]")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"SEQUENCE_SCHEMA\",\"sequence\":\"SEQUENCE_NAME\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/sequences")
  .delete(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/sequences",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'SEQUENCE_SCHEMA', sequence: 'SEQUENCE_NAME' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"SEQUENCE_SCHEMA\",\"sequence\":\"SEQUENCE_NAME\"}]"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/sequences", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/sequences   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"SEQUENCE_SCHEMA","sequence":"SEQUENCE_NAME"}]'

Response

Response Body

adminRunSuccessResBody

Status Code

200
The status of dropping sequences
400
Faile to drop sequences
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drop procedures

DELETE /admin/procedures

Request

Request Body

Required*

ProceduresDropReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/procedures"

	payload := strings.NewReader("[{\"schema\":\"PROCEDURE_SCHEMA\",\"procedure\":\"PROCEDURE_NAME\"}]")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"PROCEDURE_SCHEMA\",\"procedure\":\"PROCEDURE_NAME\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/procedures")
  .delete(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/procedures",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'PROCEDURE_SCHEMA', procedure: 'PROCEDURE_NAME' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"PROCEDURE_SCHEMA\",\"procedure\":\"PROCEDURE_NAME\"}]"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/procedures", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/procedures   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"PROCEDURE_SCHEMA","procedure":"PROCEDURE_NAME"}]'

Response

Response Body

adminRunSuccessResBody

Status Code

200
Delete procedure successfully
400
Faile to drop procedures
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

Retrieve parameters for procedure.

GET /admin/schemas/{schema_name}/procedures/{specific_name}/parameters

Request

Path Parameters

schema_name
Required*
string
the schema name of the procedure
specific_name
Required*
string
the specificname of procedure

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

ProcedureParameter[]

Status Code

200
Retrieve parameters for procedure.
400
Error information when get procedure parameters.
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

POST /admin/procedures/ddl

Request

Query Parameters

action
Required*
string
Allowable values: [create]

Request Body

Required*

CreateProceduresTemplate

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create"

	payload := strings.NewReader("{\"schema\":\"PROCEDURE_SCHEMA\"}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"PROCEDURE_SCHEMA\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/procedures/ddl?action=create",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ schema: 'PROCEDURE_SCHEMA' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"schema\":\"PROCEDURE_SCHEMA\"}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/procedures/ddl?action=create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create'   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"schema":"PROCEDURE_SCHEMA"}'

Response

Response Body

SQLCommand

Status Code

200
Generate the template of creating procedure
400
Faile to generate create procedure template
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drop functions

DELETE /admin/functions

Request

Request Body

Required*

DropFunctionsReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/functions"

	payload := strings.NewReader("[{\"schema\":\"UDT_SCHEMA\",\"function\":\"UDT_NAME\"}]")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"UDT_SCHEMA\",\"function\":\"UDT_NAME\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/functions")
  .delete(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/functions",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'UDT_SCHEMA', function: 'UDT_NAME' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"UDT_SCHEMA\",\"function\":\"UDT_NAME\"}]"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/functions", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/functions   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"UDT_SCHEMA","function":"UDT_NAME"}]'

Response

Response Body

adminRunSuccessResBody

Status Code

200
Delete function successfully
400
Faile to drop functions
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

Retrieve parameters for specific udf.

GET /admin/schemas/{schema_name}/functions/{specific_name}/parameters

Request

Path Parameters

schema_name
Required*
string
The schema name of the function.
specific_name
Required*
string
The specific name of function.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

FunctionParameter[]

Status Code

200
Retrieve parameters for specific udf.
400
Error information when get procedure parameters
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

POST /admin/functions/ddl

Request

Query Parameters

action
Required*
string
Allowable values: [create]

Request Body

Required*

CreateFunctionTemplateReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create"

	payload := strings.NewReader("{\"schema\":\"UDF_SCHEMA\"}")

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"UDF_SCHEMA\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create")
  .post(body)
  .addHeader("accept", "application/json")
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/functions/ddl?action=create",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ schema: 'UDF_SCHEMA' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"schema\":\"UDF_SCHEMA\"}"

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/functions/ddl?action=create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create'   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"schema":"UDF_SCHEMA"}'

Response

Response Body

SQLCommand

Status Code

200
Generate the template of creating function.
400
Faile to generate create function template.
403
SQLException
404
SQLException
default
Error payload

No Sample Response

This method does not specify any sample responses.

Drop User-defined Types

DELETE /admin/udts

Request

Request Body

Required*

DropUDTArray

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/udts"

	payload := strings.NewReader("[{\"schema\":\"UDT_SCHEMA\",\"udt\":\"UDT_NAME\"}]")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\"schema\":\"UDT_SCHEMA\",\"udt\":\"UDT_NAME\"}]");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/udts")
  .delete(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/udts",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify([ { schema: 'UDT_SCHEMA', udt: 'UDT_NAME' } ]));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "[{\"schema\":\"UDT_SCHEMA\",\"udt\":\"UDT_NAME\"}]"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/admin/udts", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/admin/udts   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '[{"schema":"UDT_SCHEMA","udt":"UDT_NAME"}]'

Response

Response Body

StatusSuccess

Status Code

200
The UDTs was dropped successfully.
400
Invalid parameters or run sql exception.
403
Not authorized.
default
Error payload.

No Sample Response

This method does not specify any sample responses.

Retrieve row definition for User-defined Type object

GET /admin/schemas/{schema_name}/udts/{udt_name}/definition

Request

Path Parameters

schema_name
Required*
string
The schema name of User-defined Type.
udt_name
Required*
string
The name of User-defined Type.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

UDTDefinition[]

Status Code

200
Retrieve row definition for User-defined Type object.
403
Not authorized.
404
Schema or alias not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Generate Create User-defined Types template.

POST /admin/udts/ddl

Request

Query Parameters

action
Required*
string
Type of operation.

Allowable values: [create]

Request Body

Required*

UDTDDLReqBody

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create"

	payload := strings.NewReader("{\"schema\":\"UDT_SCHEMA\"}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"UDT_SCHEMA\"}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/admin/udts/ddl?action=create",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ schema: 'UDT_SCHEMA' }));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"schema\":\"UDT_SCHEMA\"}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/admin/udts/ddl?action=create", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   'https://{REST_API_HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"schema":"UDT_SCHEMA"}'

Response

Response Body

SQLCommand

Status Code

200
Generate Create User-defined Types template.
403
Not authorized.
404
Schema or alias not found.
default
Error payload

No Sample Response

This method does not specify any sample responses.

Administrators can retrieve the list of all users in the system. Regular users will receive a list containing only their own user profile.

GET /users

Request

No Request Parameters

This method does not accept any request parameters.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/users")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/users",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/users", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/users   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

Users

Collection of users

Status Code

200
List of users
default
Error payload

No Sample Response

This method does not specify any sample responses.

Creates a new user.

This operation is only available to platform administrators.The token used in authentication has to be IAM token.

POST /users

Request

Request Body

Required*

User

User information

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/users"

	payload := strings.NewReader("{\"id\":\"test_user\",\"iam\":false,\"ibmid\":\"<ADD STRING VALUE>\",\"name\":\"test_user\",\"password\":\"dEkMc43@gfAPl!867^dSbu\",\"role\":\"bluuser\",\"email\":\"test_user@mycompany.com\",\"locked\":\"no\",\"authentication\":{\"method\":\"internal\",\"policy_id\":\"Default\"}}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"id\":\"test_user\",\"iam\":false,\"ibmid\":\"<ADD STRING VALUE>\",\"name\":\"test_user\",\"password\":\"dEkMc43@gfAPl!867^dSbu\",\"role\":\"bluuser\",\"email\":\"test_user@mycompany.com\",\"locked\":\"no\",\"authentication\":{\"method\":\"internal\",\"policy_id\":\"Default\"}}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/users")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/users",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  id: 'test_user',
  iam: false,
  ibmid: '<ADD STRING VALUE>',
  name: 'test_user',
  password: 'dEkMc43@gfAPl!867^dSbu',
  role: 'bluuser',
  email: 'test_user@mycompany.com',
  locked: 'no',
  authentication: { method: 'internal', policy_id: 'Default' }
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"id\":\"test_user\",\"iam\":false,\"ibmid\":\"<ADD STRING VALUE>\",\"name\":\"test_user\",\"password\":\"dEkMc43@gfAPl!867^dSbu\",\"role\":\"bluuser\",\"email\":\"test_user@mycompany.com\",\"locked\":\"no\",\"authentication\":{\"method\":\"internal\",\"policy_id\":\"Default\"}}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("POST", "/dbapi/v4/users", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X POST   https://{REST_API_HOSTNAME}/dbapi/v4/users   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"id":"test_user","iam":false,"ibmid":"<ADD STRING VALUE>","name":"test_user","password":"dEkMc43@gfAPl!867^dSbu","role":"bluuser","email":"test_user@mycompany.com","locked":"no","authentication":{"method":"internal","policy_id":"Default"}}'

Response

Response Body

User

Status Code

201
User response
202
The creating user task has not been finished
400
Invalid parameters or user already exists
403
Operation is only available to administrators
default
Error payload

No Sample Response

This method does not specify any sample responses.

Get a specific user by ID. Platform administrators may retrieve user information for any user.The token for platform administrator used in authentication has to be IAM token. Regular users may only retrieve themselves.

GET /users/{id}

Request

Path Parameters

id
Required*
string
ID of the user to be fetched

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/users/bluadmin"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/users/bluadmin")
  .get()
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/users/bluadmin",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("GET", "/dbapi/v4/users/bluadmin", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X GET   https://{REST_API_HOSTNAME}/dbapi/v4/users/bluadmin   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

User

Status Code

200
User response
403
Access to this user is not allowed
404
The user does not exist
default
Error payload

No Sample Response

This method does not specify any sample responses.

Updates an existing user. Attribute 'iam' can not be updated. That means no conversion between IBMid users and normal users.

Platform administrators may update user information for any user.The token for platform administrator used in authentication has to be IAM token.

PUT /users/{id}

Request

Path Parameters

id
Required*
string
ID of the user to be updated

Request Body

Required*

UserUpdate

User information

Example request

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}"

	payload := strings.NewReader("{\"id\":\"<ADD STRING VALUE>\",\"ibmid\":\"<ADD STRING VALUE>\",\"name\":\"<ADD STRING VALUE>\",\"old_password\":\"<ADD STRING VALUE>\",\"new_password\":\"<ADD STRING VALUE>\",\"role\":\"bluadmin\",\"email\":\"<ADD STRING VALUE>\",\"locked\":\"yes\",\"authentication\":{\"method\":\"internal\",\"policy_id\":\"Default\"}}")

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

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"id\":\"<ADD STRING VALUE>\",\"ibmid\":\"<ADD STRING VALUE>\",\"name\":\"<ADD STRING VALUE>\",\"old_password\":\"<ADD STRING VALUE>\",\"new_password\":\"<ADD STRING VALUE>\",\"role\":\"bluadmin\",\"email\":\"<ADD STRING VALUE>\",\"locked\":\"yes\",\"authentication\":{\"method\":\"internal\",\"policy_id\":\"Default\"}}");
Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}")
  .put(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/users/{id}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  id: '<ADD STRING VALUE>',
  ibmid: '<ADD STRING VALUE>',
  name: '<ADD STRING VALUE>',
  old_password: '<ADD STRING VALUE>',
  new_password: '<ADD STRING VALUE>',
  role: 'bluadmin',
  email: '<ADD STRING VALUE>',
  locked: 'yes',
  authentication: { method: 'internal', policy_id: 'Default' }
}));
req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

payload = "{\"id\":\"<ADD STRING VALUE>\",\"ibmid\":\"<ADD STRING VALUE>\",\"name\":\"<ADD STRING VALUE>\",\"old_password\":\"<ADD STRING VALUE>\",\"new_password\":\"<ADD STRING VALUE>\",\"role\":\"bluadmin\",\"email\":\"<ADD STRING VALUE>\",\"locked\":\"yes\",\"authentication\":{\"method\":\"internal\",\"policy_id\":\"Default\"}}"

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/users/{id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'   -d '{"id":"<ADD STRING VALUE>","ibmid":"<ADD STRING VALUE>","name":"<ADD STRING VALUE>","old_password":"<ADD STRING VALUE>","new_password":"<ADD STRING VALUE>","role":"bluadmin","email":"<ADD STRING VALUE>","locked":"yes","authentication":{"method":"internal","policy_id":"Default"}}'

Response

Response Body

User

Status Code

200
User response
202
The updating user task has not been finished
403
Access to this user is not allowed
404
The user does not exist
default
Error payload

No Sample Response

This method does not specify any sample responses.

Deletes an existing user.

Only administratos can delete users.The token for platform administrator used in authentication has to be IAM token.

DELETE /users/{id}

Request

Path Parameters

id
Required*
string
ID of the user to be deleted.

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}")
  .delete(null)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "DELETE",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/users/{id}",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("DELETE", "/dbapi/v4/users/{id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X DELETE   https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

object

Status Code

200
User deleted
202
The deleting user task has not been finished
403
Removal of this user is not allowed
404
The user does not exist
default
Error payload

No Sample Response

This method does not specify any sample responses.

Platform admin users can unlock users' accounts which have been locked out following repeated failed authentication attempts.The token for platform administrator used in authentication has to be IAM token.

PUT /users/{id}/lock

Request

Path Parameters

id
Required*
string
ID of the user who will be locked

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}/lock"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}/lock")
  .put(null)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/users/{id}/lock",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/users/{id}/lock", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}/lock   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

User

Status Code

200
User response
202
The locking user task has not been finished
403
Cannot edit this user
404
The user does not exist
default
Error payload

No Sample Response

This method does not specify any sample responses.

Platform admin users can unlock users' accounts which have been locked out following repeated failed authentication attempts.The token for platform administrator used in authentication has to be IAM token.

PUT /users/{id}/unlock

Request

Path Parameters

id
Required*
string
ID of the user who will be unlocked

Example request

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}/unlock"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
	req.Header.Add("x-deployment-id", "{DEPLOYMENT_ID}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example request

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}/unlock")
  .put(null)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {AUTH_TOKEN}")
  .addHeader("x-deployment-id", "{DEPLOYMENT_ID}")
  .build();

Response response = client.newCall(request).execute();

Example request

var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "{REST_API_HOSTNAME}",
  "port": null,
  "path": "/dbapi/v4/users/{id}/unlock",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {AUTH_TOKEN}",
    "x-deployment-id": "{DEPLOYMENT_ID}"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Example request

import http.client

conn = http.client.HTTPSConnection("{REST_API_HOSTNAME}")

headers = {
    'content-type': "application/json",
    'authorization': "Bearer {AUTH_TOKEN}",
    'x-deployment-id': "{DEPLOYMENT_ID}"
    }

conn.request("PUT", "/dbapi/v4/users/{id}/unlock", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example request

curl -X PUT   https://{REST_API_HOSTNAME}/dbapi/v4/users/{id}/unlock   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-deployment-id: {DEPLOYMENT_ID}'

Response

Response Body

User

Status Code

200
User response
202
The unlocking user task has not been finished
403
Cannot edit this user
404
The user does not exist
default
Error payload

No Sample Response

This method does not specify any sample responses.

Introduction

Root URL

Error handling

Security

Security scheme

authToken

Attribute

Type

In

Name

deploymentId

Attribute

Type

In

Name

Third-party libraries

Methods

Request a new access token

Request

Request Body

userid

password

Response

Response Body

userid

token

Status Code

200

401

default

No Sample Response

Returns public key of Json Web Token

Request

No Request Parameters

Response

Response Body

kty

e

kid

alg

n

Status Code

200

No Sample Response

Sets a new password using dswebToken

Request

Request Body

password

dswebToken

Response

Response Body

code

Status Code

200

400

403

default

No Sample Response

List currently available backups

Request

No Request Parameters

Response

Response Body

backups

id

deployment_id

type

status

created_at

size

tables

duration

Status Code

200

400

401

500

No Sample Response

Restore

Request