window.API = { "sections": [ { "name": "Accounts", "description": "Operations for Accounts.", "methods": [ { "uri": "/zios/accounts", "description": "List all accounts.", "method": "GET", "parameters": [ { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false }, { "name": "filter_field", "type": "string", "description": "A field to filter the accounts by.", "options": "name | id", "required": false }, { "name": "filter_value", "type": "string", "description": "A substring to filter the accounts by.", "required": false } ], "response": "\n\n 0\n 1\n \n \n 1461821755.08\n zios_admin\n True\n \n https://vsa-0000018f-zadara.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\n \n True\n eyal@zadarastorage.com\n normal\n 1461821754.96\n 91ea5bd5cdc04adb9f5e3c00a346c463\n \n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"accounts\": [\n {\n \"update_time\": \"1461821755.08\",\n \"name\": \"zios_admin\",\n \"is_system_account\": \"True\",\n \"public_url_list\": [\n \"https://vsa-0000018f-zadara.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\"\n ],\n \"enabled\": \"True\",\n \"email\": \"eyal@zadarastorage.com\",\n \"state\": \"normal\",\n \"create_time\": \"1461821754.96\",\n \"id\": \"91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"description\": null\n }\n ],\n \"count\": 1\n }\n}" }, { "uri": "/zios/accounts/{account_id}", "description": "Show account.", "ziosPermissions": "account_admin", "method": "GET", "response": "\n\n 0\n \n 1461821755.08\n zios_admin\n True\n \n https://vsa-0000018f-zadara.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\n \n True\n eyal@zadarastorage.com\n normal\n 1461821754.96\n 91ea5bd5cdc04adb9f5e3c00a346c463\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"count\": {\n \"update_time\": \"1461821755.08\",\n \"name\": \"zios_admin\",\n \"is_system_account\": \"True\",\n \"public_url_list\": [\n \"https://vsa-0000018f-zadara.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\"\n ],\n \"enabled\": \"True\",\n \"email\": \"eyal@zadarastorage.com\",\n \"state\": \"normal\",\n \"create_time\": \"1461821754.96\",\n \"id\": \"91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"description\": null\n }\n }\n}" }, { "uri": "/zios/accounts/{account_id}/users", "method": "GET", "description": "Show an account users.", "ziosPermissions": "account_admin", "response": "\n\n 0\n 1\n \n \n 1462073035.42\n eyal\n True\n 507ab47f362a4299aabe2f6e622c9b5f\n 1461821754.97\n True\n \n zios_admin\n \n True\n zios_admin\n 91ea5bd5cdc04adb9f5e3c00a346c463\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"users\": [\n {\n \"update_time\": \"1462073035.42\",\n \"name\": \"eyal\",\n \"enabled\": \"True\",\n \"id\": \"507ab47f362a4299aabe2f6e622c9b5f\",\n \"create_time\": \"1461821754.97\",\n \"init_password_changed\": \"True\",\n \"role_list\": [\n \"zios_admin\"\n ],\n \"is_system_user\": \"True\",\n \"account_name\": \"zios_admin\",\n \"account_id\": \"91ea5bd5cdc04adb9f5e3c00a346c463\"\n }\n ],\n \"count\": 1\n }\n}" }, { "uri": "/zios/accounts", "method": "POST", "description": "Adds a new account.", "parameters": [ { "name": "name", "type": "string", "description": "Account name", "example": "my_account", "required": true } ], "response": "\n\n 0\n da39fd0e8a484156af0c22e84d936da0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"count\": \"da39fd0e8a484156af0c22e84d936da0\"\n }\n}" }, { "uri": "/zios/accounts/{account_id}", "method": "DELETE", "description": "Delete an account.", "parameters": [ { "name": "force", "type": "string", "description": "force a deletion", "example": "YES", "required": true } ], "response": "\n 1073791826\n The request has been submitted, and it may take a few moments to complete. Check event-log for further details\n\n", "response_json": "{\n \"response\": {\n \"status\": 1073791826,\n \"message\": \"The request has been submitted, and it may take a few moments to complete. Check event-log for further details\"\n }\n}" }, { "uri": "/zios/accounts/{account_id}/cleanup", "method": "DELETE", "description": "Cleanup an account after deletion - deletes billing data.", "response": "\n 1073791826\n The request has been submitted, and it may take a few moments to complete. Check event-log for further details\n\n", "response_json": "{\n \"response\": {\n \"status\": 1073791826,\n \"message\": \"The request has been submitted, and it may take a few moments to complete. Check event-log for further details\"\n }\n}" }, { "uri": "/zios/accounts/{account_id}/disable", "method": "POST", "description": "Disables an account.", "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/accounts/{account_id}/enable", "method": "POST", "description": "Enables an account.", "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/requests", "method": "GET", "description": "List Account Requests", "parameters": [ { "name": "state", "required": false, "type": "string", "description": "Account request state", "options": "pending | approved | denied" }, { "name": "limit", "required": false, "type": "string", "description": "items per page" }, { "name": "page", "required": false, "type": "string", "description": "page number" } ], "response": "\n\n 22\n \n \n 13\n \n a8\n a8\n johndoe@gmail.com\n \n register_account\n \n \n 2016-03-01T14:12:44Z\n \n \n \n", "response_json": "{\n \"response\": {\n \"requests\": [\n {\n \"id\": 13,\n \"arguments\": {\n \"username\": \"a8\",\n \"account\": \"a8\",\n \"email\": \"johndoe@gmail.com\"\n },\n \"action\": \"register_account\",\n \"decided_by\": null,\n \"decided_at\": null,\n \"requested_at\": \"2016-03-01 14:12:44 UTC\"\n }\n ],\n \"count\": 22\n }\n}" }, { "uri": "/requests", "method": "POST", "nokey": true, "description": "Create Account Requests", "parameters": [ { "name": "request_action", "required": true, "type": "string", "example": "register_account", "options": "register_account" }, { "name": "arguments", "required": true, "type": "Object", "description": "Object containing username , account , email and password", "example": "{\"username\":\"johndoe\",\"account\":\"example\",\"password\":\"mypassword1234\" , \"email\": \"johndoe@example.com\"}", "example_as_json_string": true } ], "response": "\n\n 0\n 5\n\n", "response_json": "{\n \"response\": {\n \"status\": \"0\",\n \"request_id\": \"5\"\n }\n}" }, { "uri": "/requests/{id}/approve", "method": "POST", "description": "Approve an account request.", "response": "\n\n 0\n 11b6d6ea0fdf43b6b39b5558bb2a95a6\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"count\": \"11b6d6ea0fdf43b6b39b5558bb2a95a6\"\n }\n}" }, { "uri": "/requests/{id}/deny", "method": "POST", "description": "Deny an account request.", "response": "\n\n 0\n 33\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"request_id\": \"33\"\n }\n}" }, { "uri": "/zios/accounts/{id}/iops", "description": "Shows IOPs metering of an account.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "subserver", "required": true, "type": "string", "example": "object", "options": "object" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 9.4\n 0.0\n 9.4\n \n \n \n 9.3\n 0.0\n 9.600000000000001\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566809510,\n \"iops_put\": 9.4,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.4\n },\n {\n \"time\": 1566809570,\n \"iops_put\": 9.3,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.600000000000001\n }\n ]\n}" }, { "uri": "/zios/accounts/{id}/latency", "description": "Shows latency metering (ms) of an account.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "subserver", "required": true, "type": "string", "example": "object", "options": "object" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 29\n 0\n 12\n \n \n \n 31\n 0\n 12\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566810060,\n \"latency_put\": 29,\n \"latency_delete\": 0,\n \"latency_get\": 12\n },\n {\n \"time\": 1566810090,\n \"latency_put\": 31,\n \"latency_delete\": 0,\n \"latency_get\": 12\n }\n ]\n}" }, { "uri": "/zios/accounts/{id}/throughput", "description": "Shows bandwidth throughput metering (B/s) of an account.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "subserver", "required": true, "type": "string", "example": "object", "options": "object" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 13333335.8\n 0\n 20000000.0\n \n \n \n 26666666.6\n 0\n 25000000.0\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566811360,\n \"throughput_put\": 13333335.8,\n \"throughput_delete\": 0,\n \"throughput_get\": 20000000.0\n },\n {\n \"time\": 1566811390,\n \"throughput_put\": 26666666.6,\n \"throughput_delete\": 0,\n \"throughput_get\": 25000000.0\n }\n ]\n}" }, { "uri": "/zios/accounts/export", "description": "Exports all accounts in a CSV format.", "method": "GET", "csv": true, "response": "Name,ID,Status,Used Capacity (GiB),Containers,Objects,Enabled\nzios_admin,ididididididid,Normal,0.0,0,0,Yes\n" } ] }, { "name": "Users", "description": "Operations for Users.", "methods": [ { "uri": "/zios/users", "description": "List all users.", "ziosPermissions": "account_admin", "method": "GET", "parameters": [ { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false } ], "response": "\n\n 10\n \n \n 92\n john\n john@zadarastorage.com\n \n true\n true\n false\n \n \n 49\n Read Only\n \n \n Asia/Jerusalem\n true\n \n \n 91ea5bd5cdc04adb9f5e3c00a346c463\n zios_admin\n 507ab47f362a4299aabe2f6e622c9b5f\n MIIFHgYJKoZIhvcNAQcCoIIFDzCCBQsCAQExDTALBglghkgBZQMEAgEwggNvBgkqhkiG9w0BBwGgggNgBIIDXHsiYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDFUMDc6NDk6MTYuMzY2MzA1IiwiZXhwaXJlcyI6IjIwMTYtMDUtMDJUMDc6NDk6MTZaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MTgyMTc1NS4wNzk1OTIsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbIllKSjdTZEEzUVVTM1pHem5qSWNnaGciXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImV5YWwiLCJyb2xlc19saW5rcyI6W10sImlkIjoiNTA3YWI0N2YzNjJhNDI5OWFhYmUyZjZlNjIyYzliNWYiLCJyb2xlcyI6W3sibmFtZSI6Inppb3NfYWRtaW4ifV0sIm5hbWUiOiJleWFsIn0sIm1ldGFkYXRhIjp7ImlzX2FkbWluIjowLCJyb2xlcyI6WyJjMzgyNzdlMGQxY2E0N2IzYjg4ODUzNjQyYTc0MDA0ZiJdfX19MYIBgjCCAX4CAQEwWTBUMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVW5zZXQxDjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEVMBMGA1UEAwwMMTUwLjUwLjIuMTEwAgEBMAsGCWCGSAFlAwQCATANBgkqhkiG9w0BAQEFAASCAQBSqfm-wN23IF+OvutBrtxRwvufpPtDGYPcch7wU-G7pe0DN9QGfZsM5EVdTcx-Xk2szDsF6kxbqtD+wuLr2lqhJmpr0FFNk12oQ2fD5qdtzxz2aRPAGt-LfxwA9f4BEM13KIZaeLQ8qj4MjLByv14PNIby5hXgHVec08NTKWoSnGW7nLWVGfVA2uI0MIyRSO2h0AtvLC98q3MSzxSPCTvSNJ0KA6xYpThwOCyub392hhv+OafSfsRKpepXNpdPA6KyBr3aKQWXyj7hjliJgmT+L0bZMTQLV8C5FBdtzMt8JKS5tVS9kE+4aqBoyeYiaQwZv0i1+dusajHTfEBXH2Xu\n 2016-05-02T07:49:16Z\n 6a2f3cda52fe4056848226d1b85a5181\n 5345ee7de83e48058990f024c535e642\n https://vsa-0000018f-zadara.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\n \n \n 30\n zios_admin\n \n \n \n \n \n \n\n", "response_json": "{\n \"response\": {\n \"users\": [\n {\n \"id\": 92,\n \"username\": \"john\",\n \"email\": \"john@zadarastorage.com\",\n \"access_key\": null,\n \"primary\": true,\n \"admin\": true,\n \"locked\": false,\n \"roles\": [\n {\n \"id\": 49,\n \"name\": \"Read Only\"\n }\n ],\n \"display_timezone\": \"Asia/Jerusalem\",\n \"notify_on_events\": true,\n \"zios_data\": {\n \"zios_user\": {\n \"account_id\": \"91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"account_name\": \"zios_admin\",\n \"id\": \"507ab47f362a4299aabe2f6e622c9b5f\",\n \"token\": \"MIIFHgYJKoZIhvcNAQcCoIIFDzCCBQsCAQExDTALBglghkgBZQMEAgEwggNvBgkqhkiG9w0BBwGgggNgBIIDXHsiYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDFUMDc6NDk6MTYuMzY2MzA1IiwiZXhwaXJlcyI6IjIwMTYtMDUtMDJUMDc6NDk6MTZaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MTgyMTc1NS4wNzk1OTIsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbIllKSjdTZEEzUVVTM1pHem5qSWNnaGciXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImV5YWwiLCJyb2xlc19saW5rcyI6W10sImlkIjoiNTA3YWI0N2YzNjJhNDI5OWFhYmUyZjZlNjIyYzliNWYiLCJyb2xlcyI6W3sibmFtZSI6Inppb3NfYWRtaW4ifV0sIm5hbWUiOiJleWFsIn0sIm1ldGFkYXRhIjp7ImlzX2FkbWluIjowLCJyb2xlcyI6WyJjMzgyNzdlMGQxY2E0N2IzYjg4ODUzNjQyYTc0MDA0ZiJdfX19MYIBgjCCAX4CAQEwWTBUMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVW5zZXQxDjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEVMBMGA1UEAwwMMTUwLjUwLjIuMTEwAgEBMAsGCWCGSAFlAwQCATANBgkqhkiG9w0BAQEFAASCAQBSqfm-wN23IF+OvutBrtxRwvufpPtDGYPcch7wU-G7pe0DN9QGfZsM5EVdTcx-Xk2szDsF6kxbqtD+wuLr2lqhJmpr0FFNk12oQ2fD5qdtzxz2aRPAGt-LfxwA9f4BEM13KIZaeLQ8qj4MjLByv14PNIby5hXgHVec08NTKWoSnGW7nLWVGfVA2uI0MIyRSO2h0AtvLC98q3MSzxSPCTvSNJ0KA6xYpThwOCyub392hhv+OafSfsRKpepXNpdPA6KyBr3aKQWXyj7hjliJgmT+L0bZMTQLV8C5FBdtzMt8JKS5tVS9kE+4aqBoyeYiaQwZv0i1+dusajHTfEBXH2Xu\",\n \"token_expire_at\": \"2016-05-02 07:49:16 UTC\",\n \"s3_access_key\": \"6a2f3cda52fe4056848226d1b85a5181\",\n \"s3_secret_key\": \"5345ee7de83e48058990f024c535e642\",\n \"public_url\": \"https://vsa-0000018f-zadara.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"roles\": [\n {\n \"id\": 30,\n \"name\": \"zios_admin\"\n }\n ]\n }\n }\n }\n ],\n \"count\": 10\n }\n}" }, { "uri": "/zios/users/{id}", "description": "Show a single user.", "ziosPermissions": "account_admin", "method": "GET", "response": "\n\n \n zios_admin\n 1557815377.84\n admin\n {'self': u'http://localhost:35357/v3/users/add61429a86444a9af9984d1a4ba4dcc'}\n 1d7d87437a33422ca4d0dddcc014685e\n True\n 009979f7f61c4cee99519fd935e7d64b\n default\n 1557814699.09\n b9409960e4dc480ba0d4307392dd31ea\n True\n \n zios_admin\n \n 009979f7f61c4cee99519fd935e7d64b\n True\n add61429a86444a9af9984d1a4ba4dcc\n None\n true\n 1\n true\n team@zadarastorage.com\n \n 0\n\n", "response_json": "{\n \"response\": {\n \"user\": {\n \"account_name\": \"zios_admin\",\n \"update_time\": \"1557815377.84\",\n \"name\": \"admin\",\n \"links\": \"{'self': u'http://localhost:35357/v3/users/add61429a86444a9af9984d1a4ba4dcc'}\",\n \"s3_secret_key\": \"1d7d87437a33422ca4d0dddcc014685e\",\n \"enabled\": \"True\",\n \"account_id\": \"009979f7f61c4cee99519fd935e7d64b\",\n \"domain_id\": \"default\",\n \"create_time\": \"1557814699.09\",\n \"s3_access_key\": \"b9409960e4dc480ba0d4307392dd31ea\",\n \"init_password_changed\": \"True\",\n \"role_list\": [\n \"zios_admin\"\n ],\n \"project_id\": \"009979f7f61c4cee99519fd935e7d64b\",\n \"is_system_user\": \"True\",\n \"id\": \"add61429a86444a9af9984d1a4ba4dcc\",\n \"password_expires_at\": \"None\",\n \"notify_on_events\": true,\n \"notification_severity\": 1,\n \"primary\": true,\n \"email\": \"team@zadarastorage.com\"\n },\n \"status\": 0\n }\n}" }, { "uri": "/zios/users", "method": "POST", "description": "Adds a new user.", "ziosPermissions": "account_admin", "parameters": [ { "name": "username", "type": "string", "description": "The new username", "example": "johndoe", "required": true }, { "name": "email", "type": "string", "required": true, "description": "The new user email", "example": "johndoe@company.com" }, { "name": "account_id", "type": "string", "required": true, "description": "Account ID", "example": "91ea5bd5cdc04adb9f5e3c00a346c463" }, { "name": "notify_on_events", "type": "string", "description": "Notify the user on system events", "options": "YES | NO", "example": "YES" }, { "name": "role", "type": "string", "required": true, "description": "User role in account", "options": "zios_admin | account_admin | member", "example": "member" } ], "response": "\n\n 0\n qows969a1xdJCud6ev-t\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"code\": \"qows969a1xdJCud6ev-t\"\n }\n}" }, { "uri": "/zios/users/{id}", "method": "DELETE", "description": "Delete a user.", "ziosPermissions": "account_admin", "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/users/authenticate", "description": "Returns a user's authentication token.", "ziosPermissions": "account_admin,member", "nokey": true, "method": "POST", "parameters": [ { "name": "account", "type": "string", "required": true, "example": "zios_admin", "description": "User's account." }, { "name": "user", "type": "string", "required": true, "example": "johndoe", "description": "Username or email address." }, { "name": "password", "type": "string", "required": true, "example": "mysupersecretpassword", "description": "The user password" } ], "response": "\n\n 0\n \n 103\n johndoe1\n johndoe@company.com\n \n false\n true\n false\n \n \n 49\n Read Only\n \n \n Asia/Jerusalem\n false\n \n \n \n 91ea5bd5cdc04adb9f5e3c00a346c463\n zios_admin\n 509a0484b4a04b4f8899a370dd62e502\n MIIFJgYJKoZIhvcNAQcCoIIFFzCCBRMCAQExDTALBglghkgBZQMEAgEwggN3BgkqhkiG9w0BBwGgggNoBIIDZHsiYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDFUMTE6MTU6NDguNzU4OTg1IiwiZXhwaXJlcyI6IjIwMTYtMDUtMDJUMTE6MTU6NDhaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MjEwMTI1NC4zMTYwODMsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbImtDbzQwU0g2VG9pblJIRUFXcWRfQUEiXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImpvaG5kb2UxIiwicm9sZXNfbGlua3MiOltdLCJpZCI6IjUwOWEwNDg0YjRhMDRiNGY4ODk5YTM3MGRkNjJlNTAyIiwicm9sZXMiOlt7Im5hbWUiOiJ6aW9zX2FkbWluIn1dLCJuYW1lIjoiam9obmRvZTEifSwibWV0YWRhdGEiOnsiaXNfYWRtaW4iOjAsInJvbGVzIjpbImMzODI3N2UwZDFjYTQ3YjNiODg4NTM2NDJhNzQwMDRmIl19fX0xggGCMIIBfgIBATBZMFQxCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVVbnNldDEOMAwGA1UEBwwFVW5zZXQxDjAMBgNVBAoMBVVuc2V0MRUwEwYDVQQDDAwxNTAuNTAuMi4xMTACAQEwCwYJYIZIAWUDBAIBMA0GCSqGSIb3DQEBAQUABIIBAKJIqdYo+lw7xd+sCWwjUxwq-OzcHkrlrG9okK+v-kCOiUSv87auYJYu9HVOpw+nc-U8t76OjBJiXN41vK-pA-YfPE4+2S9f1b4kL69LljIUU4uED2nkggEMue6J9wsDmHk9pjE76HU599kt579HSz4ipaYW3DHn0sMTYX0rfBkQ4ir1SSqC3BOYw3Erx2Uc9pK88EIxjvW+dQ+lfOz0acfV-lto7CAazhnl3i2RhK9eJ3roRo9DPuqqEPGNEoKm8SwC-Nx2H-7ULMe6VKkULZA+0WG5cBCn33iozQPxLQyPDAgkhHp4-HhHXo08AMj814UE5EVKGksWraHZeTFPKHw=\n 2016-05-02T11:15:48Z\n 72f793ff6b3b4ac5a8cea6e2296e776b\n b4f4f95d28284f5b9477657f7ea40d91\n https://vsa-0000018f-zadara-dev2.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\n \n \n 30\n zios_admin\n \n \n \n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"user\": {\n \"id\": 103,\n \"username\": \"johndoe1\",\n \"email\": \"johndoe@company.com\",\n \"access_key\": null,\n \"primary\": false,\n \"admin\": true,\n \"locked\": false,\n \"roles\": [\n {\n \"id\": 49,\n \"name\": \"Read Only\"\n }\n ],\n \"display_timezone\": \"Asia/Jerusalem\",\n \"notify_on_events\": false,\n \"permissions\": [\n\n ],\n \"zios_data\": {\n \"zios_user\": {\n \"account_id\": \"91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"account_name\": \"zios_admin\",\n \"id\": \"509a0484b4a04b4f8899a370dd62e502\",\n \"token\": \"MIIFJgYJKoZIhvcNAQcCoIIFFzCCBRMCAQExDTALBglghkgBZQMEAgEwggN3BgkqhkiG9w0BBwGgggNoBIIDZHsiYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDFUMTE6MTU6NDguNzU4OTg1IiwiZXhwaXJlcyI6IjIwMTYtMDUtMDJUMTE6MTU6NDhaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MjEwMTI1NC4zMTYwODMsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbImtDbzQwU0g2VG9pblJIRUFXcWRfQUEiXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImpvaG5kb2UxIiwicm9sZXNfbGlua3MiOltdLCJpZCI6IjUwOWEwNDg0YjRhMDRiNGY4ODk5YTM3MGRkNjJlNTAyIiwicm9sZXMiOlt7Im5hbWUiOiJ6aW9zX2FkbWluIn1dLCJuYW1lIjoiam9obmRvZTEifSwibWV0YWRhdGEiOnsiaXNfYWRtaW4iOjAsInJvbGVzIjpbImMzODI3N2UwZDFjYTQ3YjNiODg4NTM2NDJhNzQwMDRmIl19fX0xggGCMIIBfgIBATBZMFQxCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVVbnNldDEOMAwGA1UEBwwFVW5zZXQxDjAMBgNVBAoMBVVuc2V0MRUwEwYDVQQDDAwxNTAuNTAuMi4xMTACAQEwCwYJYIZIAWUDBAIBMA0GCSqGSIb3DQEBAQUABIIBAKJIqdYo+lw7xd+sCWwjUxwq-OzcHkrlrG9okK+v-kCOiUSv87auYJYu9HVOpw+nc-U8t76OjBJiXN41vK-pA-YfPE4+2S9f1b4kL69LljIUU4uED2nkggEMue6J9wsDmHk9pjE76HU599kt579HSz4ipaYW3DHn0sMTYX0rfBkQ4ir1SSqC3BOYw3Erx2Uc9pK88EIxjvW+dQ+lfOz0acfV-lto7CAazhnl3i2RhK9eJ3roRo9DPuqqEPGNEoKm8SwC-Nx2H-7ULMe6VKkULZA+0WG5cBCn33iozQPxLQyPDAgkhHp4-HhHXo08AMj814UE5EVKGksWraHZeTFPKHw=\",\n \"token_expire_at\": \"2016-05-02 11:15:48 UTC\",\n \"s3_access_key\": \"72f793ff6b3b4ac5a8cea6e2296e776b\",\n \"s3_secret_key\": \"b4f4f95d28284f5b9477657f7ea40d91\",\n \"public_url\": \"https://vsa-0000018f-zadara-dev2.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"roles\": [\n {\n \"id\": 30,\n \"name\": \"zios_admin\"\n }\n ]\n }\n }\n }\n }\n}" }, { "uri": "/zios/users/{user_id}/enable", "method": "POST", "ziosPermissions": "account_admin", "description": "Enable a user.", "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/users/{user_id}/disable", "ziosPermissions": "account_admin", "method": "POST", "description": "Disable a user.", "response": "\n\n 0\n \n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/users/admin_access/enable", "method": "POST", "description": "Enables cloud admin access.", "response": "\n\n 0\n Admin access enabled.\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"message\": \"Admin access enabled.\"\n }\n}" }, { "uri": "/users/admin_access/disable", "method": "POST", "description": "Disables cloud admin access.", "response": "\n\n 0\n Admin access disabled.\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"message\": \"Admin access disabled.\"\n }\n}" }, { "uri": "/users/reset_token", "description": "Regenerate a user's authentication token.", "ziosPermissions": "account_admin,member", "nokey": true, "method": "POST", "parameters": [ { "name": "user", "type": "string", "description": "username", "example": "johndoe", "required": true }, { "name": "password", "type": "string", "description": "password", "example": "mypassword123", "required": true }, { "name": "account", "type": "string", "description": "account", "example": "zios_admin", "required": true } ], "response": "\n\n 0\n MIIFHgYJKoZIhvcNAQcCoIIFDzCCBQsCAQExDTALBglghkgBZQMEAgEwggNvBgkqhkiG9w0BBwGgggNgBIIDXHsiYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDNUMDk6NDU6MDcuMjI4MTExIiwiZXhwaXJlcyI6IjIwMTYtMDUtMDRUMDk6NDU6MDdaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MjEwNjQ3Mi43MTY1ODMsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbIkNKNXkweUxOUU4yZ3FBcE5oVkRDLUEiXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImV5YWwiLCJyb2xlc19saW5rcyI6W10sImlkIjoiNTA3YWI0N2YzNjJhNDI5OWFhYmUyZjZlNjIyYzliNWYiLCJyb2xlcyI6W3sibmFtZSI6Inppb3NfYWRtaW4ifV0sIm5hbWUiOiJleWFsIn0sIm1ldGFkYXRhIjp7ImlzX2FkbWluIjowLCJyb2xlcyI6WyJjMzgyNzdlMGQxY2E0N2IzYjg4ODUzNjQyYTc0MDA0ZiJdfX19MYIBgjCCAX4CAQEwWTBUMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVW5zZXQxDjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEVMBMGA1UEAwwMMTUwLjUwLjIuMTEwAgEBMAsGCWCGSAFlAwQCATANBgkqhkiG9w0BAQEFAASCAQAVx1VyMv68oA5Gt0IODSTNlI-rnTJsGqMG+0Lf2Lig4cv4doIW7AKpi115DrS4OIkzMtDbPujxSwUqLrpmDXEuHygHQNFjP6VBoKPko1i+GvHyEC0kutq7tk8ODRjbpMhEo6MgJ57QiKrMtB39Fkh3HaN3mJVmme3-qw5XcgmqRHI5n9hl2T8Mx8A6sasmMLQ32spBZUTQ0F9OBlw70gmmx14PveVIVXGak7gXvT0+cgPdb00vs+zsCwP0SEoQZoNZVURhaMTlRMmsftY6qMHCrtDFRfpnRwnW7r2OcIIHxNA0-0qXg6emX4XYT8G3lvYahyJ5LTbpnPauRzMJPs78\n 2016-05-04T09:45:07Z\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"token\": \"MIIFHgYJKoZIhvcNAQcCoIIFDzCCBQsCAQExDTALBglghkgBZQMEAgEwggNvBgkqhkiG9w0BBwGgggNgBIIDXHsiYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDNUMDk6NDU6MDcuMjI4MTExIiwiZXhwaXJlcyI6IjIwMTYtMDUtMDRUMDk6NDU6MDdaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MjEwNjQ3Mi43MTY1ODMsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbIkNKNXkweUxOUU4yZ3FBcE5oVkRDLUEiXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImV5YWwiLCJyb2xlc19saW5rcyI6W10sImlkIjoiNTA3YWI0N2YzNjJhNDI5OWFhYmUyZjZlNjIyYzliNWYiLCJyb2xlcyI6W3sibmFtZSI6Inppb3NfYWRtaW4ifV0sIm5hbWUiOiJleWFsIn0sIm1ldGFkYXRhIjp7ImlzX2FkbWluIjowLCJyb2xlcyI6WyJjMzgyNzdlMGQxY2E0N2IzYjg4ODUzNjQyYTc0MDA0ZiJdfX19MYIBgjCCAX4CAQEwWTBUMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVW5zZXQxDjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEVMBMGA1UEAwwMMTUwLjUwLjIuMTEwAgEBMAsGCWCGSAFlAwQCATANBgkqhkiG9w0BAQEFAASCAQAVx1VyMv68oA5Gt0IODSTNlI-rnTJsGqMG+0Lf2Lig4cv4doIW7AKpi115DrS4OIkzMtDbPujxSwUqLrpmDXEuHygHQNFjP6VBoKPko1i+GvHyEC0kutq7tk8ODRjbpMhEo6MgJ57QiKrMtB39Fkh3HaN3mJVmme3-qw5XcgmqRHI5n9hl2T8Mx8A6sasmMLQ32spBZUTQ0F9OBlw70gmmx14PveVIVXGak7gXvT0+cgPdb00vs+zsCwP0SEoQZoNZVURhaMTlRMmsftY6qMHCrtDFRfpnRwnW7r2OcIIHxNA0-0qXg6emX4XYT8G3lvYahyJ5LTbpnPauRzMJPs78\",\n \"token_expire_at\": \"2016-05-04 09:45:07 UTC\"\n }\n}" }, { "uri": "/zios/users/reset_s3_secret", "description": "Reset a user's s3 access key and secret key.", "ziosPermissions": "account_admin", "method": "POST", "parameters": [ { "name": "username", "type": "string", "description": "username", "example": "johndoe", "required": true }, { "name": "account", "type": "string", "description": "account", "example": "zios_admin", "required": true } ], "response": "\n\n 0\n 1\n \n \n 429ca61873884939a2c4a476330c230f\n 20a514133be94213953717d032a677bd\n 17c9f4e4c8bd4609acc88a049e2d3d69\n 9690f8eaea0649b39c275b77386c1b2d\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"credentials\": [\n {\n \"access\": \"429ca61873884939a2c4a476330c230f\",\n \"secret\": \"20a514133be94213953717d032a677bd\",\n \"user_id\": \"17c9f4e4c8bd4609acc88a049e2d3d69\",\n \"account_id\": \"9690f8eaea0649b39c275b77386c1b2d\"\n }\n ],\n \"count\": 1\n }\n}" }, { "uri": "/users/password", "method": "POST", "description": "Change a user's password.", "ziosPermissions": "account_admin,member", "nokey": true, "parameters": [ { "name": "account", "type": "string", "required": true, "example": "johndoe" }, { "name": "user", "type": "string", "required": true, "example": "johndoe" }, { "name": "password", "type": "string", "required": true, "description": "Existing password.", "example": "mysupersecretpassword" }, { "name": "new_password", "type": "string", "required": true, "description": "New password.", "example": "mynewsupersecretpassword" } ], "response": "\n\n 0\n Password changed.\n \n 106\n johndoe2\n johndoe@company.com\n \n false\n false\n false\n \n \n 50\n zios_account_admin\n \n \n Asia/Jerusalem\n false\n \n \n \n 91ea5bd5cdc04adb9f5e3c00a346c463\n zios_admin\n 0c0fbd574f61406883e07818a596dc0b\n MIIFKQYJKoZIhvcNAQcCoIIFGjCCBRYCAQExDTALBglghkgBZQMEAgEwggN6BgkqhkiG9w0BBwGgggNrBIIDZ3siYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDFUMTI6NDY6NDMuMDg3Nzc5IiwiZXhwaXJlcyI6IjIwMTYtMDUtMDJUMTI6NDY6NDNaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MjEwNjQ3Mi43MTY1ODMsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbImMzRDhGUU13VE9TQ01GbTUxRWkwdEEiXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImpvaG5kb2UyIiwicm9sZXNfbGlua3MiOltdLCJpZCI6IjBjMGZiZDU3NGY2MTQwNjg4M2UwNzgxOGE1OTZkYzBiIiwicm9sZXMiOlt7Im5hbWUiOiJhY2NvdW50X2FkbWluIn1dLCJuYW1lIjoiam9obmRvZTIifSwibWV0YWRhdGEiOnsiaXNfYWRtaW4iOjAsInJvbGVzIjpbIjQ2YTEyMWE3NjdlODRhZGY4ZTU3YjdiY2Y2YTU3NWM0Il19fX0xggGCMIIBfgIBATBZMFQxCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVVbnNldDEOMAwGA1UEBwwFVW5zZXQxDjAMBgNVBAoMBVVuc2V0MRUwEwYDVQQDDAwxNTAuNTAuMi4xMTACAQEwCwYJYIZIAWUDBAIBMA0GCSqGSIb3DQEBAQUABIIBABrypucm7DsNAknpNr3r1XVKcN+CFkfs7q8yE+1KiHQFgrZVaqs50RIomRI08YJCljKw0ajqd0-L3JT+fN-rKphNc88zfKm2oguWnwE-lCjuLkipqBpNNELXLjYMNuoeo4hrPWTZkyJP1yr5treLgZ0+OTjoK35ayXlfS8Mqw4znIDKJqtH11ZPq-BGjltvFKpy8XyqeYEWRVVFN90XhUQKesRjmt4g5DPHQZHm+hOVZo2pSOBv6y3PIqWauJqIjbUFSrMYUPjdxoSsxfdP+6kH9wglKhQmXQX5fgNtmmwR+JZHwyDLE-091zgEpUPD0-YzQJPXRilBmwqwgaeZDcSw=\n 2016-05-02T12:46:43Z\n 6c32b29b14e145ef810ee94ede90c585\n a78cc88cfc6247118c490b114aac4180\n https://vsa-0000018f-zadara-dev2.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\n \n \n 31\n account_admin\n \n \n \n \n \n BKmbMCO6G4yiSUJupdb2HUYawhb8CBmY3etfOCACuGw=\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"user\": {\n \"id\": 106,\n \"username\": \"johndoe2\",\n \"email\": \"johndoe@company.com\",\n \"access_key\": null,\n \"primary\": false,\n \"admin\": false,\n \"locked\": false,\n \"roles\": [\n {\n \"id\": 50,\n \"name\": \"zios_account_admin\"\n }\n ],\n \"display_timezone\": \"Asia/Jerusalem\",\n \"notify_on_events\": false,\n \"permissions\": [\n\n ],\n \"zios_data\": {\n \"zios_user\": {\n \"account_id\": \"91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"account_name\": \"zios_admin\",\n \"id\": \"0c0fbd574f61406883e07818a596dc0b\",\n \"token\": \"MIIFKQYJKoZIhvcNAQcCoIIFGjCCBRYCAQExDTALBglghkgBZQMEAgEwggN6BgkqhkiG9w0BBwGgggNrBIIDZ3siYWNjZXNzIjp7InRva2VuIjp7Imlzc3VlZF9hdCI6IjIwMTYtMDUtMDFUMTI6NDY6NDMuMDg3Nzc5IiwiZXhwaXJlcyI6IjIwMTYtMDUtMDJUMTI6NDY6NDNaIiwiaWQiOiJwbGFjZWhvbGRlciIsInRlbmFudCI6eyJ1cGRhdGVfdGltZSI6MTQ2MjEwNjQ3Mi43MTY1ODMsIm5hbWUiOiJ6aW9zX2FkbWluIiwiaXNfc3lzdGVtX2FjY291bnQiOnRydWUsImVuYWJsZWQiOnRydWUsImVtYWlsIjoiZXlhbEB6YWRhcmFzdG9yYWdlLmNvbSIsInN0YXRlIjoibm9ybWFsIiwiY3JlYXRlX3RpbWUiOjE0NjE4MjE3NTQuOTU3NTk4LCJpZCI6IjkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiZGVzY3JpcHRpb24iOiIifSwiYXVkaXRfaWRzIjpbImMzRDhGUU13VE9TQ01GbTUxRWkwdEEiXX0sInNlcnZpY2VDYXRhbG9nIjpbeyJlbmRwb2ludHMiOlt7InJlZ2lvbiI6InJlZ2lvbk9uZSIsInB1YmxpY1VSTCI6Imh0dHBzOi8vdnNhLTAwMDAwMThmLXphZGFyYS1kZXYyLnphZGFyYXppb3MuY29tOjQ0My92MS9BVVRIXzkxZWE1YmQ1Y2RjMDRhZGI5ZjVlM2MwMGEzNDZjNDYzIiwiaWQiOiIyMzBhYWQ1ODAxOTg0OGYxOGFhZDMzNmJjOTNiOWIxNCJ9XSwiZW5kcG9pbnRzX2xpbmtzIjpbXSwidHlwZSI6Im9iamVjdC1zdG9yZSIsIm5hbWUiOiJzd2lmdCJ9XSwidXNlciI6eyJ1c2VybmFtZSI6ImpvaG5kb2UyIiwicm9sZXNfbGlua3MiOltdLCJpZCI6IjBjMGZiZDU3NGY2MTQwNjg4M2UwNzgxOGE1OTZkYzBiIiwicm9sZXMiOlt7Im5hbWUiOiJhY2NvdW50X2FkbWluIn1dLCJuYW1lIjoiam9obmRvZTIifSwibWV0YWRhdGEiOnsiaXNfYWRtaW4iOjAsInJvbGVzIjpbIjQ2YTEyMWE3NjdlODRhZGY4ZTU3YjdiY2Y2YTU3NWM0Il19fX0xggGCMIIBfgIBATBZMFQxCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVVbnNldDEOMAwGA1UEBwwFVW5zZXQxDjAMBgNVBAoMBVVuc2V0MRUwEwYDVQQDDAwxNTAuNTAuMi4xMTACAQEwCwYJYIZIAWUDBAIBMA0GCSqGSIb3DQEBAQUABIIBABrypucm7DsNAknpNr3r1XVKcN+CFkfs7q8yE+1KiHQFgrZVaqs50RIomRI08YJCljKw0ajqd0-L3JT+fN-rKphNc88zfKm2oguWnwE-lCjuLkipqBpNNELXLjYMNuoeo4hrPWTZkyJP1yr5treLgZ0+OTjoK35ayXlfS8Mqw4znIDKJqtH11ZPq-BGjltvFKpy8XyqeYEWRVVFN90XhUQKesRjmt4g5DPHQZHm+hOVZo2pSOBv6y3PIqWauJqIjbUFSrMYUPjdxoSsxfdP+6kH9wglKhQmXQX5fgNtmmwR+JZHwyDLE-091zgEpUPD0-YzQJPXRilBmwqwgaeZDcSw=\",\n \"token_expire_at\": \"2016-05-02 12:46:43 UTC\",\n \"s3_access_key\": \"6c32b29b14e145ef810ee94ede90c585\",\n \"s3_secret_key\": \"a78cc88cfc6247118c490b114aac4180\",\n \"public_url\": \"https://vsa-0000018f-zadara-dev2.zadarazios.com:443/v1/AUTH_91ea5bd5cdc04adb9f5e3c00a346c463\",\n \"roles\": [\n {\n \"id\": 31,\n \"name\": \"account_admin\"\n }\n ]\n }\n }\n },\n \"csrf\": \"BKmbMCO6G4yiSUJupdb2HUYawhb8CBmY3etfOCACuGw=\",\n \"message\": \"Password changed.\"\n }\n}" }, { "uri": "/users/{username}/password_code", "method": "POST", "description": "Change a user's password using a temporary password code.", "ziosPermissions": "account_admin,member", "nokey": true, "parameters": [ { "name": "code", "required": true, "type": "string", "example": "Y5cHbh", "description": "temporary password code" }, { "name": "new_password", "required": true, "type": "string", "example": "mynewpassword" }, { "name": "username", "required": true, "type": "string", "example": "johndoe" }, { "name": "account", "required": true, "type": "string", "example": "account1" } ], "response": "\n\n 0\n Password set successfully.\n\n", "response_json": "{\n \"status\": 0,\n \"status_msg\": \"Password set successfully.\"\n}" }, { "uri": "/users/reset_password", "method": "POST", "nokey": true, "description": "Issues a temporary password code to be sent by mail.", "ziosPermissions": "account_admin,member", "parameters": [ { "name": "account", "required": true, "description": "User's account", "type": "string", "example": "zios_admin" }, { "name": "username", "required": true, "description": "User to reset password", "type": "string", "example": "johndoe" } ], "response": "\n\n 0\n Temporary passcode sent to email\n\n", "response_json": "{\n \"status\": 0,\n \"status_msg\": \"Temporary passcode sent to email\"\n}" }, { "uri": "/zios/users/{user_id}/change_role", "method": "POST", "ziosPermissions": "account_admin", "description": "Change a VPSA Object Storage user role", "parameters": [ { "name": "role", "required": true, "type": "string", "options": "zios_admin | account_admin | member", "example": "member" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/users/{id}/iops", "description": "Shows IOPs metering for a user.", "ziosPermissions": "account_admin", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "subserver", "required": true, "type": "string", "example": "object", "options": "object" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 9.4\n 0.0\n 9.4\n \n \n \n 9.3\n 0.0\n 9.600000000000001\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566809510,\n \"iops_put\": 9.4,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.4\n },\n {\n \"time\": 1566809570,\n \"iops_put\": 9.3,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.600000000000001\n }\n ]\n}" }, { "uri": "/zios/users/{id}/latency", "description": "Shows latency (ms) metering for a user.", "ziosPermissions": "account_admin", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "subserver", "required": true, "type": "string", "example": "object", "options": "object" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 29\n 0\n 12\n \n \n \n 31\n 0\n 12\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566810060,\n \"latency_put\": 29,\n \"latency_delete\": 0,\n \"latency_get\": 12\n },\n {\n \"time\": 1566810090,\n \"latency_put\": 31,\n \"latency_delete\": 0,\n \"latency_get\": 12\n }\n ]\n}" }, { "uri": "/zios/users/{id}/throughput", "description": "Shows bandwidth throughput (B/s) metering for a user.", "ziosPermissions": "account_admin", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "subserver", "required": true, "type": "string", "example": "object", "options": "object" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 13333335.8\n 0\n 20000000.0\n \n \n \n 26666666.6\n 0\n 25000000.0\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566811360,\n \"throughput_put\": 13333335.8,\n \"throughput_delete\": 0,\n \"throughput_get\": 20000000.0\n },\n {\n \"time\": 1566811390,\n \"throughput_put\": 26666666.6,\n \"throughput_delete\": 0,\n \"throughput_get\": 25000000.0\n }\n ]\n}" } ] }, { "name": "Drives", "description": "Operations involving Drives.", "methods": [ { "uri": "/zios/drives", "method": "GET", "description": "Returns a list of all drives.", "parameters": [ { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false } ], "response": "\n\n 0\n 2\n \n \n volume-00000a6f\n drive-002\n SAS_9313GB_7200RPM\n 5000CCA26755A338\n qa14-sn1\n vc-1\n 1\n 1\n 15\n zone_0\n primary\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 0\n Absent\n 9313\n 0\n 0\n 2019-07-25T03:32:36+0000\n 2019-07-28T06:19:59+0000\n \n \n volume-00000a70\n drive-010\n SAS_9313GB_7200RPM\n 5000CCA2674ECB4C\n qa14-sn1\n vc-1\n 1\n 1\n 15\n zone_0\n primary\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 0\n Absent\n 9313\n 0\n 0\n 2019-07-25T03:32:36+0000\n 2019-07-28T06:19:59+0000\n \n \n volume-00000a71\n drive-018\n SAS_9313GB_7200RPM\n 5000CCA267498820\n qa14-sn1\n vc-1\n 1\n 1\n 15\n zone_0\n primary\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 0\n Absent\n 9313\n 0\n 0\n 2019-07-25T03:32:36+0000\n 2019-07-28T06:19:59+0000\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"disks\": [\n {\n \"name\": \"volume-00000a6f\",\n \"display_name\": \"drive-002\",\n \"disk_type\": \"SAS_9313GB_7200RPM\",\n \"disk_uuid\": \"5000CCA26755A338\",\n \"storage_node\": \"qa14-sn1\",\n \"vc\": \"vc-1\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"storage_policy\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"capacity_protection\": \"0\",\n \"status\": \"Absent\",\n \"capacity\": 9313,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"created_at\": \"2019-07-25 03:32:36 UTC\",\n \"modified_at\": \"2019-07-28 06:19:59 UTC\"\n },\n {\n \"name\": \"volume-00000a70\",\n \"display_name\": \"drive-010\",\n \"disk_type\": \"SAS_9313GB_7200RPM\",\n \"disk_uuid\": \"5000CCA2674ECB4C\",\n \"storage_node\": \"qa14-sn1\",\n \"vc\": \"vc-1\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"storage_policy\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"capacity_protection\": \"0\",\n \"status\": \"Absent\",\n \"capacity\": 9313,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"created_at\": \"2019-07-25 03:32:36 UTC\",\n \"modified_at\": \"2019-07-28 06:19:59 UTC\"\n },\n {\n \"name\": \"volume-00000a71\",\n \"display_name\": \"drive-018\",\n \"disk_type\": \"SAS_9313GB_7200RPM\",\n \"disk_uuid\": \"5000CCA267498820\",\n \"storage_node\": \"qa14-sn1\",\n \"vc\": \"vc-1\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"storage_policy\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"capacity_protection\": \"0\",\n \"status\": \"Absent\",\n \"capacity\": 9313,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"created_at\": \"2019-07-25 03:32:36 UTC\",\n \"modified_at\": \"2019-07-28 06:19:59 UTC\"\n }\n ],\n \"count\": 2\n }\n}" }, { "uri": "/zios/drives/{name}", "method": "GET", "description": "Returns one drive.", "response": "\n\n 0\n \n volume-00000a6f\n drive-002\n SAS_9313GB_7200RPM\n 5000CCA26755A338\n qa14-sn1\n vc-1\n 1\n 1\n 15\n zone_0\n primary\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 0\n Absent\n 9313\n 0\n 0\n 2019-07-25T03:32:36+0000\n 2019-07-28T06:19:59+0000\n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"disk\": {\n \"name\": \"volume-00000a6f\",\n \"display_name\": \"drive-002\",\n \"disk_type\": \"SAS_9313GB_7200RPM\",\n \"disk_uuid\": \"5000CCA26755A338\",\n \"storage_node\": \"qa14-sn1\",\n \"vc\": \"vc-1\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"storage_policy\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"capacity_protection\": \"0\",\n \"status\": \"Absent\",\n \"capacity\": 9313,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"created_at\": \"2019-07-25 03:32:36 UTC\",\n \"modified_at\": \"2019-07-28 06:19:59 UTC\"\n }\n }\n}" }, { "uri": "/zios/drives/{id}/iops", "description": "Shows IOPs metering of a drive.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "disk", "options": "disk" }, { "name": "vc", "required": true, "type": "string", "example": "vc-0" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 9.4\n 0.0\n 9.4\n \n \n \n 9.3\n 0.0\n 9.600000000000001\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566809510,\n \"iops_put\": 9.4,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.4\n },\n {\n \"time\": 1566809570,\n \"iops_put\": 9.3,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.600000000000001\n }\n ]\n}" }, { "uri": "/zios/drives/{id}/latency", "description": "Shows latency metering (ms) of a drive.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "disk", "options": "disk" }, { "name": "vc", "required": true, "type": "string", "example": "vc-0" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 29\n 0\n 12\n \n \n \n 31\n 0\n 12\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566810060,\n \"latency_put\": 29,\n \"latency_delete\": 0,\n \"latency_get\": 12\n },\n {\n \"time\": 1566810090,\n \"latency_put\": 31,\n \"latency_delete\": 0,\n \"latency_get\": 12\n }\n ]\n}" }, { "uri": "/zios/drives/{id}/throughput", "description": "Shows bandwidth throughput metering (B/s) of a drive.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "disk", "options": "disk" }, { "name": "vc", "required": true, "type": "string", "example": "vc-0" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 13333335.8\n 0\n 20000000.0\n \n \n \n 26666666.6\n 0\n 25000000.0\n \n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566811360,\n \"throughput_put\": 13333335.8,\n \"throughput_delete\": 0,\n \"throughput_get\": 20000000.0\n },\n {\n \"time\": 1566811390,\n \"throughput_put\": 26666666.6,\n \"throughput_delete\": 0,\n \"throughput_get\": 25000000.0\n }\n ]\n}" } ] }, { "name": "Virtual Controllers", "description": "Operations for Virtual Controllers.", "methods": [ { "uri": "/zios/virtual_controllers", "method": "GET", "description": "Get a list of Virtual Controllers.", "parameters": [ { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false } ], "response": "\n\n 0\n 2\n \n \n vc-0\n 0\n qa14-sn4\n proxy+storage\n created\n OBJ_NORMAL\n normal\n ring master\n 2\n 6\n 15\n zone_1\n secondary\n created\n \n 2003:cdba::3256:13\n 10.3.14.75\n lbg-00000004\n NO\n 50\n YES\n NotConfigured\n 2019-07-25T03:32:39+0000\n 2019-07-28T07:01:33+0000\n \n \n vc-1\n 1\n qa14-sn1\n proxy+storage\n created\n OBJ_NORMAL\n normal\n ring slave\n 1\n 1\n 15\n zone_0\n primary\n failed\n \n 2003:cdba::3256:14\n 10.3.14.76\n lbg-00000003\n NO\n 50\n NO\n NotConfigured\n 2019-07-25T03:32:39+0000\n 2019-07-28T06:02:18+0000\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"vcs\": [\n {\n \"name\": \"vc-0\",\n \"vc_index\": 0,\n \"storage_node\": \"qa14-sn4\",\n \"role\": \"proxy+storage\",\n \"vc_state\": \"created\",\n \"proxy_state\": \"OBJ_NORMAL\",\n \"integrity\": \"normal\",\n \"manager_role\": \"ring master\",\n \"region_id\": 2,\n \"zone_id\": 6,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_1\",\n \"allocation_zone_display_name\": \"secondary\",\n \"status\": \"created\",\n \"fe_ip\": null,\n \"fe_ipv6\": \"2003:cdba::3256:13\",\n \"be_ip\": \"10.3.14.75\",\n \"lb_group_name\": \"lbg-00000004\",\n \"lb_group_owner\": \"NO\",\n \"lb_group_priority\": 50,\n \"lb_group_configured\": \"YES\",\n \"lb_state\": \"NotConfigured\",\n \"created_at\": \"2019-07-25 03:32:39 UTC\",\n \"modified_at\": \"2019-07-28 07:01:33 UTC\"\n },\n {\n \"name\": \"vc-1\",\n \"vc_index\": 1,\n \"storage_node\": \"qa14-sn1\",\n \"role\": \"proxy+storage\",\n \"vc_state\": \"created\",\n \"proxy_state\": \"OBJ_NORMAL\",\n \"integrity\": \"normal\",\n \"manager_role\": \"ring slave\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"status\": \"failed\",\n \"fe_ip\": null,\n \"fe_ipv6\": \"2003:cdba::3256:14\",\n \"be_ip\": \"10.3.14.76\",\n \"lb_group_name\": \"lbg-00000003\",\n \"lb_group_owner\": \"NO\",\n \"lb_group_priority\": 50,\n \"lb_group_configured\": \"NO\",\n \"lb_state\": \"NotConfigured\",\n \"created_at\": \"2019-07-25 03:32:39 UTC\",\n \"modified_at\": \"2019-07-28 06:02:18 UTC\"\n }\n ],\n \"count\": 2\n }\n}" }, { "uri": "/zios/virtual_controllers/{vc-index}", "method": "GET", "description": "Get one Virtual Controller.", "parameters": [ { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false } ], "response": "\n\n \n vc-0\n 0\n qa14-sn4\n proxy+storage\n created\n OBJ_NORMAL\n normal\n ring master\n 2\n 6\n 15\n zone_1\n secondary\n created\n \n 2003:cdba::3256:13\n 10.3.14.75\n lbg-00000004\n NO\n 50\n YES\n NotConfigured\n 2019-07-25T03:32:39+0000\n 2019-07-28T07:01:33+0000\n \n\n", "response_json": "{\n \"response\": {\n \"vc\": {\n \"name\": \"vc-0\",\n \"vc_index\": 0,\n \"storage_node\": \"qa14-sn4\",\n \"role\": \"proxy+storage\",\n \"vc_state\": \"created\",\n \"proxy_state\": \"OBJ_NORMAL\",\n \"integrity\": \"normal\",\n \"manager_role\": \"ring master\",\n \"region_id\": 2,\n \"zone_id\": 6,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_1\",\n \"allocation_zone_display_name\": \"secondary\",\n \"status\": \"created\",\n \"fe_ip\": null,\n \"fe_ipv6\": \"2003:cdba::3256:13\",\n \"be_ip\": \"10.3.14.75\",\n \"lb_group_name\": \"lbg-00000004\",\n \"lb_group_owner\": \"NO\",\n \"lb_group_priority\": 50,\n \"lb_group_configured\": \"YES\",\n \"lb_state\": \"NotConfigured\",\n \"created_at\": \"2019-07-25 03:32:39 UTC\",\n \"modified_at\": \"2019-07-28 07:01:33 UTC\"\n }\n }\n}" }, { "uri": "/zios/virtual_controllers/{vc-index}/drives", "method": "GET", "description": "Returns the drives list for a virtual controller.", "response": "\n\n 0\n 3\n \n \n volume-000002d0\n drive-000\n SAS_278GB_10000RPM\n 5000C5006C1F604B\n test2-sn2\n vc-0\n zone_0\n zone_0\n abc\n Normal\n 279\n 36\n 284940\n 284977\n 2014-08-26T18:11:19+0300\n 2014-08-26T18:11:19+0300\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"disks\": [\n {\n \"name\": \"volume-000002d0\",\n \"display_name\": \"drive-000\",\n \"disk_type\": \"SAS_278GB_10000RPM\",\n \"disk_uuid\": \"5000C5006C1F604B\",\n \"storage_node\": \"test2-sn2\",\n \"vc\": \"vc-0\",\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"zone_0\",\n \"storage_policy\": \"abc\",\n \"status\": \"Normal\",\n \"capacity\": 279,\n \"used_capacity\": 36,\n \"avail_capacity\": 284940,\n \"total_capacity\": 284977,\n \"created_at\": \"2014-08-26 15:11:19 UTC\",\n \"modified_at\": \"2014-08-26 15:11:19 UTC\"\n }\n ],\n \"count\": 3\n }\n}" }, { "uri": "/zios/virtual_controllers/remove_proxy_vcs", "method": "DELETE", "description": "Remove proxy VCs.", "parameters": [ { "name": "quantity", "type": "integer", "required": true, "example": 2, "description": "Number of VCs to remove" }, { "name": "region_id", "type": "integer", "example": 2, "description": "Region ID (For Multi Region VPSA object storage)" } ], "response": "\n\n 1073791826\n The request has been submitted, and it may take a few moments to complete. Check event-log for further details\n\n", "response_json": "{\n \"response\": {\n \"status\": 1073791826,\n \"message\": \"The request has been submitted, and it may take a few moments to complete. Check event-log for further details\"\n }\n}" }, { "uri": "/zios/virtual_controllers/{id}/iops", "description": "Shows IOPs metering on a VC.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 9.4\n 0.0\n 9.4\n \n \n \n 9.3\n 0.0\n 9.600000000000001\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566809510,\n \"iops_put\": 9.4,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.4\n },\n {\n \"time\": 1566809570,\n \"iops_put\": 9.3,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.600000000000001\n }\n ]\n}" }, { "uri": "/zios/virtual_controllers/{id}/latency", "description": "Shows latency metering (ms) on a VC.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 29\n 0\n 12\n \n \n \n 31\n 0\n 12\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566810060,\n \"latency_put\": 29,\n \"latency_delete\": 0,\n \"latency_get\": 12\n },\n {\n \"time\": 1566810090,\n \"latency_put\": 31,\n \"latency_delete\": 0,\n \"latency_get\": 12\n }\n ]\n}" }, { "uri": "/zios/virtual_controllers/{id}/throughput", "description": "Shows bandwidth throughput metering (B/s) on a VC.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 13333335.8\n 0\n 20000000.0\n \n \n \n 26666666.6\n 0\n 25000000.0\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566811360,\n \"throughput_put\": 13333335.8,\n \"throughput_delete\": 0,\n \"throughput_get\": 20000000.0\n },\n {\n \"time\": 1566811390,\n \"throughput_put\": 26666666.6,\n \"throughput_delete\": 0,\n \"throughput_get\": 25000000.0\n }\n ]\n}" } ] }, { "name": "Load Balancer", "description": "Operations for Load Balancer.", "methods": [ { "uri": "/zios/load_balancer_groups", "method": "GET", "description": "Get a list of Load Balancer Groups.", "parameters": [ { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false } ], "response": "\n\n 0\n 2\n \n \n lbg-00000001\n 31\n \n 2003:cdba::3256:23\n 1\n zone_0\n primary\n vc-1,vc-3,vc-5,vc-7,vc-8\n vc-8\n 2019-07-23T08:49:53+0000\n 2019-07-23T08:49:54+0000\n \n \n lbg-00000002\n 32\n \n 2003:cdba::3256:24\n 2\n zone_1\n secondary\n vc-0,vc-2,vc-4,vc-6,vc-9\n vc-9\n 2019-07-23T08:49:53+0000\n 2019-07-23T08:49:54+0000\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"lbgs\": [\n {\n \"name\": \"lbg-00000001\",\n \"vrid\": 31,\n \"ip_v4\": null,\n \"ip_v6\": \"2003:cdba::3256:23\",\n \"region_id\": 1,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"vcs\": \"vc-1,vc-3,vc-5,vc-7,vc-8\",\n \"master_vc\": \"vc-8\",\n \"created_at\": \"2019-07-23 08:49:53 UTC\",\n \"modified_at\": \"2019-07-23 08:49:54 UTC\"\n },\n {\n \"name\": \"lbg-00000002\",\n \"vrid\": 32,\n \"ip_v4\": null,\n \"ip_v6\": \"2003:cdba::3256:24\",\n \"region_id\": 2,\n \"allocation_zone\": \"zone_1\",\n \"allocation_zone_display_name\": \"secondary\",\n \"vcs\": \"vc-0,vc-2,vc-4,vc-6,vc-9\",\n \"master_vc\": \"vc-9\",\n \"created_at\": \"2019-07-23 08:49:53 UTC\",\n \"modified_at\": \"2019-07-23 08:49:54 UTC\"\n }\n ],\n \"count\": 2\n }\n}" }, { "uri": "/zios/load_balancer_groups/{name}", "method": "GET", "description": "Get info of a specific Load Balancer Group.", "response": "\n\n 0\n \n lbg-00000001\n 31\n \n 2003:cdba::3256:23\n 1\n zone_0\n primary\n vc-1,vc-3,vc-5,vc-7,vc-8\n vc-8\n 2019-07-23T08:49:53+0000\n 2019-07-23T08:49:54+0000\n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"lbg\": {\n \"name\": \"lbg-00000001\",\n \"vrid\": 31,\n \"ip_v4\": null,\n \"ip_v6\": \"2003:cdba::3256:23\",\n \"region_id\": 1,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"vcs\": \"vc-1,vc-3,vc-5,vc-7,vc-8\",\n \"master_vc\": \"vc-8\",\n \"created_at\": \"2019-07-23 08:49:53 UTC\",\n \"modified_at\": \"2019-07-23 08:49:54 UTC\"\n }\n }\n}" }, { "uri": "/zios/load_balancer_groups/{id}/iops", "description": "Shows IOPs metering of a load balancer group.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 9.4\n 0.0\n 9.4\n \n \n \n 9.3\n 0.0\n 9.600000000000001\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566809510,\n \"iops_put\": 9.4,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.4\n },\n {\n \"time\": 1566809570,\n \"iops_put\": 9.3,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.600000000000001\n }\n ]\n}" }, { "uri": "/zios/load_balancer_groups/{id}/latency", "description": "Shows latency metering (ms) of a load balancer group.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 29\n 0\n 12\n \n \n \n 31\n 0\n 12\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566810060,\n \"latency_put\": 29,\n \"latency_delete\": 0,\n \"latency_get\": 12\n },\n {\n \"time\": 1566810090,\n \"latency_put\": 31,\n \"latency_delete\": 0,\n \"latency_get\": 12\n }\n ]\n}" }, { "uri": "/zios/load_balancer_groups/{id}/throughput", "description": "Shows bandwidth throughput metering (B/s) of a load balancer group.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 13333335.8\n 0\n 20000000.0\n \n \n \n 26666666.6\n 0\n 25000000.0\n \n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566811360,\n \"throughput_put\": 13333335.8,\n \"throughput_delete\": 0,\n \"throughput_get\": 20000000.0\n },\n {\n \"time\": 1566811390,\n \"throughput_put\": 26666666.6,\n \"throughput_delete\": 0,\n \"throughput_get\": 25000000.0\n }\n ]\n}" } ] }, { "name": "Storage Policies", "description": "Operations for Storage Policies.", "methods": [ { "uri": "/zios/policies", "method": "GET", "description": "Get a list of Storage policies.", "parameters": [ { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false } ], "response": "\n\n 0\n 2\n \n \n storage-policy-00000001\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n YES\n 0\n 2\n synchronous\n 15\n NO\n 8\n 18\n 6\n 1\n object\n initialized\n Normal\n 100\n Normal\n 100\n 24\n 167642\n 0.0\n Normal\n 60.0\n 1440.0\n 90\n YES\n 0\n 0\n 0\n 0\n 0\n 0\n 0\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 2019-07-25T03:37:07+0000\n 2019-07-25T03:37:07+0000\n 2019-07-28T04:03:31+0000\n 2019-07-25T03:37:58+0000\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"policies\": [\n {\n \"name\": \"storage-policy-00000001\",\n \"display_name\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"default\": \"YES\",\n \"policy_index\": 0,\n \"num_regions\": 2,\n \"replication_mode\": \"synchronous\",\n \"policy_type\": 15,\n \"system\": \"NO\",\n \"number_of_mirrors\": 8,\n \"data_fragments\": 18,\n \"parity_fragments\": 6,\n \"ring_version\": 1,\n \"type\": \"object\",\n \"state\": \"initialized\",\n \"health_status\": \"Normal\",\n \"health_percentage\": \"100\",\n \"rebalance_status\": \"Normal\",\n \"rebalance_percentage\": \"100\",\n \"total_drives\": 24,\n \"capacity\": 167642,\n \"gb_per_month_cost\": 0.0,\n \"capacity_mode\": \"Normal\",\n \"capacity_history_min\": 60,\n \"alert_mode_min\": 1440,\n \"emergency_mode_percentage\": 90,\n \"can_reconfig\": 0,\n \"partition_percent_normal\": 0.0,\n \"partition_percent_degraded\": 0.0,\n \"partition_percent_critical\": 0.0,\n \"partition_count_normal\": 0,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"partition_count_total\": 0,\n \"short_description\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"full_description\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"created_at\": \"2019-07-25 03:37:07 UTC\",\n \"modified_at\": \"2019-07-25 03:37:07 UTC\",\n \"reported_at\": \"2019-07-28 04:03:31 UTC\",\n \"rebalanced_at\": \"2019-07-25 03:37:58 UTC\"\n }\n ],\n \"count\": 2\n }\n}" }, { "uri": "/zios/policies/{name}", "method": "GET", "description": "Get one storage policy.", "response": "\n\n 0\n \n storage-policy-00000001\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n YES\n 0\n 2\n synchronous\n 15\n NO\n 8\n 18\n 6\n 1\n object\n initialized\n Normal\n 100\n Normal\n 100\n 24\n 167642\n 0.0\n Normal\n 60.0\n 1440.0\n 90\n YES\n 0\n 0\n 0\n 0\n 0\n 0\n 0\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 2019-07-25T03:37:07+0000\n 2019-07-25T03:37:07+0000\n 2019-07-28T04:03:31+0000\n 2019-07-25T03:37:58+0000\n 24\n \n \n volume-00000a6f\n drive-002\n SAS_9313GB_7200RPM\n 5000CCA26755A338\n qa14-sn1\n vc-1\n 1\n 1\n 15\n zone_0\n primary\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 0\n Absent\n 9313\n 0\n 0\n 2019-07-25T03:32:36+0000\n 2019-07-28T06:19:59+0000\n \n \n volume-00000a70\n drive-010\n SAS_9313GB_7200RPM\n 5000CCA2674ECB4C\n qa14-sn1\n vc-1\n 1\n 1\n 15\n zone_0\n primary\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 0\n Absent\n 9313\n 0\n 0\n 2019-07-25T03:32:36+0000\n 2019-07-28T06:19:59+0000\n \n \n volume-00000a71\n drive-018\n SAS_9313GB_7200RPM\n 5000CCA267498820\n qa14-sn1\n vc-1\n 1\n 1\n 15\n zone_0\n primary\n 9-3-Erasure-Coding-Protection-Multi-Zone-HA\n 0\n Absent\n 9313\n 0\n 0\n 2019-07-25T03:32:36+0000\n 2019-07-28T06:19:59+0000\n \n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"policy\": {\n \"name\": \"storage-policy-00000001\",\n \"display_name\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"default\": \"YES\",\n \"policy_index\": 0,\n \"num_regions\": 2,\n \"replication_mode\": \"synchronous\",\n \"policy_type\": 15,\n \"system\": \"NO\",\n \"number_of_mirrors\": 8,\n \"data_fragments\": 18,\n \"parity_fragments\": 6,\n \"ring_version\": 1,\n \"type\": \"object\",\n \"state\": \"initialized\",\n \"health_status\": \"Normal\",\n \"health_percentage\": \"100\",\n \"rebalance_status\": \"Normal\",\n \"rebalance_percentage\": \"100\",\n \"total_drives\": 24,\n \"capacity\": 167642,\n \"gb_per_month_cost\": 0.0,\n \"capacity_mode\": \"Normal\",\n \"capacity_history_min\": 60,\n \"alert_mode_min\": 1440,\n \"emergency_mode_percentage\": 90,\n \"can_reconfig\": 0,\n \"partition_percent_normal\": 0.0,\n \"partition_percent_degraded\": 0.0,\n \"partition_percent_critical\": 0.0,\n \"partition_count_normal\": 0,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"partition_count_total\": 0,\n \"short_description\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"full_description\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"created_at\": \"2019-07-25 03:37:07 UTC\",\n \"modified_at\": \"2019-07-25 03:37:07 UTC\",\n \"reported_at\": \"2019-07-28 04:03:31 UTC\",\n \"rebalanced_at\": \"2019-07-25 03:37:58 UTC\",\n \"disks_count\": 24,\n \"disks\": [\n {\n \"name\": \"volume-00000a6f\",\n \"display_name\": \"drive-002\",\n \"disk_type\": \"SAS_9313GB_7200RPM\",\n \"disk_uuid\": \"5000CCA26755A338\",\n \"storage_node\": \"qa14-sn1\",\n \"vc\": \"vc-1\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"storage_policy\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"capacity_protection\": \"0\",\n \"status\": \"Absent\",\n \"capacity\": 9313,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"created_at\": \"2019-07-25 03:32:36 UTC\",\n \"modified_at\": \"2019-07-28 06:19:59 UTC\"\n },\n {\n \"name\": \"volume-00000a70\",\n \"display_name\": \"drive-010\",\n \"disk_type\": \"SAS_9313GB_7200RPM\",\n \"disk_uuid\": \"5000CCA2674ECB4C\",\n \"storage_node\": \"qa14-sn1\",\n \"vc\": \"vc-1\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"storage_policy\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"capacity_protection\": \"0\",\n \"status\": \"Absent\",\n \"capacity\": 9313,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"created_at\": \"2019-07-25 03:32:36 UTC\",\n \"modified_at\": \"2019-07-28 06:19:59 UTC\"\n },\n {\n \"name\": \"volume-00000a71\",\n \"display_name\": \"drive-018\",\n \"disk_type\": \"SAS_9313GB_7200RPM\",\n \"disk_uuid\": \"5000CCA267498820\",\n \"storage_node\": \"qa14-sn1\",\n \"vc\": \"vc-1\",\n \"region_id\": 1,\n \"zone_id\": 1,\n \"policy_type\": 15,\n \"allocation_zone\": \"zone_0\",\n \"allocation_zone_display_name\": \"primary\",\n \"storage_policy\": \"9-3-Erasure-Coding-Protection-Multi-Zone-HA\",\n \"capacity_protection\": \"0\",\n \"status\": \"Absent\",\n \"capacity\": 9313,\n \"partition_count_degraded\": 0,\n \"partition_count_critical\": 0,\n \"created_at\": \"2019-07-25 03:32:36 UTC\",\n \"modified_at\": \"2019-07-28 06:19:59 UTC\"\n }\n ]\n }\n }\n}" }, { "uri": "/zios/policies/{name}", "method": "PUT", "description": "Update a storage policy", "parameters": [ { "name": "full_description", "type": "string", "description": "policy description", "example": "2 Way mirroring policy" }, { "name": "gb_per_month_cost", "type": "float", "description": "GB per month cost", "example": "1.7" } ], "response": "\n 1073791826\n The request has been submitted, and it may take a few moments to complete. Check event-log for further details\n\n", "response_json": "{\n \"response\": {\n \"status\": 1073791826,\n \"message\": \"The request has been submitted, and it may take a few moments to complete. Check event-log for further details\"\n }\n}" }, { "uri": "/zios/policies/{name}/set_default", "method": "POST", "description": "Set a default storage policy", "response": "\n\n storage-policy-00000003\n 0\n\n", "response_json": "{\n \"response\": {\n \"policy_name\": \"storage-policy-00000003\",\n \"status\": 0\n }\n}" }, { "uri": "/zios/policies/{name}/drives", "method": "DELETE", "description": "Remove drives from storage policy", "parameters": [ { "name": "drives", "type": "Array", "required": true, "description": "Array of drive type and quantity", "example_as_json_string": true, "example": "[{\"type\": \"SAS_300_GB\" , \"quantity\": 2}]" } ], "response": "\n 1073791826\n The request has been submitted, and it may take a few moments to complete. Check event-log for further details\n\n", "response_json": "{\n \"response\": {\n \"status\": 1073791826,\n \"message\": \"The request has been submitted, and it may take a few moments to complete. Check event-log for further details\"\n }\n}" }, { "uri": "/zios/policies/{id}/iops", "description": "Shows IOPs metering of a storage policy.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 9.4\n 0.0\n 9.4\n \n \n \n 9.3\n 0.0\n 9.600000000000001\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566809510,\n \"iops_put\": 9.4,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.4\n },\n {\n \"time\": 1566809570,\n \"iops_put\": 9.3,\n \"iops_delete\": 0.0,\n \"iops_get\": 9.600000000000001\n }\n ]\n}" }, { "uri": "/zios/policies/{id}/latency", "description": "Shows latency metering (ms) of a storage policy.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 29\n 0\n 12\n \n \n \n 31\n 0\n 12\n \n\n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566810060,\n \"latency_put\": 29,\n \"latency_delete\": 0,\n \"latency_get\": 12\n },\n {\n \"time\": 1566810090,\n \"latency_put\": 31,\n \"latency_delete\": 0,\n \"latency_get\": 12\n }\n ]\n}" }, { "uri": "/zios/policies/{id}/throughput", "description": "Shows bandwidth throughput metering (B/s) of a storage policy.", "method": "GET", "parameters": [ { "name": "service", "required": true, "type": "string", "example": "proxy", "options": "proxy" }, { "name": "interval", "required": false, "type": "integer" }, { "name": "count", "required": false, "type": "integer" } ], "response": "\n\n \n \n 13333335.8\n 0\n 20000000.0\n \n \n \n 26666666.6\n 0\n 25000000.0\n \n", "response_json": "{\n \"objects\": [\n {\n \"time\": 1566811360,\n \"throughput_put\": 13333335.8,\n \"throughput_delete\": 0,\n \"throughput_get\": 20000000.0\n },\n {\n \"time\": 1566811390,\n \"throughput_put\": 26666666.6,\n \"throughput_delete\": 0,\n \"throughput_get\": 25000000.0\n }\n ]\n}" } ] }, { "name": "Remote Object Storage Endpoints", "description": "Operations for Remote Object Storage Endpoints.", "methods": [ { "uri": "/zios/object_storage_destinations", "method": "GET", "description": "Get a list of Remote Object Storage Endpoints in current user's account or in a container's account.", "parameters": [ { "name": "container_account", "description": "Container account id", "type": "string", "required": false, "example": "b1655b9387fc47a6b4d82382e9d7f497" } ], "response": "\n\n 0\n 1\n \n \n 1\n 1\n Enabled\n https://vsaid-cloud.zadarazios.com\n access key\n secret key\n us-east-1\n feip\n ZIOS_S3\n replication-target-00000001\n local target\n 2021-04-04T11:31:42+0000\n 2021-04-04T11:47:12+0000\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"container_replication_targets\": [\n {\n \"id\": 1,\n \"job_count\": 1,\n \"state\": \"Enabled\",\n \"endpoint\": \"https://vsaid-cloud.zadarazios.com\",\n \"access\": \"access key\",\n \"secret\": \"secret key\",\n \"region\": \"us-east-1\",\n \"network\": \"feip\",\n \"type\": \"ZIOS_S3\",\n \"ext_name\": \"replication-target-00000001\",\n \"display_name\": \"local target\",\n \"created_at\": \"2021-04-04 11:31:42 UTC\",\n \"modified_at\": \"2021-04-04 11:47:12 UTC\"\n }\n ],\n \"count\": 1\n }\n}" }, { "uri": "/zios/object_storage_destinations/{target-ext-name}", "method": "GET", "description": "Get one Remote Object Storage Endpoint.", "response": "\n\n 0\n \n 1\n 1\n Enabled\n https://vsaid-cloud.zadarazios.com\n access key\n secret key\n us-east-1\n feip\n ZIOS_S3\n replication-target-00000001\n local target\n 2021-04-04T11:31:42+0000\n 2021-04-04T11:47:12+0000\n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"target\": {\n \"id\": 1,\n \"job_count\": 1,\n \"state\": \"Enabled\",\n \"endpoint\": \"https://vsaid-cloud.zadarazios.com\",\n \"access\": \"access key\",\n \"secret\": \"secret key\",\n \"region\": \"us-east-1\",\n \"network\": \"feip\",\n \"type\": \"ZIOS_S3\",\n \"ext_name\": \"replication-target-00000001\",\n \"display_name\": \"local target\",\n \"created_at\": \"2021-04-04 11:31:42 UTC\",\n \"modified_at\": \"2021-04-04 11:47:12 UTC\"\n }\n }\n}" }, { "uri": "/zios/object_storage_destinations", "method": "POST", "description": "Create a Remote Object Storage Endpoint. Connection will be tested.", "parameters": [ { "name": "name", "description": "Display Name for Remote Object Storage Endpoint", "type": "string", "required": true, "example": "destination 1" }, { "name": "type", "description": "Type for Remote Object Storage Endpoint", "type": "string", "options": "AWS_S3 | ZIOS_S3", "required": true, "example": "AWS_S3" }, { "name": "endpoint", "description": "Endpoint for AWS S3 destination type", "type": "string", "required": true, "example": "s3-eu-west-1.amazonaws.com" }, { "name": "endpoint_url", "description": "Endpoint URL for VPSA Object Storage S3 destination type", "type": "string", "required": true, "example": "https://vsa-000011b4-zadara-cloud.zadarazios.com" }, { "name": "region", "description": "Region for VPSA Object Storage S3 destination type", "type": "string", "required": true, "example": "us-east-1" }, { "name": "username", "description": "Access Key ID for Remote Object Storage Endpoint", "type": "string", "required": true, "example": "mys3username" }, { "name": "password", "description": "Secret Access Key for Remote Object Storage Endpoint", "type": "string", "required": true, "example": "mys3password" }, { "name": "connectVia", "description": "Connection method for remote object storage", "type": "string", "options": "fe | outnet", "required": true, "example": "fe" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/object_storage_destinations/{ext-name}", "method": "PUT", "description": "Update an Remote Object Storage Endpoint. Connection will be tested.", "parameters": [ { "name": "name", "description": "Display Name for Remote Object Storage Endpoint", "type": "string", "required": false, "example": "destination 1" }, { "name": "type", "description": "Type for Remote Object Storage Endpoint", "type": "string", "options": "AWS_S3 | ZIOS_S3", "required": true, "example": "AWS_S3" }, { "name": "region_name", "description": "Endpoint for AWS S3 destination type", "type": "string", "required": false, "example": "s3-eu-west-1.amazonaws.com" }, { "name": "region_name_text", "description": "Region for VPSA Object Storage S3 destination type", "type": "string", "required": false, "example": "us-east-1" }, { "name": "username", "description": "Access Key ID for Remote Object Storage Endpoint", "type": "string", "required": false, "example": "mys3username" }, { "name": "password", "description": "Secret Access Key for Remote Object Storage Endpoint", "type": "string", "required": false, "example": "mys3password" }, { "name": "connectVia", "description": "Connection method for remote object storage", "type": "string", "options": "fe | outnet", "required": false, "example": "fe" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/object_storage_destinations/{ext-name}", "method": "DELETE", "description": "Delete an Remote Object Storage Endpoint.", "parameters": [ { "name": "force", "type": "string", "description": "force a deletion", "example": "YES", "required": false } ], "response": "\n\n 0\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" } ] }, { "name": "Roles", "description": "VPSA Object Storage roles.", "methods": [ { "uri": "/zios/roles", "method": "GET", "description": "Returns VPSA Object Storage roles.", "response": "\n\n 0\n \n \n account_admin\n 46a121a767e84adf8e57b7bcf6a575c4\n \n \n member\n a6f4f6dd5c2d41128aafcb2c1e9145e2\n \n \n zios_admin\n c38277e0d1ca47b3b88853642a74004f\n \n \n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"roles\": [\n {\n \"name\": \"account_admin\",\n \"id\": \"46a121a767e84adf8e57b7bcf6a575c4\"\n },\n {\n \"name\": \"member\",\n \"id\": \"a6f4f6dd5c2d41128aafcb2c1e9145e2\"\n },\n {\n \"name\": \"zios_admin\",\n \"id\": \"c38277e0d1ca47b3b88853642a74004f\"\n }\n ]\n }\n}" } ] }, { "name": "Usage reports", "description": "Operations for usage reports.", "methods": [ { "uri": "/zios/usage_reports/generate", "showParamsAsPOST": true, "description": "Generate a usage report. Each account lists the following for each policy: capacity, number of objects, number of containers, data transfer in, data transfer out\n", "method": "GET", "parameters": [ { "name": "report_time", "type": "string", "description": "Type of time frame for report. default: monthly", "example": "monthly", "options": " monthly | custom " }, { "name": "report_type", "type": "string", "description": "Type of time frame for report. default: detailed", "example": "summary", "options": " summary | detailed " }, { "name": "fromdate", "type": "string", "description": "Start time (YYYY-MM-DD). required for custom report." }, { "name": "todate", "type": "string", "description": "End time (YYYY-MM-DD). required for custom report." }, { "name": "month", "type": "string", "description": "month of the year.", "example": "4" }, { "name": "account_id", "type": "string", "description": "Account id. Default is user's account.", "example": "91ea5bd5cdc04adb9f5e3c00a346c463" } ], "response": "\n \n 0\n \n \n \n \n john@example.com\n 0.0\n daf7fc5175df43bab7893fd66a444977\n zios_admin\n \n \n \n services\n 0.0\n 0.0\n outgoing_bytes\n streaming-bytes\n GB\n \n \n services\n 0\n 3686243\n storage_policy:ec-4-2-protection-policy\n object_count\n count\n \n \n services\n 0\n 1929582\n storage_policy:ec-4-2-protection-policy\n container_count\n count\n \n \n services\n 0.0\n 0.0\n storage_policy:ec-4-2-protection-policy\n used_capacity\n GBMONTH\n \n \n services\n 0.0\n 0.0002\n incoming_bytes\n streaming-bytes\n GB\n \n \n \n \n \n vsa-000007de\n ZIOS2\n 0.0\n \n 0.0\n 0.0\n \n 0.0\n usd\n 0.0\n \n Mon Jul 16 11:28:35 2018\n 1337313\n Sun Jul 1 00:00:00 2018\n Mon Jul 16 11:28:33 2018\n \n https://vsa-000007de-testcloud.zadarazios.com:443\n \n \n \n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"usage\": {\n \"account_usage_summary\": [\n {\n \"account_header\": {\n \"email\": \"john@example.com\",\n \"total_usage_charges\": 0.0,\n \"id\": \"daf7fc5175df43bab7893fd66a444977\",\n \"name\": \"zios_admin\"\n },\n \"usage_summary\": [\n {\n \"category\": \"services\",\n \"billed_amount\": 0.0,\n \"billed_units\": 0.0,\n \"subcategory\": \"outgoing_bytes\",\n \"type\": \"streaming-bytes\",\n \"unit\": \"GB\"\n },\n {\n \"category\": \"services\",\n \"billed_amount\": 0,\n \"billed_units\": 3686243,\n \"subcategory\": \"storage_policy:ec-4-2-protection-policy\",\n \"type\": \"object_count\",\n \"unit\": \"count\"\n },\n {\n \"category\": \"services\",\n \"billed_amount\": 0,\n \"billed_units\": 1929582,\n \"subcategory\": \"storage_policy:ec-4-2-protection-policy\",\n \"type\": \"container_count\",\n \"unit\": \"count\"\n },\n {\n \"category\": \"services\",\n \"billed_amount\": 0.0,\n \"billed_units\": 0.0,\n \"subcategory\": \"storage_policy:ec-4-2-protection-policy\",\n \"type\": \"used_capacity\",\n \"unit\": \"GBMONTH\"\n },\n {\n \"category\": \"services\",\n \"billed_amount\": 0.0,\n \"billed_units\": 0.0002,\n \"subcategory\": \"incoming_bytes\",\n \"type\": \"streaming-bytes\",\n \"unit\": \"GB\"\n }\n ]\n }\n ],\n \"report_header\": {\n \"zios_name\": \"vsa-000007de\",\n \"zios_display_name\": \"ZIOS2\",\n \"upload_rate_per_gb\": 0.0,\n \"policy_capacity_usage_cost_gbmonth\": {\n \"ec_4_2_protection_policy\": 0.0,\n \"metadatapolicy\": 0.0\n },\n \"download_rate_per_gb\": 0.0,\n \"billing_unit\": \"usd\",\n \"total_usage_charges\": 0.0,\n \"reporting_interval\": {\n \"report_time\": \"Mon Jul 16 11:28:35 2018\",\n \"duration_sec\": 1337313,\n \"start_time\": \"Sun Jul 1 00:00:00 2018\",\n \"end_time\": \"Mon Jul 16 11:28:33 2018\"\n },\n \"zios_url\": \"https://vsa-000007de-testcloud.zadarazios.com:443\"\n }\n }\n }\n}" } ] }, { "name": "Logs", "description": "Retrieving logs.", "methods": [ { "uri": "/messages", "method": "GET", "description": "Retrieve event logs.", "parameters": [ { "name": "severity", "required": false, "type": "integer" }, { "name": "attr_key", "required": false, "type": "string" }, { "name": "attr_value", "required": false, "type": "string" }, { "name": "start", "description": "The item number to start from. 0 starts from the beginning.", "type": "integer", "required": false }, { "name": "limit", "description": "The total number of records to return.", "type": "integer", "required": false } ], "response": "\n\n 0\n 147\n \n \n 147\n Controller zios-vsa-0000018f-vc-0 heartbeat 2 is OK.\n 6\n 2016-05-02T09:23:32+03:00\n \n \n 146\n Controller zios-vsa-0000018f-vc-0 heartbeat 1 is OK.\n 6\n 2016-05-02T09:23:32+03:00\n \n \n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"messages\": [\n {\n \"msg_id\": \"147\",\n \"msg_title\": \"Controller zios-vsa-0000018f-vc-0 heartbeat 2 is OK.\",\n \"msg_severity\": \"6\",\n \"msg_time\": \"2016-05-02T09:23:32+03:00\"\n },\n {\n \"msg_id\": \"146\",\n \"msg_title\": \"Controller zios-vsa-0000018f-vc-0 heartbeat 1 is OK.\",\n \"msg_severity\": \"6\",\n \"msg_time\": \"2016-05-02T09:23:32+03:00\"\n }\n ],\n \"count\": 147\n }\n}" }, { "uri": "/access_logs", "method": "GET", "description": "Retrieve access logs.", "showParamsAsPOST": true, "parameters": [ { "name": "limit", "required": false, "type": "string", "description": "items per page" }, { "name": "page", "required": false, "type": "string", "description": "page number" }, { "name": "sort", "required": false, "type": "Array", "example_as_json_string": true, "example": "[{\"property\":\"created_at\",\"direction\":\"DESC\"}]" } ], "response": "\n\n 71\n \n \n 308\n eyal\n accounts\n create\n {\"name\": \"a1\"}\n 2016-04-19T13:54:52Z\n \n \n\n", "response_json": "{\n \"response\": {\n \"access_logs\": [\n {\n \"id\": 308,\n \"user\": \"eyal\",\n \"controller\": \"accounts\",\n \"action\": \"create\",\n \"params\": \"{\\\"name\\\": \\\"a1\\\"}\",\n \"created\": \"2016-04-19T13:54:52Z\"\n }\n ],\n \"count\": 71\n }\n}" } ] }, { "name": "Settings", "description": "Get / Modify Settings.", "methods": [ { "uri": "/settings_config", "method": "GET", "description": "Returns settings.", "response": "\n\n 399\n 8DA679B9791143C4A6E02B117C8CB055\n zios\n https://vsa-0000018f-zadara-dev2.zadarazios.com:443\n https://vsa-0000018f-zadara.zadarazios.com:5000/v2.0\n 16.05-404-59\n en\n NO\n 150.50.2.110\n 2001:db8:85a3::8a2e:370:7002\n 150.50.3.111\n None\n NO\n usd\n 0.0\n 0.0\n 150.50.2.110\n vsa-0000018f-zadara.zadarazios.com\n True\n 2\n enabled\n yes\n True\n 30\n pending\n NO\n OFF\n 2016-04-28T08:36:02+0300\n 2016-05-01T17:36:44+0300\n 0\n 7776000\n 8\n\n", "response_json": "{\n \"response\": {\n \"name\": \"399\",\n \"uuid\": \"8DA679B9791143C4A6E02B117C8CB055\",\n \"display_name\": \"zios\",\n \"url\": \"https://vsa-0000018f-zadara-dev2.zadarazios.com:443\",\n \"auth_service_url\": \"https://vsa-0000018f-zadara.zadarazios.com:5000/v2.0\",\n \"version\": \"16.05-404-59\",\n \"language\": \"en\",\n \"multi_zone\": \"NO\",\n \"floating_fe_ip\": \"150.50.2.110\",\n \"floating_fe_ipv6\": \"2001:db8:85a3::8a2e:370:7002\",\n \"floating_be_ip\": \"150.50.3.111\",\n \"publicip\": \"None\",\n \"auto_scale\": \"NO\",\n \"billing_unit\": \"usd\",\n \"upload_rate_per_gb\": \"0.0\",\n \"download_rate_per_gb\": \"0.0\",\n \"api_ip\": \"150.50.2.110\",\n \"api_hostname\": \"vsa-0000018f-zadara.zadarazios.com\",\n \"zswift_ratelimit_enabled\": \"True\",\n \"zswift_ratelimit\": \"2\",\n \"vhs_state\": \"enabled\",\n \"admin_access_enabled\": \"yes\",\n \"allow_tenant_name_in_url\": \"True\",\n \"token_expiry\": \"30\",\n \"policy_action\": \"pending\",\n \"zios_upgrade\": \"NO\",\n \"ssl_termination\": \"OFF\",\n \"created_at\": \"2016-04-28T08:36:02+0300\",\n \"modified_at\": \"2016-05-01T17:36:44+0300\",\n \"expire_password\": \"0\",\n \"expire_password_after\": \"7776000\",\n \"password_history\": \"8\"\n }\n}" }, { "uri": "/zios/settings/ssl_termination", "method": "POST", "description": "Set SSL Termination for VPSA Object Storage.", "parameters": [ { "name": "ssltermination", "required": true, "type": "string", "options": "on | off", "example": "on" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/set_ssl_pem", "method": "POST", "description": "Upload SSL pem file content.", "parameters": [ { "name": "ssl_pem", "required": true, "example": "-----BEGIN PRIVATE KEY-----\\nPEM-STRING\\n-----END PRIVATE KEY-----\\n", "type": "string" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/get_ssl_cert_info", "method": "GET", "description": "Get SSL certificate details.", "response": "\n\n 0\n *.zadarazios.com\n Apr 16 2022 18:32:49 UTC\n 6\n domain.cloud\n Jul 07 2022 07:11:41 UTC\n 87\n\n", "response_json": "{\n \"response\": {\n \"status\": 0,\n \"default_ssl_domain\": \"*.zadarazios.com\",\n \"default_ssl_enddate\": \"Apr 16 2022 18:32:49 UTC\",\n \"default_ssl_daysremaining\": \"6\",\n \"current_ssl_domain\": \"domain.cloud\",\n \"current_ssl_enddate\": \"Jul 07 2022 07:11:41 UTC\",\n \"current_ssl_daysremaining\": \"87\"\n }\n}" }, { "uri": "/zios/settings/billing_currency", "method": "POST", "description": "Set billing currency.", "parameters": [ { "name": "billing_unit", "required": true, "type": "string", "options": "usd | gbp | eur | aud | krw | jpy | cny", "example": "usd" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/data_transfer_pricing", "method": "POST", "description": "Set data transfer pricing.", "parameters": [ { "name": "upload_rate_per_gb", "type": "float", "example": 1.7 }, { "name": "download_rate_per_gb", "type": "float", "example": 1.8 } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/api_ip", "method": "POST", "description": "Set API IP.", "parameters": [ { "name": "api_ip", "required": true, "example": "150.50.2.100", "type": "string" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/api_hostname", "method": "POST", "description": "Set API Hostname.", "parameters": [ { "name": "api_hostname", "required": true, "type": "string", "example": "www.example.com" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/public_api_hostname", "method": "POST", "description": "Set Public API Hostname.", "parameters": [ { "name": "public_api_hostname", "required": true, "type": "string", "example": "www.example.com" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/encryption", "method": "POST", "description": "Set Encryption.", "parameters": [ { "name": "encryption_pwd", "required": true, "type": "string", "example": "mypassword" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/activate_encryption", "method": "POST", "description": "Activate Encryption.", "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/disable_encryption", "method": "POST", "description": "Disable Encryption.", "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/restore_encryption", "method": "POST", "description": "Restore Encryption password.", "parameters": [ { "name": "encryption_pwd", "required": true, "type": "string", "example": "mypassword" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/change_region", "method": "POST", "description": "Change Region.", "parameters": [ { "name": "region", "required": true, "type": "string", "example": "us-east-1" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/tenant_name_in_url", "method": "POST", "description": "Allow tenant name in object storage url.", "parameters": [ { "name": "allow_tenant_name_in_url", "required": true, "type": "boolean", "example": true } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/vhs_state", "method": "POST", "description": "Set containers Virtual-hosted style support.", "parameters": [ { "name": "vhs_state", "required": true, "type": "boolean", "example": true } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/api_errors", "method": "POST", "description": "Set API errors alerts.", "parameters": [ { "name": "enabled", "type": "boolean", "example": true }, { "name": "threshold", "type": "integer", "desciption": "Send alert when number of errors above threshold", "example": 5 } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/token_expiry", "method": "POST", "description": "Token expiration (Minutes)", "parameters": [ { "name": "token_expiry", "required": true, "type": "integer", "example": 60 } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/settings/set_mtu", "method": "POST", "description": "Changes the MTU for a network interface.", "parameters": [ { "name": "fe_mtu", "type": "string", "description": "An MTU value for the frontend interface", "example": 1024 }, { "name": "public_mtu", "type": "string", "description": "An MTU value for the public interface", "example": 2048 }, { "name": "force", "desciption": "Force MTU change despite affect on current sessions", "type": "string", "options": "YES, NO", "example": "YES" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/set_gradual_policy_expansion_percentage", "method": "POST", "description": "Gradual Disk Add - Percentage of drives to be added in each step", "parameters": [ { "name": "expansion_percent", "required": true, "type": "integer", "example": 90 } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/load_balancer_mode", "method": "POST", "description": "Load balancer mode - Direct Server Return (Default) / NAT", "parameters": [ { "name": "mode", "required": true, "type": "string", "example": "dr", "options": "dr | nat" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/custom_dns_servers", "method": "POST", "description": "Defines custom DNS servers.", "parameters": [ { "name": "custom_name_servers", "type": "string", "description": "Comma separated list of IPv4 addresses of custom name servers that will be used for private domain name resolution.", "example": "1.1.1.1,2.2.2.2" }, { "name": "dns_lookup_domain", "type": "string", "description": "Domain for which the system DNS lookup process should be overridden and the custom lookup server should be queried instead.", "example": "abc" } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" }, { "uri": "/zios/settings/global_rate_limit", "method": "POST", "description": "Set global rate limit.", "parameters": [ { "name": "enabled", "type": "boolean", "required": true, "example": true }, { "name": "global_rate_limit", "type": "integer", "description": "Limit object account operations (PUT/POST/DELETE/COPY) per second, this setting will be applied for all accounts and can be overridden for specific account.", "required": false, "example": 1 } ], "response": "\n\n 0\n\n", "response_json": "{\n \"response\": {\n \"status\": 0\n }\n}" } ] } ], "intro": "

Overview

\n\n

This document outlines the methods available for administrating your VPSA® Object Storage. The API supports form-encoded, JSON, and XML requests, and can return either JSON or XML responses.

\n\n

Usage

\n\n

The majority of the APIs available require authentication which requires an API token to use. You can retrieve this token through the Users section of your VPSA, or through the API using the “Return a user’s access key” API in the Users Section below.

\n\n

Authentication Methods

\n\n

The authentication token can be passed either through the access_key parameter inside of the body of the REST API request, or through the X-Access-Key header. Alternately, you can use the username and password parameters for authentication, but we do not recommend this method for anything other than possibly retrieving an API key.

\n\n

By default , all operations are allowed only to VPSA Object Storage admin. Some actions are allowed by an account admin and they will be marked on the action’s header

\n\n

Timeouts

\n\n

By default, all operations that don’t complete within five seconds will return a message informing you that the action may take some time to complete. When using the API, this can cause some actions, such as adding drives to storage policy, to be undesirably asynchronous. You can specify your own timeout with the timeout parameter, in seconds, and a timeout value of -1 specifies an infinite timeout.

\n\n

Metering API

\n\n

Metering information can be retrieved using the VPSA Object Storage API for the following components:

\n\n\n\n

Metering information returned by the API is subject to the following constraints:

\n\n\n\n

Values outside the accepted range will be returned as 0.

\n\n

Questions

\n\n

If you have any questions or need support involving the REST API, please contact support@zadarastorage.com for assistance.

\n" };