Hitachi IOportal Rest-API Documentation

This is the documentation of the Hitachi IOportal Rest-API.

Authorization

Get authorization token by sending username and password

Endpoint

POST /api/auth/login

Parameters

Name Description
email required The email of the user
password required Password

Request

Route

POST /api/auth/login

Headers

Version: HTTP/1.0
Content-Type: application/x-www-form-urlencoded

Body

email=email1%40email.com&password=Password123

cURL

curl "https://www.hitachi-ioportal.com/api/auth/login" -d 'email=email1%40email.com&password=Password123' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
ETag: W/"4bee950e8ca810080beff6bacb13378e"
Set-Cookie: _session_id=66d2fc51fd99d8fb54ec8a80d663d9c2; path=/; HttpOnly; SameSite=Lax
X-Request-Id: a5631f72-7089-436b-84f0-6f176f5ad414
X-Runtime: 0.130850
Content-Length: 141

Body

{
  "status": "success",
  "auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2ODY5MDk3MjB9.fgh1hWHHhyPt-spemv-w--3fQ5znaKWe0h2k9whU_n4"
}

When sending wrong credentials

Endpoint

POST /api/auth/login

Parameters

Name Description
email required The email of the user
password required Password

Request

Route

POST /api/auth/login

Headers

Version: HTTP/1.0
Content-Type: application/x-www-form-urlencoded

Body

email=candyce%40waters-wisozk.name&password=19L6sYp1MoLgEoG

cURL

curl "https://www.hitachi-ioportal.com/api/auth/login" -d 'email=candyce%40waters-wisozk.name&password=19L6sYp1MoLgEoG' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=219f10cd5fe964cba4f9ea5d237c5192; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 2abc9deb-2d10-414f-a1e1-5e9aaaf14543
X-Runtime: 0.012591
Content-Length: 57

Body

{
  "status": "unauthorized",
  "message": "Invalid credentials"
}

Customers

Get Details of a Customer

Endpoint

GET /api/customers/:id

Parameters

Name Description
id required ID of the Customer

Request

Route

GET /api/customers/6

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMCwiZXhwIjoxNjg2OTA5NzI1fQ.0Jz1dbyNr-Pti4sqzAXCWJip7L-ypojMC2GS7zyh0yg

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/6" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMCwiZXhwIjoxNjg2OTA5NzI1fQ.0Jz1dbyNr-Pti4sqzAXCWJip7L-ypojMC2GS7zyh0yg"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"63aee6c3f750b3d1d866e76b7c8a3815"
Set-Cookie: _session_id=ee17b4e3417140cc043f7cd65c64a5f1; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 3e590a16-f45c-4f62-9e5d-bd86d7d7fd36
X-Runtime: 0.046456
Content-Length: 252

Body

{
  "status": "success",
  "message": "Loaded customer 'customer_6'",
  "data": {
    "id": "6",
    "type": "customer",
    "attributes": {
      "cust_short": "c6",
      "name": "customer_6",
      "capacity_subscription": true,
      "cust_status": "active",
      "confidentiality": false,
      "proactive_service": false
    }
  }
}

Get all Capacity Consumption Reports of a Customer

Endpoint

GET /api/customers/:id/capacity_consumption_reports

Parameters

Name Description
id required ID of the Customer

Request

Route

GET /api/customers/11/capacity_consumption_reports

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyMCwiZXhwIjoxNjg2OTA5NzI2fQ.iHykh1lDfhsZ4ZGraWpW5Je_X8xIS4Qp-5isYEWvlF8

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/11/capacity_consumption_reports" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyMCwiZXhwIjoxNjg2OTA5NzI2fQ.iHykh1lDfhsZ4ZGraWpW5Je_X8xIS4Qp-5isYEWvlF8"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"b05c50d27e47e978a65251c59362869d"
Set-Cookie: _session_id=346c8560cd1e2166b365b6cbe1216ba7; path=/; HttpOnly; SameSite=Lax
X-Request-Id: cd778023-978a-4cc1-ba42-84d7308ee6e0
X-Runtime: 0.035540
Content-Length: 224

Body

{
  "status": "success",
  "message": "Loaded Capacity Consumption Reports for customer 'customer_11'",
  "data": [
    {
      "filename": "202301_Capacity_Report_customer_11.csv",
      "size": 100,
      "created_at": "2023-02-01T01:00:00.000+00:00"
    }
  ],
  "count": 1
}

Get all StorageArrays of a Customer

Endpoint

GET /api/customers/:id/storage_arrays

Parameters

Name Description
id required ID of the Customer

Request

Route

GET /api/customers/8/storage_arrays

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNCwiZXhwIjoxNjg2OTA5NzI1fQ.oBxQ3X24ZyC32EKS7LJMNJaYWcFzutDpGYJoFGSlspg

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/8/storage_arrays" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNCwiZXhwIjoxNjg2OTA5NzI1fQ.oBxQ3X24ZyC32EKS7LJMNJaYWcFzutDpGYJoFGSlspg"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"02e02082a46ec4990a8b34f725dd00a7"
Set-Cookie: _session_id=02f3f78278d598275d3773dcad71d230; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 6494e737-a5dd-4554-b1f8-8a7a8dee53b5
X-Runtime: 0.045665
Content-Length: 729

Body

{
  "status": "success",
  "message": "Loaded storage_arrays for customer 'customer_8'",
  "data": [
    {
      "id": "15",
      "type": "storage_array",
      "attributes": {
        "box": "VSP10015",
        "nickname": null,
        "serial_number": 10015,
        "machine_type": "HUS VM",
        "os_platform": "OPEN",
        "customer_id": 8,
        "ip_export": null,
        "ip_raidcom": null,
        "fc_raidcom": null,
        "agent_username": null,
        "agent_password": null,
        "box_group_name": null,
        "machine_type_short": "HUS VM"
      }
    },
    {
      "id": "16",
      "type": "storage_array",
      "attributes": {
        "box": "VSP10016",
        "nickname": null,
        "serial_number": 10016,
        "machine_type": "HUS VM",
        "os_platform": "OPEN",
        "customer_id": 8,
        "ip_export": null,
        "ip_raidcom": null,
        "fc_raidcom": null,
        "agent_username": null,
        "agent_password": null,
        "box_group_name": null,
        "machine_type_short": "HUS VM"
      }
    }
  ],
  "count": 2
}

Get latest Capacity Consumption Report of a Customer

Endpoint

GET /api/customers/:id/capacity_consumption_reports/:filename

Parameters

Name Description
id required ID of the Customer
filename required name of some file report or 'latest' for latest report

Request

Route

GET /api/customers/9/capacity_consumption_reports/latest

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNiwiZXhwIjoxNjg2OTA5NzI2fQ.lkFKJIfl32BzMqOevxUByhjcV2ld3zUXuInwA2Fkdbg

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/9/capacity_consumption_reports/latest" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNiwiZXhwIjoxNjg2OTA5NzI2fQ.lkFKJIfl32BzMqOevxUByhjcV2ld3zUXuInwA2Fkdbg"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"f45c8d89deada41f201789ff164bd054"
Set-Cookie: _session_id=06be19eaee81bc29d1d84f19760369ca; path=/; HttpOnly; SameSite=Lax
X-Request-Id: bad32f85-fc1f-402d-abbd-60102104e3a4
X-Runtime: 0.039294
Content-Length: 435

Body

{
  "status": "success",
  "message": "Loaded Capacity Consumption Report 202302_Capacity_Report_customer_9.csv for customer 'customer_9'",
  "data": [
    [
      "serial_number",
      "date",
      "pool_name",
      "used_tier_1_GB",
      "used_tier_2_GB",
      "used_tier_3_GB",
      "used_physical_GB",
      "short_term_pool_full_condition_days",
      "long_term_pool_full_condition_days",
      "comment"
    ],
    [
      "33182",
      "01.02.2023",
      "Pool-1",
      "1437265.51171875",
      "798084.861328125",
      "0.0",
      "1594",
      "2495",
      ""
    ]
  ],
  "count": 2
}

Get specific file Capacity Consumption Report of a Customer with filename

Endpoint

GET /api/customers/:id/capacity_consumption_reports/:filename

Parameters

Name Description
id required ID of the Customer
filename required name of some file report or 'latest' for latest report

Request

Route

GET /api/customers/10/capacity_consumption_reports/202301_Capacity_Report_customer_10.csv

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxOCwiZXhwIjoxNjg2OTA5NzI2fQ.TewzsNdobq055bqScK4FEV915DarNqm3FJsSPzrhazw

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/10/capacity_consumption_reports/202301_Capacity_Report_customer_10.csv" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxOCwiZXhwIjoxNjg2OTA5NzI2fQ.TewzsNdobq055bqScK4FEV915DarNqm3FJsSPzrhazw"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"e5f0a9d99766f98eb7f27b482b24527f"
Set-Cookie: _session_id=1ac4b2c644e89e54d120ff304fb2e400; path=/; HttpOnly; SameSite=Lax
X-Request-Id: b2ffa46f-76a1-4e42-a46f-6a65679088a3
X-Runtime: 0.036185
Content-Length: 530

Body

{
  "status": "success",
  "message": "Loaded Capacity Consumption Report 202301_Capacity_Report_customer_10.csv for customer 'customer_10'",
  "data": [
    [
      "serial_number",
      "date",
      "pool_name",
      "used_tier_1_GB",
      "used_tier_2_GB",
      "used_tier_3_GB",
      "used_physical_GB",
      "short_term_pool_full_condition_days",
      "long_term_pool_full_condition_days",
      "comment"
    ],
    [
      "33182",
      "01.02.2023",
      "Pool-2",
      "1437265.51171875",
      "798084.861328125",
      "0.0",
      "1594",
      "2495",
      ""
    ],
    [
      "33181",
      "01.01.2023",
      "Pool-1",
      "1437265.51171875",
      "798084.861328125",
      "0.0",
      "2594",
      "3495",
      ""
    ]
  ],
  "count": 3
}

Listing Customers

Endpoint

GET /api/customers

Request

Route

GET /api/customers

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMiwiZXhwIjoxNjg2OTA5NzI1fQ.r1w63Pa6hRAXHh8BZL3z4inQJ_J_kwvcW_HV3skBjMM

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMiwiZXhwIjoxNjg2OTA5NzI1fQ.r1w63Pa6hRAXHh8BZL3z4inQJ_J_kwvcW_HV3skBjMM"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"4363ca37a98b8d0e447b0ed45f166521"
Set-Cookie: _session_id=9e7d75f973be4c31ce9e1953532d5d35; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 9d5cf52b-0de0-4c0f-944b-0a128be4f390
X-Runtime: 0.036270
Content-Length: 150

Body

{
  "status": "success",
  "message": "Loaded customers",
  "data": [
    {
      "id": "7",
      "type": "customer",
      "attributes": {
        "cust_short": "c7",
        "name": "customer_7"
      }
    }
  ],
  "count": 1
}

Try to get details for a non authorized Customer

Endpoint

GET /api/customers/:id

Parameters

Name Description
id required ID of the Customer

Request

Route

GET /api/customers/4

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo4LCJleHAiOjE2ODY5MDk3MjV9.YFayzz55_spcc2xQseqkQhd7geC_Cs955vi5lgN7tOA

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/4" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo4LCJleHAiOjE2ODY5MDk3MjV9.YFayzz55_spcc2xQseqkQhd7geC_Cs955vi5lgN7tOA"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
Set-Cookie: _session_id=b1f8f158bc2b27f1dd16670a6c252010; path=/; HttpOnly; SameSite=Lax
X-Request-Id: e64c8790-9d74-435e-8148-cb9d26316c8a
X-Runtime: 0.041610
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}

Kpis

Get Details of a KPI

Endpoint

GET /api/kpis/:id

Parameters

Name Description
id required ID of the Kpi

Request

Route

GET /api/kpis/1

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo0LCJleHAiOjE2ODY5MDk3MjR9.2p-q7iErtUzIhNBeQDKudBjhlDTaGDGN4ZWINwvyKL8

cURL

curl -g "https://www.hitachi-ioportal.com/api/kpis/1" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo0LCJleHAiOjE2ODY5MDk3MjR9.2p-q7iErtUzIhNBeQDKudBjhlDTaGDGN4ZWINwvyKL8"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"25e14ae2f632fd1e66f34a4326ea1f37"
Set-Cookie: _session_id=2c19d9167683fdddfe5212ae90f70a56; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 19629053-3330-4de0-b4a1-17cdba6f1d67
X-Runtime: 0.197305
Content-Length: 759

Body

{
  "status": "success",
  "message": "Loaded KPI",
  "data": {
    "id": "1",
    "type": "dashboard_report",
    "attributes": {
      "start_time": "2023-06-14T02:00:00.000+02:00",
      "end_time": "2023-06-15T01:59:59.000+02:00",
      "kpi_capacity": null,
      "kpi_impact": null,
      "kpi_threshold": null,
      "storage_array": {
        "data": {
          "id": "1",
          "type": "storage_array",
          "attributes": {
            "box": "VSP10001",
            "nickname": null,
            "serial_number": 10001,
            "machine_type": "HUS VM",
            "os_platform": "OPEN",
            "customer_id": 1,
            "ip_export": null,
            "ip_raidcom": null,
            "fc_raidcom": null,
            "agent_username": null,
            "agent_password": null,
            "box_group_name": null,
            "machine_type_short": "HUS VM"
          }
        }
      },
      "dashboard_box_loads": {
        "data": [

        ]
      },
      "dashboard_datapoints": {
        "data": [

        ]
      },
      "dashboard_frontends": {
        "data": [

        ]
      },
      "dashboard_backends": {
        "data": [

        ]
      },
      "dashboard_thresholds": {
        "data": [

        ]
      }
    }
  }
}

Try to get details for a non authorized KPI

Endpoint

GET /api/kpis/:id

Parameters

Name Description
id required ID of the Kpi

Request

Route

GET /api/kpis/2

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo2LCJleHAiOjE2ODY5MDk3MjV9.pZioKh0YUWTAo1htgEprpSyQcte45fHgQOPCVFL1Nws

cURL

curl -g "https://www.hitachi-ioportal.com/api/kpis/2" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo2LCJleHAiOjE2ODY5MDk3MjV9.pZioKh0YUWTAo1htgEprpSyQcte45fHgQOPCVFL1Nws"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
Set-Cookie: _session_id=c2a6c5e91b9708e3e7a265ea3dfee4ed; path=/; HttpOnly; SameSite=Lax
X-Request-Id: ce125b10-56d5-4eae-a812-2827e01de908
X-Runtime: 0.037253
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}

Pools

Get Details of a Pool

Endpoint

GET /api/pools/:id

Parameters

Name Description
id required ID of the Pool

Request

Route

GET /api/pools/41

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozNCwiZXhwIjoxNjg2OTA5NzI3fQ.Yk36MKKCILigeGDhgif3x7l8GghDbeWX9xLBcLnEw64

cURL

curl -g "https://www.hitachi-ioportal.com/api/pools/41" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozNCwiZXhwIjoxNjg2OTA5NzI3fQ.Yk36MKKCILigeGDhgif3x7l8GghDbeWX9xLBcLnEw64"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"1c3aa36f72f051736414e4ad25275a7f"
Set-Cookie: _session_id=b5f8725a92e207a0ea104b35add80962; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 9b3c5bfe-a1be-48e4-a63d-1131ebcce5ca
X-Runtime: 0.040309
Content-Length: 1138

Body

{
  "status": "success",
  "message": "Loaded customer 'pool_41 (VSP10037 / 41)'",
  "data": {
    "id": "41",
    "type": "pool",
    "attributes": {
      "name": "pool_41",
      "pool_status": "POLN",
      "pool_type": "OPEN",
      "storage_array_id": 37,
      "pm": "N",
      "usage_rate": 0,
      "volume_count": 3,
      "ldev_nr": 100,
      "capacity_in_kb": 41220071424,
      "available_capacity_in_kb": 41220071424,
      "threshold": 95,
      "vcap": 100,
      "snap": null,
      "se_saving_in_blk": 0,
      "pl_saving_in_blk": 0,
      "pl_pre_used_in_blk": 0,
      "ses_in_perc": 0,
      "ddp_in_perc": 0,
      "cmp_in_perc": 0,
      "pls_in_perc": 0,
      "num_dedup_vols": 0,
      "num_dedup_sys_vols": null,
      "u_in_perc": "0.0",
      "act_av_in_mb": 40253976,
      "act_tp_in_mb": 40253976,
      "fr_in_perc": "0.0",
      "fmc_log_used_in_blk": 0,
      "fmc_act_used_in_blk": 0,
      "warning": 90,
      "lcnt": 3,
      "rcnt": 0,
      "av_cap_in_mb": 40253976,
      "tp_cap_in_mb": 40253976,
      "tl_cap_in_mb": 256620,
      "tr_cap_in_mb": 0,
      "bm": "FB",
      "storage_array": {
        "data": {
          "id": "37",
          "type": "storage_array",
          "attributes": {
            "box": "VSP10037",
            "nickname": null,
            "serial_number": 10037,
            "machine_type": "HUS VM",
            "os_platform": "OPEN",
            "customer_id": 19,
            "ip_export": null,
            "ip_raidcom": null,
            "fc_raidcom": null,
            "agent_username": null,
            "agent_password": null,
            "box_group_name": null,
            "machine_type_short": "HUS VM"
          }
        }
      }
    }
  }
}

Listing Pools

Endpoint

GET /api/pools

Request

Route

GET /api/pools

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozMiwiZXhwIjoxNjg2OTA5NzI3fQ.BNLkNNB-o3ZRoVkKG6156Ly0GXMZkQiSt5otpPhBZuY

cURL

curl -g "https://www.hitachi-ioportal.com/api/pools" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozMiwiZXhwIjoxNjg2OTA5NzI3fQ.BNLkNNB-o3ZRoVkKG6156Ly0GXMZkQiSt5otpPhBZuY"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"fd4e3b8c6a90e5f1f759238433167aed"
Set-Cookie: _session_id=f406ab021a5aa8f7dcde9b80413e7064; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 70877b56-e524-405a-b898-014f695b2519
X-Runtime: 0.042502
Content-Length: 548

Body

{
  "status": "success",
  "message": "Loaded customers",
  "data": [
    {
      "id": "37",
      "type": "pool",
      "attributes": {
        "name": "pool_37",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 35
      }
    },
    {
      "id": "39",
      "type": "pool",
      "attributes": {
        "name": "pool_39",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 36
      }
    },
    {
      "id": "38",
      "type": "pool",
      "attributes": {
        "name": "pool_38",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 35
      }
    },
    {
      "id": "40",
      "type": "pool",
      "attributes": {
        "name": "pool_40",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 36
      }
    }
  ],
  "count": 4
}

Try to get details for a non authorized Pool

Endpoint

GET /api/pools/:id

Parameters

Name Description
id required ID of the Pool

Request

Route

GET /api/pools/45

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozNiwiZXhwIjoxNjg2OTA5NzI4fQ.8R5zcUquXeFO2SgbNzUNpRgnyGAdh65TD265PQO1GMA

cURL

curl -g "https://www.hitachi-ioportal.com/api/pools/45" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozNiwiZXhwIjoxNjg2OTA5NzI4fQ.8R5zcUquXeFO2SgbNzUNpRgnyGAdh65TD265PQO1GMA"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
Set-Cookie: _session_id=b077c1d7556e1ff74f9bae203eca9f46; path=/; HttpOnly; SameSite=Lax
X-Request-Id: edb40d48-b9c6-4aa7-aecf-6dfbabc26168
X-Runtime: 0.035443
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}

StorageArrays

Get Details of a StorageArray

Endpoint

GET /api/storage_arrays/:id

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/29

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyOCwiZXhwIjoxNjg2OTA5NzI3fQ.vsXndgs-juGfWAz-tt-orQ1yKl13PqRccruZbsNyvU8

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/29" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyOCwiZXhwIjoxNjg2OTA5NzI3fQ.vsXndgs-juGfWAz-tt-orQ1yKl13PqRccruZbsNyvU8"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"99318d784584dd4fc76a3b941218be14"
Set-Cookie: _session_id=470505ec0f6b824e60a7b62f271d169f; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 5979f40c-11ee-44a9-845c-ac956b7a2080
X-Runtime: 0.040796
Content-Length: 500

Body

{
  "status": "success",
  "message": "Loaded storage_array 'VSP10029 (10029)'",
  "data": {
    "id": "29",
    "type": "storage_array",
    "attributes": {
      "box": "VSP10029",
      "nickname": null,
      "serial_number": 10029,
      "machine_type": "HUS VM",
      "os_platform": "OPEN",
      "customer_id": 15,
      "ip_export": null,
      "ip_raidcom": null,
      "fc_raidcom": null,
      "agent_username": null,
      "agent_password": null,
      "box_group_name": null,
      "machine_type_short": "HUS VM",
      "customer": {
        "data": {
          "id": "15",
          "type": "customer",
          "attributes": {
            "cust_short": "c15",
            "name": "customer_15"
          }
        }
      }
    }
  }
}

Get all KPIs of a StorageArray

Endpoint

GET /api/storage_arrays/:id/kpis

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/23/kpis

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyMiwiZXhwIjoxNjg2OTA5NzI2fQ.KekOUdd7tMPPueEFRsfCLESnQrlLhsbwZeU58u8bw-8

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/23/kpis" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyMiwiZXhwIjoxNjg2OTA5NzI2fQ.KekOUdd7tMPPueEFRsfCLESnQrlLhsbwZeU58u8bw-8"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"c97c71b3ca623000ac21ae6e2f3cfc71"
Set-Cookie: _session_id=83bf8630acc521b78620b47846ff173a; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 0905c83d-8598-4fe9-8855-3f35f920f6b6
X-Runtime: 0.046959
Content-Length: 240

Body

{
  "status": "success",
  "message": "Loaded KPIs for storage_array 'VSP10023 (10023)'",
  "data": [
    {
      "id": "3",
      "type": "dashboard_report",
      "attributes": {
        "start_time": "2023-06-14T02:00:00.000+02:00",
        "end_time": "2023-06-15T01:59:59.000+02:00"
      }
    }
  ],
  "count": 1
}

Get all Pools of a StorageArray

Endpoint

GET /api/storage_arrays/:id/pools

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/27/pools

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNiwiZXhwIjoxNjg2OTA5NzI2fQ.ft9w1IdzSKDeyj4BHqsC8xSUm-72mmgEqtIeofYLhj0

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/27/pools" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNiwiZXhwIjoxNjg2OTA5NzI2fQ.ft9w1IdzSKDeyj4BHqsC8xSUm-72mmgEqtIeofYLhj0"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"7239ba5913945415ff56589e096e7e9e"
Set-Cookie: _session_id=be96702e48f51ce1c9d5fc96abd2f875; path=/; HttpOnly; SameSite=Lax
X-Request-Id: af4e9415-8cb6-4f1b-b96f-7b367c6bd625
X-Runtime: 0.044721
Content-Length: 2215

Body

{
  "status": "success",
  "message": "Loaded Pools for storage_array 'VSP10027 (10027)'",
  "data": [
    {
      "id": "21",
      "type": "pool",
      "attributes": {
        "name": "pool_21",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 27,
        "pm": "N",
        "usage_rate": 0,
        "volume_count": 3,
        "ldev_nr": 100,
        "capacity_in_kb": 41220071424,
        "available_capacity_in_kb": 41220071424,
        "threshold": 95,
        "vcap": 100,
        "snap": null,
        "se_saving_in_blk": 0,
        "pl_saving_in_blk": 0,
        "pl_pre_used_in_blk": 0,
        "ses_in_perc": 0,
        "ddp_in_perc": 0,
        "cmp_in_perc": 0,
        "pls_in_perc": 0,
        "num_dedup_vols": 0,
        "num_dedup_sys_vols": null,
        "u_in_perc": "0.0",
        "act_av_in_mb": 40253976,
        "act_tp_in_mb": 40253976,
        "fr_in_perc": "0.0",
        "fmc_log_used_in_blk": 0,
        "fmc_act_used_in_blk": 0,
        "warning": 90,
        "lcnt": 3,
        "rcnt": 0,
        "av_cap_in_mb": 40253976,
        "tp_cap_in_mb": 40253976,
        "tl_cap_in_mb": 256620,
        "tr_cap_in_mb": 0,
        "bm": "FB",
        "storage_array": {
          "data": {
            "id": "27",
            "type": "storage_array",
            "attributes": {
              "box": "VSP10027",
              "nickname": null,
              "serial_number": 10027,
              "machine_type": "HUS VM",
              "os_platform": "OPEN",
              "customer_id": 14,
              "ip_export": null,
              "ip_raidcom": null,
              "fc_raidcom": null,
              "agent_username": null,
              "agent_password": null,
              "box_group_name": null,
              "machine_type_short": "HUS VM"
            }
          }
        }
      }
    },
    {
      "id": "22",
      "type": "pool",
      "attributes": {
        "name": "pool_22",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 27,
        "pm": "N",
        "usage_rate": 0,
        "volume_count": 3,
        "ldev_nr": 100,
        "capacity_in_kb": 41220071424,
        "available_capacity_in_kb": 41220071424,
        "threshold": 95,
        "vcap": 100,
        "snap": null,
        "se_saving_in_blk": 0,
        "pl_saving_in_blk": 0,
        "pl_pre_used_in_blk": 0,
        "ses_in_perc": 0,
        "ddp_in_perc": 0,
        "cmp_in_perc": 0,
        "pls_in_perc": 0,
        "num_dedup_vols": 0,
        "num_dedup_sys_vols": null,
        "u_in_perc": "0.0",
        "act_av_in_mb": 40253976,
        "act_tp_in_mb": 40253976,
        "fr_in_perc": "0.0",
        "fmc_log_used_in_blk": 0,
        "fmc_act_used_in_blk": 0,
        "warning": 90,
        "lcnt": 3,
        "rcnt": 0,
        "av_cap_in_mb": 40253976,
        "tp_cap_in_mb": 40253976,
        "tl_cap_in_mb": 256620,
        "tr_cap_in_mb": 0,
        "bm": "FB",
        "storage_array": {
          "data": {
            "id": "27",
            "type": "storage_array",
            "attributes": {
              "box": "VSP10027",
              "nickname": null,
              "serial_number": 10027,
              "machine_type": "HUS VM",
              "os_platform": "OPEN",
              "customer_id": 14,
              "ip_export": null,
              "ip_raidcom": null,
              "fc_raidcom": null,
              "agent_username": null,
              "agent_password": null,
              "box_group_name": null,
              "machine_type_short": "HUS VM"
            }
          }
        }
      }
    }
  ],
  "count": 2
}

Listing StorageArrays

Endpoint

GET /api/storage_arrays

Request

Route

GET /api/storage_arrays

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNCwiZXhwIjoxNjg2OTA5NzI2fQ.IwXHdMck1G6ytICD_FfLdzg1Om7KuxGpAbQr0Y8USNk

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNCwiZXhwIjoxNjg2OTA5NzI2fQ.IwXHdMck1G6ytICD_FfLdzg1Om7KuxGpAbQr0Y8USNk"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
ETag: W/"4c369665d0276241e56084bbc7cc49ca"
Set-Cookie: _session_id=fb230272867280f76b6290b7214f7f1a; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 89bdd010-aa1a-44ae-935a-c551ba768d4a
X-Runtime: 0.041303
Content-Length: 705

Body

{
  "status": "success",
  "message": "Loaded storage_arrays",
  "data": [
    {
      "id": "25",
      "type": "storage_array",
      "attributes": {
        "box": "VSP10025",
        "nickname": null,
        "serial_number": 10025,
        "machine_type": "HUS VM",
        "os_platform": "OPEN",
        "customer_id": 13,
        "ip_export": null,
        "ip_raidcom": null,
        "fc_raidcom": null,
        "agent_username": null,
        "agent_password": null,
        "box_group_name": null,
        "machine_type_short": "HUS VM"
      }
    },
    {
      "id": "26",
      "type": "storage_array",
      "attributes": {
        "box": "VSP10026",
        "nickname": null,
        "serial_number": 10026,
        "machine_type": "HUS VM",
        "os_platform": "OPEN",
        "customer_id": 13,
        "ip_export": null,
        "ip_raidcom": null,
        "fc_raidcom": null,
        "agent_username": null,
        "agent_password": null,
        "box_group_name": null,
        "machine_type_short": "HUS VM"
      }
    }
  ],
  "count": 2
}

Try to get details for a non authorized StorageArray

Endpoint

GET /api/storage_arrays/:id

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/31

Headers

Version: HTTP/1.0
Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozMCwiZXhwIjoxNjg2OTA5NzI3fQ.m3vIpjbLd4bMCW-vqQ2VCXX8BzacaDzjSkObgz6a1vs

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/31" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjozMCwiZXhwIjoxNjg2OTA5NzI3fQ.m3vIpjbLd4bMCW-vqQ2VCXX8BzacaDzjSkObgz6a1vs"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: no-store
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Vary: Accept
Set-Cookie: _session_id=2e673e8683a574bb3eca39f12cb05f2d; path=/; HttpOnly; SameSite=Lax
X-Request-Id: 088a3933-79e2-4b95-ae21-19ed56028d94
X-Runtime: 0.036588
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}