{"__v":4,"_id":"55ce9b0b9d28781700b7c932","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Project FiFo's API is build in a RESTful manner, in addition to `applicaiton/json` as a content type or accepted type `application/x-msgpack` can be used to provide a faster to en- and decode line protocol.\n\nWe put a high value on the API, in this aspect all our tools, pyfi (the console client) and Cerberus (the UI) are working 100% with the API without any special cases. Implemented from the documentation and not the code.\n\nBy this we want to ensure that the API is robust and offers the best possible experience when implementing other components for it.","category":"55ce9b0a9d28781700b7c931","createdAt":"2015-08-15T01:47:24.312Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"getting-started","sync_unique":"","title":"Getting Started with Project-FiFo API","type":"basic","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

Getting Started with Project-FiFo API


Project FiFo's API is build in a RESTful manner, in addition to `applicaiton/json` as a content type or accepted type `application/x-msgpack` can be used to provide a faster to en- and decode line protocol. We put a high value on the API, in this aspect all our tools, pyfi (the console client) and Cerberus (the UI) are working 100% with the API without any special cases. Implemented from the documentation and not the code. By this we want to ensure that the API is robust and offers the best possible experience when implementing other components for it.
View all 113 endpoints
Project FiFo's API is build in a RESTful manner, in addition to `applicaiton/json` as a content type or accepted type `application/x-msgpack` can be used to provide a faster to en- and decode line protocol. We put a high value on the API, in this aspect all our tools, pyfi (the console client) and Cerberus (the UI) are working 100% with the API without any special cases. Implemented from the documentation and not the code. By this we want to ensure that the API is robust and offers the best possible experience when implementing other components for it.
{"__v":1,"_id":"55cf2da18f17dc0d00da7ca8","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"PUT /api/2/vms/2ca285a3-05a8-4ca6-befd-78fa994929ab/metadata/cerberus HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json\n\n{\"notes\":  [{\"text\":\"yap\",\"created_at\":\"2014-09-13T01:34:03.379Z\"}]}","name":""}]},"params":[{"_id":"55cfadf05b49e71900262f44","required":true,"desc":"the section to set metadata in, i.e. `orgs`, `users`, etc...","default":"","type":"string","name":"section","in":"path"},{"_id":"55cfadf05b49e71900262f43","required":true,"desc":"UUID of the element","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2da18f17dc0d00da7ca9","required":false,"desc":"URL path to nested metadata","default":"","type":"string","name":"path","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","url":"/:section/:uuid/metadata/:path"},"body":"Every entity in FiFo's database can have metadata attached to it. This metadata is ignored by FiFo itself but an be leveraged by any software that integrates with it. The metadata is represented as a JSON object, nested keys can be directly accessed by using the URL to specify the path.\n\nAs a convention metadata should never be written to a the root key but should be prefixed with an identifier of the application using it. In the example code we set the `notes` to be displayed in `cerberus` so the the key is `cerberus.notes` (as seen by the URL path of `/metadata/cerberus`. This best practice prevents conflicts between applications that might want to use the same names for different kinds of metadata.\n\nMetadata generally should be kept small, a few kilobyte as most as larger metadata can have a negative impact on the performance of the overall system!","category":"55ce9b0a9d28781700b7c931","createdAt":"2015-08-15T12:16:33.519Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"metadata-set","sync_unique":"","title":"Set Metadata","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putSet Metadata


Path Params

section:
required
string
the section to set metadata in, i.e. `orgs`, `users`, etc...
uuid:
required
string
UUID of the element
path:
string
URL path to nested metadata
Every entity in FiFo's database can have metadata attached to it. This metadata is ignored by FiFo itself but an be leveraged by any software that integrates with it. The metadata is represented as a JSON object, nested keys can be directly accessed by using the URL to specify the path. As a convention metadata should never be written to a the root key but should be prefixed with an identifier of the application using it. In the example code we set the `notes` to be displayed in `cerberus` so the the key is `cerberus.notes` (as seen by the URL path of `/metadata/cerberus`. This best practice prevents conflicts between applications that might want to use the same names for different kinds of metadata. Metadata generally should be kept small, a few kilobyte as most as larger metadata can have a negative impact on the performance of the overall system!

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Every entity in FiFo's database can have metadata attached to it. This metadata is ignored by FiFo itself but an be leveraged by any software that integrates with it. The metadata is represented as a JSON object, nested keys can be directly accessed by using the URL to specify the path. As a convention metadata should never be written to a the root key but should be prefixed with an identifier of the application using it. In the example code we set the `notes` to be displayed in `cerberus` so the the key is `cerberus.notes` (as seen by the URL path of `/metadata/cerberus`. This best practice prevents conflicts between applications that might want to use the same names for different kinds of metadata. Metadata generally should be kept small, a few kilobyte as most as larger metadata can have a negative impact on the performance of the overall system!
{"__v":1,"_id":"55cf2de7c27f7d3500da1e97","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"DELETE /api/2/vms/2ca285a3-05a8-4ca6-befd-78fa994929ab/metadata/cerberus/notes HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json","name":""}]},"params":[{"_id":"55cfae1d8d728e0d00cc5b0d","required":true,"desc":"section to delete metadata key form","default":"","type":"string","name":"section","in":"path"},{"_id":"55cfae1d8d728e0d00cc5b0c","required":true,"desc":"UUID of the element","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2da18f17dc0d00da7ca9","required":false,"desc":"URL path to nested metadata to delete","default":"","type":"string","name":"path","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","url":"/:section/:uuid/metadata/:path"},"body":"Removes a metadata key form an entity, the key can be nested or top level.","category":"55ce9b0a9d28781700b7c931","createdAt":"2015-08-15T12:17:43.022Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"metadata-delete","sync_unique":"","title":"Delete Metadata","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Metadata


Path Params

section:
required
string
section to delete metadata key form
uuid:
required
string
UUID of the element
path:
string
URL path to nested metadata to delete
Removes a metadata key form an entity, the key can be nested or top level.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Removes a metadata key form an entity, the key can be nested or top level.
{"__v":0,"_id":"55d5af3e988e130d000b4089","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":" {\n   \"warnings\": [],\n   \"metrics\": {\n     \"users\": 0,\n     \"roles\": 0,\n     \"orgs\": 0,\n     \"used\": 99121,\n     \"total-memory\": 65508,\n     \"storage\": \"s3\",\n     \"size\": 454656,\n     \"reserved-memory\": 0.0,\n     \"provisioned-memory\": 46080,\n     \"l2size\": 0,\n     \"l2miss\": 0,\n     \"l2hits\": 0,\n     \"l1size\": 1830,\n     \"l1miss\": 831913,\n     \"l1hits\": 24159020,\n     \"hypervisors\": [\n       \"cae242d0-fb7a-4a37-82c7-dcc73ce0fa8d\"\n     ],\n     \"free-memory\": 19428.0,\n     \"vms\": 6\n   },\n   \"versions\": {\n     \"snarl\": \"test-a895db8, Tue Aug 26 10:40:50 2014 -0400\",\n     \"howl\": \"test-1b05ae8, Sat Jul 19 02:52:51 2014 +0200\",\n     \"sniffle\": \"test-a3eeb09, Mon Aug 25 16:58:50 2014 -0400\",\n     \"wiggle\": \"test-31008f1, Tue Aug 26 12:12:16 2014 -0400\"\n   }\n }","name":""}]},"auth":"required","params":[],"url":"/cloud"},"body":"Gets general information on the clouds status.","category":"55ce9b0a9d28781700b7c931","createdAt":"2015-08-20T10:43:10.184Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"cloud-status","sync_unique":"","title":"Cloud status","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getCloud status


Gets general information on the clouds status.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Gets general information on the clouds status.
{"__v":4,"_id":"55cea3a98f17dc0d00da7c53","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"keys\": [],\n    \"metadata\": {},\n    \"name\": \"test1\",\n    \"org\": \"\",\n    \"orgs\": [],\n    \"permissions\": [\n        [\n            \"users\",\n            \"5887f2fc-82df-4ba7-b274-b47d6cd275f2\",\n            \"...\"\n        ]\n    ],\n    \"roles\": [\n        \"ad29d0b8-111e-46f8-9d96-8ef32b17f9be\"\n    ],\n    \"uuid\": \"5887f2fc-82df-4ba7-b274-b47d6cd275f2\",\n    \"yubikeys\": []\n}","name":""}]},"settings":"","url":"/sessions"},"body":"Requests the data related to the current session.","category":"55cea3069d28781700b7c934","createdAt":"2015-08-15T02:27:53.117Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"sessions","sync_unique":"","title":"Current Session","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getCurrent Session


Requests the data related to the current session.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Requests the data related to the current session.
{"__v":1,"_id":"55cea4899d28781700b7c93b","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  token: \"sometoken\", // one time token to use\n  expiery: 30         // experiy time in seconds\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/sessions/one_time_token"},"body":"Generates a one time token to be used when opening web-socket connections.","category":"55cea3069d28781700b7c934","createdAt":"2015-08-15T02:31:37.905Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"sessions-one_time_token","sync_unique":"","title":"One Time Token","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getOne Time Token


Generates a one time token to be used when opening web-socket connections.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Generates a one time token to be used when opening web-socket connections.
{"__v":0,"_id":"55cea4f39d28781700b7c93d","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cea4f39d28781700b7c93e","required":true,"desc":"Session token to delete","default":"","type":"string","name":"session","in":"path"}],"url":"/sessions/:session"},"body":"Deletes the session with the given token, logging it out.","category":"55cea3069d28781700b7c934","createdAt":"2015-08-15T02:33:23.489Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"sessions-delete","sync_unique":"","title":"Token Deletion","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteToken Deletion


Path Params

session:
required
string
Session token to delete
Deletes the session with the given token, logging it out.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes the session with the given token, logging it out.
{"__v":3,"_id":"55d5aef4ced8b9190077cbdd","api":{"auth":"optional","params":[],"results":{"codes":[{"status":200,"language":"json","code":" {\n   \"howl\": 1,\n   \"snarl\": 1,\n   \"sniffle\": 1\n }","name":""}]},"settings":"","url":"/cloud/connection"},"body":"Returns connection status of the cloud services.","category":"55cea3069d28781700b7c934","createdAt":"2015-08-20T10:41:56.696Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"cloud-connections","sync_unique":"","title":"Cloud connection status","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getCloud connection status


Returns connection status of the cloud services.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns connection status of the cloud services.
{"__v":1,"_id":"55cea6978f17dc0d00da7c57","api":{"auth":"optional","params":[{"_id":"55cea6978f17dc0d00da7c5b","required":true,"desc":"ID of the client","default":"","type":"string","name":"client_id","in":"query"},{"_id":"55cea6978f17dc0d00da7c5a","required":true,"desc":"The URI redirected to at the end of the OAuth2 dance.","default":"","type":"string","name":"redirect_uri","in":"query"},{"_id":"55cea6978f17dc0d00da7c59","required":false,"desc":"State of the client","default":"","type":"string","name":"state","in":"query"},{"_id":"55cea6978f17dc0d00da7c58","required":false,"desc":"The requested scope.","default":"","type":"array_string","name":"scope","in":"query"}],"results":{"codes":[{"status":200,"language":"html","code":"<h1>login page</h1>","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/auth?response_type=code"},"body":"Shows the OAuth2 request form to authorize a client for a given scope. This will either show a login prompt or a simple confirmation when a *Bearer Token* was given","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T02:40:23.126Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth-code-auth-request","sync_unique":"","title":"Authorization Code Request","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getAuthorization Code Request


Query Params

client_id:
required
string
ID of the client
redirect_uri:
required
string
The URI redirected to at the end of the OAuth2 dance.
state:
string
State of the client
scope:
array of strings
The requested scope.
Shows the OAuth2 request form to authorize a client for a given scope. This will either show a login prompt or a simple confirmation when a *Bearer Token* was given

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Shows the OAuth2 request form to authorize a client for a given scope. This will either show a login prompt or a simple confirmation when a *Bearer Token* was given
{"__v":1,"_id":"55cea7eadb457c210076e5a5","api":{"auth":"optional","params":[{"_id":"55d39eb1c336ec0d007c21f8","required":true,"desc":"must be `code`","default":"code","type":"string","name":"response_type","in":"body"},{"_id":"55cea7eadb457c210076e5ac","required":true,"desc":"One of code and token","default":"","type":"string","name":"response_type","in":"body"},{"_id":"55cea7eadb457c210076e5ab","required":true,"desc":"ID of the client","default":"","type":"string","name":"client_id","in":"body"},{"_id":"55cea7eadb457c210076e5aa","required":true,"desc":"The URI redirected to at the end of the OAuth2 dacnce","default":"","type":"string","name":"redirect_uri","in":"body"},{"_id":"55cea7eadb457c210076e5a9","required":false,"desc":"","default":"","type":"array_string","name":"scope","in":"body"},{"_id":"55cea7eadb457c210076e5a8","required":false,"desc":"State of the client","default":"","type":"string","name":"state","in":"body"},{"_id":"55cea7eadb457c210076e5a7","required":false,"desc":"The username to authenticate with. (if basic auth or bearer tokens are not used)","default":"","type":"string","name":"username","in":"body"},{"_id":"55cea7eadb457c210076e5a6","required":false,"desc":"The password to authenticate with","default":"","type":"string","name":"password","in":"body"}],"results":{"codes":[{"status":302,"language":"http","code":"HTTP/1.1 302 Found\nlocation: http://client.uri?access_code=abaADbAD123BADas","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/auth"},"body":"Grants a access token or authroization code request and redirects on. On completion might redirect to GET /oauth2/2fa to perform a second set of two factor autentication if required.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"OAuth2 RFC\",\n  \"body\": \"[4.1.1 Authorization Code Grant / Authorization Request](https://tools.ietf.org/html/rfc6749#section-4.1.1)\"\n}\n[/block]\n\nHandles the following parts of the RFC:","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T02:46:02.070Z","editedParams":true,"editedParams2":true,"excerpt":"OAuth2 Grant","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth2-code-grant","sync_unique":"","title":"Authorization Code Grant","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAuthorization Code Grant

OAuth2 Grant

Body Params

response_type:
required
stringcode
must be `code`
response_type:
required
string
One of code and token
client_id:
required
string
ID of the client
redirect_uri:
required
string
The URI redirected to at the end of the OAuth2 dacnce
scope:
array of strings
state:
string
State of the client
username:
string
The username to authenticate with. (if basic auth or bearer tokens are not used)
password:
string
The password to authenticate with
Grants a access token or authroization code request and redirects on. On completion might redirect to GET /oauth2/2fa to perform a second set of two factor autentication if required. [block:callout] { "type": "info", "title": "OAuth2 RFC", "body": "[4.1.1 Authorization Code Grant / Authorization Request](https://tools.ietf.org/html/rfc6749#section-4.1.1)" } [/block] Handles the following parts of the RFC:

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Grants a access token or authroization code request and redirects on. On completion might redirect to GET /oauth2/2fa to perform a second set of two factor autentication if required. [block:callout] { "type": "info", "title": "OAuth2 RFC", "body": "[4.1.1 Authorization Code Grant / Authorization Request](https://tools.ietf.org/html/rfc6749#section-4.1.1)" } [/block] Handles the following parts of the RFC:
{"__v":1,"_id":"55ceae9f9d28781700b7c94b","api":{"auth":"optional","params":[{"_id":"55cea6978f17dc0d00da7c5b","required":true,"desc":"ID of the client","default":"","type":"string","name":"client_id","in":"query"},{"_id":"55cea6978f17dc0d00da7c5a","required":true,"desc":"The URI redirected to at the end of the OAuth2 dance.","default":"","type":"string","name":"redirect_uri","in":"query"},{"_id":"55cea6978f17dc0d00da7c59","required":false,"desc":"State of the client","default":"","type":"string","name":"state","in":"query"},{"_id":"55cea6978f17dc0d00da7c58","required":false,"desc":"The requested scope.","default":"","type":"array_string","name":"scope","in":"query"}],"results":{"codes":[{"status":200,"language":"html","code":"<h1>login page</h1>","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/auth?response_type=token"},"body":"Shows the OAuth2 request form to authorize a client for a given scope. This will either show a login prompt or a simple confirmation when a *Bearer Token* was given","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T03:14:39.616Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth-token-auth-request","sync_unique":"","title":"Implicit Request","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getImplicit Request


Query Params

client_id:
required
string
ID of the client
redirect_uri:
required
string
The URI redirected to at the end of the OAuth2 dance.
state:
string
State of the client
scope:
array of strings
The requested scope.
Shows the OAuth2 request form to authorize a client for a given scope. This will either show a login prompt or a simple confirmation when a *Bearer Token* was given

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Shows the OAuth2 request form to authorize a client for a given scope. This will either show a login prompt or a simple confirmation when a *Bearer Token* was given
{"__v":2,"_id":"55ceadb78f17dc0d00da7c66","api":{"auth":"optional","params":[{"_id":"55d39ec8f77e6d0d00b1b1ec","required":true,"desc":"must be `token`","default":"token","type":"string","name":"response_type","in":"body"},{"_id":"55cea7eadb457c210076e5ab","required":true,"desc":"ID of the client","default":"","type":"string","name":"client_id","in":"body"},{"_id":"55cea7eadb457c210076e5aa","required":true,"desc":"The URI redirected to at the end of the OAuth2 dacnce","default":"","type":"string","name":"redirect_uri","in":"body"},{"_id":"55cea7eadb457c210076e5a6","required":false,"desc":"The password to authenticate with (if basic auth or bearer tokens are not used)","default":"","type":"string","name":"password","in":"body"},{"_id":"55cea7eadb457c210076e5a7","required":false,"desc":"The username to authenticate with (if basic auth or bearer tokens are not used)","default":"","type":"string","name":"username","in":"body"},{"_id":"55cea7eadb457c210076e5a9","required":false,"desc":"","default":"","type":"array_string","name":"scope","in":"body"},{"_id":"55cea7eadb457c210076e5a8","required":false,"desc":"State of the client","default":"","type":"string","name":"state","in":"body"}],"results":{"codes":[{"status":302,"language":"http","code":"HTTP/1.1 302 Found\nlocation: http://client.uri?access_code=abaADbAD123BADas","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/auth"},"body":"Grants a access token or authroization code request and redirects on. On completion might redirect to GET /oauth2/2fa to perform a second set of two factor autentication if required.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"OAuth2 RFC\",\n  \"body\": \"[4.2.1 Implicit Grant / Authorization Request](https://tools.ietf.org/html/rfc6749#section-4.2.1)\"\n}\n[/block]\n\nHandles the following parts of the RFC:","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T03:10:47.214Z","editedParams":true,"editedParams2":true,"excerpt":"4.2.1 Implicit Grant","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth2-implict-grant","sync_unique":"","title":"Implicit Grant","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postImplicit Grant

4.2.1 Implicit Grant

Body Params

response_type:
required
stringtoken
must be `token`
client_id:
required
string
ID of the client
redirect_uri:
required
string
The URI redirected to at the end of the OAuth2 dacnce
password:
string
The password to authenticate with (if basic auth or bearer tokens are not used)
username:
string
The username to authenticate with (if basic auth or bearer tokens are not used)
scope:
array of strings
state:
string
State of the client
Grants a access token or authroization code request and redirects on. On completion might redirect to GET /oauth2/2fa to perform a second set of two factor autentication if required. [block:callout] { "type": "info", "title": "OAuth2 RFC", "body": "[4.2.1 Implicit Grant / Authorization Request](https://tools.ietf.org/html/rfc6749#section-4.2.1)" } [/block] Handles the following parts of the RFC:

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Grants a access token or authroization code request and redirects on. On completion might redirect to GET /oauth2/2fa to perform a second set of two factor autentication if required. [block:callout] { "type": "info", "title": "OAuth2 RFC", "body": "[4.2.1 Implicit Grant / Authorization Request](https://tools.ietf.org/html/rfc6749#section-4.2.1)" } [/block] Handles the following parts of the RFC:
{"__v":2,"_id":"55cea951db457c210076e5ad","api":{"auth":"optional","params":[{"_id":"55d39edec336ec0d007c21f9","required":true,"desc":"must be `authorization_code`","default":"authorization_code","type":"string","name":"grant_type","in":"body"},{"_id":"55cea951db457c210076e5b6","required":true,"desc":"Code from the prior part of OAuth2","default":"","type":"string","name":"code","in":"body"},{"_id":"55cea951db457c210076e5b5","required":true,"desc":"ID of the client","default":"","type":"string","name":"client_id","in":"body"},{"_id":"55cea951db457c210076e5b4","required":true,"desc":"Redirect for the Client","default":"","type":"string","name":"redirect_uri","in":"body"},{"_id":"55cea951db457c210076e5b2","required":false,"desc":"Secret for the client","default":"","type":"string","name":"client_secret","in":"body"},{"_id":"55cea951db457c210076e5b3","required":false,"desc":"Scope of the grant","default":"","type":"string","name":"scope","in":"body"},{"_id":"55cea951db457c210076e5b1","required":false,"desc":"State handed from the client","default":"","type":"string","name":"state","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"access_token\": \"Ebaz7zB51OPXnmOlVDnKRhv9Ig9kKW2V\",\n    \"token_type\": \"bearer\",\n    \"expires_in\": 86400,\n    \"refresh_token\": \"Qpxr7bOaDA4NUloYc9XYWmS16QAio3Dr\",\n    \"scope\": [\n        \"*\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/token"},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"[4.1.3 Access Token Request](https://tools.ietf.org/html/rfc6749#section-4.1.3)\",\n  \"title\": \"OAuth2 RFC\"\n}\n[/block]","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T02:52:01.890Z","editedParams":true,"editedParams2":true,"excerpt":"4.1.3 Access Token Request","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth2-authorization_code","sync_unique":"","title":"Access Token Request","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAccess Token Request

4.1.3 Access Token Request

Body Params

grant_type:
required
stringauthorization_code
must be `authorization_code`
code:
required
string
Code from the prior part of OAuth2
client_id:
required
string
ID of the client
redirect_uri:
required
string
Redirect for the Client
client_secret:
string
Secret for the client
scope:
string
Scope of the grant
state:
string
State handed from the client
[block:callout] { "type": "info", "body": "[4.1.3 Access Token Request](https://tools.ietf.org/html/rfc6749#section-4.1.3)", "title": "OAuth2 RFC" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:callout] { "type": "info", "body": "[4.1.3 Access Token Request](https://tools.ietf.org/html/rfc6749#section-4.1.3)", "title": "OAuth2 RFC" } [/block]
{"__v":2,"_id":"55cea976db457c210076e5b8","api":{"auth":"required","params":[{"_id":"55d39ef30168850d0073f2ff","required":true,"desc":"must be `client_credentials`","default":"client_credentials","type":"string","name":"grant_type","in":"body"},{"_id":"55cea951db457c210076e5b5","required":true,"desc":"","default":"","type":"string","name":"client_id","in":"body"},{"_id":"55cea951db457c210076e5b2","required":true,"desc":"","default":"","type":"string","name":"client_secret","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"access_token\": \"Ebaz7zB51OPXnmOlVDnKRhv9Ig9kKW2V\",\n    \"token_type\": \"bearer\",\n    \"expires_in\": 86400,\n    \"scope\": [\n        \"*\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/token"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"[4.4.2 Access Token Request](https://tools.ietf.org/html/rfc6749#section-4.4.2)\",\n  \"title\": \"OAuth2 RFC\"\n}\n[/block]","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T02:52:38.547Z","editedParams":true,"editedParams2":true,"excerpt":"4.4.2 Access Token Request","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth2tokengrant_type-client_credentials","sync_unique":"","title":"Client Credentials - Access Token Request","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postClient Credentials - Access Token Request

4.4.2 Access Token Request

Body Params

grant_type:
required
stringclient_credentials
must be `client_credentials`
client_id:
required
string
client_secret:
required
string
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:callout] { "type": "info", "body": "[4.4.2 Access Token Request](https://tools.ietf.org/html/rfc6749#section-4.4.2)", "title": "OAuth2 RFC" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:callout] { "type": "info", "body": "[4.4.2 Access Token Request](https://tools.ietf.org/html/rfc6749#section-4.4.2)", "title": "OAuth2 RFC" } [/block]
{"__v":2,"_id":"55ceaa208f17dc0d00da7c5d","api":{"auth":"required","params":[{"_id":"55d39f0ec336ec0d007c21fc","required":true,"desc":"must be `refresh_token`","default":"refresh_token","type":"string","name":"grant_type","in":"body"},{"_id":"55cea951db457c210076e5b1","required":true,"desc":"Used to obtain a new token via a.","default":"","type":"string","name":"refresh_token","in":"body"},{"_id":"55cea951db457c210076e5b5","required":true,"desc":"Client ID (may be supplied over basic auth)","default":"","type":"string","name":"client_id","in":"body"},{"_id":"55cea951db457c210076e5b4","required":true,"desc":"","default":"","type":"string","name":"redirect_uri","in":"body"},{"_id":"55cea951db457c210076e5b2","required":false,"desc":"","default":"","type":"string","name":"client_secret","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"access_token\": \"Ebaz7zB51OPXnmOlVDnKRhv9Ig9kKW2V\",\n    \"token_type\": \"bearer\",\n    \"expires_in\": 86400,\n    \"scope\": [\n        \"*\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/token"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"[6 Refreshing an Access Token](https://tools.ietf.org/html/rfc6749#section-6)\",\n  \"title\": \"OAuth2 RFC\"\n}\n[/block]","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T02:55:28.303Z","editedParams":true,"editedParams2":true,"excerpt":"6 Refreshing an Access Token","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth2-refresh_token","sync_unique":"","title":"Refreshing an Access Token","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postRefreshing an Access Token

6 Refreshing an Access Token

Body Params

grant_type:
required
stringrefresh_token
must be `refresh_token`
refresh_token:
required
string
Used to obtain a new token via a.
client_id:
required
string
Client ID (may be supplied over basic auth)
redirect_uri:
required
string
client_secret:
string
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:callout] { "type": "info", "body": "[6 Refreshing an Access Token](https://tools.ietf.org/html/rfc6749#section-6)", "title": "OAuth2 RFC" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:callout] { "type": "info", "body": "[6 Refreshing an Access Token](https://tools.ietf.org/html/rfc6749#section-6)", "title": "OAuth2 RFC" } [/block]
{"__v":2,"_id":"55ceaa458f17dc0d00da7c5e","api":{"auth":"required","params":[{"_id":"55d39f20f77e6d0d00b1b1f1","default":"password","desc":"must be `password`","name":"grant_type","required":true,"type":"string","in":"body"},{"_id":"55cea951db457c210076e5b0","required":true,"desc":"The username for the password grant.","default":"","type":"string","name":"username","in":"body"},{"_id":"55cea951db457c210076e5af","required":true,"desc":"The password for the password grant.","default":"","type":"string","name":"password","in":"body"},{"_id":"55cea951db457c210076e5b3","required":true,"desc":"The Scope for a password grant.","default":"","type":"string","name":"scope","in":"body"},{"_id":"55cea951db457c210076e5ae","required":false,"desc":"The OTP from the user if required (custom extension).","default":"","type":"string","name":"fifo_otp","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"access_token\": \"Ebaz7zB51OPXnmOlVDnKRhv9Ig9kKW2V\",\n    \"token_type\": \"bearer\",\n    \"expires_in\": 86400,\n    \"scope\": [\n        \"*\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"55df5b4addfb40170061cfeb","url":"/oauth2/token"},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"[4.3 Resource Owner Password Credentials Grant](https://tools.ietf.org/html/rfc6749#section-4.3)\",\n  \"title\": \"OAuth2 RFC\"\n}\n[/block]","category":"55cea30d8f17dc0d00da7c51","createdAt":"2015-08-15T02:56:05.851Z","editedParams":true,"editedParams2":true,"excerpt":"4.3 Resource Owner Password Credentials Grant","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55ce9a298f17dc0d00da7c48","slug":"oauth2-password","sync_unique":"","title":"Resource Owner Password Credentials Grant","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postResource Owner Password Credentials Grant

4.3 Resource Owner Password Credentials Grant

Body Params

grant_type:
required
stringpassword
must be `password`
username:
required
string
The username for the password grant.
password:
required
string
The password for the password grant.
scope:
required
string
The Scope for a password grant.
fifo_otp:
string
The OTP from the user if required (custom extension).
[block:callout] { "type": "info", "body": "[4.3 Resource Owner Password Credentials Grant](https://tools.ietf.org/html/rfc6749#section-4.3)", "title": "OAuth2 RFC" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:callout] { "type": "info", "body": "[4.3 Resource Owner Password Credentials Grant](https://tools.ietf.org/html/rfc6749#section-4.3)", "title": "OAuth2 RFC" } [/block]
{"project":"55ce9a298f17dc0d00da7c48","version":"55ce9b0a9d28781700b7c930","category":"55cea30d8f17dc0d00da7c51","_id":"55fdc78051dbf70d00c61bc7","user":"55af3b15826d210d00041e02","updates":[],"createdAt":"2015-09-19T20:37:20.379Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"default\": true,\n    \"description\": \"Everything\",\n    \"scope\": \"*\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"never","params":[],"url":"/scopes"},"order":999,"body":"Returns the scopes provided by the system.","excerpt":"","slug":"scopes-list","type":"get","title":"List Scopes","__v":0,"childrenPages":[]}

getList Scopes


Returns the scopes provided by the system.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns the scopes provided by the system.
{"__v":0,"_id":"55cf8e025b49e71900262f24","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    \"7015cc51-3b09-45da-9cab-970d94b27c45\",\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/users"},"body":"Lists all users visible to the user.\n\nSee [Get User](doc:users-get) for the fields available for `full-list-fields`.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:07:46.469Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"users-list","sync_unique":"","title":"List Users","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Users


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all users visible to the user. See [Get User](doc:users-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all users visible to the user. See [Get User](doc:users-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55cf8e47982d692b006fe0dd","api":{"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/users/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"the login","default":"","type":"string","name":"user","in":"body"},{"_id":"55cf261c46db442b00105be9","required":true,"desc":"the password for the user","default":"","type":"string","name":"password","in":"body"}],"url":"/users"},"body":"Creates a new user","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:08:55.160Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"users-create","sync_unique":"","title":"Create User","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate User


Body Params

user:
required
string
the login
password:
required
string
the password for the user
Creates a new user

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a new user
{"__v":1,"_id":"55cf8e875b49e71900262f26","api":{"auth":"required","params":[{"_id":"55cfae578d728e0d00cc5b0e","default":"","desc":"UUID of the user","name":"uuid","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"keys\": {\n    },\n    \"metadata\": {\n        \"cerberus\": {\n            \"howl\": \"ws://localhost:8888\",\n            \"ws\": \"ws://localhost:8888\"\n        },\n        \"jingles\": {\n            \"vms_orderBy\": \"{\\\"config.alias\\\":\\\"desc\\\"}\"\n        }\n    },\n    \"name\": \"admin\",\n    \"org\": \"5f8dddd1-d965-45ee-b662-ca29d677a312\",\n    \"orgs\": [\n        \"5f8dddd1-d965-45ee-b662-ca29d677a312\",\n        \"6c298215-fd8e-4e3d-80dc-6d48e8a4fea1\"\n    ],\n    \"permissions\": [\n        [\n            \"...\"\n        ],\n        [\n            \"channels\",\n            \"2e081394-7d1b-436a-bde1-08cdb28636f7\",\n            \"join\"\n        ],\n        [\n            \"cloud\",\n            \"...\"\n        ],\n        [\n            \"vms\",\n            \"2e081394-7d1b-436a-bde1-08cdb28636f7\",\n            \"...\"\n        ]\n    ],\n    \"roles\": [\n        \"ad29d0b8-111e-46f8-9d96-8ef32b17f9be\"\n    ],\n    \"tokens\": [\n        {\n            \"client\": \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\",\n            \"expiery\": 1442683138,\n            \"id\": \"6758e971-6f1d-4d23-a878-4db5599f3900\",\n            \"scope\": [\n                \"*\"\n            ],\n            \"type\": \"refresh\"\n        },\n        {\n            \"client\": \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\",\n            \"expiery\": 1442683138,\n            \"id\": \"b7b5a77e-4919-4fc7-aa6e-19366cfe49f4\",\n            \"scope\": [\n                \"*\"\n            ],\n            \"type\": \"access\"\n        },\n        {\n            \"expiery\": 1442681769,\n            \"id\": \"bbf5c619-0546-4110-a2cb-96c34924b21d\",\n            \"scope\": [\n                \"*\"\n            ],\n            \"type\": \"access\"\n        },\n        {\n            \"expiery\": 1442682118,\n            \"id\": \"1419ec15-3e33-4bbf-94fe-1957bd4dce4a\",\n            \"scope\": [\n                \"*\"\n            ],\n            \"type\": \"access\"\n        },\n        {\n            \"expiery\": 1442682394,\n            \"id\": \"3e168a85-96aa-44a4-9e04-bf058ea69ef3\",\n            \"scope\": [\n                \"*\"\n            ],\n            \"type\": \"access\"\n        }\n    ],\n    \"uuid\": \"e01d2b2c-178c-4b9d-9046-cba2471b2c27\",\n    \"yubikeys\": []\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/:uuid"},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sensitive data\",\n  \"body\": \"Note that no sensitive data will be returned from this call. Neither the users password hash nor the actual tokens used by the user are included in the reply. The token id's can **not be used** to authenticate requests!\"\n}\n[/block]\nReads a user.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:09:59.080Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"users-get","sync_unique":"","title":"Get User","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet User


Path Params

uuid:
required
string
UUID of the user
[block:callout] { "type": "info", "title": "Sensitive data", "body": "Note that no sensitive data will be returned from this call. Neither the users password hash nor the actual tokens used by the user are included in the reply. The token id's can **not be used** to authenticate requests!" } [/block] Reads a user.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:callout] { "type": "info", "title": "Sensitive data", "body": "Note that no sensitive data will be returned from this call. Neither the users password hash nor the actual tokens used by the user are included in the reply. The token id's can **not be used** to authenticate requests!" } [/block] Reads a user.
{"__v":1,"_id":"55cf8ebd5b49e71900262f28","api":{"auth":"required","params":[{"_id":"55cfae948d728e0d00cc5b0f","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"New password for the user","default":"","type":"string","name":"password","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/:uuid"},"body":"Changes the `password` of a user","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:10:53.585Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"users-password","sync_unique":"","title":"Set User Password","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putSet User Password


Path Params

uuid:
required
string
UUID of the user

Body Params

password:
required
string
New password for the user
Changes the `password` of a user

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Changes the `password` of a user
{"__v":1,"_id":"55cf8edc8d728e0d00cc5ae8","api":{"auth":"required","params":[{"_id":"55cfaea05b49e71900262f45","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","url":"/users/:uuid"},"body":"Deletes a user.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:11:24.928Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"users-delete","sync_unique":"","title":"Delete User","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete User


Path Params

uuid:
required
string
UUID of the user
Deletes a user.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a user.
{"__v":1,"_id":"55cf8f148d728e0d00cc5aea","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"GET /api/2/users/b7c658e0-2ddb-46dd-8973-4a59ffc9957e/permissions/cloud/vms/create HTTP/1.1\nhost: cloud.project-fifo.net\naccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfaeb08d728e0d00cc5b10","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29fa8f17dc0d00da7ca5","required":true,"desc":"the permission to test as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"ok\": \"allowed\"\n}","name":"Allowed"},{"name":"Forbidden","status":200,"language":"text","code":"{\n    \"error\": \"forbidden\"\n}"}]},"settings":"","url":"/users/:uuid/permissions/:permission"},"body":"Tests if a user has is allowed to perform an action. Please note that 403 here does **not** mean the user is not allowed but that the requesting token was not allowed to test for the client!","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:12:20.562Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"users-permission-test","sync_unique":"","title":"Test User Permission","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getTest User Permission


Path Params

uuid:
required
string
UUID of the user
permission:
required
string
the permission to test as path i.e. `some/funky/permission`
Tests if a user has is allowed to perform an action. Please note that 403 here does **not** mean the user is not allowed but that the requesting token was not allowed to test for the client!

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Tests if a user has is allowed to perform an action. Please note that 403 here does **not** mean the user is not allowed but that the requesting token was not allowed to test for the client!
{"__v":1,"_id":"55cf8f4d5b49e71900262f29","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"PUT /api/2/users/7df734a1-7332-45da-aa2a-9a3d856fa58a/permissions/groupings/35c4cfbb-057c-455b-93f8-e93205d44ada/get HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfaebe957dcd3500b3449f","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29e98f17dc0d00da7ca4","required":true,"desc":"the permission to grant as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":201,"language":"text","code":""}]},"settings":"","url":"/users/:uuid/permissions/:permission"},"body":"Grants a permission to a user .","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:13:17.878Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55ce9a298f17dc0d00da7c48","slug":"users-permission-grant","sync_unique":"","title":"Grant User Permissions","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putGrant User Permissions


Path Params

uuid:
required
string
UUID of the user
permission:
required
string
the permission to grant as path i.e. `some/funky/permission`
Grants a permission to a user .

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Grants a permission to a user .
{"__v":1,"_id":"55cf8fb88d728e0d00cc5aec","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"DELETE /api/2/users/7df734a1-7332-45da-aa2a-9a3d856fa58a/permissions/groupings/35c4cfbb-057c-455b-93f8-e93205d44ada/get HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfaed08d728e0d00cc5b11","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29e98f17dc0d00da7ca4","required":true,"desc":"the permission to revoke as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":204,"language":"text","code":""}]},"settings":"","url":"/users/:uuid/permissions/:permission"},"body":"Revokes a permission from a user.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:15:04.265Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55ce9a298f17dc0d00da7c48","slug":"users-permission-revoke","sync_unique":"","title":"Revoke User Permission","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRevoke User Permission


Path Params

uuid:
required
string
UUID of the user
permission:
required
string
the permission to revoke as path i.e. `some/funky/permission`
Revokes a permission from a user.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Revokes a permission from a user.
{"__v":1,"_id":"55cf90208d728e0d00cc5aed","api":{"auth":"required","params":[{"_id":"55cfaf0d957dcd3500b344a0","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"UUID of the role to join","default":"","type":"string","name":"role","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/:uuid/roles/:role"},"body":"Gives a user a role.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:16:48.294Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55ce9a298f17dc0d00da7c48","slug":"users-role-join","sync_unique":"","title":"Give Role to User","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putGive Role to User


Path Params

uuid:
required
string
UUID of the user
role:
required
string
UUID of the role to join
Gives a user a role.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Gives a user a role.
{"__v":1,"_id":"55cf903d5b49e71900262f2a","api":{"auth":"required","params":[{"_id":"55cfaf1a8d728e0d00cc5b12","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"UUID of the role to join","default":"","type":"string","name":"role","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/:uuid/roles/:role"},"body":"Removes a role from a user.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T19:17:17.089Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"55ce9a298f17dc0d00da7c48","slug":"users-role-delete","sync_unique":"","title":"Remove Role from User","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove Role from User


Path Params

uuid:
required
string
UUID of the user
role:
required
string
UUID of the role to join
Removes a role from a user.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Removes a role from a user.
{"__v":1,"_id":"55cf9e918d728e0d00cc5afa","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"PUT /api/2/users/7df734a1-7332-45da-aa2a-9a3d856fa58a/keys HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json\n\n{\n\"test@testhost\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDZyw2HsD2TBPpBcCJLge4Eu1N9IXHx0S9APSdC4GEre3h4huNT9LUA78oOB1LDIyqmwbHy5yqVVBht4awmcveaSsBIDEPBrU+ZrSeibg3ikQxBYA+7IG8gwvEqxI9EdbnF6eqstfiUIaLsLuUY2E2b2DGIohy/NIw0tccchLR0kHUGz4yjmMZg78X9ux2VqFhlTfj3xDsagxFjo90FQkrO32SLULFS9fG5Ki8vsvhfkhhtgct74i894lj4DRThqmvgygODXcyvi/wtixaqKqcn+Y1JCr5AsvXvYmWQzdRh9Rv77j0mleo0xqosqXIH1HqsM4CJmdYGCPU7JB6k0j/H test@testhost\"\n}\n","name":""}]},"params":[{"_id":"55cfaf32957dcd3500b344a1","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"key/value pair for the key","default":"","type":"string","name":"<key>","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":409,"language":"json","code":"","name":""}]},"settings":"","url":"/users/:uuid/keys"},"body":"Adds a SSH key to a user.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Doublicate keys\",\n  \"body\": \"It is not possible to add the same key to two users. A `409` error is returned when this is attempted.\"\n}\n[/block]","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T20:18:25.423Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":10,"project":"55ce9a298f17dc0d00da7c48","slug":"users-key-add","sync_unique":"","title":"Add SSH Key to User","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putAdd SSH Key to User


Path Params

uuid:
required
string
UUID of the user

Body Params

key:
required
string
key/value pair for the key
Adds a SSH key to a user. [block:callout] { "type": "danger", "title": "Doublicate keys", "body": "It is not possible to add the same key to two users. A `409` error is returned when this is attempted." } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Adds a SSH key to a user. [block:callout] { "type": "danger", "title": "Doublicate keys", "body": "It is not possible to add the same key to two users. A `409` error is returned when this is attempted." } [/block]
{"__v":0,"_id":"55cfa0e88d728e0d00cc5afb","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"auth":"required","params":[{"_id":"55cfa0e88d728e0d00cc5afd","required":true,"desc":"UUID if the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cfa0e88d728e0d00cc5afc","required":true,"desc":"id if the key to delete","default":"","type":"string","name":"key-id","in":"path"}],"url":"/users/:uuid/keys/:key-id"},"body":"Removes a SSH key from a user.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T20:28:24.376Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":11,"project":"55ce9a298f17dc0d00da7c48","slug":"users-key-delete","sync_unique":"","title":"Remove SSH key from User","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove SSH key from User


Path Params

uuid:
required
string
UUID if the user
key-id:
required
string
id if the key to delete
Removes a SSH key from a user.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Removes a SSH key from a user.
{"__v":0,"_id":"55cfa28f5b49e71900262f38","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"auth":"required","params":[{"_id":"55cfa0e88d728e0d00cc5afd","required":true,"desc":"UUID if the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cfa0e88d728e0d00cc5afc","required":true,"desc":"OTP from the YubiKey to add","default":"","type":"string","name":"otp","in":"body"}],"url":"/users/:uuid/yubikeys"},"body":"Removes a SSH key from a user.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T20:35:27.185Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":12,"project":"55ce9a298f17dc0d00da7c48","slug":"users-yubikeys-add","sync_unique":"","title":"Add Yubikey to User","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putAdd Yubikey to User


Path Params

uuid:
required
string
UUID if the user

Body Params

otp:
required
string
OTP from the YubiKey to add
Removes a SSH key from a user.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Removes a SSH key from a user.
{"__v":0,"_id":"55cfa1f45b49e71900262f37","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cfa0e88d728e0d00cc5afd","required":true,"desc":"UUID if the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cfa0e88d728e0d00cc5afc","required":true,"desc":"id if the key to delete","default":"","type":"string","name":"key-id","in":"path"}],"url":"/users/:uuid/yubikeys/:key-id"},"body":"Removes a SSH key from a user.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T20:32:52.101Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":13,"project":"55ce9a298f17dc0d00da7c48","slug":"users-yubikey-delete","sync_unique":"","title":"Remove Yubikey from User","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove Yubikey from User


Path Params

uuid:
required
string
UUID if the user
key-id:
required
string
id if the key to delete
Removes a SSH key from a user.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Removes a SSH key from a user.
{"__v":1,"_id":"55cfa3d5957dcd3500b34492","api":{"auth":"required","params":[{"_id":"55cfaf578d728e0d00cc5b13","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"UUID of the org to join","default":"","type":"string","name":"org","in":"path"},{"_id":"55cfa3d5957dcd3500b34493","required":false,"desc":"used to set an orga","default":"","type":"boolean","name":"active","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/:uuid/orgs/:org"},"body":"Adds a user to an Organisation. The first joined Organisation will automatically be set as active. Any further Organisations need to be selected as active by passing the `active` parameter in a JSON.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T20:40:53.092Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":14,"project":"55ce9a298f17dc0d00da7c48","slug":"user-org-add","sync_unique":"","title":"Adds the User to an Organisation","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putAdds the User to an Organisation


Path Params

uuid:
required
string
UUID of the user
org:
required
string
UUID of the org to join

Body Params

active:
boolean
used to set an orga
Adds a user to an Organisation. The first joined Organisation will automatically be set as active. Any further Organisations need to be selected as active by passing the `active` parameter in a JSON.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Adds a user to an Organisation. The first joined Organisation will automatically be set as active. Any further Organisations need to be selected as active by passing the `active` parameter in a JSON.
{"__v":1,"_id":"55cfa4058d728e0d00cc5b01","api":{"auth":"required","params":[{"_id":"55cfaf675b49e71900262f46","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"UUID of the role to join","default":"","type":"string","name":"org","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/:uuid/orgs/:org"},"body":"Removes user from an organization.","category":"55cea313db457c210076e5a2","createdAt":"2015-08-15T20:41:41.526Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":15,"project":"55ce9a298f17dc0d00da7c48","slug":"users-org-delete","sync_unique":"","title":"Remove User from Organistation","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove User from Organistation


Path Params

uuid:
required
string
UUID of the user
org:
required
string
UUID of the role to join
Removes user from an organization.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Removes user from an organization.
{"__v":0,"_id":"55fc81e7af72eb0d0007e080","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"bearer\": \"DZPGPuj67aVbAN62Uu2YYzdGGpYS4eUX\",\n  \"id\": \"b7b5a77e-4919-4fc7-aa6e-19366cfe49f4\"\n}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf261c46db442b00105be9","required":true,"desc":"A comment for the token","default":"","type":"string","name":"comment","in":"body"},{"_id":"55fc81e7af72eb0d0007e081","required":false,"desc":"A list of scopes for the token","default":"","type":"array_string","name":"scopes","in":"body"}],"url":"/users/:uuid/tokens"},"body":"Crates a API token for a user with a given scope, please keep in mind that the reply to this request is **THE ONLY TIME** the bearer token can be accessed!","category":"55cea313db457c210076e5a2","createdAt":"2015-09-18T21:28:07.645Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"55ce9a298f17dc0d00da7c48","slug":"users-tokens-create","sync_unique":"","title":"Create API Key","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate API Key


Path Params

uuid:
required
string
UUID of the user

Body Params

comment:
required
string
A comment for the token
scopes:
array of strings
A list of scopes for the token
Crates a API token for a user with a given scope, please keep in mind that the reply to this request is **THE ONLY TIME** the bearer token can be accessed!

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Crates a API token for a user with a given scope, please keep in mind that the reply to this request is **THE ONLY TIME** the bearer token can be accessed!
{"__v":0,"_id":"55fc8295f4dbbf0d008f44a2","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"auth":"required","params":[{"_id":"55cfaea05b49e71900262f45","required":true,"desc":"UUID of the user","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55fc8295f4dbbf0d008f44a3","required":true,"desc":"ID of the token to delete (not the token itself!)","default":"","type":"string","name":"token-id","in":"path"}],"url":"/users/:uuid/tokens/:token-id"},"body":"Revokes a token, this applies equally for access and refresh tokens.","category":"55cea313db457c210076e5a2","createdAt":"2015-09-18T21:31:01.631Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"55ce9a298f17dc0d00da7c48","slug":"users-tokens-revoke","sync_unique":"","title":"Revoke Token","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRevoke Token


Path Params

uuid:
required
string
UUID of the user
token-id:
required
string
ID of the token to delete (not the token itself!)
Revokes a token, this applies equally for access and refresh tokens.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Revokes a token, this applies equally for access and refresh tokens.
{"__v":0,"_id":"55cf261c46db442b00105be8","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","default":"false","desc":"to get a full list instead of UUIDs","name":"full-list","required":false,"type":"string","in":"query"},{"_id":"55cf261c46db442b00105be9","default":"","desc":"fields to include in the full list (`,` separated)","name":"full-list-fields","required":false,"type":"array_string","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    \"7015cc51-3b09-45da-9cab-970d94b27c45\",\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/clients"},"body":"Lists all clients visible to the user.\n\nSee [Get Client](doc:clients-get) for the fields available for `full-list-fields`.","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T11:44:28.639Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-list","sync_unique":"","title":"List Clients","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Clients


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all clients visible to the user. See [Get Client](doc:clients-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all clients visible to the user. See [Get Client](doc:clients-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55cf272046db442b00105bec","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"the ClientID","default":"","type":"string","name":"client","in":"body"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"the secret for the client","default":"","type":"string","name":"secret","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/clients/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"settings":"","url":"/clients"},"body":"Creates a new client","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T11:48:48.335Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-create","sync_unique":"","title":"Create Client","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate Client


Body Params

client:
required
string
the ClientID
secret:
string
the secret for the client
Creates a new client

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a new client
{"__v":2,"_id":"55cf275b5c06ee2100ecd9f7","api":{"auth":"required","params":[{"_id":"55cfaf8e8d728e0d00cc5b14","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"client_id\": \"Client1\",\n  \"metadata\": {},\n  \"name\": \"Client1\",\n  \"permissions\": [],\n  \"redirect_uris\": {\n    \"606054\": \"http://test.com\"\n  },\n  \"roles\": [],\n  \"type\": \"public\",\n  \"uuid\": \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/clients/:uuid"},"body":"Reads a client","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T11:49:47.926Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-get","sync_unique":"","title":"Get Client","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Client


Path Params

uuid:
required
string
UUID of the client
Reads a client

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a client
{"__v":1,"_id":"55cf28068f17dc0d00da7ca1","api":{"auth":"required","params":[{"_id":"55cfaf9b957dcd3500b344a3","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"New secret for the cleint","default":"","type":"string","name":"secret","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/clients/:uuid"},"body":"Changes the `secret` of a client","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T11:52:38.735Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-set-secret","sync_unique":"","title":"Set Client Secret","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putSet Client Secret


Path Params

uuid:
required
string
UUID of the client

Body Params

secret:
required
string
New secret for the cleint
Changes the `secret` of a client

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Changes the `secret` of a client
{"__v":1,"_id":"55cf28605c06ee2100ecd9f9","api":{"auth":"required","params":[{"_id":"55cfafb25b49e71900262f47","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","url":"/clients/:uuid"},"body":"Deletes a Client.","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T11:54:08.995Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-delete","sync_unique":"","title":"Delete Client","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Client


Path Params

uuid:
required
string
UUID of the client
Deletes a Client.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a Client.
{"__v":2,"_id":"55cf294646db442b00105bef","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"GET /api/2/clients/b7c658e0-2ddb-46dd-8973-4a59ffc9957e/permissions/cloud/vms/create HTTP/1.1\nhost: cloud.project-fifo.net\naccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfafc1957dcd3500b344a4","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29fa8f17dc0d00da7ca5","required":true,"desc":"the permission to test as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"ok\": \"allowed\"\n}","name":"Allowed"},{"name":"Forbidden","status":200,"language":"text","code":"{\n    \"error\": \"forbidden\"\n}"}]},"settings":"","url":"/clients/:uuid/permissions/:permission"},"body":"Tests if a client has is allowed to perform an action. Please note that 403 here does **not** mean the client is not allowed but that the requesting token was not allowed to test for the client!","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T11:57:58.268Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-permissions-test","sync_unique":"","title":"Test Client Permissions","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getTest Client Permissions


Path Params

uuid:
required
string
UUID of the client
permission:
required
string
the permission to test as path i.e. `some/funky/permission`
Tests if a client has is allowed to perform an action. Please note that 403 here does **not** mean the client is not allowed but that the requesting token was not allowed to test for the client!

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Tests if a client has is allowed to perform an action. Please note that 403 here does **not** mean the client is not allowed but that the requesting token was not allowed to test for the client!
{"__v":2,"_id":"55cf29b746db442b00105bf1","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"PUT /api/2/clients/7df734a1-7332-45da-aa2a-9a3d856fa58a/permissions/groupings/35c4cfbb-057c-455b-93f8-e93205d44ada/get HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfafe7957dcd3500b344a5","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29e98f17dc0d00da7ca4","required":true,"desc":"the permission to grant as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":201,"language":"text","code":""}]},"settings":"","url":"/clients/:uuid/permissions/:permission"},"body":"Grants a permission> to a client .","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T11:59:51.612Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-permission-grant","sync_unique":"","title":"Grant Client Permissions","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putGrant Client Permissions


Path Params

uuid:
required
string
UUID of the client
permission:
required
string
the permission to grant as path i.e. `some/funky/permission`
Grants a permission> to a client .

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Grants a permission> to a client .
{"__v":1,"_id":"55cf2a575c06ee2100ecd9fb","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"DELETE /api/2/clients/7df734a1-7332-45da-aa2a-9a3d856fa58a/permissions/groupings/35c4cfbb-057c-455b-93f8-e93205d44ada/get HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfaff65b49e71900262f48","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29e98f17dc0d00da7ca4","required":true,"desc":"the permission to revoke as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":204,"language":"text","code":""}]},"settings":"","url":"/clients/:uuid/permissions/:permission"},"body":"Revokes a permission to a client .","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T12:02:31.142Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-permission-revoke","sync_unique":"","title":"Revoke Client Permissions","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRevoke Client Permissions


Path Params

uuid:
required
string
UUID of the client
permission:
required
string
the permission to revoke as path i.e. `some/funky/permission`
Revokes a permission to a client .

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Revokes a permission to a client .
{"__v":1,"_id":"55cf2ae48f17dc0d00da7ca6","api":{"auth":"required","params":[{"_id":"55cfb0098d728e0d00cc5b15","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf261c46db442b00105bea","required":true,"desc":"the URI to add","default":"","type":"string","name":"uri","in":"body"}],"results":{"codes":[{"status":204,"language":"http","code":"","name":""}]},"settings":"","url":"/clients/:uuid/uris"},"body":"Adds an URI to the valid redirect URI’s for this client.","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T12:04:52.146Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-uri-add","sync_unique":"","title":"Add Redirect URI to Client","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAdd Redirect URI to Client


Path Params

uuid:
required
string
UUID of the client

Body Params

uri:
required
string
the URI to add
Adds an URI to the valid redirect URI’s for this client.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Adds an URI to the valid redirect URI’s for this client.
{"__v":1,"_id":"55cf2c205c06ee2100ecd9fd","api":{"auth":"required","params":[{"_id":"55cfb01b8d728e0d00cc5b16","required":true,"desc":"UUID of the client","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf261c46db442b00105bea","required":true,"desc":"id of the URI to delete","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":204,"language":"http","code":"","name":""}]},"settings":"","url":"/clients/:uuid/uris/:id"},"body":"Deletes key with given uuid for client with given uuid.","category":"55cea3189d28781700b7c935","createdAt":"2015-08-15T12:10:08.153Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"55ce9a298f17dc0d00da7c48","slug":"clients-uri-delete","sync_unique":"","title":"Remove Redirect URI from Client","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove Redirect URI from Client


Path Params

uuid:
required
string
UUID of the client
id:
required
integer
id of the URI to delete
Deletes key with given uuid for client with given uuid.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes key with given uuid for client with given uuid.
{"__v":0,"_id":"55cfa75a8d728e0d00cc5b06","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    \"7015cc51-3b09-45da-9cab-970d94b27c45\",\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/roles"},"body":"Lists all roles visible to the user.\n\nSee [Get Roles](doc:roles-get) for the fields available for `full-list-fields`.","category":"55cea31c9d28781700b7c936","createdAt":"2015-08-15T20:55:54.609Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"roles-list","sync_unique":"","title":"List Roles","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Roles


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all roles visible to the user. See [Get Roles](doc:roles-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all roles visible to the user. See [Get Roles](doc:roles-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55cfcc1c2096360d0071364a","api":{"settings":"","results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/roles/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"Name of the role","default":"","type":"string","name":"name","in":"body"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"the secret for the client","default":"","type":"string","name":"secret","in":"body"}],"url":"/roles"},"body":"Creates a new client","category":"55cea31c9d28781700b7c936","createdAt":"2015-08-15T23:32:44.761Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"roles-add","sync_unique":"","title":"Create Role","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate Role


Body Params

name:
required
string
Name of the role
secret:
string
the secret for the client
Creates a new client

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a new client
{"__v":0,"_id":"55cfa91b8d728e0d00cc5b08","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","default":"","desc":"UUID of the role","name":"uuid","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"metadata\": {},\n    \"name\": \"Users\",\n    \"permissions\": [\n        [\n            \"cloud\",\n            \"cloud\",\n            \"status\"\n        ],\n        [\n            \"cloud\",\n            \"datasets\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"hypervisors\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"ipranges\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"networks\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"orgs\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"packages\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"roles\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"users\",\n            \"list\"\n        ],\n        [\n            \"cloud\",\n            \"vms\",\n            \"create\"\n        ],\n        [\n            \"cloud\",\n            \"vms\",\n            \"list\"\n        ],\n        [\n            \"datasets\",\n            \"_\",\n            \"create\"\n        ],\n        [\n            \"hypervisors\",\n            \"_\",\n            \"create\"\n        ],\n        [\n            \"roles\",\n            \"ad29d0b8-111e-46f8-9d96-8ef32b17f9be\",\n            \"get\"\n        ]\n    ],\n    \"uuid\": \"ad29d0b8-111e-46f8-9d96-8ef32b17f9be\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/roles/:uuid"},"body":"Reads a role","category":"55cea31c9d28781700b7c936","createdAt":"2015-08-15T21:03:23.348Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"roles-get","sync_unique":"","title":"Get Role","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Role


Path Params

uuid:
required
string
UUID of the role
Reads a role

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a role
{"__v":0,"_id":"55cfa9a58d728e0d00cc5b0a","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","default":"false","desc":"UUID of the role","name":"uuid","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/roles/:uuid"},"body":"Deletes a role","category":"55cea31c9d28781700b7c936","createdAt":"2015-08-15T21:05:41.952Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"roles-delete","sync_unique":"","title":"Delete Role","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Role


Path Params

uuid:
required
stringfalse
UUID of the role
Deletes a role

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a role
{"__v":1,"_id":"55cfaa2a957dcd3500b3449e","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"PUT /api/2/roles/7df734a1-7332-45da-aa2a-9a3d856fa58a/permissions/groupings/35c4cfbb-057c-455b-93f8-e93205d44ada/get HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfb0748d728e0d00cc5b18","required":true,"desc":"UUID of the role","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29e98f17dc0d00da7ca4","required":true,"desc":"the permission to grant as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":201,"language":"text","code":""}]},"settings":"","url":"/roles/:uuid/permissions/:permission"},"body":"Grants a permission to a role.","category":"55cea31c9d28781700b7c936","createdAt":"2015-08-15T21:07:54.072Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"roles-permission-grant","sync_unique":"","title":"Grant Role Permissions","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putGrant Role Permissions


Path Params

uuid:
required
string
UUID of the role
permission:
required
string
the permission to grant as path i.e. `some/funky/permission`
Grants a permission to a role.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Grants a permission to a role.
{"__v":1,"_id":"55cfaa6e8d728e0d00cc5b0b","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"DELETE /api/2/roles/7df734a1-7332-45da-aa2a-9a3d856fa58a/permissions/groupings/35c4cfbb-057c-455b-93f8-e93205d44ada/get HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cfb0828d728e0d00cc5b19","required":true,"desc":"UUID of the role","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf29e98f17dc0d00da7ca4","required":true,"desc":"the permission to revoke as path i.e. `some/funky/permission`","default":"","type":"string","name":"permission","in":"path"}],"results":{"codes":[{"status":204,"language":"text","code":""}]},"settings":"","url":"/roles/:uuid/permissions/:permission"},"body":"Revokes a permission from a role.","category":"55cea31c9d28781700b7c936","createdAt":"2015-08-15T21:09:02.196Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"roles-permission-revoke","sync_unique":"","title":"Revoke Role Permissions","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRevoke Role Permissions


Path Params

uuid:
required
string
UUID of the role
permission:
required
string
the permission to revoke as path i.e. `some/funky/permission`
Revokes a permission from a role.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Revokes a permission from a role.
{"__v":0,"_id":"55cfb351957dcd3500b344a6","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    \"7015cc51-3b09-45da-9cab-970d94b27c45\",\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/orgs"},"body":"Lists all organizations visible to the user.\n\nSee [Get Org](doc:orgs-get) for the fields available for `full-list-fields`.","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T21:46:57.241Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-list","sync_unique":"","title":"List Organizations","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Organizations


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all organizations visible to the user. See [Get Org](doc:orgs-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all organizations visible to the user. See [Get Org](doc:orgs-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55cfcba63568180d0046238f","api":{"settings":"","results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nlocation: /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"the name of the organization","default":"false","type":"string","name":"name","in":"body"}],"url":"/orgs"},"body":"Creates a new organization.","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T23:30:46.882Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-add","sync_unique":"","title":"Create an Organization","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate an Organization


Body Params

name:
required
stringfalse
the name of the organization
Creates a new organization.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a new organization.
{"__v":0,"_id":"55cfcb002096360d00713647","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"metadata\": {},\n    \"name\": \"Test Org\",\n    \"triggers\": [],\n    \"uuid\": \"102747cc-b1a7-461f-b387-7fe93a7c00f5\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the org","default":"","type":"string","name":"uuid","in":"path"}],"url":"/orgs/:uuid"},"body":"Reads a org","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T23:28:00.884Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"get-organization","sync_unique":"","title":"Get Organization","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Organization


Path Params

uuid:
required
string
UUID of the org
Reads a org

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a org
{"__v":1,"_id":"55cf24c95c06ee2100ecd9f4","api":{"auth":"required","params":[{"_id":"55cfb0a05b49e71900262f49","required":true,"desc":"UUID of the organization","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf24c95c06ee2100ecd9f6","required":true,"desc":"Timestamp of the start of the accounting period","default":"","type":"int","name":"start","in":"query"},{"_id":"55cf24c95c06ee2100ecd9f5","required":true,"desc":"Timestamp of the end of the accounting period","default":"","type":"int","name":"end","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"action\": \"create\",\n        \"metadata\": {\n            \"package\": \"f33d78b0-423b-11e5-9408-4b0bc2b37a43\",\n            \"dataset\": \"008497c4-423c-11e5-a926-077d74874de7\"\n        },\n        \"resource\": \"f3121497-23ee-467c-bb3f-8b37cc41a9f6\",\n        \"timestamp\": 14211\n    },\n    {\n        \"action\": \"create\",\n        \"metadata\": {\n            \"package\": \"f33d78b0-423b-11e5-9408-4b0bc2b37a43\",\n            \"dataset\": \"1316cfd8-423c-11e5-8434-67fe3d93dfba\"\n        },\n        \"resource\": \"69b09fac-916b-42e1-9b91-9c68a077d4df\",\n        \"timestamp\": 15982\n    },\n    {\n        \"action\": \"create\",\n        \"metadata\": {\n            \"package\": \"187629d8-423c-11e5-9f87-dbc6b0f5fb32\",\n            \"dataset\": \"1de84612-423c-11e5-9a37-b388720c2b9c\"\n        },\n        \"resource\": \"cee67f6b-9a94-4356-ad20-4c8a3c40efbd\",\n        \"timestamp\": 21498\n    }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/orgs/:uuid/accounting"},"body":"This will grab accounting data for a period between `start` and `end`. The data presented will include all data points for every resource that existed in this timeframe not only those in the timeframe.\n\nThis allows reconstructing the entire situation during the time frame, including resources that were created before and destroyed after the period.","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T11:38:49.953Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-accounting","sync_unique":"","title":"Get Accounting Data","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Accounting Data


Path Params

uuid:
required
string
UUID of the organization

Query Params

start:
required
integer
Timestamp of the start of the accounting period
end:
required
integer
Timestamp of the end of the accounting period
This will grab accounting data for a period between `start` and `end`. The data presented will include all data points for every resource that existed in this timeframe not only those in the timeframe. This allows reconstructing the entire situation during the time frame, including resources that were created before and destroyed after the period.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This will grab accounting data for a period between `start` and `end`. The data presented will include all data points for every resource that existed in this timeframe not only those in the timeframe. This allows reconstructing the entire situation during the time frame, including resources that were created before and destroyed after the period.
{"__v":0,"_id":"55cfccef8d728e0d00cc5b43","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the org","default":"","type":"string","name":"uuid","in":"path"}],"url":"/orgs/:uuid"},"body":"Deletes an organization","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T23:36:15.111Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-delete","sync_unique":"","title":"Delete Organization","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Organization


Path Params

uuid:
required
string
UUID of the org
Deletes an organization

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes an organization
{"__v":0,"_id":"55cfceff2096360d0071364d","api":{"auth":"required","examples":{"codes":[{"name":"","code":"POST /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603/triggers/user_create HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json;charset=UTF-8\n\n{\n  \"action\": \"role_grant\",\n  \"base\": \"vms\",\n  \"permission\": [\"get\"],\n  \"target\": \"094a757b-84cd-46df-92bb-279a943fa489\"\n}","language":"http"},{"code":"POST /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603/triggers/user_create HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json;charset=UTF-8\n\n{\n  \"action\": \"join_role\",\n  \"target\": \"094a757b-84cd-46df-92bb-279a943fa489\"\n}","language":"http"}]},"params":[{"_id":"55cf261c46db442b00105bea","default":"false","desc":"UUID of the organization.","name":"uuid","ref":"","required":true,"type":"string","in":"path"},{"_id":"55cfceff2096360d00713651","default":"","desc":"Action to be performed, one of `join_role`, `join_org`, `role_grant` and `user_grant`.","name":"action","ref":"","required":true,"type":"string","in":"body"},{"_id":"55cfceff2096360d00713650","default":"","desc":"For `join_*` actions the role or org to be joined, for `*_grant` the role or user the permission to be granted to.","name":"target","ref":"","required":true,"type":"string","in":"body"},{"_id":"55cfceff2096360d0071364f","default":"","desc":"For `*_grant` triggers, the base of the permissions to be granted.","name":"base","ref":"","required":false,"type":"string","in":"body"},{"_id":"55cfceff2096360d0071364e","default":"","desc":"The rest of the permission to be granted","name":"permission","ref":"","required":false,"type":"array_string","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nlocation: /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603","name":""}]},"settings":"","url":"/orgs/:uuid/triggers/user_create"},"body":"This trigger is executed when a new user is created from someone who belongs to an org.","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T23:45:03.837Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-triggers-user_create","sync_unique":"","title":"Add Trigger when a User is Created","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAdd Trigger when a User is Created


Path Params

uuid:
required
stringfalse
UUID of the organization.

Body Params

action:
required
string
Action to be performed, one of `join_role`, `join_org`, `role_grant` and `user_grant`.
target:
required
string
For `join_*` actions the role or org to be joined, for `*_grant` the role or user the permission to be granted to.
base:
string
For `*_grant` triggers, the base of the permissions to be granted.
permission:
array of strings
The rest of the permission to be granted
This trigger is executed when a new user is created from someone who belongs to an org.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This trigger is executed when a new user is created from someone who belongs to an org.
{"__v":0,"_id":"55cfcf418d728e0d00cc5b44","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"POST /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603/triggers/dataset_create HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json;charset=UTF-8\n\n{\n  \"action\": \"role_grant\",\n  \"base\": \"datasets\",\n  \"permission\": [\"get\"],\n  \"target\": \"094a757b-84cd-46df-92bb-279a943fa489\"\n}","name":""}]},"params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the organization.","default":"false","type":"string","name":"uuid","in":"path"},{"_id":"55cfceff2096360d00713651","required":true,"desc":"Action to be performed, one of `join_role`, `join_org`, `role_grant` and `user_grant`.","default":"","type":"string","name":"action","in":"body"},{"_id":"55cfceff2096360d00713650","required":true,"desc":"For `join_*` actions the role or org to be joined, for `*_grant` the role or user the permission to be granted to.","default":"","type":"string","name":"target","in":"body"},{"_id":"55cfceff2096360d0071364f","required":false,"desc":"For `*_grant` triggers, the base of the permissions to be granted.","default":"","type":"string","name":"base","in":"body"},{"_id":"55cfceff2096360d0071364e","required":false,"desc":"The rest of the permission to be granted","default":"","type":"array_string","name":"permission","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nlocation: /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603","name":""}]},"settings":"","url":"/orgs/:uuid/triggers/dataset_create"},"body":"This trigger is executed when a new dataset is created from someone who belongs to this org.","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T23:46:09.974Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-triggers-dataset_create","sync_unique":"","title":"Add Trigger when a Dataset is Created","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAdd Trigger when a Dataset is Created


Path Params

uuid:
required
stringfalse
UUID of the organization.

Body Params

action:
required
string
Action to be performed, one of `join_role`, `join_org`, `role_grant` and `user_grant`.
target:
required
string
For `join_*` actions the role or org to be joined, for `*_grant` the role or user the permission to be granted to.
base:
string
For `*_grant` triggers, the base of the permissions to be granted.
permission:
array of strings
The rest of the permission to be granted
This trigger is executed when a new dataset is created from someone who belongs to this org.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This trigger is executed when a new dataset is created from someone who belongs to this org.
{"__v":0,"_id":"55cfd08c2096360d00713652","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"POST /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603/triggers/vm_create HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json;charset=UTF-8\n\n{\n  \"action\": \"role_grant\",\n  \"base\": \"datasets\",\n  \"permission\": [\"get\"],\n  \"target\": \"094a757b-84cd-46df-92bb-279a943fa489\"\n}","name":""}]},"params":[{"_id":"55cf261c46db442b00105bea","default":"false","desc":"UUID of the organization.","name":"uuid","ref":"","required":true,"type":"string","in":"path"},{"_id":"55cfceff2096360d00713651","default":"","desc":"Action to be performed, one of `join_role`, `join_org`, `role_grant` and `user_grant`.","name":"action","ref":"","required":true,"type":"string","in":"body"},{"_id":"55cfceff2096360d00713650","default":"","desc":"For `join_*` actions the role or org to be joined, for `*_grant` the role or user the permission to be granted to.","name":"target","ref":"","required":true,"type":"string","in":"body"},{"_id":"55cfceff2096360d0071364f","default":"","desc":"For `*_grant` triggers, the base of the permissions to be granted.","name":"base","ref":"","required":false,"type":"string","in":"body"},{"_id":"55cfceff2096360d0071364e","default":"","desc":"The rest of the permission to be granted","name":"permission","ref":"","required":false,"type":"array_string","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nlocation: /api/2/orgs/72b3cdb0-7647-478b-906e-28a59f09c603","name":""}]},"settings":"","url":"/orgs/:uuid/triggers/vm_create"},"body":"This trigger is executed when a new VM is created by someone who belongs to this org.","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T23:51:40.995Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"project":"55ce9a298f17dc0d00da7c48","slug":"orgs-triggers-vm_create","sync_unique":"","title":"Add Trigger when a VM is Created","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAdd Trigger when a VM is Created


Path Params

uuid:
required
stringfalse
UUID of the organization.

Body Params

action:
required
string
Action to be performed, one of `join_role`, `join_org`, `role_grant` and `user_grant`.
target:
required
string
For `join_*` actions the role or org to be joined, for `*_grant` the role or user the permission to be granted to.
base:
string
For `*_grant` triggers, the base of the permissions to be granted.
permission:
array of strings
The rest of the permission to be granted
This trigger is executed when a new VM is created by someone who belongs to this org.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This trigger is executed when a new VM is created by someone who belongs to this org.
{"__v":0,"_id":"55cfcd443568180d00462390","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the org","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cfcd443568180d00462391","required":true,"desc":"trigger to be deleted","default":"","type":"int","name":"trigger-id","in":"path"}],"url":"/orgs/:uuid/triggers/:trigger-id"},"body":"Deletes a trigger from an organization","category":"55cea3389d28781700b7c937","createdAt":"2015-08-15T23:37:40.021Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55ce9a298f17dc0d00da7c48","slug":"delete-trigger-from-organization","sync_unique":"","title":"Delete Trigger from Organization","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Trigger from Organization


Path Params

uuid:
required
string
UUID of the org
trigger-id:
required
integer
trigger to be deleted
Deletes a trigger from an organization

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a trigger from an organization
{"__v":0,"_id":"55d55d9b5082980d0009c99a","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/hypervisors"},"body":"Lists all hypervisors visible to the user.\n\nSee [Get Hypervisor](doc:hypervisors-get) for the fields available for `full-list-fields`.","category":"55cea343db457c210076e5a3","createdAt":"2015-08-20T04:54:51.328Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"hypervisors-list","sync_unique":"","title":"List Hypervisors","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Hypervisors


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all hypervisors visible to the user. See [Get Hypervisor](doc:hypervisors-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all hypervisors visible to the user. See [Get Hypervisor](doc:hypervisors-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55d55e7c5082980d0009c99b","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"alias\": \"\",\n    \"characteristics\": [],\n    \"etherstubs\": [],\n    \"host\": \"192.168.1.22\",\n    \"metadata\": [],\n    \"networks\": [\n        \"admin\"\n    ],\n    \"path\": [],\n    \"pools\": {\n        \"zones\": {\n            \"dedup\": 100,\n            \"free\": 272376,\n            \"health\": \"ONLINE\",\n            \"size\": 305152,\n            \"used\": 32776\n        }\n    },\n    \"port\": 4200,\n    \"resources\": {\n        \"free-memory\": 16356,\n        \"l1hits\": 24367455,\n        \"l1miss\": 1843639,\n        \"l1size\": 3945,\n        \"l2hits\": 0,\n        \"l2miss\": 0,\n        \"l2size\": 0,\n        \"provisioned-memory\": 0,\n        \"reserved-memory\": 0,\n        \"total-memory\": 16356\n    },\n    \"services\": {\n        \"lrc:/etc/rc2_d/S20sysetup\": \"legacy_run\",\n        \"lrc:/etc/rc2_d/S47pppd\": \"legacy_run\",\n        \"lrc:/etc/rc2_d/S81dodatadm_udaplt\": \"legacy_run\",\n        \"lrc:/etc/rc2_d/S89PRESERVE\": \"legacy_run\",\n        \"svc:/milestone/devices:default\": \"online\",\n        \"svc:/milestone/multi-user-server:default\": \"online\",\n        \"svc:/milestone/multi-user:default\": \"online\",\n        \"svc:/milestone/name-services:default\": \"online\",\n//...\n        \"svc:/system/utmp:default\": \"online\",\n        \"svc:/system/vtdaemon:default\": \"online\",\n        \"svc:/system/zones:default\": \"online\"\n    },\n    \"sysinfo\": {\n        \"Boot Parameters\": {\n            \"console\": \"text\",\n            \"smartos\": \"true\"\n        },\n        \"Boot Time\": \"1439417554\",\n        \"CPU Physical Cores\": 1,\n        \"CPU Total Cores\": 4,\n        \"CPU Type\": \"Intel(R) Xeon(R) CPU E3-1220 V2 @ 3.10GHz\",\n        \"CPU Virtualization\": \"vmx\",\n        \"Disks\": {\n            \"c1t0d0\": {\n                \"Size in GB\": 320\n            },\n            \"c1t1d0\": {\n                \"Size in GB\": 320\n            }\n        },\n        \"HW Family\": \"To be filled by O.E.M.\",\n        \"HW Version\": \"0123456789\",\n        \"Hostname\": \"00-25-90-a6-3b-c7\",\n        \"Link Aggregations\": {},\n        \"Live Image\": \"20150806T063417Z\",\n        \"Manufacturer\": \"Supermicro\",\n        \"MiB of Memory\": \"16356\",\n        \"Network Interfaces\": {\n            \"e1000g0\": {\n                \"Link Status\": \"up\",\n                \"MAC Address\": \"00:25:90:a6:3b:c7\",\n                \"NIC Names\": [\n                    \"admin\"\n                ],\n                \"ip4addr\": \"192.168.1.22\"\n            },\n            \"e1000g1\": {\n                \"Link Status\": \"down\",\n                \"MAC Address\": \"00:25:90:a6:3b:c6\",\n                \"NIC Names\": [],\n                \"ip4addr\": \"\"\n            }\n        },\n        \"Product\": \"X9SCL/X9SCM\",\n        \"SDC Version\": \"7.0\",\n        \"SKU Number\": \"To be filled by O.E.M.\",\n        \"Serial Number\": \"0123456789\",\n        \"Setup\": \"false\",\n        \"System Type\": \"SunOS\",\n        \"UUID\": \"002590a6-3bc6-0607-0025-90a63bc60e0f\",\n        \"VM Capable\": true,\n        \"Virtual Network Interfaces\": {},\n        \"Zpool\": \"zones\",\n        \"Zpool Creation\": 1365567446,\n        \"Zpool Disks\": \"c1t0d0,c1t1d0\",\n        \"Zpool Profile\": \"mirror\",\n        \"Zpool Size in GiB\": 288\n    },\n    \"uuid\": \"\",\n    \"version\": \"test-c5ed54f, Tue Aug 18 15:00:36 2015 +0200\",\n    \"virtualisation\": [\n        \"zone\",\n        \"kvm\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the hypervisor","default":"","type":"string","name":"uuid","in":"path"}],"url":"/hypervisors/:uuid"},"body":"Reads a Hypervisor","category":"55cea343db457c210076e5a3","createdAt":"2015-08-20T04:58:36.473Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"hypervisors-get","sync_unique":"","title":"Get Hypervisor","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Hypervisor


Path Params

uuid:
required
string
UUID of the hypervisor
Reads a Hypervisor

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a Hypervisor
{"__v":0,"_id":"55d55eb74fe64521006d5a95","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"auth":"required","params":[{"_id":"55cfaea05b49e71900262f45","required":true,"desc":"UUID of the hypervisor","default":"","type":"string","name":"uuid","in":"path"}],"url":"/hypervisors/:uuid"},"body":"Deletes a Hypervisor. Every VM still residing on this hypervisor will either be put in **limbo** when at  least one full backup exists, or be deleted if not.","category":"55cea343db457c210076e5a3","createdAt":"2015-08-20T04:59:35.373Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"hypervisors-delete","sync_unique":"","title":"Delete Hypervisor","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Hypervisor


Path Params

uuid:
required
string
UUID of the hypervisor
Deletes a Hypervisor. Every VM still residing on this hypervisor will either be put in **limbo** when at least one full backup exists, or be deleted if not.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a Hypervisor. Every VM still residing on this hypervisor will either be put in **limbo** when at least one full backup exists, or be deleted if not.
{"__v":0,"_id":"55d55f68988e130d000b3f8a","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"PUT /api/2/hypervisors/cae242d0-fb7a-4a37-82c7-dcc73ce0fa8d/characteristics HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json\n\n{\"color\": \"blue\"}","name":""}]},"params":[{"_id":"55cfadf05b49e71900262f43","required":true,"desc":"UUID of the hypervisor","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2da18f17dc0d00da7ca9","required":false,"desc":"URL path prefix of the characteristic","default":"","type":"string","name":"path","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","url":"/hypervisors/:uuid/characteristics/:path"},"body":"Sets a hypervisor characteristic, this can be later used on rules to match against.","category":"55cea343db457c210076e5a3","createdAt":"2015-08-20T05:02:32.942Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"hypervisors-characteristics-add","sync_unique":"","title":"Set Hypervisor Characteristic","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putSet Hypervisor Characteristic


Path Params

uuid:
required
string
UUID of the hypervisor
path:
string
URL path prefix of the characteristic
Sets a hypervisor characteristic, this can be later used on rules to match against.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Sets a hypervisor characteristic, this can be later used on rules to match against.
{"__v":1,"_id":"55d55fb7988e130d000b3f8b","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"DELETE /api/2/hypervisors/2ca285a3-05a8-4ca6-befd-78fa994929ab/characteristics/color/front HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json","name":""}]},"params":[{"_id":"55cfae1d8d728e0d00cc5b0c","required":true,"desc":"UUID of the hypervisor","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2da18f17dc0d00da7ca9","required":false,"desc":"URL path to characteristic to delete","default":"","type":"string","name":"path","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","url":"/hypervisors/:uuid/characteristics/:path"},"body":"Removes a characteristic from a hypervisor","category":"55cea343db457c210076e5a3","createdAt":"2015-08-20T05:03:51.186Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"hypervisors-characteristics-delete","sync_unique":"","title":"Delete Hypervisor Characteristic","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Hypervisor Characteristic


Path Params

uuid:
required
string
UUID of the hypervisor
path:
string
URL path to characteristic to delete
Removes a characteristic from a hypervisor

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Removes a characteristic from a hypervisor
{"__v":0,"_id":"55f2ca8ccb01c71900c8e200","api":{"examples":{"codes":[{"language":"http","code":"PUT /api/2/hypervisors/cae242d0-fb7a-4a37-82c7-dcc73ce0fa8d/characteristics HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nContent-Type: application/json\n\n{\"color\": \"blue\"}","name":""}]},"results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cfadf05b49e71900262f43","required":true,"desc":"UUID of the hypervisor","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2da18f17dc0d00da7ca9","required":true,"desc":"New alias of the hypervisor","default":"","type":"string","name":"alias","in":"body"}],"url":"/hypervisors/:uuid/config"},"body":"Sets a configuration / alias of the hypervisor.","category":"55cea343db457c210076e5a3","createdAt":"2015-09-11T12:35:24.905Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55ce9a298f17dc0d00da7c48","slug":"hypervisors-config-set","sync_unique":"","title":"Set Hypervisor Configuration","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putSet Hypervisor Configuration


Path Params

uuid:
required
string
UUID of the hypervisor

Body Params

alias:
required
string
New alias of the hypervisor
Sets a configuration / alias of the hypervisor.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Sets a configuration / alias of the hypervisor.
{"__v":0,"_id":"55d093698d728e0d00cc5b8d","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/vms"},"body":"Lists all VMs visible to the user.\n\nSee [Get VM](doc:vms-get) for the fields available for `full-list-fields`.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T13:43:05.883Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-list","sync_unique":"","title":"List VMs","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList VMs


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all VMs visible to the user. See [Get VM](doc:vms-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all VMs visible to the user. See [Get VM](doc:vms-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55d098178d728e0d00cc5b91","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"POST /api/2/vms HTTP/1.1\nAccept: application/json\nContent-Type: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\n\n {\n  \"package\": \"aa77ce44-cdb6-4e59-8f64-97f65b7eba2d\",\n  \"dataset\": \"d34c301e-10c3-11e4-9b79-5f67ca448df0\",\n  \"config\":\n  {\n   \"networks\":  {\"net0\":\"a3850354-d356-4bb7-a9ae-a41387702ad5\"},\n   \"hostnames\": {\"net0\":\"vm1\"},\n   \"metadata\":  {},\n   \"alias\": \"vm1\",\n   \"hostname\":  \"vm1\",\n   \"requirements\":  [],\n   \"autoboot\":  true\n  }\n }","name":""}]},"params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the package to use for the VM","default":"","type":"string","name":"package","in":"body"},{"_id":"55d098178d728e0d00cc5b93","required":true,"desc":"UUID of the dataset to use for the VM","default":"","type":"string","name":"dataset","in":"body"},{"_id":"55d098178d728e0d00cc5b92","required":true,"desc":"Object with aditional","default":"","type":"object","name":"config","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nlocation: /api/2/vms/72b3cdb0-7647-478b-906e-28a59f09c603","name":""}]},"settings":"","url":"/vms"},"body":"This request queues a new VM creation. Most of the keys in `config` are self-explanatory the one noteworthy is `networks` however. It is a map of nics (provided by the dataset) to UUIDs of **networks** (not ip ranges!).","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T14:03:03.276Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-create","sync_unique":"","title":"Create VM","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate VM


Body Params

package:
required
string
UUID of the package to use for the VM
dataset:
required
string
UUID of the dataset to use for the VM
config:
required
object
Object with aditional
This request queues a new VM creation. Most of the keys in `config` are self-explanatory the one noteworthy is `networks` however. It is a map of nics (provided by the dataset) to UUIDs of **networks** (not ip ranges!).

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This request queues a new VM creation. Most of the keys in `config` are self-explanatory the one noteworthy is `networks` however. It is a map of nics (provided by the dataset) to UUIDs of **networks** (not ip ranges!).
{"__v":0,"_id":"55d095ad2096360d007137a8","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","default":"","desc":"UUID of the VM","name":"uuid","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"alias\": \"\",\n    \"backups\": [\n        {\n            \"comment\": \"ex\",\n            \"files\": [\n                \"bd1d9ed0-00e8-483a-aae0-b9436c027e05/6e7da878-00ff-4edc-ad87-f51c0da16bbe\"\n            ],\n            \"local\": true,\n            \"pending\": false,\n            \"sha1\": \"49c74c48cedb8543b07b795d57797176deef5ed0\",\n            \"size\": 312442865,\n            \"state\": \"completed\",\n            \"timestamp\": 1411482863814152,\n            \"uuid\": \"6e7da878-00ff-4edc-ad87-f51c0da16bbe\",\n            \"xml\": true\n        }\n    ],\n    \"config\": {\n        \"alias\": \"fifo01\",\n        \"autoboot\": true,\n        \"cpu_cap\": 400,\n        \"cpu_shares\": 100,\n        \"created_at\": \"2015-04-26T11:29:31.297Z\",\n        \"dataset\": \"75d1b5d8-e509-11e4-a51f-2fd538c62d87\",\n        \"dns_domain\": \"local\",\n        \"hostname\": \"fifo01\",\n        \"max_swap\": 6442450944,\n        \"networks\": [\n            {\n                \"gateway\": \"192.168.10.1\",\n                \"interface\": \"net1\",\n                \"ip\": \"192.168.10.44\",\n                \"mac\": \"12:1e:96:73:04:17\",\n                \"netmask\": \"255.255.255.0\",\n                \"nic_tag\": \"admin\"\n            },\n            {\n                \"gateway\": \"192.168.1.1\",\n                \"interface\": \"net0\",\n                \"ip\": \"192.168.1.41\",\n                \"mac\": \"12:1e:96:73:04:14\",\n                \"netmask\": \"255.255.255.0\",\n                \"nic_tag\": \"admin\",\n                \"primary\": \"true\"\n            }\n        ],\n        \"quota\": 40,\n        \"ram\": 6144,\n        \"resolvers\": [\n            \"8.8.8.8\",\n            \"8.8.4.4\"\n        ],\n        \"state\": \"running\",\n        \"type\": \"zone\",\n        \"zfs_io_priority\": 100,\n        \"zonepath\": \"/zones/4fdfbd27-c51b-459f-9d9f-623ece60a4ce\"\n    },\n    \"dataset\": \"\",\n    \"fw_rules\": [],\n    \"groupings\": [],\n    \"hypervisor\": \"d1a03736-303c-41c1-9960-78b2b9a6722d\",\n    \"info\": [],\n    \"log\": [],\n    \"metadata\": [],\n    \"network_mappings\": [],\n    \"owner\": \"\",\n    \"package\": \"\",\n    \"services\": {\n        \"lrc:/etc/rc2_d/S99net_tune\": \"legacy_run\",\n        \"svc:/dalmatiner/db:default\": \"disabled\",\n        \"svc:/dalmatiner/fe:default\": \"disabled\",\n        \"svc:/leofs/gateway:default\": \"disabled\",\n        \"svc:/milestone/devices:default\": \"online\",\n        \"svc:/milestone/multi-user-server:default\": \"online\",\n        \"svc:/milestone/multi-user:default\": \"online\",\n        \"svc:/milestone/name-services:default\": \"online\",\n        //...\n        \"svc:/milestone/network:default\": \"online\",\n        \"svc:/system/svc/global:default\": \"disabled\",\n        \"svc:/system/svc/restarter:default\": \"online\",\n        \"svc:/system/sysidtool:net\": \"online\",\n        \"svc:/system/sysidtool:system\": \"online\",\n        \"svc:/system/system-log:default\": \"online\",\n        \"svc:/system/utmp:default\": \"online\",\n        \"svc:/system/vtdaemon:default\": \"disabled\",\n        \"svc:/system/zoneinit:default\": \"online\"\n    },\n    \"snapshots\": [\n        {\n            \"comment\": \"ex\",\n            \"state\": \"completed\",\n            \"timestamp\": 1411482795708708,\n            \"uuid\": \"9fc74869-0d4b-48cb-85bb-054813ac18e8\"\n        }\n    ],\n    \"state\": \"running\",\n    \"deleting\": false,\n    \"creating\": false,\n    \"uuid\": \"4fdfbd27-c51b-459f-9d9f-623ece60a4ce\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid"},"body":"Reads a VM","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T13:52:45.614Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"get-vm","sync_unique":"","title":"Get VM","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet VM


Path Params

uuid:
required
string
UUID of the VM
Reads a VM

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a VM
{"__v":0,"_id":"55f2f454d1c4c7170033dfb7","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"n\": \"cpu-usage\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"cpu-effective\",\n        \"r\": 1000,\n        \"v\": [\n            100, 100, 100, 100, // ...\n        ]\n    },\n    {\n        \"n\": \"cpu-nwait\",\n        \"r\": 1000,\n        \"v\": [\n            100, 100, 100, 100, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-usage\",\n        \"r\": 1000,\n        \"v\": [\n            31, 31, 31, 31, 31, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-value\",\n        \"r\": 1000,\n        \"v\": [\n            1024, 1024, 1024, 1024, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-usage\",\n        \"r\": 1000,\n        \"v\": [\n            31, 31, 31, 31, 31, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-value\",\n        \"r\": 1000,\n        \"v\": [\n            1024, 1024, 1024, 1024, // ...\n        ]\n    },\n    {\n        \"n\": \"net-send-ops-net0\",\n        \"r\": 1000,\n        \"v\": [\n             0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"net-recv-ops-net0\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"net-send-kb-net0\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"net-recv-kb-net0\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-read-kb\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-write-kb\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-read-ops\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-write-ops\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    }\n]","name":""},{"status":400,"language":"text","code":"bad resolution","name":""},{"status":503,"language":"text","code":"failed to connect to database"}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"}],"url":"/vms/:uuid/metrics"},"body":"Reads a VM","category":"55cea3499d28781700b7c938","createdAt":"2015-09-11T15:33:40.149Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-metrics","sync_unique":"","title":"Get VM Metrics","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet VM Metrics


Path Params

uuid:
required
string
UUID of the VM
Reads a VM

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a VM
{"__v":0,"_id":"55d09a508d728e0d00cc5b94","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","default":"","desc":"UUID of the vm","name":"uuid","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid"},"body":"Deletes a VM.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T14:12:32.668Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-delete","sync_unique":"","title":"Delete VM","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete VM


Path Params

uuid:
required
string
UUID of the vm
Deletes a VM.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a VM.
{"__v":0,"_id":"55d099b707d62c17008b016d","api":{"settings":"","results":{"codes":[{"status":201,"language":"http","code":"HTTP/1.1 201 Created\nvary: accept","name":""}]},"examples":{"codes":[{"language":"http","code":"POST /api/2/vms/dry_run HTTP/1.1\nAccept: application/json\nContent-Type: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\n\n {\n  \"package\": \"aa77ce44-cdb6-4e59-8f64-97f65b7eba2d\",\n  \"dataset\": \"d34c301e-10c3-11e4-9b79-5f67ca448df0\",\n  \"config\":\n  {\n   \"networks\":  {\"net0\":\"a3850354-d356-4bb7-a9ae-a41387702ad5\"},\n   \"metadata\":  {},\n   \"alias\": \"vm1\",\n   \"hostname\":  \"vm1\",\n   \"requirements\":  [],\n   \"autoboot\":  true\n  }\n }","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the package to use for the VM","default":"","type":"string","name":"package","in":"body"},{"_id":"55d098178d728e0d00cc5b93","required":true,"desc":"UUID of the dataset to use for the VM","default":"","type":"string","name":"dataset","in":"body"},{"_id":"55d098178d728e0d00cc5b92","required":true,"desc":"Object with aditional","default":"","type":"object","name":"config","in":"body"}],"url":"/vms/dry_run"},"body":"This is the same as the normal [Create an VM](doc:vms-create) request however it stops before sending the request to the hypervisor. So no VM is ever created however it does check if the VM could be created.\n\nIt needs to be noted that both false positives and false negatives can occur so this is a good approximation but should not be taken as a definite. False positive are more likely then false negatives.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T14:09:59.928Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-dry_run","sync_unique":"","title":"Dry run VM creation","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putDry run VM creation


Body Params

package:
required
string
UUID of the package to use for the VM
dataset:
required
string
UUID of the dataset to use for the VM
config:
required
object
Object with aditional
This is the same as the normal [Create an VM](doc:vms-create) request however it stops before sending the request to the hypervisor. So no VM is ever created however it does check if the VM could be created. It needs to be noted that both false positives and false negatives can occur so this is a good approximation but should not be taken as a definite. False positive are more likely then false negatives.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is the same as the normal [Create an VM](doc:vms-create) request however it stops before sending the request to the hypervisor. So no VM is ever created however it does check if the VM could be created. It needs to be noted that both false positives and false negatives can occur so this is a good approximation but should not be taken as a definite. False positive are more likely then false negatives.
{"__v":1,"_id":"55cf2f078f17dc0d00da7caa","api":{"auth":"required","params":[{"_id":"55d09ecc2096360d007137b5","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2f078f17dc0d00da7cac","required":true,"desc":"One of `start`, `stop` or `reboot`.","default":"","type":"string","name":"action","in":"body"},{"_id":"55cf2f078f17dc0d00da7cab","required":false,"desc":"Used for `stop` and `reboot` determines if the shutdown should be graceful or forced","default":"false","type":"boolean","name":"force","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/state"},"body":"Initiates a VM state change for the VM.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:22:31.629Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-state","sync_unique":"","title":"Change VM Power State","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putChange VM Power State


Path Params

uuid:
required
string
UUID of the VM

Body Params

action:
required
string
One of `start`, `stop` or `reboot`.
force:
booleanfalse
Used for `stop` and `reboot` determines if the shutdown should be graceful or forced
Initiates a VM state change for the VM.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Initiates a VM state change for the VM.
{"__v":1,"_id":"55cf2f425c06ee2100ecd9ff","api":{"auth":"required","params":[{"_id":"55d09ede07d62c17008b0173","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2f078f17dc0d00da7cac","required":true,"desc":"UUID of the new package","default":"","type":"string","name":"package","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/package"},"body":"Resizes the VM to a new package.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:23:30.694Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-resize","sync_unique":"","title":"Resize VM","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putResize VM


Path Params

uuid:
required
string
UUID of the VM

Body Params

package:
required
string
UUID of the new package
Resizes the VM to a new package.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Resizes the VM to a new package.
{"__v":1,"_id":"55cf2fdf5c06ee2100ecda00","api":{"auth":"required","params":[{"_id":"55d09ef907d62c17008b0174","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf2f078f17dc0d00da7cac","required":false,"desc":"the hostname of the VM","default":"","type":"string","name":"hostname","in":"body"},{"_id":"55cf2fdf5c06ee2100ecda03","required":false,"desc":"the VM’s alias","default":"","type":"string","name":"alias","in":"body"},{"_id":"55cf2fdf5c06ee2100ecda02","required":false,"desc":"list of VM’s resolvers","default":"","type":"array_string","name":"resolvers","in":"body"},{"_id":"55cf2fdf5c06ee2100ecda01","required":false,"desc":"weather the vm boots automatically or not","default":"","type":"boolean","name":"autoboot","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/config"},"body":"Updates the config for the VM","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:26:07.020Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-config","sync_unique":"","title":"Update VM Config","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putUpdate VM Config


Path Params

uuid:
required
string
UUID of the VM

Body Params

hostname:
string
the hostname of the VM
alias:
string
the VM’s alias
resolvers:
array of strings
list of VM’s resolvers
autoboot:
boolean
weather the vm boots automatically or not
Updates the config for the VM

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Updates the config for the VM
{"__v":1,"_id":"55cf302b5c06ee2100ecda04","api":{"auth":"required","params":[{"_id":"55d09f122096360d007137b6","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"New owner","default":"","type":"string","name":"org","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/owner"},"body":"Changes the owner of the VM","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:27:23.082Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-owner","sync_unique":"","title":"Change VM Ownership","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putChange VM Ownership


Path Params

uuid:
required
string
UUID of the VM

Body Params

org:
required
string
New owner
Changes the owner of the VM

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Changes the owner of the VM
{"__v":1,"_id":"55cf3077c27f7d3500da1e98","api":{"auth":"required","params":[{"_id":"55d09f2907d62c17008b0175","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"Network of the new NIC","default":"","type":"string","name":"network","in":"body"}],"results":{"codes":[{"status":303,"language":"json","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/vms/2ca285a3-05a8-4ca6-befd-78fa994929ab","name":""},{"status":412,"language":"http","code":"HTTP/1.1 412 Precondition Failed\nconnection: close\nserver: Cowboy\ndate: Sun, 23 Aug 2015 07:11:58 GMT\ncontent-length: 10\naccess-control-allow-origin: *\naccess-control-allow-headers: Authorization, content-type, x-snarl-token, x-full-list, x-full-list-fields\naccess-control-expose-headers: x-snarl-token, x-full-list, x-full-list-fields\naccess-control-allow-credentials: true\ncontent-type: application/json\nvary: accept\n\nVM Running","name":"Precondition Failed"}]},"settings":"","url":"/vms/:uuid/nics"},"body":"Adds a new NIC to a VM.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:28:39.314Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":10,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-nic-add","sync_unique":"","title":"Add NIC to VM","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAdd NIC to VM


Path Params

uuid:
required
string
UUID of the VM

Body Params

network:
required
string
Network of the new NIC
Adds a new NIC to a VM.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Adds a new NIC to a VM.
{"__v":1,"_id":"55cf30bb8f17dc0d00da7cad","api":{"auth":"required","params":[{"_id":"55d09f3e8d728e0d00cc5b9c","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"MAC address of the NIC to remove","default":"","type":"string","name":"mac","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/nis/:mac"},"body":"Removes a NIC from a VM.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:29:47.925Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":11,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-nic-delete","sync_unique":"","title":"Remove NIC from VM","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove NIC from VM


Path Params

uuid:
required
string
UUID of the VM
mac:
required
string
MAC address of the NIC to remove
Removes a NIC from a VM.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Removes a NIC from a VM.
{"__v":3,"_id":"55cf315dc27f7d3500da1e99","api":{"auth":"required","params":[{"_id":"55d09f522096360d007137b7","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"The action of the rule, either `block` or `allow`.","default":"","type":"string","name":"action","in":"body"},{"_id":"55cf31aa8f17dc0d00da7cb0","required":true,"desc":"The direction of the rule, either `inbound` or `outbound`.","default":"","type":"string","name":"direction","in":"body"},{"_id":"55cf31aa8f17dc0d00da7caf","required":true,"desc":"The other side of the rule","default":"","type":"mixed","name":"target","in":"body"},{"_id":"55cf32715c06ee2100ecda08","required":true,"desc":"The protocol to match, either `tcp`, `udp` or `icmp`.","default":"","type":"string","name":"protocol","in":"body"},{"_id":"55cf32715c06ee2100ecda07","required":true,"desc":"The filter to narrow down the match.","default":"","type":"mixed","name":"filters","in":"body"}],"results":{"codes":[{"status":303,"language":"json","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/vms/2ca285a3-05a8-4ca6-befd-78fa994929ab","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/fw_rules"},"body":"Creates a firewall rule of the VM. One side is always the current VM the other side can be defined in `target`.\n\n## target\n\n* The string `\"all\"` for all targets.\n* An object with the key `ip` and the IP address in a string as value for a single IP target.\n* An object with the key `subnet` with the base address of the subnet as string, and key `mask` with a number indicating the relevant bits as value for a subnet as target.\n\n## filters\n\n* A list of one or more ports for UDP and TCP.\n* The string `\"all\"` for UDP and TCP.\n* A list of objects containing the key `type` and optionally `code`, both with numbers as values for ICMP.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:32:29.650Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":12,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-fw-add","sync_unique":"","title":"Add Firewall Rule to VM","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postAdd Firewall Rule to VM


Path Params

uuid:
required
string
UUID of the VM

Body Params

action:
required
string
The action of the rule, either `block` or `allow`.
direction:
required
string
The direction of the rule, either `inbound` or `outbound`.
target:
required
mixed
The other side of the rule
protocol:
required
string
The protocol to match, either `tcp`, `udp` or `icmp`.
filters:
required
mixed
The filter to narrow down the match.
Creates a firewall rule of the VM. One side is always the current VM the other side can be defined in `target`. ## target * The string `"all"` for all targets. * An object with the key `ip` and the IP address in a string as value for a single IP target. * An object with the key `subnet` with the base address of the subnet as string, and key `mask` with a number indicating the relevant bits as value for a subnet as target. ## filters * A list of one or more ports for UDP and TCP. * The string `"all"` for UDP and TCP. * A list of objects containing the key `type` and optionally `code`, both with numbers as values for ICMP.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a firewall rule of the VM. One side is always the current VM the other side can be defined in `target`. ## target * The string `"all"` for all targets. * An object with the key `ip` and the IP address in a string as value for a single IP target. * An object with the key `subnet` with the base address of the subnet as string, and key `mask` with a number indicating the relevant bits as value for a subnet as target. ## filters * A list of one or more ports for UDP and TCP. * The string `"all"` for UDP and TCP. * A list of objects containing the key `type` and optionally `code`, both with numbers as values for ICMP.
{"__v":1,"_id":"55cf3311c27f7d3500da1e9a","api":{"auth":"required","params":[{"_id":"55d09f692096360d007137b8","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"The rule to remove.","default":"","type":"int","name":"rule_id","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/fw_rules/:rule_id"},"body":"Deletes a firewall rule for the VM uuid, the rule id can be found in the `rule_id` field of the rule.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-15T12:39:45.740Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":13,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-fw-delete","sync_unique":"","title":"Remove Firewall Rule from VM","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postRemove Firewall Rule from VM


Path Params

uuid:
required
string
UUID of the VM
rule_id:
required
integer
The rule to remove.
Deletes a firewall rule for the VM uuid, the rule id can be found in the `rule_id` field of the rule.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a firewall rule for the VM uuid, the rule id can be found in the `rule_id` field of the rule.
{"__v":1,"_id":"55d09bab07d62c17008b016e","api":{"auth":"required","examples":{"codes":[{"language":"text","code":""}]},"params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d098178d728e0d00cc5b93","required":true,"desc":"Comment for the snapshot","default":"","type":"string","name":"comment","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nlocation: /api/2/vms/72b3cdb0-7647-478b-906e-28a59f09c603","name":""}]},"settings":"","url":"/vms/:uuid/snapshots"},"body":"Creates a ZFS snapshot of the VM","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T14:18:19.135Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":14,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-snapshots-create","sync_unique":"","title":"Snapshot a VM","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postSnapshot a VM


Path Params

uuid:
required
string
UUID of the VM

Body Params

comment:
required
string
Comment for the snapshot
Creates a ZFS snapshot of the VM

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a ZFS snapshot of the VM
{"__v":0,"_id":"55d09da08d728e0d00cc5b98","api":{"auth":"required","params":[{"_id":"55cf302b5c06ee2100ecda05","default":"","desc":"UUID of the VM","name":"uuid","required":true,"type":"string","in":"path"},{"_id":"55d09da08d728e0d00cc5b9a","required":true,"desc":"UUID of the snapshot to restore","default":"","type":"string","name":"snap-id","in":"path"},{"_id":"55d09da08d728e0d00cc5b99","default":"rollback","desc":"needs to be `rollback`","name":"action","required":true,"type":"string","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/snapshots/:snap-id"},"body":"This will roll back a ZFS snapshot and delete all snapshots newer then the snapshot.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"zfs snapshots\",\n  \"body\": \"Please note that ZFS snapshots do not allow keeping snapshots newer that a rolled back snapshots so those will be deleted. Please use backups of this is a feature you need.\"\n}\n[/block]","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T14:26:40.485Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":15,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-snapshots-restore","sync_unique":"","title":"Restore a VM Snapshot","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putRestore a VM Snapshot


Path Params

uuid:
required
string
UUID of the VM
snap-id:
required
string
UUID of the snapshot to restore

Body Params

action:
required
stringrollback
needs to be `rollback`
This will roll back a ZFS snapshot and delete all snapshots newer then the snapshot. [block:callout] { "type": "danger", "title": "zfs snapshots", "body": "Please note that ZFS snapshots do not allow keeping snapshots newer that a rolled back snapshots so those will be deleted. Please use backups of this is a feature you need." } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


This will roll back a ZFS snapshot and delete all snapshots newer then the snapshot. [block:callout] { "type": "danger", "title": "zfs snapshots", "body": "Please note that ZFS snapshots do not allow keeping snapshots newer that a rolled back snapshots so those will be deleted. Please use backups of this is a feature you need." } [/block]
{"__v":0,"_id":"55d09e7b07d62c17008b0171","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d09e7b07d62c17008b0172","required":true,"desc":"UUID of the snapshot","default":"","type":"string","name":"snap-id","in":"path"}],"url":"/vms/:uuid/nis/:snap-id"},"body":"Deletes a Snapshot, newer snapshots will not be affected other then their size night change.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T14:30:19.233Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":16,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-snapshots-delete","sync_unique":"","title":"Delete a Snapshot form a VM","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete a Snapshot form a VM


Path Params

uuid:
required
string
UUID of the VM
snap-id:
required
string
UUID of the snapshot
Deletes a Snapshot, newer snapshots will not be affected other then their size night change.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a Snapshot, newer snapshots will not be affected other then their size night change.
{"__v":1,"_id":"55d09c8107d62c17008b016f","api":{"auth":"required","examples":{"codes":[{"language":"text","code":""}]},"params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d098178d728e0d00cc5b93","required":true,"desc":"Comment for the snapshot","default":"","type":"string","name":"comment","in":"body"},{"_id":"55d0a3dd0f37432300e05564","required":false,"desc":"UUID of the parent snapshot (needs to be local).","default":"","type":"string","name":"parent","in":"body"},{"_id":"55d0a3dd0f37432300e05563","required":false,"desc":"If `parent` is given weather the Parent will be deleted from the hypervisor after uploading the backup. If `parent` is not provided wether the backup itself will be deleted after it is uploaded.","default":"false","type":"boolean","name":"delete","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6\nlocation: /api/2/vms/72b3cdb0-7647-478b-906e-28a59f09c603","name":""}]},"settings":"","url":"/vms/:uuid/backups"},"body":"Creates a ZFS snapshot and sends it to to LeoFS as a backup. Both incremental and full backups can be created. If a incremental backup is done the parent **must** be local.\n\nIn incremental backup here means that a incremental ZFS send is done with the parent as parent.\n\nThe following files are created in LeoFS:\n\n* `<vm-uuid>/<backup-uuid>` - the gzip compressed ZFS snapshot\n* `<vm-uuid>/<backup-uuid>.xml` - the zone config XML file from `/etc/zones/<vm-uuid>.xml`\n* `<vm-uuid>/<backup-uuid>.parent` - UUID of the parent snapshot if this is a incremental backup.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T14:21:53.978Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":17,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-backups-create","sync_unique":"","title":"Backup a VM","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postBackup a VM


Path Params

uuid:
required
string
UUID of the VM

Body Params

comment:
required
string
Comment for the snapshot
parent:
string
UUID of the parent snapshot (needs to be local).
delete:
booleanfalse
If `parent` is given weather the Parent will be deleted from the hypervisor after uploading the backup. If `parent` is not provided wether the backup itself will be deleted after it is uploaded.
Creates a ZFS snapshot and sends it to to LeoFS as a backup. Both incremental and full backups can be created. If a incremental backup is done the parent **must** be local. In incremental backup here means that a incremental ZFS send is done with the parent as parent. The following files are created in LeoFS: * `<vm-uuid>/<backup-uuid>` - the gzip compressed ZFS snapshot * `<vm-uuid>/<backup-uuid>.xml` - the zone config XML file from `/etc/zones/<vm-uuid>.xml` * `<vm-uuid>/<backup-uuid>.parent` - UUID of the parent snapshot if this is a incremental backup.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a ZFS snapshot and sends it to to LeoFS as a backup. Both incremental and full backups can be created. If a incremental backup is done the parent **must** be local. In incremental backup here means that a incremental ZFS send is done with the parent as parent. The following files are created in LeoFS: * `<vm-uuid>/<backup-uuid>` - the gzip compressed ZFS snapshot * `<vm-uuid>/<backup-uuid>.xml` - the zone config XML file from `/etc/zones/<vm-uuid>.xml` * `<vm-uuid>/<backup-uuid>.parent` - UUID of the parent snapshot if this is a incremental backup.
{"__v":0,"_id":"55d0a57f8d728e0d00cc5ba6","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d09e7b07d62c17008b0172","required":true,"desc":"UUID of the backup","default":"","type":"string","name":"backup-id","in":"path"}],"url":"/vms/:uuid/nis/:backup-id"},"body":"Deletes a Backup, this will also delete all files on LeoFS related to this backup. This will **also delete all children** of this backup since the restore can no longer happen without the parent. However other backups who are not in the child path of this backup will not be affected, not even if they are newer.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T15:00:15.810Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":18,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-backups-delete","sync_unique":"","title":"Delete a Backup of a VM","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete a Backup of a VM


Path Params

uuid:
required
string
UUID of the VM
backup-id:
required
string
UUID of the backup
Deletes a Backup, this will also delete all files on LeoFS related to this backup. This will **also delete all children** of this backup since the restore can no longer happen without the parent. However other backups who are not in the child path of this backup will not be affected, not even if they are newer.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a Backup, this will also delete all files on LeoFS related to this backup. This will **also delete all children** of this backup since the restore can no longer happen without the parent. However other backups who are not in the child path of this backup will not be affected, not even if they are newer.
{"__v":0,"_id":"55d0a959d4ff801700ae8f77","api":{"auth":"required","params":[{"_id":"55cf302b5c06ee2100ecda05","default":"","desc":"UUID of the VM","name":"uuid","required":true,"type":"string","in":"path"},{"_id":"55d09da08d728e0d00cc5b9a","required":true,"desc":"UUID of the backup to restore","default":"","type":"string","name":"backup-id","in":"path"},{"_id":"55d09da08d728e0d00cc5b99","required":true,"desc":"needs to be `rollback`","default":"rollback","type":"string","name":"action","in":"body"},{"_id":"55d0a959d4ff801700ae8f78","required":false,"desc":"Restores a backup to a specifo","default":"","type":"string","name":"hypervisor","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/vms/:uuid/backups/:backup-id"},"body":"This restores a backup in the process the entire zfs volume might be destroyed and re-created, **all snapshots will be deleted**!\n\nIf the VM is 'in limbo' so not deployed to a hypervisor right now, it is possible to select the hypervisor it is re-deployed to.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T15:16:41.442Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":19,"project":"55ce9a298f17dc0d00da7c48","slug":"restore-a-vm-backup","sync_unique":"","title":"Restore a VM Backup","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putRestore a VM Backup


Path Params

uuid:
required
string
UUID of the VM
backup-id:
required
string
UUID of the backup to restore

Body Params

action:
required
stringrollback
needs to be `rollback`
hypervisor:
string
Restores a backup to a specifo
This restores a backup in the process the entire zfs volume might be destroyed and re-created, **all snapshots will be deleted**! If the VM is 'in limbo' so not deployed to a hypervisor right now, it is possible to select the hypervisor it is re-deployed to.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


This restores a backup in the process the entire zfs volume might be destroyed and re-created, **all snapshots will be deleted**! If the VM is 'in limbo' so not deployed to a hypervisor right now, it is possible to select the hypervisor it is re-deployed to.
{"__v":0,"_id":"55d0a9ec67a6c82d00300f04","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf302b5c06ee2100ecda05","required":true,"desc":"UUID of the VM","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d09da08d728e0d00cc5b9a","required":true,"desc":"The service identifier","default":"","type":"string","name":"service","in":"body"},{"_id":"55d09da08d728e0d00cc5b99","required":true,"desc":"one of `enable`, `disable`, `clear`, `restart`, and `refresh`","default":"rollback","type":"string","name":"action","in":"body"}],"url":"/vms/:uuid/services"},"body":"Changes the service state, see `man svcadm` for more information.","category":"55cea3499d28781700b7c938","createdAt":"2015-08-16T15:19:08.882Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":20,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-services-state","sync_unique":"","title":"Change Service state.","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putChange Service state.


Path Params

uuid:
required
string
UUID of the VM

Body Params

service:
required
string
The service identifier
action:
required
stringrollback
one of `enable`, `disable`, `clear`, `restart`, and `refresh`
Changes the service state, see `man svcadm` for more information.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Changes the service state, see `man svcadm` for more information.
{"__v":0,"_id":"55f2f4a779109e2d007e04e0","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"n\": \"cpu-usage\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"cpu-effective\",\n        \"r\": 1000,\n        \"v\": [\n            100, 100, 100, 100, // ...\n        ]\n    },\n    {\n        \"n\": \"cpu-nwait\",\n        \"r\": 1000,\n        \"v\": [\n            100, 100, 100, 100, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-usage\",\n        \"r\": 1000,\n        \"v\": [\n            31, 31, 31, 31, 31, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-value\",\n        \"r\": 1000,\n        \"v\": [\n            1024, 1024, 1024, 1024, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-usage\",\n        \"r\": 1000,\n        \"v\": [\n            31, 31, 31, 31, 31, // ...\n        ]\n    },\n    {\n        \"n\": \"memory-value\",\n        \"r\": 1000,\n        \"v\": [\n            1024, 1024, 1024, 1024, // ...\n        ]\n    },\n    {\n        \"n\": \"net-send-ops-net0\",\n        \"r\": 1000,\n        \"v\": [\n             0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"net-recv-ops-net0\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"net-send-kb-net0\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"net-recv-kb-net0\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-read-kb\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-write-kb\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-read-ops\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    },\n    {\n        \"n\": \"zfs-write-ops\",\n        \"r\": 1000,\n        \"v\": [\n            0, 0, 0, 0, 0, 0, //...\n        ]\n    }\n]","name":""},{"status":400,"language":"text","code":"bad resolution","name":""},{"status":503,"language":"text","code":"failed to connect to database"}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the Hypervisor","default":"","type":"string","name":"uuid","in":"path"}],"url":"/hypervisors/:uuid/metrics"},"body":"Reads a VM","category":"55cea3499d28781700b7c938","createdAt":"2015-09-11T15:35:03.541Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"55ce9a298f17dc0d00da7c48","slug":"hypervisors-metrics","sync_unique":"","title":"Get Hypervisor Metrics","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Hypervisor Metrics


Path Params

uuid:
required
string
UUID of the Hypervisor
Reads a VM

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a VM
{"__v":0,"_id":"560d60adaf97231900938128","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the vm","default":"","type":"string","name":"uuid","in":"path"}],"url":"/vms/:uuid/hypervisor"},"body":"Deletes a VM from the hypervisor to put it in 'limbo'","category":"55cea3499d28781700b7c938","createdAt":"2015-10-01T16:34:53.132Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"55ce9a298f17dc0d00da7c48","slug":"vms-hypervisor-delete","sync_unique":"","title":"Removes a VM from a hypervisor","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemoves a VM from a hypervisor


Path Params

uuid:
required
string
UUID of the vm
Deletes a VM from the hypervisor to put it in 'limbo'

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a VM from the hypervisor to put it in 'limbo'
{"__v":0,"_id":"55d102b8d4ff801700ae8ffd","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/networks"},"body":"Lists all networks visible to the user.\n\nSee [Get Network](doc:networks-get) for the fields available for `full-list-fields`.","category":"55cea34edb457c210076e5a4","createdAt":"2015-08-16T21:38:00.524Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"networks-list","sync_unique":"","title":"List Networks","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Networks


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all networks visible to the user. See [Get Network](doc:networks-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all networks visible to the user. See [Get Network](doc:networks-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55d1033fcf1e671700834001","api":{"settings":"","results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/networks/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"name of the network","default":"","type":"string","name":"name","in":"body"}],"url":"/networks"},"body":"Creates a new network","category":"55cea34edb457c210076e5a4","createdAt":"2015-08-16T21:40:15.040Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"networks-create","sync_unique":"","title":"Create Network","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate Network


Body Params

name:
required
string
name of the network
Creates a new network

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a new network
{"__v":0,"_id":"55d103d8d4ff801700ae8ffe","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"ipranges\": [\n        \"b45e7702-93f8-47ac-8ad2-92518be7c1bf\"\n    ],\n    \"metadata\": [],\n    \"name\": \"Test Net\",\n    \"uuid\": \"faa25949-e8a2-446f-b01a-ddf17f058016\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the network","default":"","type":"string","name":"uuid","in":"path"}],"url":"/networks/:uuid"},"body":"Reads a Network","category":"55cea34edb457c210076e5a4","createdAt":"2015-08-16T21:42:48.748Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"get-network","sync_unique":"","title":"Get Network","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Network


Path Params

uuid:
required
string
UUID of the network
Reads a Network

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a Network
{"__v":0,"_id":"55d10447d4ff801700ae8fff","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the network","default":"","type":"string","name":"uuid","in":"path"}],"url":"/networks/:uuid"},"body":"Deletes a Network.","category":"55cea34edb457c210076e5a4","createdAt":"2015-08-16T21:44:39.447Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"networks-delete","sync_unique":"","title":"Delete Network","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Network


Path Params

uuid:
required
string
UUID of the network
Deletes a Network.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a Network.
{"__v":0,"_id":"55d1061ccf1e67170083400d","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cfaf0d957dcd3500b344a0","required":true,"desc":"UUID of the network","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","required":true,"desc":"UUID of the iprange to add","default":"","type":"string","name":"iprange","in":"path"}],"url":"/networks/:uuid/iprange/:iprange"},"body":"Adds an iprange to a network.","category":"55cea34edb457c210076e5a4","createdAt":"2015-08-16T21:52:28.924Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"networks-ipranges-add","sync_unique":"","title":"Add an IP Range a Network","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putAdd an IP Range a Network


Path Params

uuid:
required
string
UUID of the network
iprange:
required
string
UUID of the iprange to add
Adds an iprange to a network.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Adds an iprange to a network.
{"__v":0,"_id":"55d1068d67a6c82d00300f86","api":{"auth":"required","params":[{"_id":"55cfaf1a8d728e0d00cc5b12","default":"","desc":"UUID of the network","name":"uuid","required":true,"type":"string","in":"path"},{"_id":"55cf28068f17dc0d00da7ca2","default":"","desc":"UUID of the iprange to delete","name":"role","required":true,"type":"string","in":"body"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/networks/:uuid/iprange/:iprange"},"body":"Removes an IP Range from an network.","category":"55cea34edb457c210076e5a4","createdAt":"2015-08-16T21:54:21.304Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"networks-ipranges-remove","sync_unique":"","title":"Remove an IP Range from a Network","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove an IP Range from a Network


Path Params

uuid:
required
string
UUID of the network

Body Params

role:
required
string
UUID of the iprange to delete
Removes an IP Range from an network.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Removes an IP Range from an network.
{"__v":0,"_id":"55d109bdcf1e67170083400e","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/ipranges"},"body":"Lists all IP Ranges visible to the user.\n\nSee [Get IP Range](doc:ipranges-get) for the fields available for `full-list-fields`.","category":"55cea3569d28781700b7c939","createdAt":"2015-08-16T22:07:57.460Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"ipranges-list","sync_unique":"","title":"List IP Ranges","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList IP Ranges


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all IP Ranges visible to the user. See [Get IP Range](doc:ipranges-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all IP Ranges visible to the user. See [Get IP Range](doc:ipranges-get) for the fields available for `full-list-fields`.
{"__v":1,"_id":"55d10ceed4ff801700ae9004","api":{"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"name of the ip rnage","default":"","type":"string","name":"name","in":"body"},{"_id":"55d10e94d4ff801700ae900b","required":true,"desc":"NIC Tag for the IP Range to use","default":"","type":"string","name":"tag","in":"body"},{"_id":"55d10e94d4ff801700ae900a","required":true,"desc":"The network address of the subnet","default":"","type":"string","name":"subnet","in":"body"},{"_id":"55d10e94d4ff801700ae9009","required":true,"desc":"The netmask of the subnet","default":"","type":"string","name":"netmask","in":"body"},{"_id":"55d10e94d4ff801700ae9008","required":true,"desc":"The gateway of the subnet","default":"","type":"string","name":"gateway","in":"body"},{"_id":"55d10e94d4ff801700ae9007","required":true,"desc":"First address to hand out (must be part of subnet!)","default":"","type":"string","name":"first","in":"body"},{"_id":"55d10e94d4ff801700ae9006","required":true,"desc":"Last address to hand out (must be part of subnet!)","default":"","type":"string","name":"last","in":"body"},{"_id":"55d10e94d4ff801700ae9005","required":false,"desc":"VLan to tag the nics with","default":"","type":"int","name":"vlan","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/ipranges/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"settings":"","url":"/ipranges"},"body":"Creates a new ip range","category":"55cea3569d28781700b7c939","createdAt":"2015-08-16T22:21:34.627Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"ipranges-create","sync_unique":"","title":"Create IP Range","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate IP Range


Body Params

name:
required
string
name of the ip rnage
tag:
required
string
NIC Tag for the IP Range to use
subnet:
required
string
The network address of the subnet
netmask:
required
string
The netmask of the subnet
gateway:
required
string
The gateway of the subnet
first:
required
string
First address to hand out (must be part of subnet!)
last:
required
string
Last address to hand out (must be part of subnet!)
vlan:
integer
VLan to tag the nics with
Creates a new ip range

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a new ip range
{"__v":0,"_id":"55d10b7bd4ff801700ae9003","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"free\": [\n        \"10.10.10.100\",\n        \"10.10.10.101\",\n        \"10.10.10.102\",\n        \"10.10.10.103\",\n        \"10.10.10.104\",\n        \"10.10.10.105\",\n        \"10.10.10.106\",\n        \"10.10.10.107\",\n        \"10.10.10.108\",\n        \"10.10.10.109\",\n        \"10.10.10.110\",\n        \"10.10.10.111\",\n        \"10.10.10.112\",\n        \"10.10.10.113\",\n        \"10.10.10.114\",\n        \"10.10.10.115\",\n        \"10.10.10.116\",\n        \"10.10.10.117\",\n        \"10.10.10.118\",\n        \"10.10.10.119\",\n        \"10.10.10.120\"\n    ],\n    \"gateway\": \"10.10.10.1\",\n    \"metadata\": [],\n    \"name\": \"test\",\n    \"netmask\": \"255.255.255.0\",\n    \"network\": \"10.10.10.0\",\n    \"tag\": \"admin\",\n    \"used\": [],\n    \"uuid\": \"b45e7702-93f8-47ac-8ad2-92518be7c1bf\",\n    \"vlan\": 0\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the ip range","default":"","type":"string","name":"uuid","in":"path"}],"url":"/ipranges/:uuid"},"body":"Reads a IP Range","category":"55cea3569d28781700b7c939","createdAt":"2015-08-16T22:15:23.255Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"ipranges-get","sync_unique":"","title":"Get IP Range","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet IP Range


Path Params

uuid:
required
string
UUID of the ip range
Reads a IP Range

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a IP Range
{"__v":0,"_id":"55d13611cecdd00d0034b9ad","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the iprange","default":"","type":"string","name":"uuid","in":"path"}],"url":"/ipranges/:uuid"},"body":"Deletes a Network.","category":"55cea3569d28781700b7c939","createdAt":"2015-08-17T01:17:05.914Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"delete-ip-range","sync_unique":"","title":"Delete IP Range","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete IP Range


Path Params

uuid:
required
string
UUID of the iprange
Deletes a Network.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a Network.
{"__v":0,"_id":"55d208c8945e481700afbb2e","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"tag\": \"admin\",\n    \"ip\": \"10.10.10.100\",\n    \"netmask\": \"255.255.255.0\",\n    \"gateway\": \"10.10.10.1\",\n    \"vlan\": 0\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the ip range","default":"","type":"string","name":"uuid","in":"path"}],"url":"/ipranges/:uuid"},"body":"Claims an IP Address from the range","category":"55cea3569d28781700b7c939","createdAt":"2015-08-17T16:16:08.639Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"ipranges-claim","sync_unique":"","title":"Claim IP from IP Range","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putClaim IP from IP Range


Path Params

uuid:
required
string
UUID of the ip range
Claims an IP Address from the range

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Claims an IP Address from the range
{"__v":0,"_id":"55d208fa486de50d00326f74","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the iprange","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d208fa486de50d00326f75","required":true,"desc":"IP Address to release","default":"","type":"string","name":"ip","in":"path"}],"url":"/ipranges/:uuid/:ip"},"body":"Releases an IP","category":"55cea3569d28781700b7c939","createdAt":"2015-08-17T16:16:58.821Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"iprange-release","sync_unique":"","title":"Releases an IP Range","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteReleases an IP Range


Path Params

uuid:
required
string
UUID of the iprange
ip:
required
string
IP Address to release
Releases an IP

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Releases an IP
{"__v":0,"_id":"55d576954fe64521006d5ab3","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/datasets"},"body":"Lists all Datasets visible to the user.\n\nSee [Get Dataset](doc:datasets-get) for the fields available for `full-list-fields`.","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T06:41:25.286Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-list","sync_unique":"","title":"List Datasets","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Datasets


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all Datasets visible to the user. See [Get Dataset](doc:datasets-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all Datasets visible to the user. See [Get Dataset](doc:datasets-get) for the fields available for `full-list-fields`.
{"__v":0,"_id":"55d576da5082980d0009c9c8","api":{"settings":"","results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/datasets/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"url of the manifest to import","default":"","type":"string","name":"url","in":"body"}],"url":"/datasets"},"body":"Imports a dataset form a imgapi compatible server or promotes a VM's snapshot to a dataset.\n\nIf `url` is given a imgapi import is performed. if `vm`, `snapshot` and `config` is given then the snapshot in question is promoted to a mimage.\n\n`config` is an object and needs to have the fields: `version`, `os`, `name` and `description`, all strings.","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T06:42:34.684Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-import","sync_unique":"","title":"Import Dataset","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postImport Dataset


Body Params

url:
required
string
url of the manifest to import
Imports a dataset form a imgapi compatible server or promotes a VM's snapshot to a dataset. If `url` is given a imgapi import is performed. if `vm`, `snapshot` and `config` is given then the snapshot in question is promoted to a mimage. `config` is an object and needs to have the fields: `version`, `os`, `name` and `description`, all strings.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Imports a dataset form a imgapi compatible server or promotes a VM's snapshot to a dataset. If `url` is given a imgapi import is performed. if `vm`, `snapshot` and `config` is given then the snapshot in question is promoted to a mimage. `config` is an object and needs to have the fields: `version`, `os`, `name` and `description`, all strings.
{"__v":0,"_id":"55d57761e60a2f0d00b88b6b","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"description\": \"core.io Mailbox Server\",\n  \"image_size\": 152608931,\n  \"imported\": 1,\n  \"metadata\": {\n    \"homepage\": \"https://github.com/skylime/mi-core-mbox\"\n  },\n  \"name\": \"core-mbox\",\n  \"networks\": [\n    {\n      \"description\": \"public\",\n      \"name\": \"net0\"\n    }\n  ],\n  \"os\": \"smartos\",\n  \"requirements\": [\n    {\n      \"attribute\": \"sysinfo.Live Image\",\n      \"condition\": \">=\",\n      \"value\": \"20150405T212953Z\",\n      \"weight\": \"must\"\n    }\n  ],\n  \"status\": \"imported\",\n  \"type\": \"zone\",\n  \"uuid\": \"0f3f5375-063b-43da-8407-ce14e381f440\",\n  \"version\": \"15.1.0\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the datasets","default":"","type":"string","name":"uuid","in":"path"}],"url":"/datasets/:uuid"},"body":"Reads a Dataset","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T06:44:49.502Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-get","sync_unique":"","title":"Get Dataset","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Dataset


Path Params

uuid:
required
string
UUID of the datasets
Reads a Dataset

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a Dataset
{"__v":0,"_id":"55d5ad05988e130d000b4087","api":{"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the datasets","default":"","type":"string","name":"uuid","in":"path"}],"url":"/datasets/:uuid"},"body":"Deletes a dataset","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T10:33:41.845Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-delete","sync_unique":"","title":"Delete Dataset","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Dataset


Path Params

uuid:
required
string
UUID of the datasets
Deletes a dataset

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a dataset
{"__v":0,"_id":"55d57bc7988e130d000b3fbf","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"GET /api/2/datasets/b7c658e0-2ddb-46dd-8973-4a59ffc9957e/dataset.gz HTTP/1.1\nhost: cloud.project-fifo.net\naccept: application/x-gzip\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the datasets","default":"","type":"string","name":"uuid","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"... gz data ...","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/datasets/:uuid/datasets.gz"},"body":"Downloads a zVol","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T07:03:35.271Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-get-zvol","sync_unique":"","title":"Get Dataset zVol","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Dataset zVol


Path Params

uuid:
required
string
UUID of the datasets
Downloads a zVol

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Downloads a zVol
{"__v":1,"_id":"55d5782e988e130d000b3faf","api":{"auth":"required","params":[{"_id":"55d5785f5082980d0009c9cd","required":true,"desc":"UUID of the dataset to import","default":"","type":"string","name":"uuid","in":"path"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/datasets/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"settings":"","url":"/datasets/:uuid"},"body":"Uploads a manifest as 1st step of a dataset import from a local file.","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T06:48:14.512Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-upload-manifest","sync_unique":"","title":"Upload Manifest","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putUpload Manifest


Path Params

uuid:
required
string
UUID of the dataset to import
Uploads a manifest as 1st step of a dataset import from a local file.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Uploads a manifest as 1st step of a dataset import from a local file.
{"__v":0,"_id":"55d57b194fe64521006d5ac9","api":{"auth":"required","params":[{"_id":"55d5785f5082980d0009c9cd","required":true,"desc":"UUID of the dataset to import","default":"","type":"string","name":"uuid","in":"path"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/datasets/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"settings":"","url":"/datasets/:uuid/dataset.gz"},"body":"Uploads a zvol as 2nd step of a dataset import from a local file.","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T07:00:41.004Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-upload-zvol","sync_unique":"","title":"Upload Dataset zVol","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putUpload Dataset zVol


Path Params

uuid:
required
string
UUID of the dataset to import
Uploads a zvol as 2nd step of a dataset import from a local file.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Uploads a zvol as 2nd step of a dataset import from a local file.
{"__v":0,"_id":"55d579134fe64521006d5ab9","api":{"settings":"","results":{"codes":[{"status":204,"language":"http","code":"","name":""}]},"auth":"required","params":[{"_id":"55d5785f5082980d0009c9cd","required":true,"desc":"UUID of the dataset to import","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d579134fe64521006d5abb","required":true,"desc":"name of the nic to add (i.e. `net1`)","default":"","type":"string","name":"nic","in":"path"},{"_id":"55d579134fe64521006d5aba","required":true,"desc":"description of the interface","default":"","type":"string","name":"description","in":"body"}],"url":"/datasets/:uuid/networks/:nic"},"body":"Adds or modifies a nic on the dataset.","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T06:52:03.020Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-networks-add","sync_unique":"","title":"Add NIC to Dataset","type":"put","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

putAdd NIC to Dataset


Path Params

uuid:
required
string
UUID of the dataset to import
nic:
required
string
name of the nic to add (i.e. `net1`)

Body Params

description:
required
string
description of the interface
Adds or modifies a nic on the dataset.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Adds or modifies a nic on the dataset.
{"__v":0,"_id":"55d579354fe64521006d5abe","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"DELETE /api/2/datasets/21274016-2ad3-11e4-9673-e3abad521cc2/networks/net1 HTTP/1.1\nAccept: application/json\nAuthorization: Bearer gjGGIkIM2m518n4UmEgubIH0H2Xkt1Y6","name":""}]},"params":[{"_id":"55d5785f5082980d0009c9cd","required":true,"desc":"UUID of the dataset to import","default":"","type":"string","name":"uuid","in":"path"},{"_id":"55d579134fe64521006d5abb","required":true,"desc":"name of the nic to add (i.e. `net1`)","default":"","type":"string","name":"nic","in":"path"}],"results":{"codes":[{"status":204,"language":"http","code":"","name":""}]},"settings":"","url":"/datasets/:uuid/networks/:nic"},"body":"Adds or modifies a nic on the dataset.","category":"55cea35c8f17dc0d00da7c52","createdAt":"2015-08-20T06:52:37.763Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55ce9a298f17dc0d00da7c48","slug":"datasets-networks-remove","sync_unique":"","title":"Remove NIC from Dataset","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteRemove NIC from Dataset


Path Params

uuid:
required
string
UUID of the dataset to import
nic:
required
string
name of the nic to add (i.e. `net1`)
Adds or modifies a nic on the dataset.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Adds or modifies a nic on the dataset.
{"__v":0,"_id":"55d5a74be60a2f0d00b88c28","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n    \"af7d83bd-93d4-4d16-998f-7fbd3cc756cf\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":false,"desc":"to get a full list instead of UUIDs","default":"false","type":"string","name":"full-list","in":"query"},{"_id":"55cf261c46db442b00105be9","required":false,"desc":"fields to include in the full list (`,` separated)","default":"","type":"array_string","name":"full-list-fields","in":"query"}],"url":"/packages"},"body":"Lists all Packages visible to the user.\n\nSee [Get Package](doc:packages-get) for the fields available for `full-list-fields`.","category":"55cea3689d28781700b7c93a","createdAt":"2015-08-20T10:09:15.336Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55ce9a298f17dc0d00da7c48","slug":"packages-list","sync_unique":"","title":"List Packages","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getList Packages


Query Params

full-list:
stringfalse
to get a full list instead of UUIDs
full-list-fields:
array of strings
fields to include in the full list (`,` separated)
Lists all Packages visible to the user. See [Get Package](doc:packages-get) for the fields available for `full-list-fields`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lists all Packages visible to the user. See [Get Package](doc:packages-get) for the fields available for `full-list-fields`.
{"__v":1,"_id":"55d5a8cb988e130d000b4075","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"55d5acd6ced8b9190077cbd7","required":true,"desc":"Name of the package","default":"","type":"string","name":"name","in":"body"},{"_id":"55d5acd6ced8b9190077cbd6","required":true,"desc":"`GB` of quota to give the package, for KVM this applies as secondary disk","default":"","type":"int","name":"quota","in":"body"},{"_id":"55d5acd6ced8b9190077cbd5","required":true,"desc":"`MB` of memory for the","default":"","type":"int","name":"ram","in":"body"},{"_id":"55d5acd6ced8b9190077cbd4","required":true,"desc":"`%` of CPU cores to give the zone","default":"","type":"int","name":"cpu_cap","in":"body"},{"_id":"55d5acd6ced8b9190077cbd3","required":true,"desc":"Shares of CPU time when two zones compete. (Defaults to % of memory)","default":"","type":"string","name":"cpu_shares","in":"body"},{"_id":"55d5acd6ced8b9190077cbd2","required":false,"desc":"ZFS Priority if zones are competing. (Defaults to % of memory)","default":"","type":"int","name":"zfs_io_priority","in":"body"},{"_id":"55d5acd6ced8b9190077cbd1","required":false,"desc":"Block size for KVM","default":"","type":"int","name":"blicksize","in":"body"},{"_id":"55d5acd6ced8b9190077cbd0","required":false,"desc":"Compression used for the ZFS volume","default":"","type":"string","name":"compression","in":"body"},{"_id":"55d5acd6ced8b9190077cbcf","required":false,"desc":"A list of rules to create","default":"","type":"object","name":"requirements","in":"body"}],"results":{"codes":[{"status":303,"language":"http","code":"HTTP/1.1 303 See Other\nvary: accept\nlocation: /api/2/packages/7df734a1-7332-45da-aa2a-9a3d856fa58a","name":""}]},"settings":"","url":"/packages"},"body":"Creates a new package. \n\n# Requirements\n`requirements`  is an array of objects as with the following atributes:\n\n### `weight` \nA number (positive or negative) or the string `\"must\"`, `\"cant`\" for strong enforcement or `\"scale\"` and `\"random\"`\n\n### `must`, `cant`, and `<number>` rules\n\nThis rules simply compare an attribute of the hypervisor against a value and either enforces a the rule (`must`/`cant`) or gives out points, both positive and negative to rate the found hypervisors.\n\n#### `attribute`\nThe attribute to check on the hypervisors, this can be a json like path so for example `\"characteristics.colour\"` will look up `colour` in the hypervisors `characteristics`\n\n#### `value`\nThe value to check against, this can be a number, a string, or an array.\n\n#### `condition`\nOne of:\n* `>=`, `>` - Checks if the value of `attribute` is larger (or equal) to the value\n* `=<`, `<` - Checks if the value of `attribute` is smaller (or equal) to the value\n* `=:=` - Checks if the value of `attribute` is equal to the value\n* `=/=` - Checks if the value of `attribute` is not equal to the value\n* `\"subset\"` - Checks if the value of `attribute` is a subset of value (requires value to be an array)\n* `\"superset\"` - Checks if the value of `attribute` is a superset of value (requires value to be an array)\n* `\"disjoint\"` - Checks if the value of `attribute` is disjoint with the value (requires value to be an array)\n* `\"element\"` - Checks if the value is contained in the `attribute`\n\n### `scale` rules\nThis rules linearly map an attributes value onto a given scale and give the result as points for hypervisor selection.\n\n#### `attribute`\nThe attribute to check on the hypervisors, this can be a json like path so for example `\"characteristics.cores\"` will look up `cores` in the hypervisors `characteristics` This must be an numeric value towork\n\n#### `low`, and `high`\nThe lowest and highest number of the scale, to map against.\n\n### `random` rules\nThis rules simply generate a random number on a given scale, this allows making non deterministic rules. The resulting number is used as points for hypervisor selection.\n\n#### `low`, and `high`\nThe lowest and highest number the random number is generated from.\n## exmaple\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[{\\n  \\\"weight\\\":    \\\"must\\\",\\n  \\\"attribute\\\": \\\"characteristics.colour\\\",\\n  \\\"condition\\\": \\\"=:=\\\",\\n  \\\"value\\\":     \\\"purple\\\"\\n}]\\n  \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","category":"55cea3689d28781700b7c93a","createdAt":"2015-08-20T10:15:39.839Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55ce9a298f17dc0d00da7c48","slug":"packages-create","sync_unique":"","title":"Create Package","type":"post","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

postCreate Package


Body Params

name:
required
string
Name of the package
quota:
required
integer
`GB` of quota to give the package, for KVM this applies as secondary disk
ram:
required
integer
`MB` of memory for the
cpu_cap:
required
integer
`%` of CPU cores to give the zone
cpu_shares:
required
string
Shares of CPU time when two zones compete. (Defaults to % of memory)
zfs_io_priority:
integer
ZFS Priority if zones are competing. (Defaults to % of memory)
blicksize:
integer
Block size for KVM
compression:
string
Compression used for the ZFS volume
requirements:
object
A list of rules to create
Creates a new package. # Requirements `requirements` is an array of objects as with the following atributes: ### `weight` A number (positive or negative) or the string `"must"`, `"cant`" for strong enforcement or `"scale"` and `"random"` ### `must`, `cant`, and `<number>` rules This rules simply compare an attribute of the hypervisor against a value and either enforces a the rule (`must`/`cant`) or gives out points, both positive and negative to rate the found hypervisors. #### `attribute` The attribute to check on the hypervisors, this can be a json like path so for example `"characteristics.colour"` will look up `colour` in the hypervisors `characteristics` #### `value` The value to check against, this can be a number, a string, or an array. #### `condition` One of: * `>=`, `>` - Checks if the value of `attribute` is larger (or equal) to the value * `=<`, `<` - Checks if the value of `attribute` is smaller (or equal) to the value * `=:=` - Checks if the value of `attribute` is equal to the value * `=/=` - Checks if the value of `attribute` is not equal to the value * `"subset"` - Checks if the value of `attribute` is a subset of value (requires value to be an array) * `"superset"` - Checks if the value of `attribute` is a superset of value (requires value to be an array) * `"disjoint"` - Checks if the value of `attribute` is disjoint with the value (requires value to be an array) * `"element"` - Checks if the value is contained in the `attribute` ### `scale` rules This rules linearly map an attributes value onto a given scale and give the result as points for hypervisor selection. #### `attribute` The attribute to check on the hypervisors, this can be a json like path so for example `"characteristics.cores"` will look up `cores` in the hypervisors `characteristics` This must be an numeric value towork #### `low`, and `high` The lowest and highest number of the scale, to map against. ### `random` rules This rules simply generate a random number on a given scale, this allows making non deterministic rules. The resulting number is used as points for hypervisor selection. #### `low`, and `high` The lowest and highest number the random number is generated from. ## exmaple [block:code] { "codes": [ { "code": "[{\n \"weight\": \"must\",\n \"attribute\": \"characteristics.colour\",\n \"condition\": \"=:=\",\n \"value\": \"purple\"\n}]\n ", "language": "json" } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Creates a new package. # Requirements `requirements` is an array of objects as with the following atributes: ### `weight` A number (positive or negative) or the string `"must"`, `"cant`" for strong enforcement or `"scale"` and `"random"` ### `must`, `cant`, and `<number>` rules This rules simply compare an attribute of the hypervisor against a value and either enforces a the rule (`must`/`cant`) or gives out points, both positive and negative to rate the found hypervisors. #### `attribute` The attribute to check on the hypervisors, this can be a json like path so for example `"characteristics.colour"` will look up `colour` in the hypervisors `characteristics` #### `value` The value to check against, this can be a number, a string, or an array. #### `condition` One of: * `>=`, `>` - Checks if the value of `attribute` is larger (or equal) to the value * `=<`, `<` - Checks if the value of `attribute` is smaller (or equal) to the value * `=:=` - Checks if the value of `attribute` is equal to the value * `=/=` - Checks if the value of `attribute` is not equal to the value * `"subset"` - Checks if the value of `attribute` is a subset of value (requires value to be an array) * `"superset"` - Checks if the value of `attribute` is a superset of value (requires value to be an array) * `"disjoint"` - Checks if the value of `attribute` is disjoint with the value (requires value to be an array) * `"element"` - Checks if the value is contained in the `attribute` ### `scale` rules This rules linearly map an attributes value onto a given scale and give the result as points for hypervisor selection. #### `attribute` The attribute to check on the hypervisors, this can be a json like path so for example `"characteristics.cores"` will look up `cores` in the hypervisors `characteristics` This must be an numeric value towork #### `low`, and `high` The lowest and highest number of the scale, to map against. ### `random` rules This rules simply generate a random number on a given scale, this allows making non deterministic rules. The resulting number is used as points for hypervisor selection. #### `low`, and `high` The lowest and highest number the random number is generated from. ## exmaple [block:code] { "codes": [ { "code": "[{\n \"weight\": \"must\",\n \"attribute\": \"characteristics.colour\",\n \"condition\": \"=:=\",\n \"value\": \"purple\"\n}]\n ", "language": "json" } ] } [/block]
{"__v":0,"_id":"55d5a7c0e60a2f0d00b88c29","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"compression\": \"off\",\n  \"cpu_cap\": 100,\n  \"metadata\": [],\n  \"name\": \"mini\",\n  \"quota\": 10,\n  \"ram\": 1024,\n  \"requirements\": [],\n  \"uuid\": \"42bf38f3-5632-49cb-82ce-973a04c3a8f6\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the package","default":"","type":"string","name":"uuid","in":"path"}],"url":"/packages/:uuid"},"body":"Reads a Package","category":"55cea3689d28781700b7c93a","createdAt":"2015-08-20T10:11:12.457Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55ce9a298f17dc0d00da7c48","slug":"packages-get","sync_unique":"","title":"Get Package","type":"get","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

getGet Package


Path Params

uuid:
required
string
UUID of the package
Reads a Package

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Reads a Package
{"__v":0,"_id":"55d5ad4cced8b9190077cbd8","api":{"settings":"","results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55cf261c46db442b00105bea","required":true,"desc":"UUID of the packges","default":"","type":"string","name":"uuid","in":"path"}],"url":"/packages/:uuid"},"body":"Deletes a package","category":"55cea3689d28781700b7c93a","createdAt":"2015-08-20T10:34:52.059Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55ce9a298f17dc0d00da7c48","slug":"packages-delete","sync_unique":"","title":"Delete Package","type":"delete","updates":[],"user":"55af3b15826d210d00041e02","version":"55ce9b0a9d28781700b7c930","childrenPages":[]}

deleteDelete Package


Path Params

uuid:
required
string
UUID of the packges
Deletes a package

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


Deletes a package