IBM Cloud API Docs

Introduction

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

Root URL

The context root for the Db2 Warehouse 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 with the /auth/tokens endpoint, and it is used by Db2 Warehouse on Cloud to identify who you are.

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 Warehouse 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.

Methods

Request a new access token

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

POST /auth/tokens

Request

User credentials

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/auth/tokens")
      .post(body)
      .addHeader("content-type", "application/json")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth/tokens",
      "headers": {
        "content-type": "application/json"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"userid\":\"<ADD STRING VALUE>\",\"password\":\"<ADD STRING VALUE>\"}"
    
    headers = { 'content-type': "application/json" }
    
    conn.request("POST", "/dbapi/v4/auth/tokens", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/auth/tokens   -H 'content-type: application/json'   -d '{"userid":"<ADD STRING VALUE>","password":"<ADD STRING VALUE>"}'

Response

Token generated after successful authentication.

Status Code

  • Authentication token

  • Invalid credentials

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns public key of Json Web Token

Returns public key of Json Web Token.

GET /auth/token/publickey

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth/token/publickey")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth/token/publickey",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/auth/token/publickey", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/auth/token/publickey   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Public key of token.

Status Code

  • Token public key and key id.

No Sample Response

This method does not specify any sample responses.

Perform logout operation for a token

Perform logout operation for a token.

DELETE /auth/token/logout

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/auth/token/logout"
    
    	req, _ := http.NewRequest("DELETE", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth/token/logout")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth/token/logout",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/auth/token/logout", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/auth/token/logout   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Logout successfully.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Creates a new authentication policy **ADMIN ONLY**

Creates a new authentication policy which can be used to control password parameters.

POST /auth_policies

Request

Authentication policy

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/auth_policies"
    
    	payload := strings.NewReader("{\"id\":\"this_id_is_ignored\",\"name\":\"test_policy\",\"password_history\":5,\"password_expiration\":30,\"failed_login_attempts\":6,\"lockout_duration\":30,\"min_password_length\":15}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"id\":\"this_id_is_ignored\",\"name\":\"test_policy\",\"password_history\":5,\"password_expiration\":30,\"failed_login_attempts\":6,\"lockout_duration\":30,\"min_password_length\":15}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth_policies")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth_policies",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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: 'this_id_is_ignored',
      name: 'test_policy',
      password_history: 5,
      password_expiration: 30,
      failed_login_attempts: 6,
      lockout_duration: 30,
      min_password_length: 15
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"id\":\"this_id_is_ignored\",\"name\":\"test_policy\",\"password_history\":5,\"password_expiration\":30,\"failed_login_attempts\":6,\"lockout_duration\":30,\"min_password_length\":15}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/auth_policies", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/auth_policies   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"id":"this_id_is_ignored","name":"test_policy","password_history":5,"password_expiration":30,"failed_login_attempts":6,"lockout_duration":30,"min_password_length":15}'

Response

Collection of authentication policies

Status Code

  • Authentication policy created

  • Only administrators can execute this operation

  • Error payload

No Sample Response

This method does not specify any sample responses.

Lists all authentication policies **ADMIN ONLY**

Returns a list of authentication policies.

GET /auth_policies

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/auth_policies"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth_policies")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth_policies",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/auth_policies", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/auth_policies   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Policy defining user's password rules.

Status Code

  • List of authentication policies

  • Only administrators can execute this operation

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns an authentication policy **ADMIN ONLY**

Returns an authentication policy.

GET /auth_policies/{id}

Request

Path Parameters

  • policy ID

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/auth_policies/Default"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth_policies/Default")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth_policies/Default",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/auth_policies/Default", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/auth_policies/Default   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Policy defining user's password rules.

Status Code

  • Authentication policy

  • Only administrators can execute this operation

  • Policy not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Updates an authentication policy **ADMIN ONLY**

Updates an authentication policy.

PUT /auth_policies/{id}

Request

Path Parameters

  • policy ID

Authentication policy

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/auth_policies/{id}"
    
    	payload := strings.NewReader("{\"id\":\"this_id_is_ignored\",\"name\":\"test_policy\",\"password_history\":5,\"password_expiration\":30,\"failed_login_attempts\":6,\"lockout_duration\":30,\"min_password_length\":15}")
    
    	req, _ := http.NewRequest("PUT", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"id\":\"this_id_is_ignored\",\"name\":\"test_policy\",\"password_history\":5,\"password_expiration\":30,\"failed_login_attempts\":6,\"lockout_duration\":30,\"min_password_length\":15}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth_policies/{id}")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth_policies/{id}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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: 'this_id_is_ignored',
      name: 'test_policy',
      password_history: 5,
      password_expiration: 30,
      failed_login_attempts: 6,
      lockout_duration: 30,
      min_password_length: 15
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"id\":\"this_id_is_ignored\",\"name\":\"test_policy\",\"password_history\":5,\"password_expiration\":30,\"failed_login_attempts\":6,\"lockout_duration\":30,\"min_password_length\":15}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("PUT", "/dbapi/v4/auth_policies/{id}", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/auth_policies/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"id":"this_id_is_ignored","name":"test_policy","password_history":5,"password_expiration":30,"failed_login_attempts":6,"lockout_duration":30,"min_password_length":15}'

Response

Policy defining user's password rules.

Status Code

  • Authentication policy

  • Only administrators can execute this operation

  • Policy not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Deletes an existing policy **ADMIN ONLY**

Deletes an existing policy.

Only administratos can delete policies.

DELETE /auth_policies/{id}

Request

Path Parameters

  • ID of the policy to be deleted.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/auth_policies/{id}"
    
    	req, _ := http.NewRequest("DELETE", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth_policies/{id}")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth_policies/{id}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/auth_policies/{id}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/auth_policies/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Policy deleted

  • Removal of this policy is not allowed

  • The policy does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Sets a new password using dswebToken

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

PUT /auth/password

Request

New password and dswebToken

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/auth/password")
      .put(body)
      .addHeader("content-type", "application/json")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth/password",
      "headers": {
        "content-type": "application/json"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"password\":\"<ADD STRING VALUE>\",\"dswebToken\":\"<ADD STRING VALUE>\"}"
    
    headers = { 'content-type': "application/json" }
    
    conn.request("PUT", "/dbapi/v4/auth/password", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/auth/password   -H 'content-type: application/json'   -d '{"password":"<ADD STRING VALUE>","dswebToken":"<ADD STRING VALUE>"}'

Response

Status Code

  • Password changed

  • Invalid or missing new password

  • If dswebToken is missing or invalid

  • Error payload

No Sample Response

This method does not specify any sample responses.

Requests a password reset based on user's email

An email is sent with the password reset link and code. To set a new password, the user can open the link on a web browser, or use the /auth/password endpoint providing the dswebToken. The dswebToken is valid for 12 hours.

POST /auth/reset

Request

User's email address and ID

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/auth/reset"
    
    	payload := strings.NewReader("{\"email\":\"<ADD STRING VALUE>\",\"userId\":\"<ADD STRING VALUE>\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"email\":\"<ADD STRING VALUE>\",\"userId\":\"<ADD STRING VALUE>\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/auth/reset")
      .post(body)
      .addHeader("content-type", "application/json")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/auth/reset",
      "headers": {
        "content-type": "application/json"
      }
    };
    
    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({email: '<ADD STRING VALUE>', userId: '<ADD STRING VALUE>'}));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"email\":\"<ADD STRING VALUE>\",\"userId\":\"<ADD STRING VALUE>\"}"
    
    headers = { 'content-type': "application/json" }
    
    conn.request("POST", "/dbapi/v4/auth/reset", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/auth/reset   -H 'content-type: application/json'   -d '{"email":"<ADD STRING VALUE>","userId":"<ADD STRING VALUE>"}'

Response

Status Code

  • Request accepted

  • Invalid or missing email address and userId

  • The user name and email address do not match.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get a list of backups

Get a list of backups from current instance.

GET /backups

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/backups")
      .get()
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/backups",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/backups", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/backups   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • The list of backups

  • Bad request

  • Unauthorized

  • Internal server error

No Sample Response

This method does not specify any sample responses.

Restore

Restore to a particular backup.

POST /backups/restore

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/backups/restore"
    
    	payload := strings.NewReader("{\"backup_id\":\"202010050805\"}")
    
    	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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"backup_id\":\"202010050805\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/backups/restore")
      .post(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/backups/restore",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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_id: '202010050805'}));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"backup_id\":\"202010050805\"}"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/backups/restore", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/backups/restore   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"backup_id":"202010050805"}'

Response

Status Code

  • Task detail of the restore job

  • Bad request

  • Unauthorized

  • Internal server error

No Sample Response

This method does not specify any sample responses.

Create a backup

Create a backup

POST /backups/backup

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/backups/backup")
      .post(null)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/backups/backup",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/backups/backup", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/backups/backup   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • OK

  • Bad request

  • Unauthorized

  • Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a backup

Delete a backup

DELETE /backups/{id}

Request

Path Parameters

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/backups/2020100508051122"
    
    	req, _ := http.NewRequest("DELETE", url, nil)
    
    	req.Header.Add("accept", "application/json")
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/backups/2020100508051122")
      .delete(null)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/backups/2020100508051122",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/backups/2020100508051122", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/backups/2020100508051122   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • OK

  • Bad request

  • Unauthorized

  • Unexpected error

No Sample Response

This method does not specify any sample responses.

Get backup setting

Get backup setting for scheduled time and retention policy

GET /backups/setting

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/backups/setting")
      .get()
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/backups/setting",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/backups/setting", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/backups/setting   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • OK

  • Bad request

  • Unauthorized

  • Unexpected error

No Sample Response

This method does not specify any sample responses.

Update backup setting

update backup setting for scheduled backup time or retention policy

POST /backups/setting

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/backups/setting"
    
    	payload := strings.NewReader("{\"backup_time\":\"08:05\",\"retention\":7}")
    
    	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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"backup_time\":\"08:05\",\"retention\":7}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/backups/setting")
      .post(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/backups/setting",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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', retention: 7}));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"backup_time\":\"08:05\",\"retention\":7}"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/backups/setting", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/backups/setting   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"backup_time":"08:05","retention":7}'

Response

Status Code

  • OK

  • Bad request

  • Unauthorized

  • Unexpected error

No Sample Response

This method does not specify any sample responses.

Creates a data load job, load uses external table technology

Creates a data load job

POST /load_jobs_ET

Request

Data load job details

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/load_jobs_ET"
    
    	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,\"auto_create_table\":{\"execute\":\"yes\",\"column_names\":[\"<ADD STRING VALUE>\"]},\"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\":{\"encoding\":\"<ADD STRING VALUE>\",\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"string_delimiter\":\"DOUBLE\",\"date_style\":\"<ADD STRING VALUE>\",\"time_style\":\"<ADD STRING VALUE>\",\"date_delimiter\":\"<ADD STRING VALUE>\",\"date_format\":\"<ADD STRING VALUE>\",\"time_format\":\"<ADD STRING VALUE>\",\"timestamp_format\":\"<ADD STRING VALUE>\",\"bool_style\":\"1_0 (this is the default)\",\"ignore_zero\":true,\"require_quotes\":\"<ADD STRING VALUE>\",\"ctrl_chars\":\"<ADD STRING VALUE>\",\"escape_char\":\"<ADD STRING VALUE>\"}}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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,\"auto_create_table\":{\"execute\":\"yes\",\"column_names\":[\"<ADD STRING VALUE>\"]},\"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\":{\"encoding\":\"<ADD STRING VALUE>\",\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"string_delimiter\":\"DOUBLE\",\"date_style\":\"<ADD STRING VALUE>\",\"time_style\":\"<ADD STRING VALUE>\",\"date_delimiter\":\"<ADD STRING VALUE>\",\"date_format\":\"<ADD STRING VALUE>\",\"time_format\":\"<ADD STRING VALUE>\",\"timestamp_format\":\"<ADD STRING VALUE>\",\"bool_style\":\"1_0 (this is the default)\",\"ignore_zero\":true,\"require_quotes\":\"<ADD STRING VALUE>\",\"ctrl_chars\":\"<ADD STRING VALUE>\",\"escape_char\":\"<ADD STRING VALUE>\"}}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/load_jobs_ET")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/load_jobs_ET",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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,
      auto_create_table: {execute: 'yes', column_names: ['<ADD STRING VALUE>']},
      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: {
        encoding: '<ADD STRING VALUE>',
        code_page: '<ADD STRING VALUE>',
        has_header_row: 'no',
        column_delimiter: ',',
        string_delimiter: 'DOUBLE',
        date_style: '<ADD STRING VALUE>',
        time_style: '<ADD STRING VALUE>',
        date_delimiter: '<ADD STRING VALUE>',
        date_format: '<ADD STRING VALUE>',
        time_format: '<ADD STRING VALUE>',
        timestamp_format: '<ADD STRING VALUE>',
        bool_style: '1_0 (this is the default)',
        ignore_zero: true,
        require_quotes: '<ADD STRING VALUE>',
        ctrl_chars: '<ADD STRING VALUE>',
        escape_char: '<ADD STRING VALUE>'
      }
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"auto_create_table\":{\"execute\":\"yes\",\"column_names\":[\"<ADD STRING VALUE>\"]},\"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\":{\"encoding\":\"<ADD STRING VALUE>\",\"code_page\":\"<ADD STRING VALUE>\",\"has_header_row\":\"no\",\"column_delimiter\":\",\",\"string_delimiter\":\"DOUBLE\",\"date_style\":\"<ADD STRING VALUE>\",\"time_style\":\"<ADD STRING VALUE>\",\"date_delimiter\":\"<ADD STRING VALUE>\",\"date_format\":\"<ADD STRING VALUE>\",\"time_format\":\"<ADD STRING VALUE>\",\"timestamp_format\":\"<ADD STRING VALUE>\",\"bool_style\":\"1_0 (this is the default)\",\"ignore_zero\":true,\"require_quotes\":\"<ADD STRING VALUE>\",\"ctrl_chars\":\"<ADD STRING VALUE>\",\"escape_char\":\"<ADD STRING VALUE>\"}}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/load_jobs_ET", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/load_jobs_ET   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"load_source":"SERVER","load_action":"INSERT","schema":"<ADD STRING VALUE>","table":"<ADD STRING VALUE>","max_row_count":0,"max_warning_count":1000,"auto_create_table":{"execute":"yes","column_names":["<ADD STRING VALUE>"]},"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":{"encoding":"<ADD STRING VALUE>","code_page":"<ADD STRING VALUE>","has_header_row":"no","column_delimiter":",","string_delimiter":"DOUBLE","date_style":"<ADD STRING VALUE>","time_style":"<ADD STRING VALUE>","date_delimiter":"<ADD STRING VALUE>","date_format":"<ADD STRING VALUE>","time_format":"<ADD STRING VALUE>","timestamp_format":"<ADD STRING VALUE>","bool_style":"1_0 (this is the default)","ignore_zero":true,"require_quotes":"<ADD STRING VALUE>","ctrl_chars":"<ADD STRING VALUE>","escape_char":"<ADD STRING VALUE>"}}'

Response

Confirmation of load job created

Status Code

  • load jobs.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Lists all data load jobs, load uses Db2 load utility technology

Lists all data load jobs for the user.

GET /load_jobs

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/load_jobs")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/load_jobs",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/load_jobs", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/load_jobs   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Information about a data load job

Status Code

  • Data load jobs

  • Error payload

No Sample Response

This method does not specify any sample responses.

Creates a data load job

Creates a data load job

POST /load_jobs

Request

Data load job details

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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,\"auto_create_table\":{\"execute\":\"yes\",\"column_names\":[\"<ADD STRING VALUE>\"]},\"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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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,\"auto_create_table\":{\"execute\":\"yes\",\"column_names\":[\"<ADD STRING VALUE>\"]},\"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://{HOSTNAME}/dbapi/v4/load_jobs")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/load_jobs",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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,
      auto_create_table: {execute: 'yes', column_names: ['<ADD STRING VALUE>']},
      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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"load_source\":\"SERVER\",\"load_action\":\"INSERT\",\"schema\":\"<ADD STRING VALUE>\",\"table\":\"<ADD STRING VALUE>\",\"max_row_count\":0,\"max_warning_count\":1000,\"auto_create_table\":{\"execute\":\"yes\",\"column_names\":[\"<ADD STRING VALUE>\"]},\"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}"
        }
    
    conn.request("POST", "/dbapi/v4/load_jobs", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/load_jobs   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"load_source":"SERVER","load_action":"INSERT","schema":"<ADD STRING VALUE>","table":"<ADD STRING VALUE>","max_row_count":0,"max_warning_count":1000,"auto_create_table":{"execute":"yes","column_names":["<ADD STRING VALUE>"]},"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

Confirmation of load job created

Status Code

  • load jobs.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns details about a load job including its progress

Returns details about a load job including its progress.

GET /load_jobs/{id}

Request

Path Parameters

  • Load job ID

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/load_jobs/{id}")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/load_jobs/{id}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/load_jobs/{id}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/load_jobs/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Information about a data load job

Status Code

  • Data load job

  • Not authorized to access load job

  • Job not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Removes load job from history

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

  • Load job ID

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/load_jobs/{id}")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/load_jobs/{id}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/load_jobs/{id}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/load_jobs/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Load job deleted

  • Not authorized to delete load job

  • Job not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Dowloads log file for a data load job

Downloads log file for a data load job

GET /load_jobs/{id}/log

Request

Path Parameters

  • Load job ID

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/load_jobs/{id}/log"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "file")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/load_jobs/{id}/log")
      .get()
      .addHeader("content-type", "file")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/load_jobs/{id}/log",
      "headers": {
        "content-type": "file",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "file",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/load_jobs/{id}/log", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/load_jobs/{id}/log   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: file'

Response

Status Code

  • Log file

  • Not authorized to access load log

  • Log not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Lists all schemas in the database

Returns a list of schemas.

GET /schemas

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/schemas"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/schemas")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/schemas",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/schemas", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/schemas   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Collection of schemas

Status Code

  • List of schemas

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns schema information

Returns schema information.

GET /schemas/{schema_name}

Request

Path Parameters

  • Schema name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/schemas/SYSIBM",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/schemas/SYSIBM", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Schema information

  • Schema not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Lists tables in a schema

Returns the list of tables in a schema.

GET /schemas/{schema_name}/tables

Request

Path Parameters

  • Schema name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM/tables"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM/tables")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/schemas/SYSIBM/tables",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/schemas/SYSIBM/tables", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM/tables   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Collection of tables

Status Code

  • List of tables

  • Database or schema not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns information about a table

Return information about a table.

GET /schemas/{schema_name}/tables/{table_name}

Request

Path Parameters

  • Schema name

  • Table name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM/tables/SYSROLES"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM/tables/SYSROLES")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/schemas/SYSIBM/tables/SYSROLES",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/schemas/SYSIBM/tables/SYSROLES", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/schemas/SYSIBM/tables/SYSROLES   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Includes table definition and statistics. Note that statistics such as row count and size are not updated real time. Check the stats_timestamp value to know how current that information is.

Status Code

  • Table information

  • Table not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Deletes all table data

Deletes all table data using a TRUNCATE operation.

DELETE /schemas/{schema_name}/tables/{table_name}/data

Request

Path Parameters

  • Schema name

  • Table name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/schemas/NOT_EXIST_SCHEMA/tables/NOT_EXIST_TABLE/data"
    
    	req, _ := http.NewRequest("DELETE", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/schemas/NOT_EXIST_SCHEMA/tables/NOT_EXIST_TABLE/data")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/schemas/NOT_EXIST_SCHEMA/tables/NOT_EXIST_TABLE/data",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/schemas/NOT_EXIST_SCHEMA/tables/NOT_EXIST_TABLE/data", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/schemas/NOT_EXIST_SCHEMA/tables/NOT_EXIST_TABLE/data   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Success

  • Not authorized to access table data

  • Table not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query the list of object schemas

Query the list of object schemas.

GET /admin/schemas/obj_type/{obj_type}

Request

Path Parameters

  • Object type.

    Allowable values: [table,hadooptable,view,mqt,alias,sequence,procedure,nickname,udt,function]

Query Parameters

  • Object type.

  • Whether to show system objects.

    Allowable values: [true,false]

  • The amount of return records.

    Default: 500

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Status Code

  • Query the list of object schemas.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Create schema

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

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/schemas")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"name\":\"TESTSCHEMA\",\"authorization\":\"SYSIBM\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/schemas", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/admin/schemas   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"name":"TESTSCHEMA","authorization":"SYSIBM"}'

Response

Status Code

  • Schema created.

  • Invalid parameters or schema already exists

  • Only administrators can create schemas directly.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drops an empty schema

Drops an empty schema. An error is returned if the schema contains any objects.

DELETE /admin/schemas

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "[{\"name\":\"TESTSCHEMA\"}]");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas")
      .delete(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"name\":\"TESTSCHEMA\"}]"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/schemas", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/schemas   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"name":"TESTSCHEMA"}]'

Response

Status Code

  • The schema was dropped successfully.

  • Invalid parameters.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get single object privilege

Get single object privilege.

GET /admin/privileges

Request

Query Parameters

  • Object type.

    Allowable values: [TABLE,VIEW,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,SCHEMA,UDT]

  • Schema name of the object. For table and database, this parameter is not required.

  • Name of the object. For database, this parameter is not required.

  • The amount of return records.

    Default: 1000

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Status Code

  • Get object privilege.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Privilege list of selected objects

Privilege list of selected objects.

POST /admin/privileges

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"obj_type\":\"VIEW\",\"rows_return\":10,\"filter\":[{\"schema\":\"SYSCAT\",\"obj_name\":\"TABLES\"}]}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/privileges", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/admin/privileges   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"obj_type":"VIEW","rows_return":10,"filter":[{"schema":"SYSCAT","obj_name":"TABLES"}]}'

Response

Status Code

  • Privilege list of selected objects

  • Get error when search authid

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revoke privileges

Grant or revoke privileges

PUT /admin/privileges

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("PUT", "/dbapi/v4/admin/privileges", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/admin/privileges   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -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

Status Code

  • The status of grant or revoke

  • Get error when grant or revoke

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate schema DDL

Generate schema DDL.

POST /admin/schemas/ddl

Request

Query Parameters

  • Type of operation.

    Allowable values: [more]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/schemas/ddl?action=more"
    
    	payload := strings.NewReader("{\"objects\":[{\"schema\":\"SCHEMA_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"objects\":[{\"schema\":\"SCHEMA_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/ddl?action=more")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/ddl?action=more",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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({objects: [{schema: 'SCHEMA_NAME'}], options: [{}], stat_terminator: ';'}));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"objects\":[{\"schema\":\"SCHEMA_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/schemas/ddl?action=more", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/schemas/ddl?action=more'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"objects":[{"schema":"SCHEMA_NAME"}],"options":[{}],"stat_terminator":";"}'

Response

Status Code

  • Generate schema DDL.

  • Invalid parameters.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Create a new table

Create a new table.

PUT /admin/tables

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/tables")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tables",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("PUT", "/dbapi/v4/admin/tables", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/admin/tables   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"TABLE_SCHEMA","table":"TABLE_NAME","column_info":[{"data_type":"DECIMAL","length":5,"scale":{},"column_name":"COL_NAME","nullable":true}]}'

Response

Status Code

  • The table was created successfully.

  • Invalid parameters.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop table

Drop table.

DELETE /admin/tables

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/tables")
      .delete(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tables",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\"}]"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/tables", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/tables   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"TABLE_SCHEMA","table":"TABLE_NAME"}]'

Response

Status Code

  • The alias was dropped successfully.

  • Invalid parameters.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get table definition

Get table definition.

GET /admin/schemas/{schema_name}/tables/{table_name}/definition

Request

Path Parameters

  • Schema name of the object.

  • Table name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get table definition.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query table data

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 of the object.

  • Table name.

Query Parameters

  • The amount of return records.

    Default: 1000

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/data?rows_return=1000'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get column detail properties

Get column detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/columns/{column_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Table name.

  • Column name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/columns/CREATE_TIME/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get column detail properties.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the metadata type

Get the metadata type.

GET /admin/tables/meta/datatype

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tables/meta/datatype")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tables/meta/datatype",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/tables/meta/datatype", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/tables/meta/datatype   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get the metadata type.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate table DDL

Generate table DDL.

POST /admin/tables/ddl

Request

Query Parameters

  • Type of operation.

    Allowable values: [create,alter,more]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}],\"objects\":[{\"schema\":\"TABLE_SCHEMA\",\"name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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}],\"objects\":[{\"schema\":\"TABLE_SCHEMA\",\"name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tables/ddl?action=create",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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
        }
      ],
      objects: [{schema: 'TABLE_SCHEMA', name: 'TABLE_NAME'}],
      options: [{}],
      stat_terminator: ';'
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"schema\":\"TABLE_SCHEMA\",\"table\":\"TABLE_NAME\",\"column_info\":[{\"data_type\":\"DECIMAL\",\"length\":5,\"scale\":{},\"column_name\":\"COL_NAME\",\"nullable\":true}],\"objects\":[{\"schema\":\"TABLE_SCHEMA\",\"name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/tables/ddl?action=create", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/tables/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"TABLE_SCHEMA","table":"TABLE_NAME","column_info":[{"data_type":"DECIMAL","length":5,"scale":{},"column_name":"COL_NAME","nullable":true}],"objects":[{"schema":"TABLE_SCHEMA","name":"TABLE_NAME"}],"options":[{}],"stat_terminator":";"}'

Response

Status Code

  • Generate table DDL.

  • Invalid parameters.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get distributin keys

Get distributin keys.

GET /admin/schemas/{schema_name}/tables/{table_name}/distribution_keys

Request

Path Parameters

  • Schema name of the table.

  • Name of the table.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distribution_keys   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get distributin keys.

  • Invalid parameters.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get data distributin property

Get data distributin property.

GET /admin/schemas/{schema_name}/tables/{table_name}/distributions/properties

Request

Path Parameters

  • Schema name of the table.

  • Name of the table.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/distributions/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get data distributin property.

  • Invalid parameters.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get partition expressions

Get partition expressions.

GET /admin/schemas/{schema_name}/tables/{table_name}/partitions/expressions

Request

Path Parameters

  • Schema name of the table.

  • Name of the table.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions/expressions   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get partition expressions.

  • Invalid parameters.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get data partitions

Get data partitions.

GET /admin/schemas/{schema_name}/tables/{table_name}/partitions

Request

Path Parameters

  • Schema name of the table.

  • Name of the table.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/partitions   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get data partitions.

  • Invalid parameters.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query view detail properties

Query view detail properties.

GET /admin/schemas/{schema_name}/views/{view_name}/properties

Request

Path Parameters

  • Schema name of the view.

  • Name of the view.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Query view detail properties.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop views

Drop views.

DELETE /admin/views

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/views")
      .delete(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/views",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\"}]"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/views", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/views   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"VIEW_SCHEMA","view":"VIEW_NAME"}]'

Response

Status Code

  • The alias was dropped successfully.

  • Run sql exception.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query view data

Query view data.

GET /admin/schemas/{schema_name}/views/{view_name}/data

Request

Path Parameters

  • Schema name of the object.

  • View name.

Query Parameters

  • The amount of return records.

    Default: 1000

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/data?rows_return=100'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get View definition

Get view definition.

GET /admin/schemas/{schema_name}/views/{view_name}/definition

Request

Path Parameters

  • Schema name of the object.

  • View name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get View definition.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate view DDL

Generate view DDL.

POST /admin/views/ddl

Request

Query Parameters

  • Type of operation.

    Allowable values: [create,alter,more]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/views/ddl?action=create"
    
    	payload := strings.NewReader("{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\",\"objects\":[{\"schema\":\"VIEW_SCHEMA\",\"name\":\"VIEW_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\",\"objects\":[{\"schema\":\"VIEW_SCHEMA\",\"name\":\"VIEW_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/views/ddl?action=create")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/views/ddl?action=create",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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',
      objects: [{schema: 'VIEW_SCHEMA', name: 'VIEW_NAME'}],
      options: [{}],
      stat_terminator: ';'
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"schema\":\"VIEW_SCHEMA\",\"view\":\"VIEW_NAME\",\"objects\":[{\"schema\":\"VIEW_SCHEMA\",\"name\":\"VIEW_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/views/ddl?action=create", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/views/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"VIEW_SCHEMA","view":"VIEW_NAME","objects":[{"schema":"VIEW_SCHEMA","name":"VIEW_NAME"}],"options":[{}],"stat_terminator":";"}'

Response

Status Code

  • Generate view DDL.

  • Invalid parameters.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the dependencies of the object

Get the dependencies of the object.

GET /admin/schemas/{schema_name}/{obj_type}/{object_name}/dependencies

Request

Path Parameters

  • Schema name of the object.

  • Type of object.

    Allowable values: [tables,views,nicknames,sequences,aliases,mqts,procedures,functions,udts]

  • Name of the object.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSCAT/views/TABLES/dependencies   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get the dependencies of the object.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the dependencies of the tablespace

Get the dependencies of the tablespace.

GET /admin/tablespaces/{tablespace}/dependencies

Request

Path Parameters

  • Tablespace name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/dependencies   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get the dependencies of the object.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query bufferpool detail properties

Query bufferpool detail properties.

GET /admin/bufferpools/{bufferpool_name}/properties

Request

Path Parameters

  • Name of the object.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/bufferpools/{bufferpool_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query constraint detail properties

Query constraint detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Table name.

  • Name of the constraint.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query index detail properties

Query index detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Table name.

  • Name of the index.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query trigger detail properties

Query trigger detail properties.

GET /admin/schemas/{schema_name}/triggers/{trigger_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Name of the trigger.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/triggers/{trigger_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query MQT detail properties

Query MQT detail properties.

GET /admin/schemas/{schema_name}/mqts/{mqt_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Name of the MQT.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query UDF detail properties

Query UDF detail properties.

GET /admin/schemas/{schema_name}/functions/{specific_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Name of the UDF.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/functions/{specific_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query tablespace detail properties

Query tablespace detail properties.

GET /admin/tablespaces/{table_space}/properties

Request

Path Parameters

  • Tablespace name of the object.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tablespaces/{table_space}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/tablespaces/{table_space}/properties", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/tablespaces/{table_space}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query procedure detail properties

Query procedure detail properties.

GET /admin/schemas/{schema_name}/procedures/{specific_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Name of the procedure.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/procedures/{specific_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query sequence detail properties

Query sequence detail properties.

GET /admin/schemas/{schema_name}/sequences/{sequence_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Name of the sequence.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/sequences/{sequence_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query package detail properties

Query package detail properties.

GET /admin/schemas/{schema_name}/packages/{package_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Name of the package.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/packages/{package_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query UDT detail properties

Query UDT detail properties.

GET /admin/schemas/{schema_name}/udts/{type_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Name of the user-defined type.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/{schema_name}/udts/{type_name}/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query alias detail properties

Query alias detail properties.

GET /admin/schemas/{schema_name}/aliases/{alias_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Alias name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Query alias detail properties.

  • Not authorized.

  • Schema or alias not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get table detail properties

Get table detail properties.

GET /admin/schemas/{schema_name}/tables/{table_name}/properties

Request

Path Parameters

  • Schema name of the object.

  • Table name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSIBM/tables/SYSROLES/properties   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get table detail properties.

  • Not authorized.

  • Object not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Create alias

Create alias.

PUT /admin/aliases

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/aliases")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/aliases",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("PUT", "/dbapi/v4/admin/aliases", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/admin/aliases   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"base_obj_schema":"SYSCAT","base_obj_name":"TABLES","alias_name":"ALIAS_NAME","alias_schema":"ALIAS_SCHEMA"}'

Response

Status Code

  • The alias was created successfully.

  • Invalid parameters.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop alias

Drop alias.

DELETE /admin/aliases

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/aliases")
      .delete(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/aliases",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"ALIAS_SCHEMA\",\"alias\":\"ALIAS_NAME\"}]"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/aliases", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/aliases   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"ALIAS_SCHEMA","alias":"ALIAS_NAME"}]'

Response

Status Code

  • The alias was dropped successfully.

  • Invalid parameters or run sql exception.

  • Not authorized.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Generate Alias DDL

Generate Alias DDL.

POST /admin/aliases/ddl

Request

Query Parameters

  • Type of operation.

    Allowable values: [create,more]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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\",\"objects\":[{\"schema\":\"ALIAS_SCHEMA\",\"name\":\"ALIAS_NAME\",\"base_schema\":\"TABLE_SCHEMA\",\"base_name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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\",\"objects\":[{\"schema\":\"ALIAS_SCHEMA\",\"name\":\"ALIAS_NAME\",\"base_schema\":\"TABLE_SCHEMA\",\"base_name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/aliases/ddl?action=create",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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',
      objects: [
        {
          schema: 'ALIAS_SCHEMA',
          name: 'ALIAS_NAME',
          base_schema: 'TABLE_SCHEMA',
          base_name: 'TABLE_NAME'
        }
      ],
      options: [{}],
      stat_terminator: ';'
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"base_obj_schema\":\"SYSCAT\",\"base_obj_name\":\"TABLES\",\"alias_name\":\"ALIAS_NAME\",\"alias_schema\":\"ALIAS_SCHEMA\",\"objects\":[{\"schema\":\"ALIAS_SCHEMA\",\"name\":\"ALIAS_NAME\",\"base_schema\":\"TABLE_SCHEMA\",\"base_name\":\"TABLE_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/aliases/ddl?action=create", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/aliases/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"base_obj_schema":"SYSCAT","base_obj_name":"TABLES","alias_name":"ALIAS_NAME","alias_schema":"ALIAS_SCHEMA","objects":[{"schema":"ALIAS_SCHEMA","name":"ALIAS_NAME","base_schema":"TABLE_SCHEMA","base_name":"TABLE_NAME"}],"options":[{}],"stat_terminator":";"}'

Response

Status Code

  • Generate Alias DDL.

  • Invalid parameters.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query alias data

Query alias data.

GET /admin/schemas/{schema_name}/aliases/{alias_name}/data

Request

Path Parameters

  • Schema name of the object.

  • Alias name.

Query Parameters

  • The amount of return records.

    Default: 1000

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/schemas/SYSPUBLIC/aliases/DUAL/data?rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Not authorized.

  • Schema or alias not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the SQL statement template for creating MQT table

Get the SQL statement template for creating MQT table.

POST /admin/mqts/ddl

Request

Query Parameters

  • Allowable values: [create,more]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE"
    
    	payload := strings.NewReader("{\"schema\":\"schemaName\",\"objects\":[{\"schema\":\"MQT_SCHEMA\",\"name\":\"MQT_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"schemaName\",\"objects\":[{\"schema\":\"MQT_SCHEMA\",\"name\":\"MQT_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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',
      objects: [{schema: 'MQT_SCHEMA', name: 'MQT_NAME'}],
      options: [{}],
      stat_terminator: ';'
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"schema\":\"schemaName\",\"objects\":[{\"schema\":\"MQT_SCHEMA\",\"name\":\"MQT_NAME\"}],\"options\":[{}],\"stat_terminator\":\";\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/mqts/ddl?action=SOME_STRING_VALUE'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"schemaName","objects":[{"schema":"MQT_SCHEMA","name":"MQT_NAME"}],"options":[{}],"stat_terminator":";"}'

Response

Status Code

  • The SQL statement of creating MQT table

  • Get error when create MQT table

  • Error payload

No Sample Response

This method does not specify any sample responses.

Delete mqt tables

Delete mqt tables.

DELETE /admin/mqts

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/mqts")
      .delete(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/mqts",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"schemaName\",\"mqt\":\"mqtName\"}]"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/mqts", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/mqts   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"schemaName","mqt":"mqtName"}]'

Response

Status Code

  • The status of deleting MQT tables

  • Error payload

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the definition of MQT table

Get the definition of MQT table.

GET /admin/schemas/{schema_name}/mqts/{mqt_name}/definition

Request

Path Parameters

  • Schema name

  • mqt name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/DB2GSE/mqts/GSE_SRS_REPLICATED_AST/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Definition of MTQ table

  • Error information when get mqt definition

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the data of specified mqt table

Get the data of specified mqt table.

GET /admin/schemas/{schema_name}/mqts/{mqt_name}/data

Request

Path Parameters

Query Parameters

  • Default: 1000

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Status Code

  • Get the data of MQT table,include table columns information and data

  • Error information when get mqt data

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get authentications through the authid filter

Get authentications through the authid filter

GET /admin/privileges/authentications

Request

Query Parameters

  • 0 means return all query results

    Default: 0

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/privileges/authentications?rows_return=10&authid=PUBLIC'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • The list of authid and authid type

  • Get error when search authid

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the privieles of auth id

Get the privieles of auth id

GET /admin/privileges/{authid_type}/{authid}/{obj_type}

Request

Path Parameters

  • authid type

    Allowable values: [GROUP,USER,ROLE]

  • Authorization id.

  • Type of object

    Allowable values: [VIEW,TABLE,DATABASE,PROCEDURE,FUNCTION,MQT,SEQUENCE,HADOOP_TABLE,NICKNAME,TABLESPACE]

Query Parameters

  • Default: 1000

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/privileges/GROUP/PUBLIC/VIEW?rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Returned result was successful.

  • Get error when get privileges

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get SQL statement of grant or revoke privileges

Get SQL statement of grant or revoke privileges

POST /admin/privileges/dcl

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges/dcl")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/dcl",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/privileges/dcl", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/admin/privileges/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"SYSCAT","obj_name":"TABLES","obj_type":"VIEW","grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["select"],"revoke":["insert"]}]'

Response

Status Code

  • SQL statement for grant or revoke privileges

  • Get error when get privileges

  • Error payload

No Sample Response

This method does not specify any sample responses.

Add new role

Add new role

POST /admin/privileges/roles

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"authid\":\"authid\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/roles",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"authid\":\"authid\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/privileges/roles", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/admin/privileges/roles   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"authid":"authid"}'

Response

Status Code

  • The status of adding new role

  • Get error when add new roles

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revoke the privilges of role

Grant or revoke the privilges of role

PUT /admin/privileges/roles

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges/roles")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/roles",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("PUT", "/dbapi/v4/admin/privileges/roles", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/admin/privileges/roles   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -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

Status Code

  • The status of grant or revoke the role's privileges

  • Error payload

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Delete one role

Delete one role

DELETE /admin/privileges/roles/{role_name}

Request

Path Parameters

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/roles/roleName",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/privileges/roles/roleName", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/roleName   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • The status of deleting one role

  • Error payload

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the membership of authid

Get the membership of authid

GET /admin/privileges/roles/{authid_type}/{authid}

Request

Path Parameters

  • authid type

    Allowable values: [USER,GROUP,ROLE]

  • authid

Query Parameters

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/GROUP/PUBLIC?rows_return=10'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • The membership of one auth

  • Error payload

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get SQL statement of grant or revoke role

Get SQL statement of grant or revoke role

POST /admin/privileges/roles/dcl

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/roles/dcl",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/privileges/roles/dcl", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/admin/privileges/roles/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"grantee":{"authid":"PUBLIC","authid_type":"GROUP"},"grant":["<ADD STRING VALUE>"],"revoke":["<ADD STRING VALUE>"]}]'

Response

Status Code

  • The SQL statement of grant or revoke role

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get SQL statement for grant or revoke privileges

Get SQL statement for grant or revoke privileges

POST /admin/privileges/multiple_objtypes/dcl

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/multiple_objtypes/dcl",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/privileges/multiple_objtypes/dcl", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -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

Status Code

  • The SQL statement for grant or revoke privileges

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revole privileges for multiple objects and objects type

Grant or revole privileges for multiple objects and objects type

PUT /admin/privileges/multiple_objtypes

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/multiple_objtypes",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("PUT", "/dbapi/v4/admin/privileges/multiple_objtypes", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_objtypes   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -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

Status Code

  • The status of grant or revoke privileges

  • Error payload

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the SQL statement for grant or revoke multiple roles

Get the SQL statement for grant or revoke multiple roles

POST /admin/privileges/multiple_roles/dcl

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/multiple_roles/dcl",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"grantee\":[{\"authid\":\"PUBLIC\",\"authid_type\":\"GROUP\"}],\"grant\":[\"SYSTS_USR\"],\"revoke\":[\"SYSTS_USR\"]}]"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/privileges/multiple_roles/dcl", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles/dcl   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"grant":["SYSTS_USR"],"revoke":["SYSTS_USR"]}]'

Response

Status Code

  • The SQL statement for grant or revoke multiple roles

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Grant or revoke multiple roles

Grant or revoke multiple roles

PUT /admin/privileges/multiple_roles

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/privileges/multiple_roles",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("PUT", "/dbapi/v4/admin/privileges/multiple_roles", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/admin/privileges/multiple_roles   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"privileges":[{"grantee":[{"authid":"PUBLIC","authid_type":"GROUP"}],"grant":["SYSTS_USR"],"revoke":["SYSTS_USR"]}],"stop_on_error":false}'

Response

Status Code

  • The status of grant or revoke roles

  • Error payload

  • Error payload

  • Error payload

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate workload DDL

Generate workload DDL.

POST /admin/workloads/ddl

Request

Query Parameters

  • Type of operation.

    Allowable values: [create]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/workloads/ddl?action=create",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"categorization\":\"GetWorkloadDDLTemplate\",\"enable_coll_act_data\":true}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/workloads/ddl?action=create", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/workloads/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"categorization":"GetWorkloadDDLTemplate","enable_coll_act_data":true}'

Response

Status Code

  • Return the ddl of creating workloads.

  • Invalid parameters or miss some parameters

  • Error payload

No Sample Response

This method does not specify any sample responses.

Lists workloads

Returns the list of workloads.

GET /admin/workloads

Request

Query Parameters

  • The amount of return records.

    Default: 1000

  • Workload name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/workloads?rows_return=10&search_name=SEARCH_NAME'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Return the list of workloads

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop sequences

Drop sequences

DELETE /admin/sequences

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/sequences")
      .delete(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/sequences",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"SEQUENCE_SCHEMA\",\"sequence\":\"SEQUENCE_NAME\"}]"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/sequences", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/sequences   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"SEQUENCE_SCHEMA","sequence":"SEQUENCE_NAME"}]'

Response

Status Code

  • The status of dropping sequences

  • Faile to drop sequences

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop procedures

Drop procedures

DELETE /admin/procedures

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/procedures")
      .delete(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/procedures",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"PROCEDURE_SCHEMA\",\"procedure\":\"PROCEDURE_NAME\"}]"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/procedures", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/procedures   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"PROCEDURE_SCHEMA","procedure":"PROCEDURE_NAME"}]'

Response

Status Code

  • Delete procedure successfully

  • Faile to drop procedures

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Retrieve parameters for procedure

Retrieve parameters for procedure.

GET /admin/schemas/{schema_name}/procedures/{specific_name}/parameters

Request

Path Parameters

  • The schema name of the procedure

  • The specificname of procedure

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/PROCEDURE_SCHEMA/procedures/PROCEDURE_NAME/parameters   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Retrieve parameters for procedure.

  • Error information when get procedure parameters.

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate create procedure template

POST /admin/procedures/ddl

Request

Query Parameters

  • Allowable values: [create]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create")
      .post(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/procedures/ddl?action=create",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"schema\":\"PROCEDURE_SCHEMA\"}"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/procedures/ddl?action=create", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/procedures/ddl?action=create'   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"PROCEDURE_SCHEMA"}'

Response

Status Code

  • Generate the template of creating procedure

  • Faile to generate create procedure template

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop functions

Drop functions

DELETE /admin/functions

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/functions")
      .delete(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/functions",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"UDT_SCHEMA\",\"function\":\"UDT_NAME\"}]"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/functions", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/functions   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"UDT_SCHEMA","function":"UDT_NAME"}]'

Response

Status Code

  • Delete function successfully

  • Faile to drop functions

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Retrieve parameters for specific udf

Retrieve parameters for specific udf.

GET /admin/schemas/{schema_name}/functions/{specific_name}/parameters

Request

Path Parameters

  • The schema name of the function.

  • The specific name of function.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/UDF_SCHEMA/functions/UDF_NAME/parameters   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Retrieve parameters for specific udf.

  • Error information when get procedure parameters

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate create function template

POST /admin/functions/ddl

Request

Query Parameters

  • Allowable values: [create]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create")
      .post(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/functions/ddl?action=create",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"schema\":\"UDF_SCHEMA\"}"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/functions/ddl?action=create", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/functions/ddl?action=create'   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"UDF_SCHEMA"}'

Response

Status Code

  • Generate the template of creating function.

  • Faile to generate create function template.

  • SQLException

  • SQLException

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop User-defined Types

Drop User-defined Types

DELETE /admin/udts

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/udts")
      .delete(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/udts",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "[{\"schema\":\"UDT_SCHEMA\",\"udt\":\"UDT_NAME\"}]"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/udts", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/udts   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '[{"schema":"UDT_SCHEMA","udt":"UDT_NAME"}]'

Response

Status Code

  • The UDTs was dropped successfully.

  • Invalid parameters or run sql exception.

  • Not authorized.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Retrieve row definition for User-defined Type object

Retrieve row definition for User-defined Type object

GET /admin/schemas/{schema_name}/udts/{udt_name}/definition

Request

Path Parameters

  • The schema name of User-defined Type.

  • The name of User-defined Type.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/schemas/UDT_SCHEMA/udts/UDT_NAME/definition   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Retrieve row definition for User-defined Type object.

  • Not authorized.

  • Schema or alias not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate Create User-defined Types template

Generate Create User-defined Types template.

POST /admin/udts/ddl

Request

Query Parameters

  • Type of operation.

    Allowable values: [create]

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/udts/ddl?action=create",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"schema\":\"UDT_SCHEMA\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/admin/udts/ddl?action=create", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   'https://{HOSTNAME}/dbapi/v4/admin/udts/ddl?action=create'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"UDT_SCHEMA"}'

Response

Status Code

  • Generate Create User-defined Types template.

  • Not authorized.

  • Schema or alias not found.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Query the list of tablespace

Query the list of tablespace.

GET /admin/tablespaces

Request

Query Parameters

  • Tablespace name.

  • The amount of return records.

    Default: 500

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/tablespaces?search_name=SYSCATSPACE&rows_return=50"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces?search_name=SYSCATSPACE&rows_return=50")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tablespaces?search_name=SYSCATSPACE&rows_return=50",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/tablespaces?search_name=SYSCATSPACE&rows_return=50", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/admin/tablespaces?search_name=SYSCATSPACE&rows_return=50'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Query the list of tablespace.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Drop tablespaces

Drop tablespaces.

DELETE /admin/tablespaces

Request

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/tablespaces"
    
    	payload := strings.NewReader("{\"tablespaces\":[\"TBSTEST\"]}")
    
    	req, _ := http.NewRequest("DELETE", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"tablespaces\":[\"TBSTEST\"]}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces")
      .delete(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tablespaces",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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({tablespaces: ['TBSTEST']}));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"tablespaces\":[\"TBSTEST\"]}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/admin/tablespaces", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/admin/tablespaces   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"tablespaces":["TBSTEST"]}'

Response

Status Code

  • The tablespaces was dropped successfully.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the I/O settings of the tablespace

Get the I/O settings of the tablespace.

GET /admin/tablespaces/{tablespace}/iosetting

Request

Path Parameters

  • Tablespace name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/iosetting"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/iosetting")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tablespaces/SYSCATSPACE/iosetting",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/tablespaces/SYSCATSPACE/iosetting", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/iosetting   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get the I/O settings of the tablespace.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the tablespace size

Get the tablespace size.

GET /admin/tablespaces/{tablespace}/size

Request

Path Parameters

  • Tablespace name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/size"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/size")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/admin/tablespaces/SYSCATSPACE/size",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/admin/tablespaces/SYSCATSPACE/size", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/admin/tablespaces/SYSCATSPACE/size   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Get the tablespace size.

  • Not authorized.

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate visual explain model for a given sql

Generate visual explain model for a given sql.

POST /explain/explain_model

Request

The SQL query to be explained.

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/explain/explain_model"
    
    	payload := strings.NewReader("{\"schema\":\"sysibm\",\"sql\":\"select * from sysibm.systables where name ='a'\",\"profileName\":\"<ADD STRING VALUE>\",\"showRecomm\":false}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"schema\":\"sysibm\",\"sql\":\"select * from sysibm.systables where name ='a'\",\"profileName\":\"<ADD STRING VALUE>\",\"showRecomm\":false}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/explain/explain_model")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/explain/explain_model",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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: 'sysibm',
      sql: 'select * from sysibm.systables where name =\'a\'',
      profileName: '<ADD STRING VALUE>',
      showRecomm: false
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"schema\":\"sysibm\",\"sql\":\"select * from sysibm.systables where name ='a'\",\"profileName\":\"<ADD STRING VALUE>\",\"showRecomm\":false}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/explain/explain_model", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/explain/explain_model   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"schema":"sysibm","sql":"select * from sysibm.systables where name ='\''a'\''","profileName":"<ADD STRING VALUE>","showRecomm":false}'

Response

Session id of visual explain

Status Code

  • return visual explain session id

  • Invalid parameters or invalid content type

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get visual explain nodes information

Get visual explain nodes including id and label information.

GET /explain/explain_model/{sessionId}/diagram/nodes/

Request

Path Parameters

  • The session id that used to generate the basic node information of visual explain.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

todo

Status Code

  • Return the ids and labels in visual explain

  • Invalid parameters or invalid content type

  • Error payload

No Sample Response

This method does not specify any sample responses.

Generate visual explain layout

Generate visual explain laytout.

POST /explain/explain_model/{sessionId}/diagram/layout

Request

Path Parameters

  • The session id that used to generate the basic node information of visual explain.

The ids and labels and their height and width of font that used to generate the layout of visual explain.

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/layout"
    
    	payload := strings.NewReader("{\"containerWidth\":0,\"idFontHeight\":0,\"ids\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}],\"label1FontHeight\":0,\"label1s\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}],\"label2s\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}]}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"containerWidth\":0,\"idFontHeight\":0,\"ids\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}],\"label1FontHeight\":0,\"label1s\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}],\"label2s\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}]}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/layout")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/explain/explain_model/{sessionId}/diagram/layout",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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({
      containerWidth: 0,
      idFontHeight: 0,
      ids: [{text: '<ADD STRING VALUE>', width: 0}],
      label1FontHeight: 0,
      label1s: [{text: '<ADD STRING VALUE>', width: 0}],
      label2s: [{text: '<ADD STRING VALUE>', width: 0}]
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"containerWidth\":0,\"idFontHeight\":0,\"ids\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}],\"label1FontHeight\":0,\"label1s\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}],\"label2s\":[{\"text\":\"<ADD STRING VALUE>\",\"width\":0}]}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/explain/explain_model/{sessionId}/diagram/layout", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/layout   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"containerWidth":0,"idFontHeight":0,"ids":[{"text":"<ADD STRING VALUE>","width":0}],"label1FontHeight":0,"label1s":[{"text":"<ADD STRING VALUE>","width":0}],"label2s":[{"text":"<ADD STRING VALUE>","width":0}]}'

Response

The laytout information of visual explain

Status Code

  • Return the layout information in visual explain

  • Invalid parameters or invalid content type

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get the data of the selected node

Get the data of the selected node

GET /explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description

Request

Path Parameters

  • The session id that used to get the node description of visual explain.

  • The node id that used to get the node description of visual explain.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

The description of the selected node in the visual explain

Status Code

  • Return the description of the selected node

  • Invalid parameters or invalid content type

  • Error payload

No Sample Response

This method does not specify any sample responses.

Search node based on the key word and predefined rule

Search node based on the key word and predefined rule

GET /explain/explain_model/search/{sessionId}/{namePattern}

Request

Path Parameters

  • The session id that used to get the node description of visual explain.

  • The key word to search node.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/explain/explain_model/search/{sessionId}/{namePattern}"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/explain/explain_model/search/{sessionId}/{namePattern}")
      .get()
      .addHeader("content-type", "application/json")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/explain/explain_model/search/{sessionId}/{namePattern}",
      "headers": {
        "content-type": "application/json"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = { 'content-type': "application/json" }
    
    conn.request("GET", "/dbapi/v4/explain/explain_model/search/{sessionId}/{namePattern}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/explain/explain_model/search/{sessionId}/{namePattern}   -H 'content-type: application/json'

Response

The description of the selected node in the visual explain

Status Code

  • Return the list of nodes

  • Error payload

No Sample Response

This method does not specify any sample responses.

Search node based on the key word and predefined rule

Search node based on the key word and predefined rule

POST /explain/explain_model/search/{sessionId}

Request

Path Parameters

  • The session id that used to get the node description of visual explain.

The key word and predefined rule to search node

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/explain/explain_model/search/{sessionId}"
    
    	payload := strings.NewReader("{\"advanacedSearchRequests\":[{\"type\":\"COMMON.SEARCHBY.NODE_NAME\"}],\"namePattern\":\"<ADD STRING VALUE>\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"advanacedSearchRequests\":[{\"type\":\"COMMON.SEARCHBY.NODE_NAME\"}],\"namePattern\":\"<ADD STRING VALUE>\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/explain/explain_model/search/{sessionId}")
      .post(body)
      .addHeader("content-type", "application/json")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/explain/explain_model/search/{sessionId}",
      "headers": {
        "content-type": "application/json"
      }
    };
    
    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({
      advanacedSearchRequests: [{type: 'COMMON.SEARCHBY.NODE_NAME'}],
      namePattern: '<ADD STRING VALUE>'
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"advanacedSearchRequests\":[{\"type\":\"COMMON.SEARCHBY.NODE_NAME\"}],\"namePattern\":\"<ADD STRING VALUE>\"}"
    
    headers = { 'content-type': "application/json" }
    
    conn.request("POST", "/dbapi/v4/explain/explain_model/search/{sessionId}", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/explain/explain_model/search/{sessionId}   -H 'content-type: application/json'   -d '{"advanacedSearchRequests":[{"type":"COMMON.SEARCHBY.NODE_NAME"}],"namePattern":"<ADD STRING VALUE>"}'

Response

The description of the selected node in the visual explain

Status Code

  • Return the list of nodes

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns metadata of an item in the user's home storage

Returns metadata of an item files and folders stored in the user's home storage. Only support file with suffix '.csv','.txt','dat' and 'del'.

GET /home/{path}

Request

Path Parameters

  • Path of a file or folder

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/home/{path}"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/home/{path}")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/home/{path}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/home/{path}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/home/{path}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Describes a file or folder.

Status Code

  • Metadata about a file or folder

  • File or folder not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Deletes a file in the user's home storage

Deletes a file in the user's home storage

DELETE /home/{path}

Request

Path Parameters

  • File path

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/home/{path}")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/home/{path}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/home/{path}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/home/{path}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • File deleted

  • Error payload

No Sample Response

This method does not specify any sample responses.

Download file from user's home storage

Download file from user's home storage.

GET /home_content/{path}

Request

Custom Headers

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

Path Parameters

  • File path

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/home_content/{path}"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/octet-stream")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/home_content/{path}")
      .get()
      .addHeader("content-type", "application/octet-stream")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/home_content/{path}",
      "headers": {
        "content-type": "application/octet-stream",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/octet-stream",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/home_content/{path}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/home_content/{path}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/octet-stream'

Response

Describes a file or folder.

Status Code

  • Metadata about a file or folder

  • File not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Uploads a file to the user's home storage

Uploads a file to a folder under the user's home storage. The target folder is automatically created if it does not exit.

POST /home_content/{path}

Request

Path Parameters

  • Target folder

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/home_content/{path}")
      .post(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/home_content/{path}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/home_content/{path}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/home_content/{path}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Describes a file or folder.

Status Code

  • Files successfully uploaded

  • Error payload

No Sample Response

This method does not specify any sample responses.

Retrieves current configuration

Returns current encryption key information.

GET /platform-keys/configurations

Request

Query Parameters

  • Cloud Resource Name (CRN) for db2 instance.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/platform-keys/configurations?db2_crn=SOME_STRING_VALUE"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/platform-keys/configurations?db2_crn=SOME_STRING_VALUE")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/platform-keys/configurations?db2_crn=SOME_STRING_VALUE",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/platform-keys/configurations?db2_crn=SOME_STRING_VALUE", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/platform-keys/configurations?db2_crn=SOME_STRING_VALUE'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Platform key current configuration

  • Bad request

  • Unauthorized

  • Forbidden, Db2 does not have access to the migrated key.

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Migrate key

Migrate existing key, from local key to Key Proect key or from one Key Protect key to another

POST /platform-keys/configurations

Request

key information

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/platform-keys/configurations"
    
    	payload := strings.NewReader("{\"kpInstance\":{\"kpInstanceID\":\"<ADD STRING VALUE>\",\"kpInstanceName\":\"<ADD STRING VALUE>\",\"kpRegion\":\"<ADD STRING VALUE>\"},\"kpKey\":{\"kpKeyID\":\"<ADD STRING VALUE>\",\"kpKeyName\":\"<ADD STRING VALUE>\"},\"db2CRN\":\"<ADD STRING VALUE>\"}")
    
    	req, _ := http.NewRequest("POST", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"kpInstance\":{\"kpInstanceID\":\"<ADD STRING VALUE>\",\"kpInstanceName\":\"<ADD STRING VALUE>\",\"kpRegion\":\"<ADD STRING VALUE>\"},\"kpKey\":{\"kpKeyID\":\"<ADD STRING VALUE>\",\"kpKeyName\":\"<ADD STRING VALUE>\"},\"db2CRN\":\"<ADD STRING VALUE>\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/platform-keys/configurations")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/platform-keys/configurations",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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({
      kpInstance: {
        kpInstanceID: '<ADD STRING VALUE>',
        kpInstanceName: '<ADD STRING VALUE>',
        kpRegion: '<ADD STRING VALUE>'
      },
      kpKey: {kpKeyID: '<ADD STRING VALUE>', kpKeyName: '<ADD STRING VALUE>'},
      db2CRN: '<ADD STRING VALUE>'
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"kpInstance\":{\"kpInstanceID\":\"<ADD STRING VALUE>\",\"kpInstanceName\":\"<ADD STRING VALUE>\",\"kpRegion\":\"<ADD STRING VALUE>\"},\"kpKey\":{\"kpKeyID\":\"<ADD STRING VALUE>\",\"kpKeyName\":\"<ADD STRING VALUE>\"},\"db2CRN\":\"<ADD STRING VALUE>\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/platform-keys/configurations", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/platform-keys/configurations   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"kpInstance":{"kpInstanceID":"<ADD STRING VALUE>","kpInstanceName":"<ADD STRING VALUE>","kpRegion":"<ADD STRING VALUE>"},"kpKey":{"kpKeyID":"<ADD STRING VALUE>","kpKeyName":"<ADD STRING VALUE>"},"db2CRN":"<ADD STRING VALUE>"}'

Response

Status Code

  • Key migrated

  • Bad request

  • Unauthorized

  • Forbidden, user has no permission for this API.

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns Key Protect instance information

Returns Key Protect instance information.

GET /platform-keys/instances

Request

Query Parameters

  • Cloud Resource Name (CRN) for db2 instance.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/platform-keys/instances?db2_crn=SOME_STRING_VALUE"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/platform-keys/instances?db2_crn=SOME_STRING_VALUE")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/platform-keys/instances?db2_crn=SOME_STRING_VALUE",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/platform-keys/instances?db2_crn=SOME_STRING_VALUE", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/platform-keys/instances?db2_crn=SOME_STRING_VALUE'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • KP instance information

  • Bad request

  • Unauthorized

  • Forbidden, user has no permission for this API.

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns keys for given Key Protect instance

Returns keys for given Key Protect instance

GET /platform-keys/instances/{instance_id}/region/{region_id}/keys

Request

Path Parameters

  • Key Protect instance id

  • Key Protect region id

Query Parameters

  • Cloud Resource Name (CRN) for db2 instance.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/platform-keys/instances/{instance_id}/region/{region_id}/keys?db2_crn=SOME_STRING_VALUE"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/platform-keys/instances/{instance_id}/region/{region_id}/keys?db2_crn=SOME_STRING_VALUE")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/platform-keys/instances/{instance_id}/region/{region_id}/keys?db2_crn=SOME_STRING_VALUE",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/platform-keys/instances/{instance_id}/region/{region_id}/keys?db2_crn=SOME_STRING_VALUE", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/platform-keys/instances/{instance_id}/region/{region_id}/keys?db2_crn=SOME_STRING_VALUE'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Keys for KP instance

  • Bad request

  • Unauthorized

  • Forbidden, user has no permission for this API.

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns overall status of system components

Returns overall status of system components.

GET /monitor

Request

Custom Headers

  • Database profile name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/monitor")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("x-db-profile", "SOME_STRING_VALUE")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/monitor",
      "headers": {
        "content-type": "application/json",
        "x-db-profile": "SOME_STRING_VALUE",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/monitor", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/monitor   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'

Response

Services status

Status Code

  • System status

  • Operation is only available to administrators

  • Error payload

No Sample Response

This method does not specify any sample responses.

Lists active database connections **DB ADMIN ONLY**

Returns a list of active database connections.

GET /monitor/connections

Request

Custom Headers

  • Database profile name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/monitor/connections")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("x-db-profile", "SOME_STRING_VALUE")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/monitor/connections",
      "headers": {
        "content-type": "application/json",
        "x-db-profile": "SOME_STRING_VALUE",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/monitor/connections", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/monitor/connections   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'

Response

Collection of active database connections

Status Code

  • Active connections

  • Operation is only available to administrators

  • Error payload

No Sample Response

This method does not specify any sample responses.

Terminates a database connection **DB ADMIN ONLY**

Terminates an active database connection.

DELETE /monitor/connections/{application_handle}

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Application handle name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/monitor/connections/{application_handle}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/monitor/connections/{application_handle}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'

Response

Status Code

  • Connection terminated

  • Operation is only available to administrators

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns current storage usage **DB ADMIN ONLY**

Returns current storage usage.

GET /monitor/storage

Request

Custom Headers

  • Database profile name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/monitor/storage")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("x-db-profile", "SOME_STRING_VALUE")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/monitor/storage",
      "headers": {
        "content-type": "application/json",
        "x-db-profile": "SOME_STRING_VALUE",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/monitor/storage", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/monitor/storage   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'

Response

Status Code

  • Storage usage

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns storage usage history **DB ADMIN ONLY**

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

  • Database profile name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/monitor/storage/history")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("x-db-profile", "SOME_STRING_VALUE")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/monitor/storage/history",
      "headers": {
        "content-type": "application/json",
        "x-db-profile": "SOME_STRING_VALUE",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/monitor/storage/history", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/monitor/storage/history   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'

Response

Collection of system storage stats

Status Code

  • Storage usage history

  • Error payload

No Sample Response

This method does not specify any sample responses.

Storage utilization by schema **DB ADMIN ONLY**

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

  • Database profile name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/monitor/storage/by_schema", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/monitor/storage/by_schema   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'

Response

Collection of schema's storage usage data

Status Code

  • Storage usage by schema

  • Operation is only available to administrators

  • Error payload

No Sample Response

This method does not specify any sample responses.

Storage utilization of a schema **DB ADMIN ONLY**

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

  • Database profile name.

Path Parameters

  • Schema name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/monitor/storage/by_schema/{schema_name}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{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'

Response

Status Code

  • Storage usage for a schema

  • Operation is only available to administrators

  • Schema does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Return the number of statements for a specified time frame. **DB ADMIN ONLY**

Return the number of statements for a specified time frame.

GET /metrics/statements_count

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Number of statements.

Status Code

  • Return the number of statements for a specified time frame.

  • Operation is only available to administrators.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Return the histogram of response time for a specified time frame. **DB ADMIN ONLY**

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

GET /metrics/response_time_histograms

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of histogram data.

Status Code

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

  • Database profile not found.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Return the average response time for a specified time frame. **DB ADMIN ONLY**

Return the average response time for a specified time frame.

GET /metrics/average_response_time

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Event monitor stats top.

Status Code

  • Return the average response time for a specified time frame.

  • Operation is only available to administrators.

  • 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. **DB ADMIN ONLY**

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

GET /metrics/response_time

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of AverageResponseTime.

Status Code

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

  • Database profile not found.

  • 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. **DB ADMIN ONLY**

Return the average number of statements executed every minutes for a specified time frame.

GET /metrics/average_statements_rate

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

SQL rate(sql/min).

Status Code

  • Return the average number of statements executed every minutes for a specified time frame

  • Operation is only available to administrators.

  • 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. **DB ADMIN ONLY**

Return numbers of statements executed every minutes for a specified time frame.

GET /metrics/statements_rate

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of SQL rate(sql/min).

Status Code

  • Return numbers of statements executed every minutes for a specified time frame

  • Database profile not found.

  • 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. **DB ADMIN ONLY**

Return the average number of rows read(rows/min) for a specified time frame.

GET /metrics/average_rows_read

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Rows read(rows/min).

Status Code

  • Return the average number of rows read(rows/min) for a specified time frame.

  • Operation is only available to administrators.

  • 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. **DB ADMIN ONLY**

Return the numbers of rows read(rows/min) for a specified time frame.

GET /metrics/rows_read

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of rows read(rows/min).

Status Code

  • Return the numbers of rows read(rows/min) for a specified time frame.

  • Database profile not found.

  • 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 **DB ADMIN ONLY**

Return the maximum number of concurrent connections for a specified time frame

GET /metrics/max_connections_count

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

The maximum connections count.

Status Code

  • Return the maximum number of concurrent connections for a specified time frame end

  • Operation is only available to administrators.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Return maximum numbers of concurrent connections for a specified time frame. **DB ADMIN ONLY**

Return maximum numbers of concurrent connections for a specified time frame.

GET /metrics/connections_count

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of connection count.

Status Code

  • Return maximum numbers of concurrent connections for a specified time frame.

  • Database profile not found.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum lockwaits per minute for a specified time frame. **DB ADMIN ONLY**

Return the maximum lockwaits per minute for a specified time frame.

GET /metrics/max_lockwaits_rate

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

The maximum lockwaits rate(lockwaits/min).

Status Code

  • Return the maximum lockwaits per minute for a specified time frame

  • Operation is only available to administrators.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Return the maximum lockwaits per minute for a specified time frame. **DB ADMIN ONLY**

Return the maximum lockwaits per minute for a specified time frame.

GET /metrics/lockwaits_rate

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of lockwaits rate(lockwaits/min).

Status Code

  • Return the maximum lockwaits per minute for a specified time frame.

  • Database profile not found.

  • 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. **DB ADMIN ONLY**

Return the maximum usage percentage of logs for a specified time frame.

GET /metrics/max_log_space

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

The maximum log space.

Status Code

  • Return the maximum usage percentage of logs for a specified time frame.

  • Operation is only available to administrators.

  • 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. **DB ADMIN ONLY**

Return the maximum usage percentages of logs for a specified time frame.

GET /metrics/log_space

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of LogSpace.

Status Code

  • Return the maximum usage percentages of logs in for a specified time frame.

  • Database profile not found.

  • 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. **DB ADMIN ONLY**

Return the maximum percent of node CPU usage for a specified time frame.

GET /metrics/max_cpu

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of CPU.

Status Code

  • Return the maximum percent of node CPU usage for a specified time frame.

  • Operation is only available to administrators.

  • 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. **DB ADMIN ONLY**

Return the percent of node CPU usage for a specified time frame.

GET /metrics/cpu_summary

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of CPU.

Status Code

  • Return the percent of node CPU usage for a specified time frame.

  • Database profile not found.

  • 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. **DB ADMIN ONLY**

Return the maximum percent of node memory usage for a specified time frame.

GET /metrics/max_memory

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of Memory.

Status Code

  • Return the maximum percent of node memory usage for a specified time frame.

  • Operation is only available to administrators.

  • 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. **DB ADMIN ONLY**

Return the percent of node memory usage for a specified time frame.

GET /metrics/memory_summary

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of Memory.

Status Code

  • Return the percent of memory usage in each node for a specified time frame.

  • Database profile not found.

  • 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. **DB ADMIN ONLY**

Return the maximum usage percent of storage for a specified time frame.

GET /metrics/max_storage

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of Storage.

Status Code

  • Return the maximum usage percent of storage for a specified time frame.

  • Operation is only available to administrators.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Return the usage percent of storage for a specified time frame. **DB ADMIN ONLY**

Return the usage percent of storage for a specified time frame.

GET /metrics/storage

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/metrics/storage?start=1546272000000&end=1546272300000", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   'https://{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'

Response

A list of Storage.

Status Code

  • Return the usage percent of storage for a specified time frame.

  • Database profile not found.

  • 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. **DB ADMIN ONLY**

Return the time spent in each operation for a specified time frame.

GET /metrics/timespent

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/metrics/timespent?start=1546272000000&end=1546272300000", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   'https://{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'

Response

Timespent.

Status Code

  • Return the time spent in each operation for a specified time frame.

  • Database profile not found.

  • Error payload.

No Sample Response

This method does not specify any sample responses.

Return a table storage usage in a time range **DB ADMIN ONLY**

Return a table storage usage in a time range.

GET /metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Tabname

  • Tabschema

Query Parameters

  • end

  • start

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json;charset=utf-8",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Status Code

  • OK

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list for tables storage **DB ADMIN ONLY**

Returns a list for tables storage. Only returns the last collected data between start and end.

GET /metrics/tables/storage

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if includes system tables in the return list

    Default: false

  • The amount of return records. Limit and offset should be set together.

    Default: 100

  • The starting position of return records. Limit and offset should be set together

    Default: 0

  • Used to filter by schema

  • Used to filter by tabname

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of table storage data.

Status Code

  • Returns a list for tables storage

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a table storage **DB ADMIN ONLY**

Returns a table storage. Only returns the last collected data between start and end.

GET /metrics/schemas/{tabschema}/tables/{tabname}/storage

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Used to filter by schema

  • Used to filter by tabname

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of schemas storage data.

Status Code

  • Returns the list for tables storage

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list for schemas storage **DB ADMIN ONLY**

Returns a list for schemas storage. Only returns the last collected data between start and end.

GET /metrics/storage/schemas

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if includes system schemas in the return list

    Default: false

  • The amount of return records. Limit and offset should be set together.

    Default: 100

  • The starting position of return records. Limit and offset should be set together

    Default: 0

  • Used to filter by schema

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of schemas storage data.

Status Code

  • Returns a list for schemas storage

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Return a schema used storage in a time range **DB ADMIN ONLY**

Return a schema used storage in a time range.

GET /metrics/storage/schemas/{tabschema}/timeseries

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Used to filter by schema

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json;charset=utf-8",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Status Code

  • OK

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a schema storage **DB ADMIN ONLY**

Returns a schema storage. Only returns the last collected data between start and end.

GET /metrics/storage/schemas/{tabschema}

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Used to filter by schema

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Status Code

  • Returns the list for schema storage

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Runs a tables storage collection **DB ADMIN ONLY**

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

  • Database profile name.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/metrics/tables/storage/collector", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/metrics/tables/storage/collector   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -H 'x-db-profile: SOME_STRING_VALUE'

Response

Status Code

  • Runs a tables storage collection

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of inflight executions

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

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if include system statements in the return list

    Default: false

  • The amount of return records. Limit and offset should be set together.

    Default: 100

  • The starting position of return records. Limit and offset should be set together

    Default: 0

  • Used to filter by IP address

  • Used to filter by statement text

  • Used to filter by application_name

  • Used to filter by session_auth_id

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Collection of in flight execution data

Status Code

  • Returns a list of inflight executions name

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of current inflight executions

Returns a list of current inflight executions

GET /metrics/statements/inflight_executions/current/list

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Field to set if include system statements in the return list

    Default: false

  • The amount of return records. Limit and offset should be set together.

    Default: 100

  • The starting position of return records. Limit and offset should be set together

    Default: 0

  • Used to filter by IP address

  • Used to filter by statement text

  • Used to filter by application_name

  • Used to filter by session_auth_id

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Collection of in flight execution data

Status Code

  • Returns a list of current inflight executions

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a infight execution detail

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

  • Database profile name.

Path Parameters

  • A system-wide unique ID for the application.

  • The unit of work identifier.

  • Counter which uniquely identifies an activity for an application within a given unit of work.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

inflight statement Execution details

Status Code

  • Returns a infight execution detail

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Terminates a statement **DB ADMIN ONLY**

Terminates a statement

DELETE /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}

Request

Custom Headers

  • Database profile name.

Path Parameters

  • A system-wide unique ID for the application.

  • The unit of work identifier.

  • Counter which uniquely identifies an activity for an application within a given unit of work.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X DELETE   https://{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'

Response

Status Code

  • Connection terminated

  • Operation is only available to administrators

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of connections

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

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if include system statements in the return list

    Default: false

  • The amount of return records. Limit and offset should be set together.

    Default: 100

  • The starting position of return records. Limit and offset should be set together

    Default: 0

  • Used to filter by IP address

  • Used to filter by application_name

  • Used to filter by session_auth_id

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

a list of application connections

Status Code

  • Returns Connections with the specific profile name

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of current connections

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

  • Database profile name.

Query Parameters

  • Field to set if include system statements in the return list

    Default: false

  • The amount of return records. Limit and offset should be set together.

    Default: 100

  • The starting position of return records. Limit and offset should be set together

    Default: 0

  • Used to filter by IP address

  • Used to filter by application_name

  • Used to filter by session_auth_id

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

a list of application connections

Status Code

  • Returns Connections with the specific profile name

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a connection detail

Returns a connection detail

GET /metrics/applications/connections/{application_handle}

Request

Custom Headers

  • Database profile name.

Path Parameters

  • A system-wide unique ID for the application.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

application connections

Status Code

  • Returns connection details with the specific profile name and specific application handle

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Terminates a database connection **DB ADMIN ONLY**

Terminates an active database connection.

DELETE /metrics/applications/connections/{application_handle}

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Application handle name

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/metrics/applications/connections/{application_handle}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{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'

Response

Status Code

  • Connection terminated

  • Operation is only available to administrators

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns a list of timeseries of a connection

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

  • Database profile name.

Path Parameters

  • A system-wide unique ID for the application.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

a list of application connections

Status Code

  • Returns connection details of timeseries with the specific profile name and specific application handle

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics for schemas **DB ADMIN ONLY**

Returns performance metrics for schemas. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/schemas

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if include system schemas in the return list

    Default: false

  • Field to set the amount of return records

    Default: 100

  • Field to set the starting position of return records.

    Default: 0

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

a list of Sechmas

Status Code

  • returns performance of schemas

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics for schemas **DB ADMIN ONLY**

Returns current performance metrics for schemas.

GET /metrics/schemas/current/list

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Field to set if include system schemas in the return list

    Default: false

  • Field to set the amount of return records

    Default: 100

  • Field to set the starting position of return records.

    Default: 0

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

a list of Sechmas

Status Code

  • returns performance of schemas

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics for one schema **DB ADMIN ONLY**

Returns performance metrics for one schema. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/schemas/{schema_name}

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Schema name

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Schema Perf

Status Code

  • Returns performance metrics for one schema

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics on all members for one schema **DB ADMIN ONLY**

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

  • Database profile name.

Path Parameters

  • Schema name

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Schema Perf list

Status Code

  • Returns performance metrics on all members for one schema

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance metrics timeseries for one schema **DB ADMIN ONLY**

Returns performance metrics timeseries for one schema.

GET /metrics/schemas/{schema_name}/timeseries

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Schema name

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Schema Perf Timeseries list

Status Code

  • Returns performance metrics timeseries for one schema

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance of tables **DB ADMIN ONLY**

Returns performance of tables. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/tables

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if include system tables in the return list

    Default: false

  • Field to set the amount of return records

    Default: 100

  • Field to set the starting position of return records.

    Default: 0

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of tables

Status Code

  • Returns performance of tables

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns current performance of tables **DB ADMIN ONLY**

Returns current performance of tables.

GET /metrics/tables/current/list

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Field to set if include system tables in the return list

    Default: false

  • Field to set the amount of return records

    Default: 100

  • Field to set the starting position of return records.

    Default: 0

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

A list of tables

Status Code

  • Returns performance of tables

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance of one table **DB ADMIN ONLY**

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

  • Database profile name.

Path Parameters

  • Schema name

  • Table name

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Table performance

Status Code

  • Returns performance of one table

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance on all members for one table **DB ADMIN ONLY**

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

  • Database profile name.

Path Parameters

  • Schema name

  • Table name

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Table performance list

Status Code

  • Returns performance on all members for one table

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance timeseries for one table **DB ADMIN ONLY**

Returns performance timeseries for one table.

GET /metrics/schemas/{schema_name}/tables/{table_name}/timeseries

Request

Custom Headers

  • Database profile name.

Path Parameters

  • Schema name

  • Table name

Query Parameters

  • Start timestamp.

  • End timestamp.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Table performance timeseries list

Status Code

  • Returns performance timeseries for one table

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns performance of tables and schemas **DB ADMIN ONLY**

Returns performance of tables and schemas. If there are multiple collections. They’ll been aggregated averagely.

GET /metrics/tableperformance

Request

Custom Headers

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if include system tables in the return list

    Default: false

  • Field to set the amount of return records

    Default: 100

  • Field to set the starting position of return records.

    Default: 0

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Result of tables and schemas

Status Code

  • Returns performance of tables

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns current performance of tables and schemas **DB ADMIN ONLY**

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

  • Database profile name.

Query Parameters

  • Start timestamp.

  • End timestamp.

  • Field to set if include system tables in the return list

    Default: false

  • Field to set the amount of return records

    Default: 100

  • Field to set the starting position of return records.

    Default: 0

  • 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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'x-db-profile': "SOME_STRING_VALUE",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    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"))
  • curl -X GET   'https://{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'

Response

Result of current tables and schemas

Status Code

  • Returns performance of tables

  • Current user does not have permission to access this database

  • Database profile not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Executes SQL statements

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

SQL script and execution options

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/sql_jobs")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/sql_jobs",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("POST", "/dbapi/v4/sql_jobs", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/sql_jobs   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -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

Status Code

  • SQL execution job

  • Error payload

No Sample Response

This method does not specify any sample responses.

Fetches partial results of a SQL job execution

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 of the SQL execution job

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/sql_jobs/{id}")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/sql_jobs/{id}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/sql_jobs/{id}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/sql_jobs/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Contains the results of executing the SQL statements associated with a SQL execution job

Status Code

  • Result of a SQL job

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns the results of a SQL query to CSV

Executes the specified SQL query and returns the data as a CSV file. The amount of data returned is limited to 100,000 rows.

POST /sql_query_export

Request

The SQL query to be executed

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/sql_query_export")
      .post(body)
      .addHeader("content-type", "text/csv")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/sql_query_export",
      "headers": {
        "content-type": "text/csv",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"command\":\"<ADD STRING VALUE>\"}"
    
    headers = {
        'content-type': "text/csv",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/sql_query_export", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/sql_query_export   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: text/csv'   -d '{"command":"<ADD STRING VALUE>"}'

Response

Status Code

  • CSV file containing query results

  • Error payload

No Sample Response

This method does not specify any sample responses.

Create a scaling request

Scale the instance with desired amount of storage and cpu value.

PUT /manage/scaling/add

Request

Contains the number of cores and the amount of storage to scale.

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/manage/scaling/add"
    
    	payload := strings.NewReader("{\"total_cores\":12,\"total_storage\":80,\"trigger_time_unix_ms\":1651782663715}")
    
    	req, _ := http.NewRequest("PUT", url, payload)
    
    	req.Header.Add("accept", "application/json")
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"total_cores\":12,\"total_storage\":80,\"trigger_time_unix_ms\":1651782663715}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/manage/scaling/add")
      .put(body)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/manage/scaling/add",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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: 12, total_storage: 80, trigger_time_unix_ms: 1651782663715}));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"total_cores\":12,\"total_storage\":80,\"trigger_time_unix_ms\":1651782663715}"
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("PUT", "/dbapi/v4/manage/scaling/add", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/manage/scaling/add   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"total_cores":12,"total_storage":80,"trigger_time_unix_ms":1651782663715}'

Response

Status Code

  • Send scaling request successfully.

  • Bad request

  • Unauthorized

  • Internal server error

No Sample Response

This method does not specify any sample responses.

Cancel a pending scaling request

Cancel a pending scaling request based on request ID

DELETE /manage/scaling/cancel/{id}

Request

Path Parameters

  • Request ID to be cancelled. This can be obtained from API /manage/scaling/list

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/manage/scaling/cancel/3d09f26e-0abf-4b69-952d-ede90cf912c6-1"
    
    	req, _ := http.NewRequest("DELETE", url, nil)
    
    	req.Header.Add("accept", "application/json")
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/manage/scaling/cancel/3d09f26e-0abf-4b69-952d-ede90cf912c6-1")
      .delete(null)
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/manage/scaling/cancel/3d09f26e-0abf-4b69-952d-ede90cf912c6-1",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/manage/scaling/cancel/3d09f26e-0abf-4b69-952d-ede90cf912c6-1", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/manage/scaling/cancel/3d09f26e-0abf-4b69-952d-ede90cf912c6-1   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • OK

  • Bad request

  • Unauthorized

  • Not Found

  • Unauthorized

No Sample Response

This method does not specify any sample responses.

Get the last scaling request status

Get the status from the last scaling request

GET /manage/scaling/last_status

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/manage/scaling/last_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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/manage/scaling/last_status")
      .get()
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/manage/scaling/last_status",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/manage/scaling/last_status", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/manage/scaling/last_status   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • OK

  • Bad request

  • Unauthorized

  • Not Found

  • Unauthorized

No Sample Response

This method does not specify any sample responses.

Get the complete list of scaling requests

Get the complete list of scaling requests performed on this instance

GET /manage/scaling/list

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/manage/scaling/list"
    
    	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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/manage/scaling/list")
      .get()
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/manage/scaling/list",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/manage/scaling/list", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/manage/scaling/list   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • OK

  • Bad request

  • Unauthorized

  • Not Found

  • Unauthorized

No Sample Response

This method does not specify any sample responses.

Get supported scaling ranges and current allocated resources

Get allocated storage and cpu at the time of request. Also, it returns the supported scaling ranges for this IBM Cloud Db2 service.

GET /manage/scaling/resources

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/manage/scaling/resources"
    
    	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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/manage/scaling/resources")
      .get()
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/manage/scaling/resources",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/manage/scaling/resources", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/manage/scaling/resources   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Details for supported scaling ranges and current allocated resources.

  • Bad request

  • Unauthorized

  • Unexpected error

No Sample Response

This method does not specify any sample responses.

View scaling history saved in console

View the scaling history data showing in console

GET /manage/scaling/history

Request

Query Parameters

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/manage/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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/manage/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}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/manage/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}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/manage/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"))
  • curl -X GET   'https://{HOSTNAME}/dbapi/v4/manage/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'

Response

Status Code

  • View scaling history

  • Bad request

  • Unauthorized

  • Internal server error

No Sample Response

This method does not specify any sample responses.

Returns the system's current settings

Returns the system's current settings.

GET /settings

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/settings"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/settings")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/settings",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/settings", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/settings   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

A collection of system settings.

Status Code

  • System settings

  • Error payload

No Sample Response

This method does not specify any sample responses.

Updates the system settings **ADMIN ONLY**

The only setting that can be modified is database_ssl_connections_enforced. By setting database_ssl_connections_enforced to true database connection requests must be secured. If set to false both secured and unsecured database connections are accepted.

This operation is only available to system administrators.

PUT /settings

Request

System settings

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/settings"
    
    	payload := strings.NewReader("{\"database_ssl_connections_enforced\":\"yes\"}")
    
    	req, _ := http.NewRequest("PUT", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"database_ssl_connections_enforced\":\"yes\"}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/settings")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/settings",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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({database_ssl_connections_enforced: 'yes'}));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"database_ssl_connections_enforced\":\"yes\"}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("PUT", "/dbapi/v4/settings", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/settings   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"database_ssl_connections_enforced":"yes"}'

Response

A collection of system settings.

Status Code

  • System settings

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get tasks status

GET /tasks/status

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/tasks/status")
      .get()
      .addHeader("accept", "application/json")
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/tasks/status",
      "headers": {
        "accept": "application/json",
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'accept': "application/json",
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/tasks/status", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/tasks/status   -H 'accept: application/json'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • contain tasks status for scaling ,restore etc.

  • Bad request

  • Unauthorized

  • Error

No Sample Response

This method does not specify any sample responses.

Generates a new Aspera token

Aspera is a high-speed file transfer technology that can be used to speed up file uploads to Db2 Warehouse on Cloud. This endpoint generates a new token that must be used when uploading files with Aspera.

POST /aspera

Request

No Request Parameters

This method does not accept any request parameters.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/aspera"
    
    	req, _ := http.NewRequest("POST", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/aspera")
      .post(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/aspera",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("POST", "/dbapi/v4/aspera", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/aspera   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Token generated for Aspera

Status Code

  • Aspera token

  • Error payload

No Sample Response

This method does not specify any sample responses.

Deletes an Aspera token

Deletes an Aspera token. You should delete a token after the upload is complete. Optionally provide the name of a file that was uploaded using Aspera to prepare it for loading.

DELETE /aspera/{token}

Request

Path Parameters

  • Aspera token

Query Parameters

  • Name of file that was uploaded

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/aspera/{token}?filename=SOME_STRING_VALUE"
    
    	req, _ := http.NewRequest("DELETE", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/aspera/{token}?filename=SOME_STRING_VALUE")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/aspera/{token}?filename=SOME_STRING_VALUE",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/aspera/{token}?filename=SOME_STRING_VALUE", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   'https://{HOSTNAME}/dbapi/v4/aspera/{token}?filename=SOME_STRING_VALUE'   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • Success

  • Token or file not found

  • Error payload

No Sample Response

This method does not specify any sample responses.

Analyzes CSV data to return a list of data types of its values

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

Data to analyze

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/schema_discovery")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/schema_discovery",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("POST", "/dbapi/v4/schema_discovery", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/schema_discovery   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"column_separator":"<ADD STRING VALUE>","includes_header":"<ADD STRING VALUE>","data":"<ADD STRING VALUE>"}'

Response

Result of running schema discovery.

Status Code

  • Suggested table schema

  • Error payload

No Sample Response

This method does not specify any sample responses.

Returns the list of users

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.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/users"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/users")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/users", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/users   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Collection of users

Status Code

  • List of users

  • Error payload

No Sample Response

This method does not specify any sample responses.

Creates a new user. **ADMIN ONLY**

Creates a new user.

This operation is only available to system administrators.

POST /users

Request

User information

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/users")
      .post(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "POST",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("POST", "/dbapi/v4/users", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X POST   https://{HOSTNAME}/dbapi/v4/users   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -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

Status Code

  • User response

  • Invalid parameters or user already exists

  • Operation is only available to administrators

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get a specific user by ID

Get a specific user by ID.

System administrators may retrieve user information for any user. Regular users may only retrieve themselves.

GET /users/{id}

Request

Path Parameters

  • ID of the user to be fetched

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/users/bluadmin")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users/bluadmin",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/users/bluadmin", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/users/bluadmin   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • User response

  • Access to this user is not allowed

  • The user does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Updates an existing user

Updates an existing user. Attribute 'iam' can not be updated. That means no conversion between IBMid users and normal users.

System administrators may update user information for any user. Regular users may only update themselves.

PUT /users/{id}

Request

Path Parameters

  • ID of the user to be updated

User information

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • 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://{HOSTNAME}/dbapi/v4/users/{id}")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users/{id}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{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}"
        }
    
    conn.request("PUT", "/dbapi/v4/users/{id}", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/users/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -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

Status Code

  • User response

  • Access to this user is not allowed

  • The user does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Deletes an existing user **ADMIN ONLY**

Deletes an existing user.

Only administratos can delete users.

DELETE /users/{id}

Request

Path Parameters

  • ID of the user to be deleted.

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/users/{id}")
      .delete(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "DELETE",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users/{id}",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("DELETE", "/dbapi/v4/users/{id}", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X DELETE   https://{HOSTNAME}/dbapi/v4/users/{id}   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • User deleted

  • Removal of this user is not allowed

  • The user does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Locks a user account indefinitely. **ADMIN ONLY**

Admin users can unlock users' accounts which have been locked out following repeated failed authentication attempts.

PUT /users/{id}/lock

Request

Path Parameters

  • ID of the user who will be locked

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/users/{id}/lock")
      .put(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users/{id}/lock",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("PUT", "/dbapi/v4/users/{id}/lock", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/users/{id}/lock   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • User response

  • Cannot edit this user

  • The user does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Unlocks a user account **ADMIN ONLY**

Admin users can unlock users' accounts which have been locked out following repeated failed authentication attempts.

PUT /users/{id}/unlock

Request

Path Parameters

  • ID of the user who will be unlocked

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{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}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/users/{id}/unlock")
      .put(null)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users/{id}/unlock",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("PUT", "/dbapi/v4/users/{id}/unlock", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/users/{id}/unlock   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • User response

  • Cannot edit this user

  • The user does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Get a specific user's connection privileges

Get a specific user's connection privileges.

If restricted is set to 'yes', the user will only be allowed to make database connections from IP addresses or hostnames in the authorized_hosts list.

System administrators may retrieve connection privilege information for any user. Regular users may only retrieve their own connection privileges.

GET /users/{id}/connection_privileges

Request

Path Parameters

  • ID of the user who's information is to be fetched

  • package main
    
    import (
    	"fmt"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/users/{id}/connection_privileges"
    
    	req, _ := http.NewRequest("GET", url, nil)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/users/{id}/connection_privileges")
      .get()
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users/{id}/connection_privileges",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("GET", "/dbapi/v4/users/{id}/connection_privileges", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X GET   https://{HOSTNAME}/dbapi/v4/users/{id}/connection_privileges   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'

Response

Status Code

  • User's connection privileges

  • Access to this user's connection privileges is not allowed

  • The user does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.

Updates an existing user's connection privileges **ADMIN ONLY**

Updates an existing user's connection privileges.

If restricted is set to 'yes', the user will only be allowed to make database connections from IP addresses or hostnames in the authorized_hosts list.

This operation is only available to system administrators. An administrator may set the privileges of all users other than themself.

PUT /users/{id}/connection_privileges

Request

Path Parameters

  • ID of the user who's information is to be updated

Connection privilege information

  • package main
    
    import (
    	"fmt"
    	"strings"
    	"net/http"
    	"io/ioutil"
    )
    
    func main() {
    
    	url := "https://{HOSTNAME}/dbapi/v4/users/{id}/connection_privileges"
    
    	payload := strings.NewReader("{\"userid\":\"<ADD STRING VALUE>\",\"restricted\":\"<ADD STRING VALUE>\",\"authorized_hosts\":[\"<ADD STRING VALUE>\"]}")
    
    	req, _ := http.NewRequest("PUT", url, payload)
    
    	req.Header.Add("content-type", "application/json")
    	req.Header.Add("authorization", "Bearer {AUTH_TOKEN}")
    
    	res, _ := http.DefaultClient.Do(req)
    
    	defer res.Body.Close()
    	body, _ := ioutil.ReadAll(res.Body)
    
    	fmt.Println(res)
    	fmt.Println(string(body))
    
    }
  • OkHttpClient client = new OkHttpClient();
    
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"userid\":\"<ADD STRING VALUE>\",\"restricted\":\"<ADD STRING VALUE>\",\"authorized_hosts\":[\"<ADD STRING VALUE>\"]}");
    Request request = new Request.Builder()
      .url("https://{HOSTNAME}/dbapi/v4/users/{id}/connection_privileges")
      .put(body)
      .addHeader("content-type", "application/json")
      .addHeader("authorization", "Bearer {AUTH_TOKEN}")
      .build();
    
    Response response = client.newCall(request).execute();
  • var http = require("https");
    
    var options = {
      "method": "PUT",
      "hostname": "{HOSTNAME}",
      "port": null,
      "path": "/dbapi/v4/users/{id}/connection_privileges",
      "headers": {
        "content-type": "application/json",
        "authorization": "Bearer {AUTH_TOKEN}"
      }
    };
    
    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>',
      restricted: '<ADD STRING VALUE>',
      authorized_hosts: ['<ADD STRING VALUE>']
    }));
    req.end();
  • import http.client
    
    conn = http.client.HTTPSConnection("{HOSTNAME}")
    
    payload = "{\"userid\":\"<ADD STRING VALUE>\",\"restricted\":\"<ADD STRING VALUE>\",\"authorized_hosts\":[\"<ADD STRING VALUE>\"]}"
    
    headers = {
        'content-type': "application/json",
        'authorization': "Bearer {AUTH_TOKEN}"
        }
    
    conn.request("PUT", "/dbapi/v4/users/{id}/connection_privileges", payload, headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
  • curl -X PUT   https://{HOSTNAME}/dbapi/v4/users/{id}/connection_privileges   -H 'authorization: Bearer {AUTH_TOKEN}'   -H 'content-type: application/json'   -d '{"userid":"<ADD STRING VALUE>","restricted":"<ADD STRING VALUE>","authorized_hosts":["<ADD STRING VALUE>"]}'

Response

Status Code

  • Updated user connection privileges

  • Access to this user's connection privileges is not allowed

  • The user does not exist

  • Error payload

No Sample Response

This method does not specify any sample responses.