Blockbridge REST API

Document last updated 2024-11-20T12:21:39

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

Optional Parameters

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

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

Optional Parameters

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

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

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

Optional Parameters

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

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

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

Optional Parameters