REST API Administrator Information

1 Data Volume Limit
- 1.1 Description
- 1.2 URI syntax
- 1.3 Example response
2 Global Volume and License Information
- 2.1 Description
- 2.2 URI syntax
- 2.3 Example response
3 Upload License File
- 3.1 Description
- 3.2 URI syntax
- 3.3 Example response
4 Product ID
- 4.1 Description
- 4.2 URI syntax
- 4.3 Example response
5 Metrics
- 5.1 Description
- 5.2 URI syntax
- 5.3 Additional notes
6 JAMon
- 6.1 Description
- 6.2 URI syntax
7 Create Variable
- 7.1 Description
- 7.2 URI syntax
- 7.3 Example response
8 Update Variable
- 8.1 Description
- 8.2 URI syntax
- 8.3 Example response
- 8.4 Additional notes
  - 8.4.1 Update multiple variables
  - 8.4.2 URI syntax
  - 8.4.3 Example response
  - 8.4.4 Note
9 Delete Variable
- 9.1 Description
- 9.2 URI syntax
- 9.3 Example response
- 9.4 Additional notes
  - 9.4.1 Delete multiple variables
  - 9.4.2 URI syntax
  - 9.4.3 Example response
10 List a Variable
- 10.1 Description
- 10.2 URI syntax
- 10.3 Example response
- 10.4 Additional notes
  - 10.4.1 List all variables
  - 10.4.2 URI syntax
  - 10.4.3 Example response

For each call, you can add the following command:

-w"\n%{http_code}\n"

After the username and password in order to receive more meaningful HTTP errors.

Data Volume Limit

Request method - GET

Description

Returns the volume size of a job (in bytes).

URI syntax

curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/job-configuration/volume-report/<job-configuration-id>'

Example response

[
  {
    "id": 187,
    "jobStatus": "COMPLETED",
    "importedVolume": 56765,
    "type": "NORMAL"
  },
  {
    "id": 186,
    "jobStatus": "COMPLETED",
    "importedVolume": 4098,
    "type": "NORMAL"
  }
]

Global Volume and License Information

Request method - GET

Description

Returns information on your Datameer product. This information includes the product ID, version, license holder, license type, start date of license, expiration of license, volume period, volume limit (in bytes), and total volume consumed (in bytes).

URI syntax

curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/license-details'

Example response

{
  "ProductId": "4c4038ba-3250-4844-b432-7c8f64d85807",
  "ProductVersion": "2.1.3",
  "LicenseHolder": "CN=Stefan Groschupf,O=Datameer,STREET=Unknown,L=Unknown Unknown,ST=Unknown,C=Unknown",
  "LicenseType": "Enterprise",
  "LicenseStartDate": "Jan 23, 2013 5:20:10 PM",
  "LicenseExpirationDate": "Mar 25, 2013 5:20:10 PM",
  "LicenseVolumePeriodInMonths": 1,
  "LicenseVolumelimitInBytes": 214748364800,
  "TotalVolumeConsumedInBytes": 38758720
}

Upload License File

Request method - POST

Description

Uploads a license file to Datameer.

URI syntax

curl -u '<username>:<password>' -X POST --form "file=@<license path>" http://<Datameer-serverIP>:<port-number>/license/upload

Example response

If the license is accepted.

VALID

If the license isn't accepted.

INVALID

Product ID

Request method - GET

Description

Returns the product ID and version.

URI syntax

curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/license/product-id'

Example response

Returns the product ID and version.

4b4038ba-3550-4844-b432-4c6f64d80807das-test:Datameer-2.1.3-1.0.3

Metrics

Request method - GET

Description

Viewing the metrics in JSON format.

URI syntax

curl -s -S -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/monitor/'
curl -s -S -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/monitor/prependLabel'

Additional notes

An HTML table of the metrics for the current collection interval can be viewed with the following command

curl -s -S -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/monitor/html'

JAMon

Request method - PUT

Description

Allows clients to enable or disable JAMon at runtime.

URI syntax

curl -s -S -u '<username>:<password>' -X PUT 'http://<Datameer-serverIP>:<port-number>/rest/monitor/enable'
curl -s -S -u '<username>:<password>' -X PUT 'http://<Datameer-serverIP>:<port-number>/rest/monitor/disable'

If your file name includes " " (empty spaces), replace those spaces with "+".

Create Variable

Request method - POST

Description

Create a variable value that can be called within Datameer paths and workbooks.