Blockbridge REST API

Document last updated 2025-07-01T06:36:31

This document describes the Blockbridge REST API.

The Blockbridge REST API allows you to incorporate secure storage provisioning directly into your services. You can use the API to provision storage of a certain media type like SSD or 10k SAS, reliability (RAID-6, SATA, etc.), or from a certain availability zone, even a certain rack. With the API, you can take snapshots, make thin clones, and initiate backups to an object store like Amazon S3 or OpenStack Swift.

This document begins with a brief overview of concepts and terminology, how to authenticate to the API, and how to manage application authorizations. This is followed by detailed documentation of the API resources.

Status Test

Before you begin, let's ensure that your REST API endpoint is operational. Use curl to connect to the Blockbridge REST API of your management node using HTTPS. Request the resource /api/status.

$ curl -ik https://mgmt-node/api/status
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 29
Server: Goliath
Date: Mon, 21 Sep 2015 21:57:56 GMT

{"status":200,"message":"ok"}

Curl

This document contains numerous examples that use the curl command to talk to the API. Replace 'mgmt-node' in the examples with your own Blockbridge management node hostname. These example commands may also lack authentication information that you'll need to make your experimentation work. You can use HTTP basic authentication, as describe below, with the -u command-line option to get going as quickly as possible.

Authentication

Nearly every Blockbridge API call must be executed as an authenticated user. There are a few ways to authenticate to the Blockbridge API.

Basic Authentication

You can use HTTP basic authentication, supplying the username and password with each request.

$ curl -iku user:pass https://mgmt-node/api/status/authorization
HTTP/1.1 200 OK
...

{"type":"basic_creds","serial":"USR1B6B194C40626410", ... }

OAuth 2 Token Generation

Obtain a reusable, time-limited secure access token. By default, the token expires in one hour.

POST /api/oauth2/token

The username and password are supplied as arguments.

$ curl -ik -X POST -H 'Content-Type: application/json' -d '{"grant_type":"password", "username":"user", "password":pass"}' https://mgmt-node/api/oauth2/token 
HTTP/1.1 201 Created

{
    "access_token": "0/wsu/1OR2g5cSjDWC4Kxx5LcrRhB21Hav74XAaRtdXKLSyr/U5HaAhw", 
    "token_type": "Bearer", 
    "expires_in": 3599, 
    "user": {
        "account": {
            "serial": "ACT076BD94C40626440", 
            "name": "system", 
            "id": "account:1:3"
        }, 
        "id": "session:17:3", 
        "user": {
            "serial": "USR1B6B894C40626440", 
            "name": "system", 
            "id": "user_profile:1:3"
        }
    }
}

In the response JSON, pull the token from the access_token field.

OAuth 2 Token Submission

Submit the access token in the HTTP header of each request, as Authorization: Bearer <token>.

$ curl -ik -H "Authorization: Bearer 1/wSijaLxU7sLhOeSDnAluOFRFdQ51rv9yX2s6/aGJksGBKKNovFTtgw" https://mgmt-node/api/status/authorization/
HTTP/1.1 200 OK
...

{
    "account": {
        "serial": "ACT076BD94C40626460", 
        "name": "user"
    }, 
    "created_at": "2015-09-22T11:11:26.000-04:00", 
    ...
}

Generate a Persistent Access Token

For long-term use, create a persistent access token that never expires. These long-lived tokens are managed using the authorization resource. A user may have more than one, and they may be individually revoked.

$ curl -iku user:pass -d '' https://mgmt-node/api/authorization
HTTP/1.1 201 Created
...

{
    "app_id": null, 
    "access_type": "online", 
    "restrict": "auth", 
    "lifetime": null, 
    "serial": "ATH476B094C40626410", 
    "id": "authz:4:3", 
    "user_id": "user_profile:4:3", 
    "access_token_digest": "DXglP+STaihfPyNC2Mo5g2bfVzsXEryOLSv97MvmX9o", 
    "expires_in": null, 
    "access_token": "1/wSijaLxU7sLhOeSDnAluOFRFdQ51rv9yX2s6/aGJksGBKKNovFTtgw", 
    "created_at": "2015-09-22T11:11:26.744-04:00", 
}

Two-Factor Authentication

Each user account has individual control over its two-factor authentication parameters. When enabled, a basic authentication request will fail with 401 Unauthorized and X-Blockbridge-OTP: required.

$ curl -iku user:pass  https://mgmt-node/api/status/authorization/ 
HTTP/1.1 401 Unauthorized
X-Blockbridge-OTP: required

To continue submitting requests for this user, you must generate a time-limited OAuth2 token, supplying the username and password inside the JSON body of the request, along with the appropriate OTP in the request header:

$ curl -ik -X POST -H 'X-Blockbridge-OTP: 609179' -H 'Content-Type: application/json' -d '{"grant_type":"password", "username":"user", "password":"pass"}' https://mgmt-node/api/oauth2/token 
HTTP/1.1 201 Created
...

Schema

The Blockbridge API is described by a machine-readable JSON schema. Retrieve the schema directly from your management node with the following command line:

curl https://mgmt-node/schema/

Methods

The API uses a standard set of HTTP verbs for RESTful services.

Parameters

Submit JSON-encoded parameters in the request body. Actions may have both required and optional parameters, as defined by the schema. Some GET requests have URL-encoded parameters.

Request Status

The HTTP status in the response indicates whether a request succeeded or failed. Successful requests receive a JSON-formatted document in response, as described by the schema.

Success

Error Responses

When a request fails, the HTTP status code indicates the reason for the failure. Where applicable, JSON-encoded data in the response body offers additional clarification. There are two classes of errors. Client errors result from malformed requests and should be addressed by the client. Blockbridge errors result from problems on the server side.

Client Errors

Blockbridge Errors

Validation Failure

A request that fails with HTTP status 400 (Bad Request) is likely due to a validation failure. The response body contains detailed information on one or more fields that are in error.

Each element in the errors array has the schema shown below

Validation Failure Error

Example

Attempt to create a virtual disk, but neglect to include its capacity. The request fails with HTTP status 400, and the response indicates that the /capacity field is missing.

$ curl -iku system:system -X POST -H 'Content-Type: application/json' -d '{"vss_id":"VSS186B994C40626440"}' https://mgmt-node/api/vdisk/
HTTP/1.1 400 Bad Request

{
    "status": 400, 
    "message": "parameter validation failure", 
    "errors": [
        {
            "msg": "must be present", 
            "field": "/capacity", 
            "type": "missing"
        }
    ], 
    "type": "validation"
}

Account

Blockbridge is a secure multi-tenant storage system. Each tenant has an Account which is isolated from every other tenant Account. All of the tenant's storage, configuration data, credentials, audit history, and statistics - anything that could be considered private data - is inaccessible to other Accounts.

Accounts have one or more Users, who are each assigned a set of permissions that control the actions they may perform. One user may be simply an observer: able to query state, but unable to change anything. Another user may be able to provision services, but not remove any existing ones. Another is permitted to manage crypto keys.

Lastly, the Account object contains contact information for the primary account holder.

Attributes

Account Info

Retrieve an existing account.

GET /account/{account_id_or_serial}

Curl Example

$ curl https://mgmt-node/api/account/account:10:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:55 GMT
Server: Goliath
ETag: "b79489b7c6d35e1095871de7ebd93436"
Content-Type: application/json
Content-Length: 649

{
  "id": "account:10:10",
  "uuid": "c432e1f5-074d-4ecb-9078-7a5b50574fc0",
  "serial": "ACT0762194C406264FE",
  "evt_qry": "serial=ACT0762194C406264FE",
  "ctime": 1507570012941,
  "mtime": 1507570013202,
  "seq": 1507570013297,
  "status": null,
  "ec": {
    "status": "retrieving",
    "table": null,
    "seq": 1507570012954
  },
  "rec_status": null,
  "usage_id": "account_usage:10:10",
  "name": "account42",
  "primary_contact": {
    "first_name": "",
    "last_name": ""
  },
  "billing_contact": null,
  "admin_profile_id": "user_profile:15:10",
  "disabled": false,
  "limits": {
    "vss_num": 32,
    "size_reserve_total": null
  },
  "provisioning": {
    "size_reserve_max": null,
    "iops_reserve_max": null,
    "tags_include": [

    ],
    "tags_exclude": [

    ],
    "tags_permit": null
  }
}

Account List

Enumerate accounts.

GET /account

Curl Example

$ curl https://mgmt-node/api/account \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:53 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 1504

[
  {
    "id": "account:1:10",
    "uuid": "1fb3cea1-0778-4090-a288-d9f7a456f31b",
    "serial": "ACT0762194C40626445",
    "evt_qry": "serial=ACT0762194C40626445",
    "ctime": 1507562835275,
    "mtime": 1507569805914,
    "seq": 1507570010663,
    "status": null,
    "ec": {
      "status": "current",
      "table": {
        "time": 1507570010000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              192,
              226,
              226,
              226
            ],
            "v": "dbg"
          },
          {
            "d": [
              118,
              145,
              145,
              145
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              9,
              10,
              10,
              10
            ],
            "v": "err"
          }
        ]
      },
      "seq": 1507570010663
    },
    "rec_status": null,
    "usage_id": "account_usage:1:10",
    "name": "system",
    "primary_contact": {
      "first_name": "System user",
      "last_name": ""
    },
    "billing_contact": null,
    "admin_profile_id": "user_profile:1:10",
    "disabled": false,
    "limits": {
      "vss_num": null,
      "size_reserve_total": null
    },
    "provisioning": {
      "size_reserve_max": null,
      "iops_reserve_max": null,
      "tags_include": [

      ],
      "tags_exclude": [

      ],
      "tags_permit": null
    }
  },
  {
    "id": "account:10:10",
    "uuid": "c432e1f5-074d-4ecb-9078-7a5b50574fc0",
    "serial": "ACT0762194C406264FE",
    "evt_qry": "serial=ACT0762194C406264FE",
    "ctime": 1507570012941,
    "mtime": 1507570013202,
    "seq": 1507570013297,
    "status": null,
    "ec": {
      "status": "retrieving",
      "table": null,
      "seq": 1507570012954
    },
    "rec_status": null,
    "usage_id": "account_usage:10:10",
    "name": "account42",
    "primary_contact": {
      "first_name": "",
      "last_name": ""
    },
    "billing_contact": null,
    "admin_profile_id": "user_profile:15:10",
    "disabled": false,
    "limits": {
      "vss_num": 32,
      "size_reserve_total": null
    },
    "provisioning": {
      "size_reserve_max": null,
      "iops_reserve_max": null,
      "tags_include": [

      ],
      "tags_exclude": [

      ],
      "tags_permit": null
    }
  }
]

Account Create

Create a new account.

POST /account

Required Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | name | string | account name
Length: 1..64 |

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | password | string | password to set in primary user profile
Length: 3..∞ | | permissions:realm:rights:can_switch_user | boolean | can SU to lower level user | | permissions:realm:rights:manage_node_membership | boolean | accept or delete nodes from the management network | | permissions:realm:rights:manage_accounts | boolean | can create or delete other accounts, users and their settings | | permissions:realm:rights:view_logs | boolean | view administrative logs | | permissions:realm:rights:run_admin_tasks | boolean | run realm administrative tasks | | permissions:realm:rights:run_tests | boolean | run realm administrative tests | | permissions:node:all_realm_scope | boolean | apply to all nodes in the realm
default: true | | permissions:node:nodes | array | scope permissions to specific nodes | | permissions:node:rights:manage_storage | boolean | configure OS devices, iSCSI devices, and system datastores | | permissions:node:rights:manage_networks | boolean | configure networks | | permissions:node:rights:provision_vss | boolean | manually provision virtual storage services | | permissions:node:rights:remove_vss | boolean | remove virtual storage services | | permissions:vss:all_account_scope | boolean | apply to all virtual storage services in the account
default: true | | permissions:vss:vsses | array | limit scope to specified vsses | | permissions:vss:rights:dismiss_tasks | boolean | dismiss tasks | | permissions:vss:rights:update_vss | boolean | update vss configuration | | permissions:vss:rights:remove_vss | boolean | remove vss | | permissions:vss:rights:set_vss_quota | boolean | set vss quota | | permissions:vss:rights:manage_internal_disks | boolean | manage internal disks | | permissions:vss:rights:manage_external_disks | boolean | manage external disks | | permissions:vss:rights:manage_removable_disks | boolean | manage removable disks | | permissions:vss:rights:manage_disk_cryptography | boolean | manage disk cryptography | | permissions:vss:rights:remove_locked_disks | boolean | remove locked disks | | permissions:vss:rights:validate_data_integrity | boolean | validate data integrity | | permissions:vss:rights:manage_targets | boolean | manage targets | | permissions:vss:rights:manage_profiles | boolean | manage profiles | | permissions:vss:rights:manage_secure_access_tokens | boolean | manage secure access tokens | | permissions:vss:rights:manage_rules | boolean | manage rules | | permissions:vss:rights:replicate_disks | boolean | replicate disks | | permissions:vss:rights:synchronize_disks | boolean | synchronize disks | | permissions:vss:rights:format_disks | boolean | format disks | | permissions:vss:rights:resize_disks | boolean | resize disks | | permissions:vss:rights:manage_snapshots | boolean | manage snapshots | | permissions:vss:rights:backup_disks | boolean | backup disks | | permissions:vss:rights:replicate_and_synchronize_disks | boolean | replicate and synchronize disks (DEPRECATED) | | permissions:vss:rights:compress_disks | boolean | compress disks | | permissions:vss:rights:manage_disk_compression | boolean | manage disk | | permissions:user:rights:manage_users | boolean | create or delete users in an account | | permissions:user:rights:modify_user_contact_settings | boolean | modify user contact info | | permissions:user:rights:reset_user_password | boolean | reset user password | | permissions:user:rights:reset_user_two_factor | boolean | reset two factor authentication | | permissions:user:rights:manage_authorizations | boolean | create or delete persistent authorizations | | permissions:account:rights:modify_contact_settings | boolean | modify account contact settings | | permissions:account:rights:view_events | boolean | view events | | permissions:account:rights:view_statistics | boolean | view statistics | | permissions:account:rights:manage_global_profiles | boolean | manage global profiles | | permissions:account:rights:manage_global_secure_access_tokens | boolean | manage global secure access tokens | | permissions:account:rights:query_catalog | boolean | query product catalog | | permissions:account:rights:provision_vss | boolean | provision vss from catalog | | permissions:account:rights:manage_obj_stores | boolean | manage obj stores | | permissions:account:rights:read_object_storage | boolean | read from object storage | | permissions:account:rights:write_object_storage | boolean | write to object storage | | permissions:account:rights:delete_object_storage | boolean | delete from object storage | | level | integer | privilege level | | access:web | boolean | web access permitted
default: true | | access:api | boolean | api access permitted | | activated | boolean | user profile activated | | primary_contact:first_name | string | First Name
default: ""
Length: 0..255 | | primary_contact:last_name | string | Last Name
default: ""
Length: 0..255 | | primary_contact:company | string | company name
Length: 0..255 | | primary_contact:address:addr | array | physical address lines | | primary_contact:address:city | string | city | | primary_contact:address:state | string | state | | primary_contact:address:zip | string | zip code | | primary_contact:address:country | string | country
default: "US" | | primary_contact:phone | string | phone number
Length: 0..24 | | primary_contact:email | email | email address
Length: 0..128 | | billing_contact:first_name | string | First Name
default: ""
Length: 0..255 | | billing_contact:last_name | string | Last Name
default: ""
Length: 0..255 | | billing_contact:company | string | company name
Length: 0..255 | | billing_contact:address:addr | array | physical address lines | | billing_contact:address:city | string | city | | billing_contact:address:state | string | state | | billing_contact:address:zip | string | zip code | | billing_contact:address:country | string | country
default: "US" | | billing_contact:phone | string | phone number
Length: 0..24 | | billing_contact:email | email | email address
Length: 0..128 | | limits:vss_num | nullable integer | number of virtual storage services | | limits:size_reserve_total | nullable integer | maximum size of storage | | provisioning:size_reserve_max | nullable integer | maximum size reserve of a single virtual storage service | | provisioning:iops_reserve_max | nullable integer | maximum iops reserve of a single virtual storage service | | provisioning:tags_include | array | tags included
default: [] | | provisioning:tags_exclude | array | tags excluded
default: [] | | provisioning:tags_permit | nullable array | tags permitted | | provisioning:tags_permit | nullable array | tags permitted | | uuid | uuid | account UUID | | user_uuid | uuid | user profile UUID | | template | string | accounte template |

Curl Example

$ curl -X POST https://mgmt-node/api/account \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "name": "account42"
}'

Response Example

201 Created
Date: Mon, 09 Oct 2017 17:26:52 GMT
Server: Goliath
ETag: "52c9ce267e5b151a1d7e1e6bd8af120d"
Content-Type: application/json
Content-Length: 651

{
  "id": "account:10:10",
  "uuid": "c432e1f5-074d-4ecb-9078-7a5b50574fc0",
  "serial": "ACT0762194C406264FE",
  "evt_qry": "serial=ACT0762194C406264FE",
  "ctime": 1507570012941,
  "mtime": 1507570012942,
  "seq": 1507570012954,
  "status": null,
  "ec": {
    "status": "retrieving",
    "table": null,
    "seq": 1507570012954
  },
  "rec_status": null,
  "usage_id": "account_usage:10:10",
  "name": "account42",
  "primary_contact": {
    "first_name": "",
    "last_name": ""
  },
  "billing_contact": null,
  "admin_profile_id": "user_profile:15:10",
  "disabled": false,
  "limits": {
    "vss_num": null,
    "size_reserve_total": null
  },
  "provisioning": {
    "size_reserve_max": null,
    "iops_reserve_max": null,
    "tags_include": [

    ],
    "tags_exclude": [

    ],
    "tags_permit": null
  }
}

Account Remove

Remove an existing account.

DELETE /account/{account_id_or_serial}

Curl Example

$ curl -X DELETE https://mgmt-node/api/account/account:10:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

204 No Content
Date: Mon, 09 Oct 2017 17:27:38 GMT
Server: Goliath

Account Update

Change the configuration of an existing account.

PATCH /account/{account_id_or_serial}

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | host | string | server hostname originating request (for url) | | primary_contact:first_name | string | First Name
Length: 0..255 | | primary_contact:last_name | string | Last Name
Length: 0..255 | | primary_contact:company | string | company name
Length: 0..255 | | primary_contact:address:addr | array | physical address lines | | primary_contact:address:city | string | city | | primary_contact:address:state | string | state | | primary_contact:address:zip | string | zip code | | primary_contact:address:country | string | country | | primary_contact:phone | string | phone number
Length: 0..24 | | primary_contact:email | email | email address
Length: 0..128 | | billing_contact:first_name | string | First Name
Length: 0..255 | | billing_contact:last_name | string | Last Name
Length: 0..255 | | billing_contact:company | string | company name
Length: 0..255 | | billing_contact:address:addr | array | physical address lines | | billing_contact:address:city | string | city | | billing_contact:address:state | string | state | | billing_contact:address:zip | string | zip code | | billing_contact:address:country | string | country | | billing_contact:phone | string | phone number
Length: 0..24 | | billing_contact:email | email | email address
Length: 0..128 | | password | string | password of primary user profile
Length: 3..∞ | | limits:vss_num | nullable integer | number of virtual storage services | | limits:size_reserve_total | nullable integer | maximum size of storage | | provisioning:size_reserve_max | nullable integer | maximum size reserve of a single virtual storage service | | provisioning:iops_reserve_max | nullable integer | maximum iops reserve of a single virtual storage service | | provisioning:tags_include | array | tags included | | provisioning:tags_exclude | array | tags excluded | | provisioning:tags_permit | nullable array | tags permitted | | provisioning:tags_permit | nullable array | tags permitted |

Curl Example

$ curl -X PATCH https://mgmt-node/api/account/account:10:10 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "limits": {
    "vss_num": 32
  }
}'

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:53 GMT
Server: Goliath
ETag: "b79489b7c6d35e1095871de7ebd93436"
Content-Type: application/json
Content-Length: 649

{
  "id": "account:10:10",
  "uuid": "c432e1f5-074d-4ecb-9078-7a5b50574fc0",
  "serial": "ACT0762194C406264FE",
  "evt_qry": "serial=ACT0762194C406264FE",
  "ctime": 1507570012941,
  "mtime": 1507570013202,
  "seq": 1507570013297,
  "status": null,
  "ec": {
    "status": "retrieving",
    "table": null,
    "seq": 1507570012954
  },
  "rec_status": null,
  "usage_id": "account_usage:10:10",
  "name": "account42",
  "primary_contact": {
    "first_name": "",
    "last_name": ""
  },
  "billing_contact": null,
  "admin_profile_id": "user_profile:15:10",
  "disabled": false,
  "limits": {
    "vss_num": 32,
    "size_reserve_total": null
  },
  "provisioning": {
    "size_reserve_max": null,
    "iops_reserve_max": null,
    "tags_include": [

    ],
    "tags_exclude": [

    ],
    "tags_permit": null
  }
}

Account Usage

Display usage for an existing account.

GET /account/{account_id_or_serial}/usage

Curl Example

$ curl https://mgmt-node/api/account/account:10:10/usage \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:53 GMT
Server: Goliath
ETag: "13f732476b4b2e858afe17d3f88a9350"
Content-Type: application/json
Content-Length: 150

{
  "size_reserve": 0,
  "iops_reserve": 0,
  "vss_num": 0,
  "vdisk_num": 0,
  "clones_num": 0,
  "repl_num": 0,
  "snapshot_num": 0,
  "target_num": 0,
  "profile_num": 0,
  "user_num": 1
}

User Profile

An Account has one or more Users, who are permitted to administer and consume storage according to various defined roles. Each User has a profile object that has the User's name, email address, password and two-factor authentication information for the API and web application.

Attributes

User Profile Info

Retrieve an existing user profile.

GET /user-profile/{user_profile_id_or_serial}

Curl Example

$ curl https://mgmt-node/api/user-profile/user_profile:16:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:54 GMT
Server: Goliath
ETag: "14ea1ef48b481c651dfac513537e09a5"
Content-Type: application/json
Content-Length: 2070

{
  "id": "user_profile:16:10",
  "uuid": "11bccdde-f3b6-4b65-a28f-25d0463b1564",
  "serial": "USR1B62194C4062655E",
  "evt_qry": "serial=USR1B62194C4062655E",
  "account_id": "account:10:10",
  "ctime": 1507570014375,
  "mtime": 1507570014709,
  "seq": 1507570014716,
  "label": null,
  "status": null,
  "ec": {
    "table": null,
    "status": "retrieving",
    "seq": 1507570014382
  },
  "rec_status": null,
  "xmd_refs": [

  ],
  "xref": null,
  "xmd": null,
  "login": "account421@account42",
  "activated": false,
  "app_default": "storage",
  "access": {
    "web": true,
    "api": true
  },
  "permissions": {
    "node": {
      "all_realm_scope": false,
      "nodes": [

      ],
      "rights": {
        "manage_storage": false,
        "manage_networks": false,
        "provision_vss": false,
        "remove_vss": false
      }
    },
    "vss": {
      "all_account_scope": true,
      "rights": {
        "dismiss_tasks": true,
        "update_vss": true,
        "remove_vss": true,
        "set_vss_quota": true,
        "manage_internal_disks": true,
        "manage_external_disks": true,
        "manage_removable_disks": true,
        "manage_disk_cryptography": true,
        "remove_locked_disks": true,
        "replicate_disks": true,
        "synchronize_disks": true,
        "format_disks": true,
        "resize_disks": true,
        "backup_disks": true,
        "validate_data_integrity": true,
        "manage_snapshots": true,
        "manage_targets": true,
        "manage_profiles": true,
        "manage_secure_access_tokens": true,
        "manage_rules": true
      }
    },
    "realm": {
      "rights": {
        "can_switch_user": false,
        "manage_node_membership": false,
        "manage_accounts": false,
        "view_logs": false,
        "run_admin_tasks": false,
        "run_tests": false
      }
    },
    "user": {
      "rights": {
        "manage_users": true,
        "modify_user_contact_settings": true,
        "reset_user_password": true,
        "reset_user_two_factor": true,
        "manage_authorizations": true
      }
    },
    "account": {
      "rights": {
        "modify_contact_settings": true,
        "manage_global_profiles": true,
        "manage_global_secure_access_tokens": true,
        "view_events": true,
        "view_statistics": true,
        "query_catalog": true,
        "provision_vss": true,
        "manage_obj_stores": true,
        "read_object_storage": true,
        "write_object_storage": true,
        "delete_object_storage": true
      }
    }
  },
  "account_admin": false,
  "allow_su": false,
  "level": 0,
  "timezone": "local",
  "two_factor": {
    "auth": "none"
  },
  "email": null,
  "email_notify": false,
  "email_verified": false,
  "sms": {
    "number": "XXX-XXX-XXXX",
    "valid": false
  },
  "sms_notify": false,
  "password_set": true,
  "sessions": [

  ]
}

User Profile List

Enumerate user profiles.

GET /user-profile

Curl Example

$ curl https://mgmt-node/api/user-profile \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:54 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 7744

[
  {
    "id": "user_profile:16:10",
    "uuid": "11bccdde-f3b6-4b65-a28f-25d0463b1564",
    "serial": "USR1B62194C4062655E",
    "evt_qry": "serial=USR1B62194C4062655E",
    "account_id": "account:10:10",
    "ctime": 1507570014375,
    "mtime": 1507570014375,
    "seq": 1507570014382,
    "label": null,
    "status": null,
    "ec": {
      "table": null,
      "status": "retrieving",
      "seq": 1507570014382
    },
    "rec_status": null,
    "xmd_refs": [

    ],
    "xref": null,
    "xmd": null,
    "login": "account421@account42",
    "activated": true,
    "app_default": "storage",
    "access": {
      "web": true,
      "api": true
    },
    "permissions": {
      "node": {
        "all_realm_scope": false,
        "nodes": [

        ],
        "rights": {
          "manage_storage": false,
          "manage_networks": false,
          "provision_vss": false,
          "remove_vss": false
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "realm": {
        "rights": {
          "can_switch_user": false,
          "manage_node_membership": false,
          "manage_accounts": false,
          "view_logs": false,
          "run_admin_tasks": false,
          "run_tests": false
        }
      },
      "user": {
        "rights": {
          "manage_users": true,
          "modify_user_contact_settings": true,
          "reset_user_password": true,
          "reset_user_two_factor": true,
          "manage_authorizations": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "view_events": true,
          "view_statistics": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    },
    "account_admin": false,
    "allow_su": false,
    "level": 0,
    "timezone": "local",
    "two_factor": {
      "auth": "none"
    },
    "email": null,
    "email_notify": false,
    "email_verified": false,
    "sms": {
      "number": "XXX-XXX-XXXX",
      "valid": false
    },
    "sms_notify": false,
    "password_set": true,
    "sessions": [

    ]
  },
  {
    "id": "user_profile:1:10",
    "uuid": "f687e09f-85b4-4cad-8e6a-6b8622fb6f8d",
    "serial": "USR1B62194C40626440",
    "evt_qry": "serial=USR1B62194C40626440",
    "account_id": "account:1:10",
    "ctime": 1507562835275,
    "mtime": 1507562839801,
    "seq": 1507570013664,
    "label": null,
    "status": null,
    "ec": {
      "table": {
        "time": 1507570013000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              196,
              230,
              230,
              230
            ],
            "v": "dbg"
          },
          {
            "d": [
              120,
              146,
              146,
              146
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              9,
              10,
              10,
              10
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507570013664
    },
    "rec_status": null,
    "xmd_refs": [

    ],
    "xref": null,
    "xmd": null,
    "login": "system",
    "activated": true,
    "app_default": "infrastructure",
    "access": {
      "web": true,
      "api": true
    },
    "permissions": {
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "user": {
        "rights": {
          "manage_users": true,
          "modify_user_contact_settings": true,
          "reset_user_password": true,
          "reset_user_two_factor": true,
          "manage_authorizations": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "view_events": true,
          "view_statistics": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    },
    "account_admin": true,
    "allow_su": true,
    "level": 0,
    "timezone": "local",
    "two_factor": {
      "auth": "none"
    },
    "email": null,
    "email_notify": false,
    "email_verified": false,
    "sms": {
      "number": "XXX-XXX-XXXX",
      "valid": false
    },
    "sms_notify": false,
    "password_set": true,
    "sessions": [
      {
        "serial": "SES1662194C40626432",
        "id": "session:6:10",
        "created_ms": 1507566844334,
        "last_ms": 1507566844334,
        "addr": "172.16.5.200"
      },
      {
        "serial": "SES1662194C4062642A",
        "id": "session:7:10",
        "created_ms": 1507567736453,
        "last_ms": 1507569935236,
        "addr": "172.16.9.2"
      },
      {
        "serial": "SES1662194C406264D0",
        "id": "session:8:10",
        "created_ms": 1507567897105,
        "last_ms": 1507567897105,
        "addr": "172.16.5.200"
      },
      {
        "serial": "SES1662194C406264C8",
        "id": "session:9:10",
        "created_ms": 1507567914713,
        "last_ms": 1507567914713,
        "addr": "172.16.5.200"
      },
      {
        "serial": "SES1662194C406264F0",
        "id": "session:10:10",
        "created_ms": 1507567940495,
        "last_ms": 1507568149181,
        "addr": "172.16.5.200"
      },
      {
        "serial": "SES1662194C406264E8",
        "id": "session:11:10",
        "created_ms": 1507568228790,
        "last_ms": 1507569437816,
        "addr": "172.16.5.200"
      },
      {
        "serial": "SES1662194C40626491",
        "id": "session:12:10",
        "created_ms": 1507568321420,
        "last_ms": 1507568321420,
        "addr": "::1"
      },
      {
        "serial": "SES1662194C40626489",
        "id": "session:13:10",
        "created_ms": 1507568758214,
        "last_ms": 1507569935630,
        "addr": "172.16.5.237"
      },
      {
        "serial": "SES1662194C406264B1",
        "id": "session:14:10",
        "created_ms": 1507569793599,
        "last_ms": 1507569793599,
        "addr": "172.16.5.200"
      },
      {
        "serial": "SES1662194C406264A9",
        "id": "session:15:10",
        "created_ms": 1507569963874,
        "last_ms": 1507569963874,
        "addr": "172.16.5.200"
      },
      {
        "serial": "SES1662194C40626555",
        "id": "session:16:10",
        "created_ms": 1507570010499,
        "last_ms": 1507570010499,
        "addr": "172.16.5.200"
      }
    ]
  },
  {
    "id": "user_profile:15:10",
    "uuid": "9af5fd5e-f4b0-411d-9cf8-6f376640d445",
    "serial": "USR1B62194C406264A2",
    "evt_qry": "serial=USR1B62194C406264A2",
    "account_id": "account:10:10",
    "ctime": 1507570012942,
    "mtime": 1507570012942,
    "seq": 1507570012954,
    "label": null,
    "status": null,
    "ec": {
      "table": null,
      "status": "retrieving",
      "seq": 1507570012954
    },
    "rec_status": null,
    "xmd_refs": [

    ],
    "xref": null,
    "xmd": null,
    "login": "account42",
    "activated": true,
    "app_default": "storage",
    "access": {
      "web": true,
      "api": false
    },
    "permissions": {
      "node": {
        "all_realm_scope": false,
        "nodes": [

        ],
        "rights": {
          "manage_storage": false,
          "manage_networks": false,
          "provision_vss": false,
          "remove_vss": false
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "realm": {
        "rights": {
          "can_switch_user": false,
          "manage_node_membership": false,
          "manage_accounts": false,
          "view_logs": false,
          "run_admin_tasks": false,
          "run_tests": false
        }
      },
      "user": {
        "rights": {
          "manage_users": true,
          "modify_user_contact_settings": true,
          "reset_user_password": true,
          "reset_user_two_factor": true,
          "manage_authorizations": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "view_events": true,
          "view_statistics": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    },
    "account_admin": true,
    "allow_su": true,
    "level": 0,
    "timezone": "local",
    "two_factor": {
      "auth": "none"
    },
    "email": null,
    "email_notify": false,
    "email_verified": false,
    "sms": {
      "number": "XXX-XXX-XXXX",
      "valid": false
    },
    "sms_notify": false,
    "password_set": false,
    "sessions": [

    ]
  }
]

User Profile Create

Create a new user profile.

POST /user-profile

Required Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | username | string | user-assigned portion of username (username@account)
Length: 1..64 |

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | xmd_refs | array | array of extensible metadata reference keys | | xref | nullable string | arbitrary string reference
Length: 1..256 | | host | string | server hostname originating request (for url) | | password | nullable string | user-assigned password
Length: 1..64 | | two_factor:auth | string | two-factor authentication type
default: "none"
one of:"none" or "yubikey" or "google" | | two_factor:otp | string | one-time-password from authentication device
Length: 1..∞ | | two_factor:secret | string | shared AES secret
pattern: ^[a-fA-F0-9]$
Length: 1..∞ | | two_factor:private_id | string | yubikey private ID
pattern: ^[a-fA-F0-9]$
Length: 1..∞ | | two_factor:security_email | email | security email for lost authenticator recovery
Length: 0..128 | | permissions:realm:rights:can_switch_user | boolean | can SU to lower level user | | permissions:realm:rights:manage_node_membership | boolean | accept or delete nodes from the management network | | permissions:realm:rights:manage_accounts | boolean | can create or delete other accounts, users and their settings | | permissions:realm:rights:view_logs | boolean | view administrative logs | | permissions:realm:rights:run_admin_tasks | boolean | run realm administrative tasks | | permissions:realm:rights:run_tests | boolean | run realm administrative tests | | permissions:node:all_realm_scope | boolean | apply to all nodes in the realm
default: true | | permissions:node:nodes | array | scope permissions to specific nodes | | permissions:node:rights:manage_storage | boolean | configure OS devices, iSCSI devices, and system datastores | | permissions:node:rights:manage_networks | boolean | configure networks | | permissions:node:rights:provision_vss | boolean | manually provision virtual storage services | | permissions:node:rights:remove_vss | boolean | remove virtual storage services | | permissions:vss:all_account_scope | boolean | apply to all virtual storage services in the account
default: true | | permissions:vss:vsses | array | limit scope to specified vsses | | permissions:vss:rights:dismiss_tasks | boolean | dismiss tasks | | permissions:vss:rights:update_vss | boolean | update vss configuration | | permissions:vss:rights:remove_vss | boolean | remove vss | | permissions:vss:rights:set_vss_quota | boolean | set vss quota | | permissions:vss:rights:manage_internal_disks | boolean | manage internal disks | | permissions:vss:rights:manage_external_disks | boolean | manage external disks | | permissions:vss:rights:manage_removable_disks | boolean | manage removable disks | | permissions:vss:rights:manage_disk_cryptography | boolean | manage disk cryptography | | permissions:vss:rights:remove_locked_disks | boolean | remove locked disks | | permissions:vss:rights:validate_data_integrity | boolean | validate data integrity | | permissions:vss:rights:manage_targets | boolean | manage targets | | permissions:vss:rights:manage_profiles | boolean | manage profiles | | permissions:vss:rights:manage_secure_access_tokens | boolean | manage secure access tokens | | permissions:vss:rights:manage_rules | boolean | manage rules | | permissions:vss:rights:replicate_disks | boolean | replicate disks | | permissions:vss:rights:synchronize_disks | boolean | synchronize disks | | permissions:vss:rights:format_disks | boolean | format disks | | permissions:vss:rights:resize_disks | boolean | resize disks | | permissions:vss:rights:manage_snapshots | boolean | manage snapshots | | permissions:vss:rights:backup_disks | boolean | backup disks | | permissions:vss:rights:replicate_and_synchronize_disks | boolean | replicate and synchronize disks (DEPRECATED) | | permissions:vss:rights:compress_disks | boolean | compress disks | | permissions:vss:rights:manage_disk_compression | boolean | manage disk | | permissions:user:rights:manage_users | boolean | create or delete users in an account | | permissions:user:rights:modify_user_contact_settings | boolean | modify user contact info | | permissions:user:rights:reset_user_password | boolean | reset user password | | permissions:user:rights:reset_user_two_factor | boolean | reset two factor authentication | | permissions:user:rights:manage_authorizations | boolean | create or delete persistent authorizations | | permissions:account:rights:modify_contact_settings | boolean | modify account contact settings | | permissions:account:rights:view_events | boolean | view events | | permissions:account:rights:view_statistics | boolean | view statistics | | permissions:account:rights:manage_global_profiles | boolean | manage global profiles | | permissions:account:rights:manage_global_secure_access_tokens | boolean | manage global secure access tokens | | permissions:account:rights:query_catalog | boolean | query product catalog | | permissions:account:rights:provision_vss | boolean | provision vss from catalog | | permissions:account:rights:manage_obj_stores | boolean | manage obj stores | | permissions:account:rights:read_object_storage | boolean | read from object storage | | permissions:account:rights:write_object_storage | boolean | write to object storage | | permissions:account:rights:delete_object_storage | boolean | delete from object storage | | access:web | boolean | web access permitted
default: true | | access:api | boolean | API access permitted
default: true | | allow_su | boolean | admin allowed to SU to user | | email_notify | boolean | email notifications enabled | | email | nullable email | email address
Length: 0..128 | | email_verify | boolean | require email address verification | | sms_notify | boolean | SMS notifications enabled | | sms | string | notification number for SMS messages | | sms_verify | boolean | require SMS number verification | | app_default | string | default web-ui application
default: "storage"
one of:"storage" or "infrastructure" or "account" or "securedrive" | | account_id | string | account id | | level | integer | user privilege level | | uuid | uuid | object UUID |

Curl Example

$ curl -X POST https://mgmt-node/api/user-profile \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "username": "account421",
  "password": "password421",
  "account_id": "account:10:10"
}'

Response Example

201 Created
Date: Mon, 09 Oct 2017 17:26:54 GMT
Server: Goliath
ETag: "1f8aac360f9ceb42a4143aa83f8c152b"
Content-Type: application/json
Content-Length: 2069

{
  "id": "user_profile:16:10",
  "uuid": "11bccdde-f3b6-4b65-a28f-25d0463b1564",
  "serial": "USR1B62194C4062655E",
  "evt_qry": "serial=USR1B62194C4062655E",
  "account_id": "account:10:10",
  "ctime": 1507570014375,
  "mtime": 1507570014375,
  "seq": 1507570014382,
  "label": null,
  "status": null,
  "ec": {
    "table": null,
    "status": "retrieving",
    "seq": 1507570014382
  },
  "rec_status": null,
  "xmd_refs": [

  ],
  "xref": null,
  "xmd": null,
  "login": "account421@account42",
  "activated": true,
  "app_default": "storage",
  "access": {
    "web": true,
    "api": true
  },
  "permissions": {
    "node": {
      "all_realm_scope": false,
      "nodes": [

      ],
      "rights": {
        "manage_storage": false,
        "manage_networks": false,
        "provision_vss": false,
        "remove_vss": false
      }
    },
    "vss": {
      "all_account_scope": true,
      "rights": {
        "dismiss_tasks": true,
        "update_vss": true,
        "remove_vss": true,
        "set_vss_quota": true,
        "manage_internal_disks": true,
        "manage_external_disks": true,
        "manage_removable_disks": true,
        "manage_disk_cryptography": true,
        "remove_locked_disks": true,
        "replicate_disks": true,
        "synchronize_disks": true,
        "format_disks": true,
        "resize_disks": true,
        "backup_disks": true,
        "validate_data_integrity": true,
        "manage_snapshots": true,
        "manage_targets": true,
        "manage_profiles": true,
        "manage_secure_access_tokens": true,
        "manage_rules": true
      }
    },
    "realm": {
      "rights": {
        "can_switch_user": false,
        "manage_node_membership": false,
        "manage_accounts": false,
        "view_logs": false,
        "run_admin_tasks": false,
        "run_tests": false
      }
    },
    "user": {
      "rights": {
        "manage_users": true,
        "modify_user_contact_settings": true,
        "reset_user_password": true,
        "reset_user_two_factor": true,
        "manage_authorizations": true
      }
    },
    "account": {
      "rights": {
        "modify_contact_settings": true,
        "manage_global_profiles": true,
        "manage_global_secure_access_tokens": true,
        "view_events": true,
        "view_statistics": true,
        "query_catalog": true,
        "provision_vss": true,
        "manage_obj_stores": true,
        "read_object_storage": true,
        "write_object_storage": true,
        "delete_object_storage": true
      }
    }
  },
  "account_admin": false,
  "allow_su": false,
  "level": 0,
  "timezone": "local",
  "two_factor": {
    "auth": "none"
  },
  "email": null,
  "email_notify": false,
  "email_verified": false,
  "sms": {
    "number": "XXX-XXX-XXXX",
    "valid": false
  },
  "sms_notify": false,
  "password_set": true,
  "sessions": [

  ]
}

User Profile Remove

Remove an existing user profile.

DELETE /user-profile/{user_profile_id_or_serial}

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | account_id | string | account id |

Curl Example

$ curl -X DELETE https://mgmt-node/api/user-profile/user_profile:16:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

204 No Content
Date: Mon, 09 Oct 2017 17:26:55 GMT
Server: Goliath

User Profile Update

Change the configuration of an existing user profile.

PATCH /user-profile/{user_profile_id_or_serial}

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | xmd_refs | array | array of extensible metadata reference keys | | host | string | server hostname originating request (for url) | | new_password | nullable string | new password | | auth_password | string | current password; required when changing password for non-admin users | | two_factor:auth | string | two-factor authentication type
one of:"none" or "yubikey" or "google" | | two_factor:otp | string | one-time-password from authentication device
Length: 1..∞ | | two_factor:secret | string | shared AES secret
pattern: ^[a-fA-F0-9]$
Length: 1..∞ | | two_factor:private_id | string | yubikey private ID
pattern: ^[a-fA-F0-9]$
Length: 1..∞ | | two_factor:security_email | email | security email for lost authenticator recovery
Length: 0..128 | | two_factor:state | string | enable or disable two-factor authentication
one of:"enable" or "disable" | | email_notify | boolean | email notifications are enabled | | email | nullable email | notification email address
Length: 0..128 | | email_verify | boolean | require email address verification | | sms_notify | boolean | SMS notifications enabled | | sms | string | notification number for SMS messages | | sms_verify | boolean | require SMS number verification | | app_default | string | default web-ui application
one of:"storage" or "infrastructure" or "account" or "securedrive" | | activated | boolean | user profile activated | | ext_auth:key | nullable string | no documentation | | ext_auth:scope | nullable string | name of external authentication scope | | ext_auth:login | nullable string | mapped external login | | ext_auth:domain | nullable string | mapped external domain | | ext_auth:domain_function | nullable string | mapped external domain function | | permissions:realm:rights:can_switch_user | boolean | can SU to lower level user | | permissions:realm:rights:manage_node_membership | boolean | accept or delete nodes from the management network | | permissions:realm:rights:manage_accounts | boolean | can create or delete other accounts, users and their settings | | permissions:realm:rights:view_logs | boolean | view administrative logs | | permissions:realm:rights:run_admin_tasks | boolean | run realm administrative tasks | | permissions:realm:rights:run_tests | boolean | run realm administrative tests | | permissions:node:all_realm_scope | boolean | apply to all nodes in the realm
default: true | | permissions:node:nodes | array | scope permissions to specific nodes | | permissions:node:rights:manage_storage | boolean | configure OS devices, iSCSI devices, and system datastores | | permissions:node:rights:manage_networks | boolean | configure networks | | permissions:node:rights:provision_vss | boolean | manually provision virtual storage services | | permissions:node:rights:remove_vss | boolean | remove virtual storage services | | permissions:vss:all_account_scope | boolean | apply to all virtual storage services in the account
default: true | | permissions:vss:vsses | array | limit scope to specified vsses | | permissions:vss:rights:dismiss_tasks | boolean | dismiss tasks | | permissions:vss:rights:update_vss | boolean | update vss configuration | | permissions:vss:rights:remove_vss | boolean | remove vss | | permissions:vss:rights:set_vss_quota | boolean | set vss quota | | permissions:vss:rights:manage_internal_disks | boolean | manage internal disks | | permissions:vss:rights:manage_external_disks | boolean | manage external disks | | permissions:vss:rights:manage_removable_disks | boolean | manage removable disks | | permissions:vss:rights:manage_disk_cryptography | boolean | manage disk cryptography | | permissions:vss:rights:remove_locked_disks | boolean | remove locked disks | | permissions:vss:rights:validate_data_integrity | boolean | validate data integrity | | permissions:vss:rights:manage_targets | boolean | manage targets | | permissions:vss:rights:manage_profiles | boolean | manage profiles | | permissions:vss:rights:manage_secure_access_tokens | boolean | manage secure access tokens | | permissions:vss:rights:manage_rules | boolean | manage rules | | permissions:vss:rights:replicate_disks | boolean | replicate disks | | permissions:vss:rights:synchronize_disks | boolean | synchronize disks | | permissions:vss:rights:format_disks | boolean | format disks | | permissions:vss:rights:resize_disks | boolean | resize disks | | permissions:vss:rights:manage_snapshots | boolean | manage snapshots | | permissions:vss:rights:backup_disks | boolean | backup disks | | permissions:vss:rights:replicate_and_synchronize_disks | boolean | replicate and synchronize disks (DEPRECATED) | | permissions:vss:rights:compress_disks | boolean | compress disks | | permissions:vss:rights:manage_disk_compression | boolean | manage disk | | permissions:user:rights:manage_users | boolean | create or delete users in an account | | permissions:user:rights:modify_user_contact_settings | boolean | modify user contact info | | permissions:user:rights:reset_user_password | boolean | reset user password | | permissions:user:rights:reset_user_two_factor | boolean | reset two factor authentication | | permissions:user:rights:manage_authorizations | boolean | create or delete persistent authorizations | | permissions:account:rights:modify_contact_settings | boolean | modify account contact settings | | permissions:account:rights:view_events | boolean | view events | | permissions:account:rights:view_statistics | boolean | view statistics | | permissions:account:rights:manage_global_profiles | boolean | manage global profiles | | permissions:account:rights:manage_global_secure_access_tokens | boolean | manage global secure access tokens | | permissions:account:rights:query_catalog | boolean | query product catalog | | permissions:account:rights:provision_vss | boolean | provision vss from catalog | | permissions:account:rights:manage_obj_stores | boolean | manage obj stores | | permissions:account:rights:read_object_storage | boolean | read from object storage | | permissions:account:rights:write_object_storage | boolean | write to object storage | | permissions:account:rights:delete_object_storage | boolean | delete from object storage | | permissions_update_mode | string | user permissions update mode
default: "merge"
one of:"replace" or "merge" | | allow_su | boolean | admin allowed to SU to user | | account_id | string | account id |

Curl Example

$ curl -X PATCH https://mgmt-node/api/user-profile/user_profile:16:10 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "activated": false
}'

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:54 GMT
Server: Goliath
ETag: "14ea1ef48b481c651dfac513537e09a5"
Content-Type: application/json
Content-Length: 2070

{
  "id": "user_profile:16:10",
  "uuid": "11bccdde-f3b6-4b65-a28f-25d0463b1564",
  "serial": "USR1B62194C4062655E",
  "evt_qry": "serial=USR1B62194C4062655E",
  "account_id": "account:10:10",
  "ctime": 1507570014375,
  "mtime": 1507570014709,
  "seq": 1507570014716,
  "label": null,
  "status": null,
  "ec": {
    "table": null,
    "status": "retrieving",
    "seq": 1507570014382
  },
  "rec_status": null,
  "xmd_refs": [

  ],
  "xref": null,
  "xmd": null,
  "login": "account421@account42",
  "activated": false,
  "app_default": "storage",
  "access": {
    "web": true,
    "api": true
  },
  "permissions": {
    "node": {
      "all_realm_scope": false,
      "nodes": [

      ],
      "rights": {
        "manage_storage": false,
        "manage_networks": false,
        "provision_vss": false,
        "remove_vss": false
      }
    },
    "vss": {
      "all_account_scope": true,
      "rights": {
        "dismiss_tasks": true,
        "update_vss": true,
        "remove_vss": true,
        "set_vss_quota": true,
        "manage_internal_disks": true,
        "manage_external_disks": true,
        "manage_removable_disks": true,
        "manage_disk_cryptography": true,
        "remove_locked_disks": true,
        "replicate_disks": true,
        "synchronize_disks": true,
        "format_disks": true,
        "resize_disks": true,
        "backup_disks": true,
        "validate_data_integrity": true,
        "manage_snapshots": true,
        "manage_targets": true,
        "manage_profiles": true,
        "manage_secure_access_tokens": true,
        "manage_rules": true
      }
    },
    "realm": {
      "rights": {
        "can_switch_user": false,
        "manage_node_membership": false,
        "manage_accounts": false,
        "view_logs": false,
        "run_admin_tasks": false,
        "run_tests": false
      }
    },
    "user": {
      "rights": {
        "manage_users": true,
        "modify_user_contact_settings": true,
        "reset_user_password": true,
        "reset_user_two_factor": true,
        "manage_authorizations": true
      }
    },
    "account": {
      "rights": {
        "modify_contact_settings": true,
        "manage_global_profiles": true,
        "manage_global_secure_access_tokens": true,
        "view_events": true,
        "view_statistics": true,
        "query_catalog": true,
        "provision_vss": true,
        "manage_obj_stores": true,
        "read_object_storage": true,
        "write_object_storage": true,
        "delete_object_storage": true
      }
    }
  },
  "account_admin": false,
  "allow_su": false,
  "level": 0,
  "timezone": "local",
  "two_factor": {
    "auth": "none"
  },
  "email": null,
  "email_notify": false,
  "email_verified": false,
  "sms": {
    "number": "XXX-XXX-XXXX",
    "valid": false
  },
  "sms_notify": false,
  "password_set": true,
  "sessions": [

  ]
}

User Profile Permissions

Enumerate the permissions of an existing user profile.

GET /user-profile/permissions

Curl Example

$ curl https://mgmt-node/api/user-profile/permissions \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:54 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 3052

{
  "node": {
    "all_realm_scope": "apply permissions to all nodes",
    "rights": {
      "manage_storage": "node permission to manage storage",
      "manage_networks": "node permission to manage networks",
      "provision_vss": "node permission to provision vss",
      "remove_vss": "node permission to remove vss"
    }
  },
  "vss": {
    "all_account_scope": "apply permissions to all virtual storage services",
    "rights": {
      "dismiss_tasks": "vss permission to dismiss tasks",
      "update_vss": "vss permission to update vss configuration",
      "remove_vss": "vss permission to remove vss",
      "set_vss_quota": "vss permission to set vss quota",
      "manage_internal_disks": "vss permission to manage internal disks",
      "manage_external_disks": "vss permission to manage external disks",
      "manage_removable_disks": "vss permission to manage removable disks",
      "manage_disk_cryptography": "vss permission to manage disk cryptography",
      "remove_locked_disks": "vss permission to remove locked disks",
      "replicate_disks": "vss permission to configure replication",
      "synchronize_disks": "vss permission to synchronize disk contents",
      "format_disks": "vss permission to format disks",
      "resize_disks": "vss permission to resize disks",
      "backup_disks": "vss permission to backup disks",
      "validate_data_integrity": "vss permission to validate data integrity",
      "manage_snapshots": "vss permission to create, update and remove snapshots",
      "manage_targets": "vss permission to manage targets",
      "manage_profiles": "vss permission to manage profiles",
      "manage_secure_access_tokens": "vss permission to manage secure access tokens",
      "manage_rules": "vss permission to manage rules"
    }
  },
  "realm": {
    "rights": {
      "can_switch_user": "realm permission to switch users",
      "manage_node_membership": "realm permission to manage node membership",
      "manage_accounts": "realm permission to manage accounts",
      "view_logs": "realm permission to view logs",
      "run_admin_tasks": "realm permission to run administrator tasks",
      "run_tests": "realm permission to run tests"
    }
  },
  "user": {
    "rights": {
      "manage_users": "user permission to manage users",
      "modify_user_contact_settings": "user permission to modify user contact settings",
      "reset_user_password": "user permission to reset user password",
      "reset_user_two_factor": "user permission to reset user two-factor authentication",
      "manage_authorizations": "user permission to manage persistent authorizations"
    }
  },
  "account": {
    "rights": {
      "modify_contact_settings": "account permission to modify contact settings",
      "manage_global_profiles": "account permission to manage global profiles",
      "manage_global_secure_access_tokens": "account permission to manage global secure access tokens",
      "view_events": "account permission to view events",
      "view_statistics": "account permission to view statistics",
      "query_catalog": "account permission to query the catalog",
      "provision_vss": "account permission to provision from the catalog",
      "manage_obj_stores": "account permission to manage obj stores",
      "read_object_storage": "account permission to read from object storage",
      "write_object_storage": "account permission to write to object storage",
      "delete_object_storage": "account permission to delete from object storage"
    }
  }
}

OAuth 2 Access Token

Submit a username and password to create a time-limited OAuth 2 API access token. Include this token in the Authorization HTTP header in subsequent requests. For example,:

Authorization: Bearer 0/EYZPk2DHOQ+ep8NyFerJake9NCG+M3WSbsoj5cfn6L5xh0+TYMc6Hw

OAuth 2 Access Token Create

Exchange authorization of some sort for an access token.

POST /oauth2/token

Required Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | grant_type | string | type of grant request |

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | client_id | string | (optional) client id of request | | client_secret | string | (optional) client supplied secret | | code | string | (optional) code | | redirect_url | string | (optional) redirect url | | username | string | username to request token for | | password | string | password for username | | method | string | (optional) method of authorization | | expires_in | integer | when access token will expire (in seconds) |

Curl Example

$ curl -X POST https://mgmt-node/api/oauth2/token \
  -H "Content-Type: application/json" \
  -d \
'{
  "grant_type": "password",
  "username": "system",
  "password": "system"
}'

Response Example

201 Created
Date: Mon, 09 Oct 2017 17:26:50 GMT
Server: Goliath
Cache-Control: no-store
Pragma: no-cache
Content-Type: application/json
Content-Length: 305

{
  "access_token": "0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg",
  "token_type": "Bearer",
  "expires_in": 3599,
  "user": {
    "id": "session:16:10",
    "user": {
      "name": "system",
      "id": "user_profile:1:10",
      "serial": "USR1B62194C40626440"
    },
    "account": {
      "name": "system",
      "id": "account:1:10",
      "serial": "ACT0762194C40626445"
    }
  }
}

Authorization

Manage secure application access to the API using revokable authorization tokens. A user may have many authorization tokens, in support of many different applications. Each token may be independently revoked with a DELETE request.

Attributes

Authorization Info

Retrieve existing authorizations.

GET /authorization/{authz_id_or_serial}

Curl Example

$ curl https://mgmt-node/api/authorization/authz:8:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:55 GMT
Server: Goliath
ETag: "15063787638d004d7fa22789908788fa"
Content-Type: application/json
Content-Length: 2577

{
  "id": "authz:8:10",
  "serial": "ATH4762194C406264DA",
  "account_id": "account:1:10",
  "user_id": "user_profile:1:10",
  "xref": null,
  "notes": null,
  "fingerprint": null,
  "enabled": true,
  "app_id": null,
  "scope": null,
  "access_type": "online",
  "lifetime": null,
  "restrict": "auth",
  "enforce_two_factor": false,
  "created_at": "2017-10-09T17:26:55.195+00:00",
  "updated_at": "2017-10-09T17:26:55.195+00:00",
  "expires_in": null,
  "access_token_digest": "+rQjeekqAsn2Dpc+SswdGSG8Dj1MpKPzbsGoYP00onc",
  "access_token_suffix": "ZM3mJpCA",
  "refresh_token_digest": null,
  "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
  "permissions": {
    "realm": {
      "rights": {
        "can_switch_user": true,
        "manage_node_membership": true,
        "manage_accounts": true,
        "view_logs": true,
        "run_admin_tasks": true,
        "run_tests": true
      }
    },
    "node": {
      "all_realm_scope": true,
      "rights": {
        "manage_storage": true,
        "manage_networks": true,
        "provision_vss": true,
        "remove_vss": true
      }
    },
    "vss": {
      "all_account_scope": true,
      "rights": {
        "dismiss_tasks": true,
        "update_vss": true,
        "remove_vss": true,
        "set_vss_quota": true,
        "manage_internal_disks": true,
        "manage_external_disks": true,
        "manage_removable_disks": true,
        "manage_disk_cryptography": true,
        "remove_locked_disks": true,
        "replicate_disks": true,
        "synchronize_disks": true,
        "format_disks": true,
        "resize_disks": true,
        "backup_disks": true,
        "validate_data_integrity": true,
        "manage_snapshots": true,
        "manage_targets": true,
        "manage_profiles": true,
        "manage_secure_access_tokens": true,
        "manage_rules": true
      }
    },
    "account": {
      "rights": {
        "modify_contact_settings": true,
        "view_events": true,
        "view_statistics": true,
        "manage_global_profiles": true,
        "manage_global_secure_access_tokens": true,
        "query_catalog": true,
        "provision_vss": true,
        "manage_obj_stores": true,
        "read_object_storage": true,
        "write_object_storage": true,
        "delete_object_storage": true
      }
    }
  }
}

Authorization List

Enumerate authorizations.

GET /authorization

Curl Example

$ curl https://mgmt-node/api/authorization \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:55 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 18469

[
  {
    "id": "authz:4:10",
    "serial": "ATH4762194C40626418",
    "account_id": "account:1:10",
    "user_id": "user_profile:1:10",
    "xref": null,
    "notes": "authz updated to be disabled",
    "fingerprint": null,
    "enabled": false,
    "app_id": null,
    "scope": null,
    "access_type": "online",
    "lifetime": null,
    "restrict": "auth",
    "enforce_two_factor": false,
    "created_at": "2017-10-09T16:52:24.826+00:00",
    "updated_at": "2017-10-09T16:52:25.211+00:00",
    "expires_in": null,
    "access_token_digest": "3wKrRNRjjMNRG/J9AN3aNdv6sAC/uAWsv2KYzW71g2c",
    "access_token_suffix": "7tASp9eg",
    "refresh_token_digest": null,
    "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
    "permissions": {
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "view_events": true,
          "view_statistics": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    }
  },
  {
    "id": "authz:8:10",
    "serial": "ATH4762194C406264DA",
    "account_id": "account:1:10",
    "user_id": "user_profile:1:10",
    "xref": null,
    "notes": null,
    "fingerprint": null,
    "enabled": true,
    "app_id": null,
    "scope": null,
    "access_type": "online",
    "lifetime": null,
    "restrict": "auth",
    "enforce_two_factor": false,
    "created_at": "2017-10-09T17:26:55.195+00:00",
    "updated_at": "2017-10-09T17:26:55.195+00:00",
    "expires_in": null,
    "access_token_digest": "+rQjeekqAsn2Dpc+SswdGSG8Dj1MpKPzbsGoYP00onc",
    "access_token_suffix": "ZM3mJpCA",
    "refresh_token_digest": null,
    "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
    "permissions": {
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "view_events": true,
          "view_statistics": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    }
  },
  {
    "id": "authz:5:10",
    "serial": "ATH4762194C40626400",
    "account_id": "account:1:10",
    "user_id": "user_profile:1:10",
    "xref": null,
    "notes": "authz updated to be disabled",
    "fingerprint": null,
    "enabled": false,
    "app_id": null,
    "scope": null,
    "access_type": "online",
    "lifetime": null,
    "restrict": "auth",
    "enforce_two_factor": false,
    "created_at": "2017-10-09T16:57:13.342+00:00",
    "updated_at": "2017-10-09T16:57:13.740+00:00",
    "expires_in": null,
    "access_token_digest": "zKVffwlpVKIxvE3BqRMJOmK4EKwbSrewJVRhEdLqOQA",
    "access_token_suffix": "USFxtvCQ",
    "refresh_token_digest": null,
    "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
    "permissions": {
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "view_events": true,
          "view_statistics": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    }
  },
  {
    "id": "authz:1:10",
    "serial": "ATH4762194C40626441",
    "account_id": "account:1:10",
    "user_id": "user_profile:1:10",
    "xref": null,
    "notes": null,
    "fingerprint": null,
    "enabled": true,
    "app_id": null,
    "scope": null,
    "access_type": "online",
    "lifetime": null,
    "restrict": "none",
    "enforce_two_factor": false,
    "created_at": "2017-10-09T15:27:15.198+00:00",
    "updated_at": "2017-10-09T15:27:15.198+00:00",
    "expires_in": null,
    "access_token_digest": "ZR1XPlVBm4h2aouqN0q/Ark46/iw7lu4xV7zfd8Elho",
    "access_token_suffix": "5jYFny4w",
    "refresh_token_digest": null,
    "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage u:r=manage_users u:r=modify_user_contact_settings u:r=reset_user_password u:r=reset_user_two_factor u:r=manage_authorizations n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
    "permissions": {
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "user": {
        "rights": {
          "manage_users": true,
          "modify_user_contact_settings": true,
          "reset_user_password": true,
          "reset_user_two_factor": true,
          "manage_authorizations": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "view_events": true,
          "view_statistics": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    }
  },
  {
    "id": "authz:6:10",
    "serial": "ATH4762194C40626438",
    "account_id": "account:1:10",
    "user_id": "user_profile:1:10",
    "xref": null,
    "notes": "authz updated to be disabled",
    "fingerprint": null,
    "enabled": false,
    "app_id": null,
    "scope": null,
    "access_type": "online",
    "lifetime": null,
    "restrict": "auth",
    "enforce_two_factor": false,
    "created_at": "2017-10-09T17:23:18.287+00:00",
    "updated_at": "2017-10-09T17:23:18.687+00:00",
    "expires_in": null,
    "access_token_digest": "2xjPfMNO8Vsee3cF9Nf7Pc0Hvh4tIg6dSKmTLLOhUqc",
    "access_token_suffix": "cb7BffIQ",
    "refresh_token_digest": null,
    "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
    "permissions": {
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "view_events": true,
          "view_statistics": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    }
  },
  {
    "id": "authz:7:10",
    "serial": "ATH4762194C40626420",
    "account_id": "account:1:10",
    "user_id": "user_profile:1:10",
    "xref": null,
    "notes": "authz updated to be disabled",
    "fingerprint": null,
    "enabled": false,
    "app_id": null,
    "scope": null,
    "access_type": "online",
    "lifetime": null,
    "restrict": "auth",
    "enforce_two_factor": false,
    "created_at": "2017-10-09T17:26:08.527+00:00",
    "updated_at": "2017-10-09T17:26:08.944+00:00",
    "expires_in": null,
    "access_token_digest": "c+9quISbNsmFNpUMqZVdXip4YBN/SRCfWJI9/c+hj8c",
    "access_token_suffix": "41uymTyw",
    "refresh_token_digest": null,
    "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
    "permissions": {
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "view_events": true,
          "view_statistics": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    }
  },
  {
    "id": "authz:3:10",
    "serial": "ATH4762194C40626461",
    "account_id": "account:1:10",
    "user_id": "user_profile:1:10",
    "xref": null,
    "notes": "authz updated to be disabled",
    "fingerprint": null,
    "enabled": false,
    "app_id": null,
    "scope": null,
    "access_type": "online",
    "lifetime": null,
    "restrict": "auth",
    "enforce_two_factor": false,
    "created_at": "2017-10-09T15:38:47.532+00:00",
    "updated_at": "2017-10-09T15:38:47.907+00:00",
    "expires_in": null,
    "access_token_digest": "C4nYZuzLrQPzugNyjRREMwXP9QBXhCDNzYYoYBD25p0",
    "access_token_suffix": "QR4Wo+nQ",
    "refresh_token_digest": null,
    "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
    "permissions": {
      "realm": {
        "rights": {
          "can_switch_user": true,
          "manage_node_membership": true,
          "manage_accounts": true,
          "view_logs": true,
          "run_admin_tasks": true,
          "run_tests": true
        }
      },
      "node": {
        "all_realm_scope": true,
        "rights": {
          "manage_storage": true,
          "manage_networks": true,
          "provision_vss": true,
          "remove_vss": true
        }
      },
      "vss": {
        "all_account_scope": true,
        "rights": {
          "dismiss_tasks": true,
          "update_vss": true,
          "remove_vss": true,
          "set_vss_quota": true,
          "manage_internal_disks": true,
          "manage_external_disks": true,
          "manage_removable_disks": true,
          "manage_disk_cryptography": true,
          "remove_locked_disks": true,
          "replicate_disks": true,
          "synchronize_disks": true,
          "format_disks": true,
          "resize_disks": true,
          "backup_disks": true,
          "validate_data_integrity": true,
          "manage_snapshots": true,
          "manage_targets": true,
          "manage_profiles": true,
          "manage_secure_access_tokens": true,
          "manage_rules": true
        }
      },
      "account": {
        "rights": {
          "modify_contact_settings": true,
          "view_events": true,
          "view_statistics": true,
          "manage_global_profiles": true,
          "manage_global_secure_access_tokens": true,
          "query_catalog": true,
          "provision_vss": true,
          "manage_obj_stores": true,
          "read_object_storage": true,
          "write_object_storage": true,
          "delete_object_storage": true
        }
      }
    }
  }
]

Authorization Create

Create a persistent API authorization token.

POST /authorization

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | fingerprint | nullable string | client-side differentiator to permit multiple authorizations per application/user | | app_id | nullable string | associated client application (null = no/unspecified application) | | notes | nullable string | user assigned notes
Length: 0..256 | | scope | nullable string | authorization scope (null maps to referenced user permissions) | | enabled | boolean | authorization is enabled
default: true | | access_type | string | authorization access type (offline access includes a refresh token)
default: "online"
one of:"online" or "offline" | | restrict | string | specify how the user permissions are mapped/filtered
default: "auth"
one of:"none" or "auth" | | permissions:realm:rights:can_switch_user | boolean | can SU to lower level user | | permissions:realm:rights:manage_node_membership | boolean | accept or delete nodes from the management network | | permissions:realm:rights:manage_accounts | boolean | can create or delete other accounts, users and their settings | | permissions:realm:rights:view_logs | boolean | view administrative logs | | permissions:realm:rights:run_admin_tasks | boolean | run realm administrative tasks | | permissions:realm:rights:run_tests | boolean | run realm administrative tests | | permissions:node:all_realm_scope | boolean | apply to all nodes in the realm
default: true | | permissions:node:nodes | array | scope permissions to specific nodes | | permissions:node:rights:manage_storage | boolean | configure OS devices, iSCSI devices, and system datastores | | permissions:node:rights:manage_networks | boolean | configure networks | | permissions:node:rights:provision_vss | boolean | manually provision virtual storage services | | permissions:node:rights:remove_vss | boolean | remove virtual storage services | | permissions:vss:all_account_scope | boolean | apply to all virtual storage services in the account
default: true | | permissions:vss:vsses | array | limit scope to specified vsses | | permissions:vss:rights:dismiss_tasks | boolean | dismiss tasks | | permissions:vss:rights:update_vss | boolean | update vss configuration | | permissions:vss:rights:remove_vss | boolean | remove vss | | permissions:vss:rights:set_vss_quota | boolean | set vss quota | | permissions:vss:rights:manage_internal_disks | boolean | manage internal disks | | permissions:vss:rights:manage_external_disks | boolean | manage external disks | | permissions:vss:rights:manage_removable_disks | boolean | manage removable disks | | permissions:vss:rights:manage_disk_cryptography | boolean | manage disk cryptography | | permissions:vss:rights:remove_locked_disks | boolean | remove locked disks | | permissions:vss:rights:validate_data_integrity | boolean | validate data integrity | | permissions:vss:rights:manage_targets | boolean | manage targets | | permissions:vss:rights:manage_profiles | boolean | manage profiles | | permissions:vss:rights:manage_secure_access_tokens | boolean | manage secure access tokens | | permissions:vss:rights:manage_rules | boolean | manage rules | | permissions:vss:rights:replicate_disks | boolean | replicate disks | | permissions:vss:rights:synchronize_disks | boolean | synchronize disks | | permissions:vss:rights:format_disks | boolean | format disks | | permissions:vss:rights:resize_disks | boolean | resize disks | | permissions:vss:rights:manage_snapshots | boolean | manage snapshots | | permissions:vss:rights:backup_disks | boolean | backup disks | | permissions:vss:rights:replicate_and_synchronize_disks | boolean | replicate and synchronize disks (DEPRECATED) | | permissions:vss:rights:compress_disks | boolean | compress disks | | permissions:vss:rights:manage_disk_compression | boolean | manage disk | | permissions:user:rights:manage_users | boolean | create or delete users in an account | | permissions:user:rights:modify_user_contact_settings | boolean | modify user contact info | | permissions:user:rights:reset_user_password | boolean | reset user password | | permissions:user:rights:reset_user_two_factor | boolean | reset two factor authentication | | permissions:user:rights:manage_authorizations | boolean | create or delete persistent authorizations | | permissions:account:rights:modify_contact_settings | boolean | modify account contact settings | | permissions:account:rights:view_events | boolean | view events | | permissions:account:rights:view_statistics | boolean | view statistics | | permissions:account:rights:manage_global_profiles | boolean | manage global profiles | | permissions:account:rights:manage_global_secure_access_tokens | boolean | manage global secure access tokens | | permissions:account:rights:query_catalog | boolean | query product catalog | | permissions:account:rights:provision_vss | boolean | provision vss from catalog | | permissions:account:rights:manage_obj_stores | boolean | manage obj stores | | permissions:account:rights:read_object_storage | boolean | read from object storage | | permissions:account:rights:write_object_storage | boolean | write to object storage | | permissions:account:rights:delete_object_storage | boolean | delete from object storage | | uuid | uuid | object UUID | | xref | string | arbitrary string reference
Length: 1..256 | | enforce_two_factor | boolean | enforce user two-factor auth (if configured) | | user_id | string | user profile id |

Curl Example

$ curl -X POST https://mgmt-node/api/authorization \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

201 Created
Date: Mon, 09 Oct 2017 17:26:55 GMT
Server: Goliath
Cache-Control: no-store
Pragma: no-cache
Content-Type: application/json
Content-Length: 2672

{
  "id": "authz:8:10",
  "serial": "ATH4762194C406264DA",
  "account_id": "account:1:10",
  "user_id": "user_profile:1:10",
  "xref": null,
  "notes": null,
  "fingerprint": null,
  "enabled": true,
  "app_id": null,
  "scope": null,
  "access_type": "online",
  "lifetime": null,
  "restrict": "auth",
  "enforce_two_factor": false,
  "created_at": "2017-10-09T17:26:55.195+00:00",
  "updated_at": "2017-10-09T17:26:55.195+00:00",
  "expires_in": null,
  "access_token_digest": "+rQjeekqAsn2Dpc+SswdGSG8Dj1MpKPzbsGoYP00onc",
  "access_token_suffix": "ZM3mJpCA",
  "refresh_token_digest": null,
  "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
  "permissions": {
    "realm": {
      "rights": {
        "can_switch_user": true,
        "manage_node_membership": true,
        "manage_accounts": true,
        "view_logs": true,
        "run_admin_tasks": true,
        "run_tests": true
      }
    },
    "node": {
      "all_realm_scope": true,
      "rights": {
        "manage_storage": true,
        "manage_networks": true,
        "provision_vss": true,
        "remove_vss": true
      }
    },
    "vss": {
      "all_account_scope": true,
      "rights": {
        "dismiss_tasks": true,
        "update_vss": true,
        "remove_vss": true,
        "set_vss_quota": true,
        "manage_internal_disks": true,
        "manage_external_disks": true,
        "manage_removable_disks": true,
        "manage_disk_cryptography": true,
        "remove_locked_disks": true,
        "replicate_disks": true,
        "synchronize_disks": true,
        "format_disks": true,
        "resize_disks": true,
        "backup_disks": true,
        "validate_data_integrity": true,
        "manage_snapshots": true,
        "manage_targets": true,
        "manage_profiles": true,
        "manage_secure_access_tokens": true,
        "manage_rules": true
      }
    },
    "account": {
      "rights": {
        "modify_contact_settings": true,
        "view_events": true,
        "view_statistics": true,
        "manage_global_profiles": true,
        "manage_global_secure_access_tokens": true,
        "query_catalog": true,
        "provision_vss": true,
        "manage_obj_stores": true,
        "read_object_storage": true,
        "write_object_storage": true,
        "delete_object_storage": true
      }
    }
  },
  "access_token": "1/Yw7mTN5iY0ncIb3auY/1fl25VQsNWAx2xrIn5A4tseDjDuZM3mJpCA",
  "refresh_token": null
}

Authorization Remove

Remove a persistent API authorization token.

DELETE /authorization/{authz_id_or_serial}

Curl Example

$ curl -X DELETE https://mgmt-node/api/authorization/authz:8:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

204 No Content
Date: Mon, 09 Oct 2017 17:27:38 GMT
Server: Goliath

Authorization Update

Change a persistent API authorization token.

PATCH /authorization/{authz_id_or_serial}

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | enabled | boolean | authorization is enabled
default: true | | notes | nullable string | user assigned notes
Length: 0..256 | | scope | nullable string | authorization scope (null maps to referenced user permissions) | | permissions:realm:rights:can_switch_user | boolean | can SU to lower level user | | permissions:realm:rights:manage_node_membership | boolean | accept or delete nodes from the management network | | permissions:realm:rights:manage_accounts | boolean | can create or delete other accounts, users and their settings | | permissions:realm:rights:view_logs | boolean | view administrative logs | | permissions:realm:rights:run_admin_tasks | boolean | run realm administrative tasks | | permissions:realm:rights:run_tests | boolean | run realm administrative tests | | permissions:node:all_realm_scope | boolean | apply to all nodes in the realm
default: true | | permissions:node:nodes | array | scope permissions to specific nodes | | permissions:node:rights:manage_storage | boolean | configure OS devices, iSCSI devices, and system datastores | | permissions:node:rights:manage_networks | boolean | configure networks | | permissions:node:rights:provision_vss | boolean | manually provision virtual storage services | | permissions:node:rights:remove_vss | boolean | remove virtual storage services | | permissions:vss:all_account_scope | boolean | apply to all virtual storage services in the account
default: true | | permissions:vss:vsses | array | limit scope to specified vsses | | permissions:vss:rights:dismiss_tasks | boolean | dismiss tasks | | permissions:vss:rights:update_vss | boolean | update vss configuration | | permissions:vss:rights:remove_vss | boolean | remove vss | | permissions:vss:rights:set_vss_quota | boolean | set vss quota | | permissions:vss:rights:manage_internal_disks | boolean | manage internal disks | | permissions:vss:rights:manage_external_disks | boolean | manage external disks | | permissions:vss:rights:manage_removable_disks | boolean | manage removable disks | | permissions:vss:rights:manage_disk_cryptography | boolean | manage disk cryptography | | permissions:vss:rights:remove_locked_disks | boolean | remove locked disks | | permissions:vss:rights:validate_data_integrity | boolean | validate data integrity | | permissions:vss:rights:manage_targets | boolean | manage targets | | permissions:vss:rights:manage_profiles | boolean | manage profiles | | permissions:vss:rights:manage_secure_access_tokens | boolean | manage secure access tokens | | permissions:vss:rights:manage_rules | boolean | manage rules | | permissions:vss:rights:replicate_disks | boolean | replicate disks | | permissions:vss:rights:synchronize_disks | boolean | synchronize disks | | permissions:vss:rights:format_disks | boolean | format disks | | permissions:vss:rights:resize_disks | boolean | resize disks | | permissions:vss:rights:manage_snapshots | boolean | manage snapshots | | permissions:vss:rights:backup_disks | boolean | backup disks | | permissions:vss:rights:replicate_and_synchronize_disks | boolean | replicate and synchronize disks (DEPRECATED) | | permissions:vss:rights:compress_disks | boolean | compress disks | | permissions:vss:rights:manage_disk_compression | boolean | manage disk | | permissions:user:rights:manage_users | boolean | create or delete users in an account | | permissions:user:rights:modify_user_contact_settings | boolean | modify user contact info | | permissions:user:rights:reset_user_password | boolean | reset user password | | permissions:user:rights:reset_user_two_factor | boolean | reset two factor authentication | | permissions:user:rights:manage_authorizations | boolean | create or delete persistent authorizations | | permissions:account:rights:modify_contact_settings | boolean | modify account contact settings | | permissions:account:rights:view_events | boolean | view events | | permissions:account:rights:view_statistics | boolean | view statistics | | permissions:account:rights:manage_global_profiles | boolean | manage global profiles | | permissions:account:rights:manage_global_secure_access_tokens | boolean | manage global secure access tokens | | permissions:account:rights:query_catalog | boolean | query product catalog | | permissions:account:rights:provision_vss | boolean | provision vss from catalog | | permissions:account:rights:manage_obj_stores | boolean | manage obj stores | | permissions:account:rights:read_object_storage | boolean | read from object storage | | permissions:account:rights:write_object_storage | boolean | write to object storage | | permissions:account:rights:delete_object_storage | boolean | delete from object storage | | enforce_two_factor | boolean | enforce user two-factor auth (if configured) |

Curl Example

$ curl -X PATCH https://mgmt-node/api/authorization/authz:8:10 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "enabled": false,
  "notes": "authz updated to be disabled"
}'

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:55 GMT
Server: Goliath
ETag: "919bea09732c41cb208b03cd10885a81"
Content-Type: application/json
Content-Length: 2604

{
  "id": "authz:8:10",
  "serial": "ATH4762194C406264DA",
  "account_id": "account:1:10",
  "user_id": "user_profile:1:10",
  "xref": null,
  "notes": "authz updated to be disabled",
  "fingerprint": null,
  "enabled": false,
  "app_id": null,
  "scope": null,
  "access_type": "online",
  "lifetime": null,
  "restrict": "auth",
  "enforce_two_factor": false,
  "created_at": "2017-10-09T17:26:55.195+00:00",
  "updated_at": "2017-10-09T17:26:55.603+00:00",
  "expires_in": null,
  "access_token_digest": "+rQjeekqAsn2Dpc+SswdGSG8Dj1MpKPzbsGoYP00onc",
  "access_token_suffix": "ZM3mJpCA",
  "refresh_token_digest": null,
  "effective_scope": "r:r=can_switch_user r:r=manage_node_membership r:r=manage_accounts r:r=view_logs r:r=run_admin_tasks r:r=run_tests a:r=modify_contact_settings a:r=view_events a:r=view_statistics a:r=manage_global_profiles a:r=manage_global_secure_access_tokens a:r=query_catalog a:r=provision_vss a:r=manage_obj_stores a:r=read_object_storage a:r=write_object_storage a:r=delete_object_storage n:r=manage_storage n:r=manage_networks n:r=provision_vss n:r=remove_vss v:r=dismiss_tasks v:r=update_vss v:r=remove_vss v:r=set_vss_quota v:r=manage_internal_disks v:r=manage_external_disks v:r=manage_removable_disks v:r=manage_disk_cryptography v:r=remove_locked_disks v:r=replicate_disks v:r=synchronize_disks v:r=format_disks v:r=resize_disks v:r=backup_disks v:r=validate_data_integrity v:r=manage_snapshots v:r=manage_targets v:r=manage_profiles v:r=manage_secure_access_tokens v:r=manage_rules n:o=all v:o=all",
  "permissions": {
    "realm": {
      "rights": {
        "can_switch_user": true,
        "manage_node_membership": true,
        "manage_accounts": true,
        "view_logs": true,
        "run_admin_tasks": true,
        "run_tests": true
      }
    },
    "node": {
      "all_realm_scope": true,
      "rights": {
        "manage_storage": true,
        "manage_networks": true,
        "provision_vss": true,
        "remove_vss": true
      }
    },
    "vss": {
      "all_account_scope": true,
      "rights": {
        "dismiss_tasks": true,
        "update_vss": true,
        "remove_vss": true,
        "set_vss_quota": true,
        "manage_internal_disks": true,
        "manage_external_disks": true,
        "manage_removable_disks": true,
        "manage_disk_cryptography": true,
        "remove_locked_disks": true,
        "replicate_disks": true,
        "synchronize_disks": true,
        "format_disks": true,
        "resize_disks": true,
        "backup_disks": true,
        "validate_data_integrity": true,
        "manage_snapshots": true,
        "manage_targets": true,
        "manage_profiles": true,
        "manage_secure_access_tokens": true,
        "manage_rules": true
      }
    },
    "account": {
      "rights": {
        "modify_contact_settings": true,
        "view_events": true,
        "view_statistics": true,
        "manage_global_profiles": true,
        "manage_global_secure_access_tokens": true,
        "query_catalog": true,
        "provision_vss": true,
        "manage_obj_stores": true,
        "read_object_storage": true,
        "write_object_storage": true,
        "delete_object_storage": true
      }
    }
  }
}

Node

A Blockbridge Node is an instance of Blockbridge node software running on physical or virtual hardware. It can be a management node, a storage node, or a converged node.

• A management node provides configuration, monitoring, and other administrative capabilities. The management web application and API clients are terminated at the management node.
• A storage node delivers secure storage services using direct-attached and iSCSI storage. Client iSCSI connections are terminated at a storage node.
• A converged node contains both a management node and a storage node in one system. For most management purposes (including in the management web application) converged nodes are treated as a distinct management node and storage node.

Attributes

Node Info

Retrieve an existing node.

GET /node/{node_id_or_serial}

Curl Example

$ curl https://mgmt-node/api/node/node:10000 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:50 GMT
Server: Goliath
ETag: "6b394f6213c622e08f82de002403957d"
Content-Type: application/json
Content-Length: 2163

{
  "id": "node:10000",
  "uuid": "4347e01f-f106-4735-bfbf-68addda9982f",
  "serial": "NOD0F68194C40601558",
  "evt_qry": "serial=NOD0F68194C40601558",
  "ctime": 1507562835087,
  "mtime": 1507569964547,
  "seq": 1507569993701,
  "label": "node101",
  "notes": "node updated to 101",
  "status": {
    "value": "online",
    "indicator": "online",
    "detail": ""
  },
  "ec": {
    "table": {
      "time": 1507569969000,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "d": [
            94,
            160,
            160,
            160
          ],
          "v": "dbg"
        },
        {
          "d": [
            45,
            85,
            85,
            85
          ],
          "v": "info"
        },
        {
          "d": [
            1,
            2,
            2,
            2
          ],
          "v": "warn"
        },
        {
          "d": [
            2,
            2,
            2,
            2
          ],
          "v": "err"
        }
      ]
    },
    "status": "current",
    "seq": 1507569969666
  },
  "rec_status": null,
  "site_id": "site:10",
  "type": [
    "storage"
  ],
  "tags": [

  ],
  "disk_nodes": [

  ],
  "license": {
    "type": [
      "evaluation"
    ],
    "minutes_remaining": 43100,
    "token": "8cf63f34593571104393cb8306b6cb13"
  },
  "activation_code": null,
  "activation_state": "activated",
  "install_mode": "solo",
  "install_token": "WyJpMSIsIm1hc3Rlci1ob28yd29vMWFlcGhlaTZjIiwic3MiLDMxNzg5MjYwODJd",
  "ip": {
    "pub_addr": "172.16.100.61",
    "pub_addr_user_set": true,
    "prv_addr": "10.10.200.23",
    "prv_addr_user_set": true
  },
  "build_time": "Thu Oct 05 10:32 UTC 2017",
  "build_version": "4.0.0-4252.1",
  "cpu_model": "Intel Xeon E312xx (Sandy Bridge)",
  "cpu_processors": 1,
  "mem_total": 1929072640,
  "humantime": "Mon Oct 09 17:26 UTC 2017",
  "isotime": "2017-10-09T17:26+00:00",
  "version": {
    "major": 4,
    "minor": 0,
    "patch": 0,
    "release": "4252.1",
    "tag": "",
    "hash": "f41b54b0c02b9ecbee50ffca17fc1d74a6e20672",
    "timestamp": 1507199541000
  },
  "restore": {
    "start_time": null,
    "end_time": null,
    "state": null,
    "errors": null,
    "phase": null,
    "failure": null
  },
  "sn": {
    "data_cache_size": 536870912,
    "meta_cache_size_limit": 134217728,
    "max_data_log_size": 142078242,
    "max_meta_cache_size": 134217728,
    "usage": {
      "accounts": 0,
      "sds": 0,
      "os_dev": 8,
      "iscsi_dev": 0,
      "vss": 0,
      "vdisk_int": 0,
      "vdisk_ext": 0,
      "clones": 0,
      "snapshots": 0,
      "removable": 0,
      "repl_masters": 0,
      "repl_slaves": 0,
      "profiles": 0,
      "targets": 0,
      "rules": 0,
      "sessions": 0,
      "conn_insecure": 0,
      "conn_secure": 0,
      "vdisk_int_cap_mb": 0,
      "os_dev_max": 64,
      "profile_max": 8192,
      "rule_max": 16384,
      "session_max": 8192,
      "target_max": 8192,
      "vdisk_max": 4096,
      "vss_max": 4096
    }
  },
  "cluster": {
    "is_cluster": false,
    "failover": null,
    "members": [

    ],
    "status": {
      "value": "pending",
      "indicator": "degraded",
      "detail": "unable to connect to cluster"
    }
  }
}

Node List

Enumerate nodes.

GET /node

Curl Example

$ curl https://mgmt-node/api/node \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:50 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 6744

[
  {
    "id": "node:10000",
    "uuid": "4347e01f-f106-4735-bfbf-68addda9982f",
    "serial": "NOD0F68194C40601558",
    "evt_qry": "serial=NOD0F68194C40601558",
    "ctime": 1507562835087,
    "mtime": 1507569964547,
    "seq": 1507569993701,
    "label": "node101",
    "notes": "node updated to 101",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507569969000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              94,
              160,
              160,
              160
            ],
            "v": "dbg"
          },
          {
            "d": [
              45,
              85,
              85,
              85
            ],
            "v": "info"
          },
          {
            "d": [
              1,
              2,
              2,
              2
            ],
            "v": "warn"
          },
          {
            "d": [
              2,
              2,
              2,
              2
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507569969666
    },
    "rec_status": null,
    "site_id": "site:10",
    "type": [
      "storage"
    ],
    "tags": [

    ],
    "disk_nodes": [

    ],
    "license": {
      "type": [
        "evaluation"
      ],
      "minutes_remaining": 43100,
      "token": "8cf63f34593571104393cb8306b6cb13"
    },
    "activation_code": null,
    "activation_state": "activated",
    "install_mode": "solo",
    "install_token": "WyJpMSIsIm1hc3Rlci1ob28yd29vMWFlcGhlaTZjIiwic3MiLDMxNzg5MjYwODJd",
    "ip": {
      "pub_addr": "172.16.100.61",
      "pub_addr_user_set": true,
      "prv_addr": "10.10.200.23",
      "prv_addr_user_set": true
    },
    "build_time": "Thu Oct 05 10:32 UTC 2017",
    "build_version": "4.0.0-4252.1",
    "cpu_model": "Intel Xeon E312xx (Sandy Bridge)",
    "cpu_processors": 1,
    "mem_total": 1929072640,
    "humantime": "Mon Oct 09 17:26 UTC 2017",
    "isotime": "2017-10-09T17:26+00:00",
    "version": {
      "major": 4,
      "minor": 0,
      "patch": 0,
      "release": "4252.1",
      "tag": "",
      "hash": "f41b54b0c02b9ecbee50ffca17fc1d74a6e20672",
      "timestamp": 1507199541000
    },
    "restore": {
      "start_time": null,
      "end_time": null,
      "state": null,
      "errors": null,
      "phase": null,
      "failure": null
    },
    "sn": {
      "data_cache_size": 536870912,
      "meta_cache_size_limit": 134217728,
      "max_data_log_size": 142078242,
      "max_meta_cache_size": 134217728,
      "usage": {
        "accounts": 0,
        "sds": 0,
        "os_dev": 8,
        "iscsi_dev": 0,
        "vss": 0,
        "vdisk_int": 0,
        "vdisk_ext": 0,
        "clones": 0,
        "snapshots": 0,
        "removable": 0,
        "repl_masters": 0,
        "repl_slaves": 0,
        "profiles": 0,
        "targets": 0,
        "rules": 0,
        "sessions": 0,
        "conn_insecure": 0,
        "conn_secure": 0,
        "vdisk_int_cap_mb": 0,
        "os_dev_max": 64,
        "profile_max": 8192,
        "rule_max": 16384,
        "session_max": 8192,
        "target_max": 8192,
        "vdisk_max": 4096,
        "vss_max": 4096
      }
    },
    "cluster": {
      "is_cluster": false,
      "failover": null,
      "members": [

      ],
      "status": {
        "value": "pending",
        "indicator": "degraded",
        "detail": "unable to connect to cluster"
      }
    }
  },
  {
    "id": "node:10",
    "uuid": "c323c428-2336-4bc4-9412-839e2d325261",
    "serial": "NOD0F68194C406264FD",
    "evt_qry": "serial=NOD0F68194C406264FD",
    "ctime": 1507562833437,
    "mtime": 1507569970863,
    "seq": 1507569970885,
    "label": "management node",
    "notes": null,
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": null,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "v": "dbg",
            "d": [
              0,
              0,
              0,
              0
            ]
          },
          {
            "v": "info",
            "d": [
              0,
              0,
              0,
              0
            ]
          },
          {
            "v": "warn",
            "d": [
              0,
              0,
              0,
              0
            ]
          },
          {
            "v": "err",
            "d": [
              0,
              0,
              0,
              0
            ]
          }
        ]
      },
      "status": "current",
      "seq": 1507562839605
    },
    "rec_status": null,
    "site_id": "site:10",
    "type": [
      "management"
    ],
    "tags": [

    ],
    "disk_nodes": null,
    "license": {
      "type": [
        "evaluation"
      ],
      "minutes_remaining": 43100,
      "token": "8cf63f34593571104393cb8306b6cb13"
    },
    "eula": {
      "accepted": true,
      "accepted_at": 1507563022812
    },
    "activation_code": null,
    "activation_state": null,
    "params": {
      "scheduling_algorithms": [
        {
          "type": [
            "ideal_usage"
          ],
          "label": "ideal-usage",
          "ideal_usage_pct": 50,
          "min_usage_pct": 10,
          "capacity_weight_pct": 50,
          "iops_weight_pct": 50,
          "default": true
        }
      ],
      "service_templates": [
        {
          "type": [
            "gp"
          ],
          "description": "General Purpose",
          "default": true,
          "tags": {
            "include": [

            ],
            "exclude": [

            ]
          },
          "size": {
            "reserve_min": 1073741824,
            "reserve_max": 17592186044416,
            "limit_percent": 200
          },
          "iops": {
            "ratio": 3,
            "burst": 3000,
            "burst_credit": 5400000,
            "min": 100,
            "max": 3000
          },
          "piops": {
            "type": [
              "disabled"
            ],
            "value": null,
            "ratio": null,
            "min": null,
            "max": null
          }
        },
        {
          "type": [
            "piops"
          ],
          "description": "Provisioned IOPS",
          "default": false,
          "tags": {
            "include": [

            ],
            "exclude": [

            ]
          },
          "size": {
            "reserve_min": 4294967296,
            "reserve_max": 17592186044416,
            "limit_percent": 200
          },
          "iops": {
            "ratio": 50,
            "burst": null,
            "burst_credit": null,
            "min": 100,
            "max": 20000
          },
          "piops": {
            "type": [
              "user-specified"
            ],
            "value": null,
            "ratio": 50,
            "min": 100,
            "max": 20000
          }
        },
        {
          "type": [
            "unlimited"
          ],
          "description": "Unlimited Provisioning",
          "default": false,
          "tags": {
            "include": [

            ],
            "exclude": [

            ]
          },
          "size": {
            "reserve_min": 1048576,
            "reserve_max": null,
            "limit_percent": null
          },
          "iops": {
            "ratio": null,
            "burst": null,
            "burst_credit": null,
            "min": null,
            "max": null
          },
          "piops": {
            "type": [
              "disabled"
            ],
            "value": null,
            "ratio": null,
            "min": null,
            "max": null
          }
        }
      ],
      "scheduling_workloads": [
        {
          "workload": "lower_iops",
          "iops": 100
        },
        {
          "workload": "normal_iops",
          "iops": 500
        },
        {
          "workload": "higher_iops",
          "iops": 2000
        }
      ],
      "account_templates": [
        {
          "type": [
            "standard"
          ],
          "description": "Standard Account",
          "default": true,
          "provisioning": {
            "size_reserve_max": null,
            "iops_reserve_max": null,
            "tags_include": [

            ],
            "tags_exclude": [

            ],
            "tags_permit": null
          },
          "limits": {
            "vss_num": null,
            "size_reserve_total": null
          },
          "permissions": {
            "vss": {
              "all_account_scope": true,
              "rights": {
                "dismiss_tasks": true,
                "update_vss": true,
                "remove_vss": true,
                "set_vss_quota": true,
                "manage_internal_disks": true,
                "manage_external_disks": true,
                "manage_removable_disks": true,
                "manage_disk_cryptography": true,
                "remove_locked_disks": true,
                "replicate_disks": true,
                "synchronize_disks": true,
                "format_disks": true,
                "resize_disks": true,
                "backup_disks": true,
                "validate_data_integrity": true,
                "manage_snapshots": true,
                "manage_targets": true,
                "manage_profiles": true,
                "manage_secure_access_tokens": true,
                "manage_rules": true
              }
            },
            "user": {
              "rights": {
                "manage_users": true,
                "modify_user_contact_settings": true,
                "reset_user_password": true,
                "reset_user_two_factor": true,
                "manage_authorizations": true
              }
            },
            "account": {
              "rights": {
                "modify_contact_settings": true,
                "view_events": true,
                "view_statistics": true,
                "manage_global_profiles": true,
                "manage_global_secure_access_tokens": true,
                "query_catalog": true,
                "provision_vss": true,
                "manage_obj_stores": true,
                "read_object_storage": true,
                "write_object_storage": true,
                "delete_object_storage": true
              }
            }
          }
        }
      ]
    },
    "openstack_idp": {
      "id": "idp:1:10",
      "uuid": "e1f2692a-4543-443c-9c08-c7afc4349b2f",
      "label": "openstack",
      "type": [
        "openstack"
      ],
      "enabled": false,
      "url": null,
      "auth": {
        "user": {
          "id": null,
          "name": "admin",
          "password": null
        },
        "project": {
          "id": null,
          "name": "admin"
        },
        "domain": {
          "id": "default",
          "name": null
        }
      },
      "auto_create_account": true,
      "auto_create_user": true,
      "accepted_roles": [

      ],
      "recheck_interval": 60
    },
    "install_mode": null,
    "install_token": null,
    "ip": {
      "pub_addr": "172.16.100.61",
      "pub_addr_user_set": true,
      "prv_addr": "10.10.200.23",
      "prv_addr_user_set": true
    },
    "build_time": "Thu Oct 05 10:32 UTC 2017",
    "build_version": "4.0.0-4252.1",
    "cpu_model": null,
    "cpu_processors": null,
    "mem_total": null,
    "humantime": "Mon Oct 09 17:26 UTC 2017",
    "isotime": "2017-10-09T17:26+00:00",
    "version": {
      "major": 4,
      "minor": 0,
      "patch": 0,
      "release": "4252.1",
      "tag": "",
      "hash": "f41b54b0c02b9ecbee50ffca17fc1d74a6e20672",
      "timestamp": 1507199541000
    },
    "restore": {
      "start_time": null,
      "end_time": null,
      "state": null,
      "errors": null,
      "phase": null,
      "failure": null
    },
    "cluster": {
      "is_cluster": false,
      "failover": null,
      "members": [

      ],
      "status": {
        "value": "pending",
        "indicator": "degraded",
        "detail": "unable to connect to cluster"
      }
    }
  }
]

Node Create

Create a new storage node.

POST /node

Required Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | site_id | string | site id | | type | string | type of processing node
one of:"management" or "storage" or "disk" |

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | uuid | uuid | UUID to use for created object | | label | string | user assigned label
Length: 1..64 | | notes | string | user assigned notes
Length: 0..256 | | license | string | software license bundle | | mode | string | node clustering mode
default: "solo"
one of:"solo" or "cluster" | | pub_ipaddr | ipv4 | node public IP address | | pub_ipaddr_desc | string | node public IP address description | | prv_ipaddr | ipv4 | node private IP address | | prv_ipaddr_desc | string | node private IP address description | | maintenance:mode | string | maintenance mode
one of:"none" or "restrict" or "rendezvous" | | maintenance:restrict/type | string | restriction type
one of:"svc_purchase" or "pt_queue_user" or "pt_queue_admin" or "pt_queue_remote" or "pt_rpc_send" or "pt_rpc_recv" or "pt_sched_user" or "pt_sched_admin" or "rpc_send" or "rpc_recv" or "rc_task_add" or "rc_task_sched" or "rc_msg_send" or "rc_msg_recv" or "cp_proxy" or "slp_send_boot" | | maintenance:restrict/set | boolean | restriction set | | maintenance:reason | string | reason for restriction | | params:scheduling_algorithms/type | string | scheduling algorithm type
one of:"ideal_usage" | | params:scheduling_algorithms/label | nullable string | no documentation | | params:scheduling_algorithms/ideal_usage_pct | nullable string | no documentation | | params:scheduling_algorithms/min_usage_pct | nullable string | no documentation | | params:scheduling_algorithms/capacity_weight_pct | nullable string | no documentation | | params:scheduling_algorithms/iops_weight_pct | nullable string | no documentation | | params:scheduling_algorithms/default | nullable string | no documentation | | params:service_templates/type | string | service type name
Length: 1..32 | | params:service_templates/description | string | service type description
Length: 1..256 | | params:service_templates/default | boolean | default template | | params:service_templates/tags:include | array | include array | | params:service_templates/tags:exclude | array | exclude array | | params:service_templates/size:reserve_min | nullable integer | minimum size reserve | | params:service_templates/size:reserve_max | nullable integer | maximum size reserve | | params:service_templates/size:limit_percent | nullable integer | Set the hard limit on storage consumption to a percentage of the size reserved. Must be at least 100% of the reserved size. If null, it's unlimited.
Range: 100 <= value | | params:service_templates/iops:ratio | nullable integer | baseline IOPS ratio, specified as a ratio of IOPS to reserved size (in IOPS/GiB) | | params:service_templates/iops:burst | nullable integer | IOPS burst limit (in IOPS) | | params:service_templates/iops:burst_credit | nullable integer | maximum burst credits (in IOPS credits); not supported with provisioned IOPS | | params:service_templates/iops:min | nullable integer | minimum IOPS | | params:service_templates/iops:max | nullable integer | maximum IOPS | | params:service_templates/iops:type | string | how limited IOPS are specified
default: "disabled"
one of:"disabled" or "capacity-scaled" | | params:service_templates/iops:burst_type | string | how burst IOPS are specified
default: "disabled"
one of:"disabled" or "admin-fixed" or "capacity-scaled" | | params:service_templates/iops:burst_ratio | nullable integer | baseline burst IOPS ratio, specified as a ratio of burst IOPS to reserved size (in IOPS/GiB) | | params:service_templates/piops:type | string | how provisioned IOPS are specified
default: "disabled"
one of:"disabled" or "admin-fixed" or "capacity-scaled" or "user-specified" | | params:service_templates/piops:value | nullable integer | fixed IOPS value
Range: 1 <= value | | params:service_templates/piops:ratio | nullable integer | baseline provisioned IOPS ratio, specified as a ratio of IOPS to reserved size (in IOPS/GiB) | | params:service_templates/piops:min | nullable integer | minimum provisioned IOPS | | params:service_templates/piops:max | nullable integer | maximum provisioned IOPS | | cert_fingerprint | string | TLS certificate fingerprint | | openstack_idp:id | nullable string | no documentation | | openstack_idp:uuid | nullable uuid | no documentation | | openstack_idp:label | string | no documentation
default: "openstack"
Length: 1..∞ | | openstack_idp:type | string | identity provider type
default: "openstack"
one of:"internal" or "openstack" | | openstack_idp:enabled | boolean | identity provider enabled | | openstack_idp:url | nullable string | idP API endpoint | | openstack_idp:auth:user:id | nullable string | look up user by idp-specific index | | openstack_idp:auth:user:name | nullable string | look up user by name/login
default: "admin" | | openstack_idp:auth:user:password | nullable string | authenticate using supplied password | | openstack_idp:auth:project:id | nullable string | look up project by idp-specific index | | openstack_idp:auth:project:name | nullable string | look up project by name
default: "admin" | | openstack_idp:auth:domain:id | nullable string | look up domain by idp-specific index
default: "default" | | openstack_idp:auth:domain:name | nullable string | look up domain by name | | openstack_idp:auto_create_account | boolean | automatically create mapped accounts
default: true | | openstack_idp:auto_create_user | boolean | automatically create mapped users
default: true | | openstack_idp:accepted_roles | array | accepted roles
default: [] | | openstack_idp:recheck_interval | nullable integer | time after which a token must be re-validated (in seconds)
default: 60 | | visibility_ctl | string | object visibility control
default: "default"
one of:"default" or "show" or "hide" | | tags | array | object tags |

Curl Example

$ curl -X POST https://mgmt-node/api/node \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "label": "node100",
  "site_id": "site:18",
  "type": [
    "storage"
  ]
}'

Response Example

201 Created
Date: Mon, 09 Oct 2017 17:27:39 GMT
Server: Goliath
ETag: "a7e87547e5dc760784a3217a9335a328"
Content-Type: application/json
Content-Length: 1759

{
  "id": "node:10001",
  "uuid": "e69e5740-19bd-4e5d-a5a8-4ec04776b7d4",
  "serial": "NOD0F68194C40601540",
  "evt_qry": "serial=NOD0F68194C40601540",
  "ctime": 1507570059104,
  "mtime": 1507570059104,
  "seq": 1507570059150,
  "label": "node100",
  "notes": null,
  "status": {
    "value": "degraded",
    "indicator": "degraded",
    "detail": "node not registered"
  },
  "ec": {
    "table": null,
    "status": "retrieving",
    "seq": 1507570059150
  },
  "rec_status": null,
  "site_id": "site:18",
  "type": [
    "storage"
  ],
  "tags": [

  ],
  "disk_nodes": [

  ],
  "license": {
    "type": [
      "none"
    ],
    "token": "8cf63f34593571104393cb8306b6cb13"
  },
  "activation_code": "WyJhMSIsIjEwLjEwLjIwMC4yMyIsMjA0MDAsMTAwMDEsInN0b3JhZ2UiLCIyMGNhZWQxMTJkMWEzODZiMWRhOGYxM2NiZmJiYzhiMiJd",
  "activation_state": "node not registered",
  "install_mode": "solo",
  "install_token": "WyJpMSIsIm1hc3Rlci1ob28yd29vMWFlcGhlaTZjIiwic3MiLDMxNzg5MjYwODJd",
  "ip": null,
  "build_time": null,
  "build_version": null,
  "cpu_model": null,
  "cpu_processors": null,
  "mem_total": null,
  "humantime": null,
  "isotime": null,
  "version": null,
  "restore": {
    "start_time": null,
    "end_time": null,
    "state": null,
    "errors": null,
    "phase": null,
    "failure": null
  },
  "sn": {
    "data_cache_size": null,
    "meta_cache_size_limit": null,
    "max_data_log_size": null,
    "max_meta_cache_size": null,
    "usage": {
      "accounts": null,
      "sds": null,
      "os_dev": null,
      "iscsi_dev": null,
      "vss": null,
      "vdisk_int": null,
      "vdisk_ext": null,
      "clones": null,
      "snapshots": null,
      "removable": null,
      "repl_masters": null,
      "repl_slaves": null,
      "profiles": null,
      "targets": null,
      "rules": null,
      "sessions": null,
      "conn_insecure": null,
      "conn_secure": null,
      "vdisk_int_cap_mb": null,
      "os_dev_max": null,
      "profile_max": null,
      "rule_max": null,
      "session_max": null,
      "target_max": null,
      "vdisk_max": null,
      "vss_max": null
    }
  },
  "cluster": {
    "is_cluster": false,
    "failover": null,
    "members": [

    ],
    "status": {
      "value": "pending",
      "indicator": "degraded",
      "detail": "unable to connect to cluster"
    }
  }
}

Node Remove

Remove an existing storage node.

DELETE /node/{node_id_or_serial}

Curl Example

$ curl -X DELETE https://mgmt-node/api/node/node:10001 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

204 No Content
Date: Mon, 09 Oct 2017 17:27:40 GMT
Server: Goliath

Node Update

Change the configuration of an existing management node or a storage node.

PATCH /node/{node_id_or_serial}

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | label | string | user assigned label
Length: 1..64 | | notes | string | user assigned notes
Length: 0..256 | | enabled | boolean | node enabled for use | | maintenance:mode | string | maintenance mode
one of:"none" or "restrict" or "rendezvous" | | maintenance:restrict/type | string | restriction type
one of:"svc_purchase" or "pt_queue_user" or "pt_queue_admin" or "pt_queue_remote" or "pt_rpc_send" or "pt_rpc_recv" or "pt_sched_user" or "pt_sched_admin" or "rpc_send" or "rpc_recv" or "rc_task_add" or "rc_task_sched" or "rc_msg_send" or "rc_msg_recv" or "cp_proxy" or "slp_send_boot" | | maintenance:restrict/set | boolean | restriction set | | maintenance:reason | string | reason for restriction | | management:ca | string | no documentation
one of:"none" or "embedded" | | management:hostname | string | no documentation
Length: 1..∞ | | pub_ipaddr | ipv4 | node public IP address | | pub_ipaddr_desc | string | node public IP address description | | prv_ipaddr | ipv4 | node private IP address | | prv_ipaddr_desc | string | node private IP address description | | params:scheduling_algorithms/type | string | scheduling algorithm type
one of:"ideal_usage" | | params:scheduling_algorithms/label | nullable string | no documentation | | params:scheduling_algorithms/ideal_usage_pct | nullable string | no documentation | | params:scheduling_algorithms/min_usage_pct | nullable string | no documentation | | params:scheduling_algorithms/capacity_weight_pct | nullable string | no documentation | | params:scheduling_algorithms/iops_weight_pct | nullable string | no documentation | | params:scheduling_algorithms/default | nullable string | no documentation | | params:service_templates/type | string | service type name
Length: 1..32 | | params:service_templates/description | string | service type description
Length: 1..256 | | params:service_templates/default | boolean | default template | | params:service_templates/tags:include | array | include array | | params:service_templates/tags:exclude | array | exclude array | | params:service_templates/size:reserve_min | nullable integer | minimum size reserve | | params:service_templates/size:reserve_max | nullable integer | maximum size reserve | | params:service_templates/size:limit_percent | nullable integer | Set the hard limit on storage consumption to a percentage of the size reserved. Must be at least 100% of the reserved size. If null, it's unlimited.
Range: 100 <= value | | params:service_templates/iops:ratio | nullable integer | baseline IOPS ratio, specified as a ratio of IOPS to reserved size (in IOPS/GiB) | | params:service_templates/iops:burst | nullable integer | IOPS burst limit (in IOPS) | | params:service_templates/iops:burst_credit | nullable integer | maximum burst credits (in IOPS credits); not supported with provisioned IOPS | | params:service_templates/iops:min | nullable integer | minimum IOPS | | params:service_templates/iops:max | nullable integer | maximum IOPS | | params:service_templates/iops:type | string | how limited IOPS are specified
default: "disabled"
one of:"disabled" or "capacity-scaled" | | params:service_templates/iops:burst_type | string | how burst IOPS are specified
default: "disabled"
one of:"disabled" or "admin-fixed" or "capacity-scaled" | | params:service_templates/iops:burst_ratio | nullable integer | baseline burst IOPS ratio, specified as a ratio of burst IOPS to reserved size (in IOPS/GiB) | | params:service_templates/piops:type | string | how provisioned IOPS are specified
default: "disabled"
one of:"disabled" or "admin-fixed" or "capacity-scaled" or "user-specified" | | params:service_templates/piops:value | nullable integer | fixed IOPS value
Range: 1 <= value | | params:service_templates/piops:ratio | nullable integer | baseline provisioned IOPS ratio, specified as a ratio of IOPS to reserved size (in IOPS/GiB) | | params:service_templates/piops:min | nullable integer | minimum provisioned IOPS | | params:service_templates/piops:max | nullable integer | maximum provisioned IOPS | | params:account_templates/type | string | account template name
Length: 1..32 | | params:account_templates/description | string | account template description
Length: 1..256 | | params:account_templates/default | boolean | default template | | params:account_templates/provisioning:size_reserve_max | nullable integer | maximum size reserve of a single virtual storage service | | params:account_templates/provisioning:iops_reserve_max | nullable integer | maximum iops reserve of a single virtual storage service | | params:account_templates/provisioning:tags_include | array | tags included
default: [] | | params:account_templates/provisioning:tags_exclude | array | tags excluded
default: [] | | params:account_templates/provisioning:tags_permit | nullable array | tags permitted | | params:account_templates/provisioning:tags_permit | nullable array | tags permitted | | params:account_templates/limits:vss_num | nullable integer | number of virtual storage services | | params:account_templates/limits:size_reserve_total | nullable integer | maximum size of storage | | params:account_templates/permissions:realm:rights:can_switch_user | boolean | can SU to lower level user | | params:account_templates/permissions:realm:rights:manage_node_membership | boolean | accept or delete nodes from the management network | | params:account_templates/permissions:realm:rights:manage_accounts | boolean | can create or delete other accounts, users and their settings | | params:account_templates/permissions:realm:rights:view_logs | boolean | view administrative logs | | params:account_templates/permissions:realm:rights:run_admin_tasks | boolean | run realm administrative tasks | | params:account_templates/permissions:realm:rights:run_tests | boolean | run realm administrative tests | | params:account_templates/permissions:node:all_realm_scope | boolean | apply to all nodes in the realm
default: true | | params:account_templates/permissions:node:nodes | array | scope permissions to specific nodes | | params:account_templates/permissions:node:rights:manage_storage | boolean | configure OS devices, iSCSI devices, and system datastores | | params:account_templates/permissions:node:rights:manage_networks | boolean | configure networks | | params:account_templates/permissions:node:rights:provision_vss | boolean | manually provision virtual storage services | | params:account_templates/permissions:node:rights:remove_vss | boolean | remove virtual storage services | | params:account_templates/permissions:vss:all_account_scope | boolean | apply to all virtual storage services in the account
default: true | | params:account_templates/permissions:vss:vsses | array | limit scope to specified vsses | | params:account_templates/permissions:vss:rights:dismiss_tasks | boolean | dismiss tasks | | params:account_templates/permissions:vss:rights:update_vss | boolean | update vss configuration | | params:account_templates/permissions:vss:rights:remove_vss | boolean | remove vss | | params:account_templates/permissions:vss:rights:set_vss_quota | boolean | set vss quota | | params:account_templates/permissions:vss:rights:manage_internal_disks | boolean | manage internal disks | | params:account_templates/permissions:vss:rights:manage_external_disks | boolean | manage external disks | | params:account_templates/permissions:vss:rights:manage_removable_disks | boolean | manage removable disks | | params:account_templates/permissions:vss:rights:manage_disk_cryptography | boolean | manage disk cryptography | | params:account_templates/permissions:vss:rights:remove_locked_disks | boolean | remove locked disks | | params:account_templates/permissions:vss:rights:replicate_and_synchronize_disks | boolean | replicate and synchronize disks | | params:account_templates/permissions:vss:rights:validate_data_integrity | boolean | validate data integrity | | params:account_templates/permissions:vss:rights:manage_targets | boolean | manage targets | | params:account_templates/permissions:vss:rights:manage_profiles | boolean | manage profiles | | params:account_templates/permissions:vss:rights:manage_secure_access_tokens | boolean | manage secure access tokens | | params:account_templates/permissions:vss:rights:manage_rules | boolean | manage rules | | params:account_templates/permissions:vss:rights:replicate_disks | boolean | replicate disks | | params:account_templates/permissions:vss:rights:synchronize_disks | boolean | synchronize disks | | params:account_templates/permissions:vss:rights:format_disks | boolean | format disks | | params:account_templates/permissions:vss:rights:resize_disks | boolean | resize disks | | params:account_templates/permissions:vss:rights:backup_disks | boolean | backup disks | | params:account_templates/permissions:vss:rights:manage_snapshots | boolean | manage snapshots | | params:account_templates/permissions:vss:rights:compress_disks | boolean | compress disks | | params:account_templates/permissions:vss:rights:manage_disk_compression | boolean | manage disk | | params:account_templates/permissions:user:rights:manage_users | boolean | create or delete users in an account | | params:account_templates/permissions:user:rights:modify_user_contact_settings | boolean | modify user contact info | | params:account_templates/permissions:user:rights:reset_user_password | boolean | reset user password | | params:account_templates/permissions:user:rights:reset_user_two_factor | boolean | reset two factor authentication | | params:account_templates/permissions:user:rights:manage_authorizations | boolean | create or delete persistent authorizations | | params:account_templates/permissions:account:rights:modify_contact_settings | boolean | modify account contact settings | | params:account_templates/permissions:account:rights:view_events | boolean | view events | | params:account_templates/permissions:account:rights:view_statistics | boolean | view statistics | | params:account_templates/permissions:account:rights:manage_global_profiles | boolean | manage global profiles | | params:account_templates/permissions:account:rights:manage_global_secure_access_tokens | boolean | manage global secure access tokens | | params:account_templates/permissions:account:rights:query_catalog | boolean | query product catalog | | params:account_templates/permissions:account:rights:provision_vss | boolean | provision vss from catalog | | params:account_templates/permissions:account:rights:manage_obj_stores | boolean | manage object stores | | params:account_templates/permissions:account:rights:read_object_storage | boolean | read from object storage | | params:account_templates/permissions:account:rights:write_object_storage | boolean | write to object storage | | params:account_templates/permissions:account:rights:delete_object_storage | boolean | delete from object storage | | cert_fingerprint | string | TLS certificate fingerprint | | license | string | software license bundle | | registration:allow | boolean | allow registrations for this node | | openstack_idp:label | string | no documentation
Length: 1..∞ | | openstack_idp:enabled | boolean | identity provider enabled | | openstack_idp:auto_create_account | boolean | automatically create mapped accounts | | openstack_idp:auto_create_user | boolean | automatically create mapped users | | openstack_idp:url | nullable string | idP API endpoint | | openstack_idp:auth:user:id | nullable string | look up user by idp-specific index | | openstack_idp:auth:user:name | nullable string | look up user by name/login | | openstack_idp:auth:user:password | nullable string | authenticate using supplied password | | openstack_idp:auth:project:id | nullable string | look up project by idp-specific index | | openstack_idp:auth:project:name | nullable string | look up project by name | | openstack_idp:auth:domain:id | nullable string | look up domain by idp-specific index | | openstack_idp:auth:domain:name | nullable string | look up domain by name | | openstack_idp:accepted_roles | array | accepted roles | | eula:accepted | boolean | eula accepted | | tags | array | object tags | | disk_nodes | array | object tags | | visibility_ctl | string | object visibility control
one of:"default" or "show" or "hide" | | openstack_portal_filter:ip | ipv4 | IP address | | openstack_portal_filter:mask | ipv4 | netmask |

Curl Example

$ curl -X PATCH https://mgmt-node/api/node/node:10000 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "label": "node101",
  "notes": "node updated to 101"
}'

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:51 GMT
Server: Goliath
ETag: "ff28c49726b8b52cae4c6b4bc04ea79d"
Content-Type: application/json
Content-Length: 2163

{
  "id": "node:10000",
  "uuid": "4347e01f-f106-4735-bfbf-68addda9982f",
  "serial": "NOD0F68194C40601558",
  "evt_qry": "serial=NOD0F68194C40601558",
  "ctime": 1507562835087,
  "mtime": 1507570011169,
  "seq": 1507570011197,
  "label": "node101",
  "notes": "node updated to 101",
  "status": {
    "value": "online",
    "indicator": "online",
    "detail": ""
  },
  "ec": {
    "table": {
      "time": 1507569969000,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "d": [
            94,
            160,
            160,
            160
          ],
          "v": "dbg"
        },
        {
          "d": [
            45,
            85,
            85,
            85
          ],
          "v": "info"
        },
        {
          "d": [
            1,
            2,
            2,
            2
          ],
          "v": "warn"
        },
        {
          "d": [
            2,
            2,
            2,
            2
          ],
          "v": "err"
        }
      ]
    },
    "status": "current",
    "seq": 1507569969666
  },
  "rec_status": null,
  "site_id": "site:10",
  "type": [
    "storage"
  ],
  "tags": [

  ],
  "disk_nodes": [

  ],
  "license": {
    "type": [
      "evaluation"
    ],
    "minutes_remaining": 43100,
    "token": "8cf63f34593571104393cb8306b6cb13"
  },
  "activation_code": null,
  "activation_state": "activated",
  "install_mode": "solo",
  "install_token": "WyJpMSIsIm1hc3Rlci1ob28yd29vMWFlcGhlaTZjIiwic3MiLDMxNzg5MjYwODJd",
  "ip": {
    "pub_addr": "172.16.100.61",
    "pub_addr_user_set": true,
    "prv_addr": "10.10.200.23",
    "prv_addr_user_set": true
  },
  "build_time": "Thu Oct 05 10:32 UTC 2017",
  "build_version": "4.0.0-4252.1",
  "cpu_model": "Intel Xeon E312xx (Sandy Bridge)",
  "cpu_processors": 1,
  "mem_total": 1929072640,
  "humantime": "Mon Oct 09 17:26 UTC 2017",
  "isotime": "2017-10-09T17:26+00:00",
  "version": {
    "major": 4,
    "minor": 0,
    "patch": 0,
    "release": "4252.1",
    "tag": "",
    "hash": "f41b54b0c02b9ecbee50ffca17fc1d74a6e20672",
    "timestamp": 1507199541000
  },
  "restore": {
    "start_time": null,
    "end_time": null,
    "state": null,
    "errors": null,
    "phase": null,
    "failure": null
  },
  "sn": {
    "data_cache_size": 536870912,
    "meta_cache_size_limit": 134217728,
    "max_data_log_size": 142078242,
    "max_meta_cache_size": 134217728,
    "usage": {
      "accounts": 0,
      "sds": 0,
      "os_dev": 8,
      "iscsi_dev": 0,
      "vss": 0,
      "vdisk_int": 0,
      "vdisk_ext": 0,
      "clones": 0,
      "snapshots": 0,
      "removable": 0,
      "repl_masters": 0,
      "repl_slaves": 0,
      "profiles": 0,
      "targets": 0,
      "rules": 0,
      "sessions": 0,
      "conn_insecure": 0,
      "conn_secure": 0,
      "vdisk_int_cap_mb": 0,
      "os_dev_max": 64,
      "profile_max": 8192,
      "rule_max": 16384,
      "session_max": 8192,
      "target_max": 8192,
      "vdisk_max": 4096,
      "vss_max": 4096
    }
  },
  "cluster": {
    "is_cluster": false,
    "failover": null,
    "members": [

    ],
    "status": {
      "value": "pending",
      "indicator": "degraded",
      "detail": "unable to connect to cluster"
    }
  }
}

Node Discover Devices

Retrieve a list of operating system storage devices that match the specified parameters.

GET /node/{node_id_or_serial}/devices

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | type | string | device type
default: "block"
one of:"block" | | subsystem | nullable string | device subsystem
one of:"scsi" or "xen" |

Curl Example

$ curl https://mgmt-node/api/node/node:10000/devices \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:50 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 6063

[
  {
    "name": "sdd",
    "desc": "disk",
    "path": "/dev/sdd",
    "preferred_path": "/dev/disk/by-id/wwn-0x60a010a04628d4f81962194c406558c1",
    "parent": "",
    "devlinks": [
      "/dev/bb/6932606f-1cd8-43bc-bc4c-6fb5f8d42846",
      "/dev/disk/by-id/scsi-360a010a04628d4f81962194c406558c1",
      "/dev/disk/by-id/wwn-0x60a010a04628d4f81962194c406558c1",
      "/dev/disk/by-path/ip-172.16.5.148:3260-iscsi-iqn.2009-12.com.blockbridge:t-pjuagemzukanm-abpdmcle-lun-0"
    ],
    "syspath": "/sys/devices/platform/host5/session4/target5:0:0/5:0:0:0/block/sdd",
    "type": [
      "block"
    ],
    "subsystem": "scsi",
    "driver": "sd",
    "raw_size": 107374182400,
    "properties": [
      {
        "name": "DEVLINKS",
        "value": "/dev/bb/6932606f-1cd8-43bc-bc4c-6fb5f8d42846 /dev/disk/by-id/scsi-360a010a04628d4f81962194c406558c1 /dev/disk/by-id/wwn-0x60a010a04628d4f81962194c406558c1 /dev/disk/by-path/ip-172.16.5.148:3260-iscsi-iqn.2009-12.com.blockbridge:t-pjuagemzukanm-abpdmcle-lun-0"
      },
      {
        "name": "DEVNAME",
        "value": "/dev/sdd"
      },
      {
        "name": "DEVPATH",
        "value": "/devices/platform/host5/session4/target5:0:0/5:0:0:0/block/sdd"
      },
      {
        "name": "DEVTYPE",
        "value": "disk"
      },
      {
        "name": "DM_MULTIPATH_TIMESTAMP",
        "value": "1507562788"
      },
      {
        "name": "ID_BUS",
        "value": "scsi"
      },
      {
        "name": "ID_MODEL",
        "value": "SECURE_DRIVE"
      },
      {
        "name": "ID_MODEL_ENC",
        "value": "SECURE\\x20DRIVE"
      },
      {
        "name": "ID_PATH",
        "value": "ip-172.16.5.148:3260-iscsi-iqn.2009-12.com.blockbridge:t-pjuagemzukanm-abpdmcle-lun-0"
      },
      {
        "name": "ID_PATH_TAG",
        "value": "ip-172_16_5_148_3260-iscsi-iqn_2009-12_com_blockbridge_t-pjuagemzukanm-abpdmcle-lun-0"
      },
      {
        "name": "ID_REVISION",
        "value": "4.0"
      },
      {
        "name": "ID_SCSI",
        "value": "1"
      },
      {
        "name": "ID_SCSI_SERIAL",
        "value": "6932606f-1cd8-43bc-bc4c-6fb5f8d42846"
      },
      {
        "name": "ID_SERIAL",
        "value": "360a010a04628d4f81962194c406558c1"
      },
      {
        "name": "ID_SERIAL_SHORT",
        "value": "60a010a04628d4f81962194c406558c1"
      },
      {
        "name": "ID_TYPE",
        "value": "disk"
      },
      {
        "name": "ID_VENDOR",
        "value": "B_BRIDGE"
      },
      {
        "name": "ID_VENDOR_ENC",
        "value": "B\\x2aBRIDGE"
      },
      {
        "name": "ID_WWN",
        "value": "0x60a010a04628d4f8"
      },
      {
        "name": "ID_WWN_VENDOR_EXTENSION",
        "value": "0x1962194c406558c1"
      },
      {
        "name": "ID_WWN_WITH_EXTENSION",
        "value": "0x60a010a04628d4f81962194c406558c1"
      },
      {
        "name": "MAJOR",
        "value": "8"
      },
      {
        "name": "MINOR",
        "value": "48"
      },
      {
        "name": "MPATH_SBIN_PATH",
        "value": "/sbin"
      },
      {
        "name": "SUBSYSTEM",
        "value": "block"
      },
      {
        "name": "TAGS",
        "value": ":systemd:"
      },
      {
        "name": "USEC_INITIALIZED",
        "value": "7443479"
      }
    ],
    "wwn": "0x60a010a04628d4f81962194c406558c1",
    "inuse": true
  },
  {
    "name": "md124",
    "desc": "disk",
    "path": "/dev/md124",
    "preferred_path": "/dev/disk/by-id/md-name-mirror1",
    "parent": "",
    "devlinks": [
      "/dev/disk/by-id/md-name-mirror1",
      "/dev/disk/by-id/md-uuid-7b70f246:5a824029:b39ef139:929c9a9e",
      "/dev/md/mirror1"
    ],
    "syspath": "/sys/devices/virtual/block/md124",
    "type": [
      "block"
    ],
    "subsystem": "",
    "driver": "",
    "raw_size": 107338530816,
    "properties": [
      {
        "name": "DEVLINKS",
        "value": "/dev/disk/by-id/md-name-mirror1 /dev/disk/by-id/md-uuid-7b70f246:5a824029:b39ef139:929c9a9e /dev/md/mirror1"
      },
      {
        "name": "DEVNAME",
        "value": "/dev/md124"
      },
      {
        "name": "DEVPATH",
        "value": "/devices/virtual/block/md124"
      },
      {
        "name": "DEVTYPE",
        "value": "disk"
      },
      {
        "name": "DM_MULTIPATH_TIMESTAMP",
        "value": "1507562788"
      },
      {
        "name": "MAJOR",
        "value": "9"
      },
      {
        "name": "MD_CONTAINER",
        "value": "/dev/md/mirror1:c"
      },
      {
        "name": "MD_CTIME",
        "value": "1507562847"
      },
      {
        "name": "MD_DEVICES",
        "value": "2"
      },
      {
        "name": "MD_DEVICE_sdc_DEV",
        "value": "/dev/sdc"
      },
      {
        "name": "MD_DEVICE_sdc_ROLE",
        "value": "1"
      },
      {
        "name": "MD_DEVICE_sde_DEV",
        "value": "/dev/sde"
      },
      {
        "name": "MD_DEVICE_sde_ROLE",
        "value": "0"
      },
      {
        "name": "MD_DEVNAME",
        "value": "mirror1"
      },
      {
        "name": "MD_LEVEL",
        "value": "raid1"
      },
      {
        "name": "MD_MEMBER",
        "value": "0"
      },
      {
        "name": "MD_MON_THIS",
        "value": "../md125"
      },
      {
        "name": "MD_MTIME",
        "value": "1507562847"
      },
      {
        "name": "MD_NAME",
        "value": "mirror1"
      },
      {
        "name": "MD_UUID",
        "value": "7b70f246:5a824029:b39ef139:929c9a9e"
      },
      {
        "name": "MINOR",
        "value": "124"
      },
      {
        "name": "MPATH_SBIN_PATH",
        "value": "/sbin"
      },
      {
        "name": "SUBSYSTEM",
        "value": "block"
      },
      {
        "name": "SYSTEMD_WANTS",
        "value": "mdmonitor.service mdmon@md125.service"
      },
      {
        "name": "TAGS",
        "value": ":systemd:"
      },
      {
        "name": "USEC_INITIALIZED",
        "value": "3539136"
      }
    ],
    "inuse": true
  },
  {
    "name": "md126p6",
    "desc": "partition",
    "path": "/dev/md126p6",
    "preferred_path": "/dev/md126p6",
    "parent": "/dev/md126",
    "devlinks": [
      "/dev/disk/by-id/md-name-bb:system-array-part6",
      "/dev/disk/by-id/md-uuid-791bf0b6:27184b1a:a7cc46b9:c7d4a716-part6",
      "/dev/md/bb:system-array6"
    ],
    "syspath": "/sys/devices/virtual/block/md126/md126p6",
    "type": [
      "block"
    ],
    "subsystem": "block",
    "driver": "",
    "raw_size": 18216893952,
    "properties": [
      {
        "name": "BLOCKBRIDGE_LABEL",
        "value": "system"
      },
      {
        "name": "BLOCKBRIDGE_WHITELIST",
        "value": "1"
      },
      {
        "name": "DEVLINKS",
        "value": "/dev/disk/by-id/md-name-bb:system-array-part6 /dev/disk/by-id/md-uuid-791bf0b6:27184b1a:a7cc46b9:c7d4a716-part6 /dev/md/bb:system-array6"
      },
      {
        "name": "DEVNAME",
        "value": "/dev/md126p6"
      },
      {
        "name": "DEVPATH",
        "value": "/devices/virtual/block/md126/md126p6"
      },
      {
        "name": "DEVTYPE",
        "value": "partition"
      },
      {
        "name": "ID_PART_ENTRY_DISK",
        "value": "9:126"
      },
      {
        "name": "ID_PART_ENTRY_NAME",
        "value": "blockbridge-sp"
      },
      {
        "name": "ID_PART_ENTRY_NUMBER",
        "value": "6"
      },
      {
        "name": "ID_PART_ENTRY_OFFSET",
        "value": "174065664"
      },
      {
        "name": "ID_PART_ENTRY_SCHEME",
        "value": "gpt"
      },
      {
        "name": "ID_PART_ENTRY_SIZE",
        "value": "35579871"
      },
      {
        "name": "ID_PART_ENTRY_TYPE",
        "value": "0fc63daf-8483-4772-8e79-3d69d8477de4"
      },
      {
        "name": "ID_PART_ENTRY_UUID",
        "value": "c0edd702-7801-42ef-b675-2b34411ee13e"
      },
      {
        "name": "MAJOR",
        "value": "259"
      },
      {
        "name": "MD_CONTAINER",
        "value": "/dev/md/bb:system-array:c"
      },
      {
        "name": "MD_CTIME",
        "value": "1507562801"
      },
      {
        "name": "MD_DEVICES",
        "value": "2"
      },
      {
        "name": "MD_DEVICE_sda_DEV",
        "value": "/dev/sda"
      },
      {
        "name": "MD_DEVICE_sda_ROLE",
        "value": "1"
      },
      {
        "name": "MD_DEVICE_sdb_DEV",
        "value": "/dev/sdb"
      },
      {
        "name": "MD_DEVICE_sdb_ROLE",
        "value": "0"
      },
      {
        "name": "MD_DEVNAME",
        "value": "bb:system-array"
      },
      {
        "name": "MD_LEVEL",
        "value": "raid1"
      },
      {
        "name": "MD_MEMBER",
        "value": "0"
      },
      {
        "name": "MD_MON_THIS",
        "value": "../md127"
      },
      {
        "name": "MD_MTIME",
        "value": "1507562801"
      },
      {
        "name": "MD_NAME",
        "value": "bb:system-array"
      },
      {
        "name": "MD_UUID",
        "value": "791bf0b6:27184b1a:a7cc46b9:c7d4a716"
      },
      {
        "name": "MINOR",
        "value": "5"
      },
      {
        "name": "SUBSYSTEM",
        "value": "block"
      },
      {
        "name": "SYSTEMD_WANTS",
        "value": "mdmonitor.service mdmon@md127.service"
      },
      {
        "name": "TAGS",
        "value": ":systemd:"
      },
      {
        "name": "USEC_INITIALIZED",
        "value": "9419779"
      }
    ],
    "inuse": true
  }
]

Node Discover Interfaces

Retrieve a list of network interfaces that match the specified parameters.

GET /node/{node_id_or_serial}/interfaces

Curl Example

$ curl https://mgmt-node/api/node/node:10000/interfaces \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:51 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 900

[
  {
    "interface": "eth0",
    "hwaddr": "FA:16:3E:6A:7C:79",
    "mtu": 1400,
    "flags": {
      "up": true,
      "broadcast": true,
      "debug": false,
      "loopback": false,
      "pointopoint": false,
      "notrailers": false,
      "running": true,
      "noarp": false,
      "promisc": false,
      "master": false,
      "slave": false,
      "multicast": true
    },
    "link": {
      "detected": true,
      "speed": null,
      "duplex": null,
      "port": "other"
    },
    "driver": {
      "name": "virtio_net",
      "version": "1.0.0",
      "fw_version": "",
      "bus": "0000:00:03.0"
    },
    "stats": {
      "tx_packets": 0,
      "tx_bytes": 0,
      "tx_errors": 0,
      "tx_dropped": 0,
      "rx_packets": 0,
      "rx_bytes": 0,
      "rx_errors": 0,
      "rx_dropped": 0
    },
    "ipaddrs": [
      {
        "addr": "10.10.200.23",
        "family": "IPv4"
      },
      {
        "addr": "fe80::f816:3eff:fe6a:7c79%eth0",
        "family": "IPv6"
      }
    ],
    "inuse": true,
    "config": {
      "net_id": "net:8:10",
      "service": {
        "application": {
          "enabled": false
        },
        "management": {
          "enabled": false
        },
        "storage": {
          "enabled": true,
          "shared": true
        },
        "replication": {
          "enabled": true
        },
        "infrastructure": {
          "enabled": true
        },
        "external": {
          "enabled": true
        }
      }
    }
  }
]

Site

Sites are groups of storage and management nodes. When deploying a Blockbridge storage network, you can use sites to group nodes together that are co-located in the same data center. Or, you can subdivide a datacenter into multiple sites, or align sites along business unit lines. Every node in a site shares the same SMTP configuration.

Attributes

Site Info

Retrieve an existing site.

GET /site/{site_id_or_serial}

Curl Example

$ curl https://mgmt-node/api/site/site:18 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:52 GMT
Server: Goliath
ETag: "d9adddf3c3dfd1418fd44fa1da69b35e"
Content-Type: application/json
Content-Length: 681

{
  "id": "site:18",
  "uuid": "d0132f8e-05c5-48d9-97da-806011f94bcd",
  "serial": "SIT1468194C40626570",
  "evt_qry": "serial=SIT1468194C40626570",
  "ctime": 1507570012289,
  "mtime": 1507570012535,
  "seq": 1507570012682,
  "label": "virginia1",
  "notes": "site updated",
  "status": {
    "value": "online",
    "indicator": "online",
    "detail": ""
  },
  "ec": {
    "table": {
      "time": 1507570012000,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "d": [
            4,
            4,
            4,
            4
          ],
          "v": "dbg"
        },
        {
          "d": [
            3,
            3,
            3,
            3
          ],
          "v": "info"
        },
        {
          "d": [
            0,
            0,
            0,
            0
          ],
          "v": "warn"
        },
        {
          "d": [
            0,
            0,
            0,
            0
          ],
          "v": "err"
        }
      ]
    },
    "status": "current",
    "seq": 1507570012682
  },
  "rec_status": null,
  "tier": "IV",
  "location": {
    "country": "US",
    "lat": 39.0436,
    "long": -77.4875,
    "city": "Ashburn",
    "state": "VA"
  },
  "email": {
    "type": [
      "none"
    ]
  }
}

Site List

Enumerate sites.

GET /site

Curl Example

$ curl https://mgmt-node/api/site \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:52 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 6119

[
  {
    "id": "site:12",
    "uuid": "0ad99d88-c1e4-4e3e-8ce9-1ebbf261e73e",
    "serial": "SIT1468194C40626494",
    "evt_qry": "serial=SIT1468194C40626494",
    "ctime": 1507567898865,
    "mtime": 1507567899084,
    "seq": 1507567899667,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507567899000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              4,
              4,
              4,
              4
            ],
            "v": "dbg"
          },
          {
            "d": [
              3,
              3,
              3,
              3
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507567899667
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:16",
    "uuid": "53184182-b00c-4b6c-94c0-ed470b958c72",
    "serial": "SIT1468194C40626550",
    "evt_qry": "serial=SIT1468194C40626550",
    "ctime": 1507569795479,
    "mtime": 1507569795721,
    "seq": 1507569796666,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507569795000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              4,
              4,
              4,
              4
            ],
            "v": "dbg"
          },
          {
            "d": [
              3,
              3,
              3,
              3
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507569796666
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:13",
    "uuid": "16f3d9e8-10ca-46e9-be38-40e7472c6541",
    "serial": "SIT1468194C4062648C",
    "evt_qry": "serial=SIT1468194C4062648C",
    "ctime": 1507567916392,
    "mtime": 1507567916616,
    "seq": 1507567916674,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507567916000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              4,
              4,
              4,
              4
            ],
            "v": "dbg"
          },
          {
            "d": [
              3,
              3,
              3,
              3
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507567916674
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:17",
    "uuid": "e66d233a-00d9-43aa-92d1-e03ed0e2faec",
    "serial": "SIT1468194C40626548",
    "evt_qry": "serial=SIT1468194C40626548",
    "ctime": 1507569965655,
    "mtime": 1507569965913,
    "seq": 1507569966668,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507569965000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              4,
              4,
              4,
              4
            ],
            "v": "dbg"
          },
          {
            "d": [
              3,
              3,
              3,
              3
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507569966668
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:10",
    "uuid": "e582c5ea-26f5-452c-98f6-8133bf91790e",
    "serial": "SIT1468194C406264F5",
    "evt_qry": "serial=SIT1468194C406264F5",
    "ctime": 1507562833433,
    "mtime": 1507562839908,
    "seq": 1507570011670,
    "label": "packet.net",
    "notes": null,
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507570011000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              14,
              22,
              22,
              22
            ],
            "v": "dbg"
          },
          {
            "d": [
              17,
              28,
              28,
              28
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507570011670
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "USA",
      "lat": 40,
      "long": -43,
      "city": "Newark",
      "state": "NJ"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:14",
    "uuid": "8e9b9c5e-6145-42af-ac79-7d03f21d7750",
    "serial": "SIT1468194C406264B4",
    "evt_qry": "serial=SIT1468194C406264B4",
    "ctime": 1507567942158,
    "mtime": 1507567942381,
    "seq": 1507567942673,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507567942000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              4,
              4,
              4,
              4
            ],
            "v": "dbg"
          },
          {
            "d": [
              3,
              3,
              3,
              3
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507567942673
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:18",
    "uuid": "d0132f8e-05c5-48d9-97da-806011f94bcd",
    "serial": "SIT1468194C40626570",
    "evt_qry": "serial=SIT1468194C40626570",
    "ctime": 1507570012289,
    "mtime": 1507570012535,
    "seq": 1507570012540,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": null,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "v": "dbg",
            "d": [
              0,
              0,
              0,
              0
            ]
          },
          {
            "v": "info",
            "d": [
              0,
              0,
              0,
              0
            ]
          },
          {
            "v": "warn",
            "d": [
              0,
              0,
              0,
              0
            ]
          },
          {
            "v": "err",
            "d": [
              0,
              0,
              0,
              0
            ]
          }
        ]
      },
      "status": "current",
      "seq": 1507570012310
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:11",
    "uuid": "79110da6-9357-4700-9f4d-d3cb2a4734c8",
    "serial": "SIT1468194C406264ED",
    "evt_qry": "serial=SIT1468194C406264ED",
    "ctime": 1507563525129,
    "mtime": 1507563525260,
    "seq": 1507563525691,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507563525000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              4,
              4,
              4,
              4
            ],
            "v": "dbg"
          },
          {
            "d": [
              3,
              3,
              3,
              3
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507563525691
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  },
  {
    "id": "site:15",
    "uuid": "35a002d9-59f0-4fa7-99f3-a71718f2f0d8",
    "serial": "SIT1468194C406264AC",
    "evt_qry": "serial=SIT1468194C406264AC",
    "ctime": 1507568230545,
    "mtime": 1507568230778,
    "seq": 1507568231667,
    "label": "virginia1",
    "notes": "site updated",
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507568230000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              4,
              4,
              4,
              4
            ],
            "v": "dbg"
          },
          {
            "d": [
              3,
              3,
              3,
              3
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507568231667
    },
    "rec_status": null,
    "tier": "IV",
    "location": {
      "country": "US",
      "lat": 39.0436,
      "long": -77.4875,
      "city": "Ashburn",
      "state": "VA"
    },
    "email": {
      "type": [
        "none"
      ]
    }
  }
]

Site Create

Create a new site.

POST /site

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | label | string | user assigned label
Length: 1..64 | | notes | string | user assigned notes
Length: 0..256 | | location:country | string | ISO 3166-1 alpha-3 country code
default: "" | | location:lat | number | latitude
default: 0 | | location:long | number | longitude
default: 0 | | location:city | string | city
default: "" | | location:state | string | state as two-character USPS abbreviation
default: "" | | tier | string | datacenter infrastructure tier
default: "IV"
one of:"I" or "II" or "III" or "IV" | | email:type | string | email type
one of:"none" or "smtp" or "mailgun" | | email:smtp:mail_from | email | mail from email address
Length: 0..128 | | email:smtp:server_ssl | string | smtp server ssl
one of:"none" or "required" or "optional" | | email:smtp:server_addr | hostname | smtp server name
Length: 0..1024 | | email:smtp:server_password | string | smtp auth password | | email:smtp:server_username | string | smtp auth username | | email:smtp:server_auth | boolean | smtp auth enabled | | email:smtp:server_port | integer | smtp server port
default: 587
Range: 1 <= value <= 65535 | | uuid | uuid | object UUID |

Curl Example

$ curl -X POST https://mgmt-node/api/site \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "label": "virginia",
  "location": {
    "country": "US",
    "lat": 39.0436,
    "long": -77.4875,
    "city": "Ashburn",
    "state": "VA"
  },
  "tier": "IV"
}'

Response Example

201 Created
Date: Mon, 09 Oct 2017 17:26:52 GMT
Server: Goliath
ETag: "805c3bcb643efd2efe2db982d234b60d"
Content-Type: application/json
Content-Length: 661

{
  "id": "site:18",
  "uuid": "d0132f8e-05c5-48d9-97da-806011f94bcd",
  "serial": "SIT1468194C40626570",
  "evt_qry": "serial=SIT1468194C40626570",
  "ctime": 1507570012289,
  "mtime": 1507570012289,
  "seq": 1507570012310,
  "label": "virginia",
  "notes": null,
  "status": {
    "value": "online",
    "indicator": "online",
    "detail": ""
  },
  "ec": {
    "table": {
      "time": null,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "v": "dbg",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "info",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "warn",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "err",
          "d": [
            0,
            0,
            0,
            0
          ]
        }
      ]
    },
    "status": "current",
    "seq": 1507570012310
  },
  "rec_status": null,
  "tier": "IV",
  "location": {
    "country": "US",
    "lat": 39.0436,
    "long": -77.4875,
    "city": "Ashburn",
    "state": "VA"
  },
  "email": {
    "type": [
      "none"
    ]
  }
}

Site Remove

Remove an existing site.

DELETE /site/{site_id_or_serial}

Curl Example

$ curl -X DELETE https://mgmt-node/api/site/SIT1468194C40626570 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

204 No Content
Date: Mon, 09 Oct 2017 17:27:40 GMT
Server: Goliath

Site Update

Change the configuration of an existing site.

PATCH /site/{site_id_or_serial}

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | notes | string | user assigned notes
Length: 0..256 | | label | string | user assigned label
Length: 1..64 | | location:country | string | ISO 3166-1 alpha-3 country code
default: "" | | location:lat | number | latitude
default: 0 | | location:long | number | longitude
default: 0 | | location:city | string | city
default: "" | | location:state | string | state as two-character USPS abbreviation
default: "" | | zip_code | string | ZIP code | | tier | string | datacenter infrastructure tier
one of:"I" or "II" or "III" or "IV" | | email:type | string | email type
one of:"none" or "smtp" or "mailgun" | | email:smtp:server_port | integer | SMTP server port
default: 587
Range: 1 <= value <= 65535 | | email:smtp:mail_from | email | alternative mail-from email address
Length: 0..128 | | email:smtp:server_ssl | string | SMTP server SSL/TLS
one of:"none" or "required" or "optional" | | email:smtp:server_addr | hostname | SMTP server name
Length: 0..1024 | | email:smtp:server_password | string | SMTP authentication password
Length: 1..∞ | | email:smtp:server_username | string | SMTP authentication username
Length: 1..∞ | | email:smtp:server_auth | boolean | SMTP authentication is enabled |

Curl Example

$ curl -X PATCH https://mgmt-node/api/site/SIT1468194C40626570 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "label": "virginia1",
  "notes": "site updated"
}'

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:52 GMT
Server: Goliath
ETag: "515d98722d696ec32dc7467e13f46587"
Content-Type: application/json
Content-Length: 672

{
  "id": "site:18",
  "uuid": "d0132f8e-05c5-48d9-97da-806011f94bcd",
  "serial": "SIT1468194C40626570",
  "evt_qry": "serial=SIT1468194C40626570",
  "ctime": 1507570012289,
  "mtime": 1507570012535,
  "seq": 1507570012540,
  "label": "virginia1",
  "notes": "site updated",
  "status": {
    "value": "online",
    "indicator": "online",
    "detail": ""
  },
  "ec": {
    "table": {
      "time": null,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "v": "dbg",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "info",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "warn",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "err",
          "d": [
            0,
            0,
            0,
            0
          ]
        }
      ]
    },
    "status": "current",
    "seq": 1507570012310
  },
  "rec_status": null,
  "tier": "IV",
  "location": {
    "country": "US",
    "lat": 39.0436,
    "long": -77.4875,
    "city": "Ashburn",
    "state": "VA"
  },
  "email": {
    "type": [
      "none"
    ]
  }
}

Network Interface

Blockbridge storage node software detects the Ethernet interfaces you have configured on your nodes. Network Interface resources allow you to define how these interfaces are used for Blockbridge storage services.

The Blockbridge system thinks of networking in terms of these interfaces. You have the full power of Linux networking at your disposal including channel bonding, VLANs, and tunnels. You can have multiple interfaces for segregation, performance or high availability.

When a storage node completes its initial rendezvous with the management node, it registers the first Ethernet interface it finds, along with its IP addresses. If the node has additional interfaces, use this interface to register them.

Attributes

Network Interface Info

Retrieve an existing network interface.

GET /net/{net_id_or_serial}

Curl Example

$ curl https://mgmt-node/api/net/net:9:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:27:38 GMT
Server: Goliath
ETag: "67faa3dd29a0443799d26eaca7edac70"
Content-Type: application/json
Content-Length: 1498

{
  "id": "net:9:10",
  "uuid": "aa3b1c6b-456d-45a7-9840-40d6879df950",
  "serial": "NET1C62194C406264CE",
  "evt_qry": "serial=NET1C62194C406264CE",
  "node_id": "node:10000",
  "ctime": 1507570011779,
  "mtime": 1507570011779,
  "seq": 1507570013237,
  "label": "net-1",
  "notes": null,
  "status": {
    "value": "online",
    "indicator": "online",
    "detail": ""
  },
  "ec": {
    "table": {
      "time": 1507570011000,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "d": [
            2,
            2,
            2,
            2
          ],
          "v": "dbg"
        },
        {
          "d": [
            1,
            1,
            1,
            1
          ],
          "v": "info"
        },
        {
          "d": [
            0,
            0,
            0,
            0
          ],
          "v": "warn"
        },
        {
          "d": [
            0,
            0,
            0,
            0
          ],
          "v": "err"
        }
      ]
    },
    "status": "current",
    "seq": 1507570012677
  },
  "rec_status": null,
  "enabled": true,
  "interface": "eth0",
  "hostname": null,
  "nat_addr": null,
  "service": {
    "application": {
      "enabled": false
    },
    "management": {
      "enabled": false
    },
    "storage": {
      "enabled": true,
      "shared": true
    },
    "replication": {
      "enabled": true
    },
    "infrastructure": {
      "enabled": true
    },
    "external": {
      "enabled": true
    }
  },
  "network": {
    "interface": "eth0",
    "hwaddr": "FA:16:3E:6A:7C:79",
    "mtu": 1400,
    "flags": {
      "up": true,
      "broadcast": true,
      "debug": false,
      "loopback": false,
      "pointopoint": false,
      "notrailers": false,
      "running": true,
      "noarp": false,
      "promisc": false,
      "master": false,
      "slave": false,
      "multicast": true
    },
    "link": {
      "detected": true,
      "speed": null,
      "duplex": null,
      "port": "other"
    },
    "driver": {
      "name": "virtio_net",
      "version": "1.0.0",
      "fw_version": "",
      "bus": "0000:00:03.0"
    },
    "stats": {
      "tx_packets": 0,
      "tx_bytes": 0,
      "tx_errors": 0,
      "tx_dropped": 0,
      "rx_packets": 0,
      "rx_bytes": 0,
      "rx_errors": 0,
      "rx_dropped": 0
    },
    "ipaddrs": [
      {
        "addr": "10.10.200.23",
        "family": "IPv4"
      },
      {
        "addr": "fe80::f816:3eff:fe6a:7c79%eth0",
        "family": "IPv6"
      }
    ]
  }
}

Network Interface List

Enumerate network interfaces.

GET /net

Curl Example

$ curl https://mgmt-node/api/net \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:51 GMT
Server: Goliath
Content-Type: application/json
Content-Length: 1500

[
  {
    "id": "net:8:10",
    "uuid": "9935b887-1f48-4d60-b4d1-c7dcef082a66",
    "serial": "NET1C62194C406264D6",
    "evt_qry": "serial=NET1C62194C406264D6",
    "node_id": "node:10000",
    "ctime": 1507569965178,
    "mtime": 1507569965242,
    "seq": 1507570010649,
    "label": "net-1",
    "notes": null,
    "status": {
      "value": "online",
      "indicator": "online",
      "detail": ""
    },
    "ec": {
      "table": {
        "time": 1507569965000,
        "hdrs": [
          3600000,
          86400000,
          604800000,
          2629800000
        ],
        "rows": [
          {
            "d": [
              2,
              2,
              2,
              2
            ],
            "v": "dbg"
          },
          {
            "d": [
              1,
              1,
              1,
              1
            ],
            "v": "info"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "warn"
          },
          {
            "d": [
              0,
              0,
              0,
              0
            ],
            "v": "err"
          }
        ]
      },
      "status": "current",
      "seq": 1507569965673
    },
    "rec_status": null,
    "enabled": true,
    "interface": "eth0",
    "hostname": null,
    "nat_addr": null,
    "service": {
      "application": {
        "enabled": false
      },
      "management": {
        "enabled": false
      },
      "storage": {
        "enabled": true,
        "shared": true
      },
      "replication": {
        "enabled": true
      },
      "infrastructure": {
        "enabled": true
      },
      "external": {
        "enabled": true
      }
    },
    "network": {
      "interface": "eth0",
      "hwaddr": "FA:16:3E:6A:7C:79",
      "mtu": 1400,
      "flags": {
        "up": true,
        "broadcast": true,
        "debug": false,
        "loopback": false,
        "pointopoint": false,
        "notrailers": false,
        "running": true,
        "noarp": false,
        "promisc": false,
        "master": false,
        "slave": false,
        "multicast": true
      },
      "link": {
        "detected": true,
        "speed": null,
        "duplex": null,
        "port": "other"
      },
      "driver": {
        "name": "virtio_net",
        "version": "1.0.0",
        "fw_version": "",
        "bus": "0000:00:03.0"
      },
      "stats": {
        "tx_packets": 0,
        "tx_bytes": 0,
        "tx_errors": 0,
        "tx_dropped": 0,
        "rx_packets": 0,
        "rx_bytes": 0,
        "rx_errors": 0,
        "rx_dropped": 0
      },
      "ipaddrs": [
        {
          "addr": "10.10.200.23",
          "family": "IPv4"
        },
        {
          "addr": "fe80::f816:3eff:fe6a:7c79%eth0",
          "family": "IPv6"
        }
      ]
    }
  }
]

Network Interface Create

Register a new network interface.

POST /net

Required Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | node_id | string | node id | | interface | string | interface name |

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | label | string | user assigned label
Length: 1..64 | | notes | string | user assigned notes
Length: 0..256 | | enabled | boolean | service is enabled on this network interface
default: true | | nat_addr | nullable ipv4 | NAT IP address | | hostname | nullable hostname | hostname
Length: 0..1024 | | service:application:enabled | boolean | application service enabled | | service:management:enabled | boolean | management service enabled | | service:storage:enabled | boolean | storage service enabled
default: true | | service:storage:shared | boolean | storage service shared
default: true | | service:replication:enabled | boolean | replication service enabled
default: true | | service:infrastructure:enabled | boolean | infrastructure service enabled
default: true | | service:external:enabled | boolean | external service enabled
default: true | | uuid | uuid | object UUID | | portals | nullable array | published portals | | portals | nullable array | published portals | | cplx_id | nullable integer | processor complex assignment | | acl_type | string | access control policy for the supplied list
default: "deny_all"
one of:"allow_all" or "deny_all" or "allow_list" or "deny_list" | | acl | array | list of account names, enforced if acl_type is allow_list or deny_list
default: [] |

Curl Example

$ curl -X POST https://mgmt-node/api/net \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg" \
  -d \
'{
  "node_id": "node:10000",
  "interface": "eth0"
}'

Response Example

201 Created
Date: Mon, 09 Oct 2017 17:26:51 GMT
Server: Goliath
ETag: "45e7c4efa8349d677789a828f54636d4"
Content-Type: application/json
Content-Length: 881

{
  "id": "net:9:10",
  "uuid": "aa3b1c6b-456d-45a7-9840-40d6879df950",
  "serial": "NET1C62194C406264CE",
  "evt_qry": "serial=NET1C62194C406264CE",
  "node_id": "node:10000",
  "ctime": 1507570011779,
  "mtime": 1507570011779,
  "seq": 1507570011789,
  "label": "net-1",
  "notes": null,
  "status": {
    "value": "pending",
    "indicator": "degraded",
    "detail": "retrieving status; please wait"
  },
  "ec": {
    "table": {
      "time": null,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "v": "dbg",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "info",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "warn",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "err",
          "d": [
            0,
            0,
            0,
            0
          ]
        }
      ]
    },
    "status": "current",
    "seq": 1507570011789
  },
  "rec_status": null,
  "enabled": true,
  "interface": "eth0",
  "hostname": null,
  "nat_addr": null,
  "service": {
    "application": {
      "enabled": false
    },
    "management": {
      "enabled": false
    },
    "storage": {
      "enabled": true,
      "shared": true
    },
    "replication": {
      "enabled": true
    },
    "infrastructure": {
      "enabled": true
    },
    "external": {
      "enabled": true
    }
  },
  "network": null
}

Network Interface Remove

Remove the configuration for an existing network interface.

DELETE /net/{net_id_or_serial}

Curl Example

$ curl -X DELETE https://mgmt-node/api/net/net:8:10 \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

204 No Content
Date: Mon, 09 Oct 2017 17:26:51 GMT
Server: Goliath

Network Interface Update

Change the configuration of an existing network interface.

PATCH /net/{net_id_or_serial}

Optional Parameters

| Name | Type | Description | | ------- | ------- | ------- | ------- | | label | string | user assigned label
Length: 1..64 | | notes | string | user assigned notes
Length: 0..256 | | enabled | boolean | service is enabled on this network interface | | interface | string | interface name | | nat_addr | nullable ipv4 | NAT IP address | | hostname | nullable hostname | hostname
Length: 0..1024 | | service:application:enabled | boolean | application service enabled | | service:management:enabled | boolean | management service enabled | | service:storage:enabled | boolean | storage service enabled | | service:storage:shared | boolean | storage service shared | | service:replication:enabled | boolean | replication service enabled | | service:infrastructure:enabled | boolean | infrastructure service enabled | | service:external:enabled | boolean | external service enabled | | portals | nullable array | published portals | | portals | nullable array | published portals | | cplx_id | nullable integer | processor complex assignment | | acl_type | string | access control policy for the supplied list
one of:"allow_all" or "deny_all" or "allow_list" or "deny_list" | | acl | array | list of account names, enforced if acl_type is allow_list or deny_list |

Curl Example

$ curl -X PATCH https://mgmt-node/api/net/net:9:10 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 0/ZWbIgDWDjWa86fkBeFN34C/p+TDTQf/2hFEomiWU2Q1lZ8iANYOHdg"

Response Example

200 OK
Date: Mon, 09 Oct 2017 17:26:51 GMT
Server: Goliath
ETag: "45e7c4efa8349d677789a828f54636d4"
Content-Type: application/json
Content-Length: 881

{
  "id": "net:9:10",
  "uuid": "aa3b1c6b-456d-45a7-9840-40d6879df950",
  "serial": "NET1C62194C406264CE",
  "evt_qry": "serial=NET1C62194C406264CE",
  "node_id": "node:10000",
  "ctime": 1507570011779,
  "mtime": 1507570011779,
  "seq": 1507570011789,
  "label": "net-1",
  "notes": null,
  "status": {
    "value": "pending",
    "indicator": "degraded",
    "detail": "retrieving status; please wait"
  },
  "ec": {
    "table": {
      "time": null,
      "hdrs": [
        3600000,
        86400000,
        604800000,
        2629800000
      ],
      "rows": [
        {
          "v": "dbg",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "info",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "warn",
          "d": [
            0,
            0,
            0,
            0
          ]
        },
        {
          "v": "err",
          "d": [
            0,
            0,
            0,
            0
          ]
        }
      ]
    },
    "status": "current",
    "seq": 1507570011789
  },
  "rec_status": null,
  "enabled": true,
  "interface": "eth0",
  "hostname": null,
  "nat_addr": null,
  "service": {
    "application": {
      "enabled": false
    },
    "management": {
      "enabled": false
    },
    "storage": {
      "enabled": true,
      "shared": true
    },
    "replication": {
      "enabled": true
    },
    "infrastructure": {
      "enabled": true
    },
    "external": {
      "enabled": true
    }
  },
  "network": null
}

Operating System Device

The Operating System Storage Device object has the configuration necessary for a Blockbridge storage node to integrate direct-attached (DAS) storage into a System Datastore. The operating system has been configured with the proper drivers for the storage technology, and is responsible for providing a persistent device path. You can use any storage device that's compatible with Linux, such as NVDIMM, NVMe, PCI Flash, direct-attached hardware RAID, or a Fibre Channel SAN.

Attributes