This page contains a list of resources available in API v6.0, their actions, description, parameters and example usage.
This API is based on the HaveAPI framework. You can access it using existing clients:
The code examples found on this page are for HaveAPI v0.17.0, so be sure to use clients of the same version.
require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0$ curl --request OPTIONS 'http://api.vpsfree.cz/v6.0/'OPTIONS /v6.0/ HTTP/1.1
Host: api.vpsfree.cz
Authentication using HTTP basic. Username and password is passed via HTTP header. Its use is forbidden from web browsers.
require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
client.authenticate(:basic, user: "user", password: "secret")
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.authenticate("basic", {
user: "user",
password: "secret"
}, function (client, status) {
console.log("Authenticated?", status);
});
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$api->authenticate("basic", ["user" => "user", "password" => "secret"]);
# Provide credentials on command line
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 --auth basic --user user --password secret
# If username or password isn't provided, the user is asked on stdin
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 --auth basic --user user
Password: secret
# Provide credentials as file system options
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0 -o auth_method=basic,user=myuser,password=secret
# If username or password isn't provided, the user is asked on stdin
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0 -o auth_method=basic,user=myuser
Password: secret
# Password is asked on standard input
$ curl --request OPTIONS \
--user username \
'http://api.vpsfree.cz'
Password: secret
# Password given on the command line
$ curl --request OPTIONS \
--user username:secret \
'http://api.vpsfree.cz'
GET / HTTP/1.1
Host: api.vpsfree.cz
Authorization: Basic dXNlcjpzZWNyZXQ=
The client authenticates with credentials, usually username and password, and gets a token. From this point, the credentials can be forgotten and the token is used instead. Tokens can have different lifetimes, can be renewed and revoked. The token is passed either via HTTP header or query parameter.
No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Valid_to | valid_to | Datetime |
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "token"
},
"output": {
"parameters": {
"valid_to": {
"required": false,
"label": "Valid_to",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "token"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/_auth/token/tokens/renew",
"method": "POST",
"help": "/_auth/token/tokens/renew?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| User | user | yes | String | Present
|
||
| Password | password | yes | String | Present
|
||
| Lifetime | lifetime | yes | String | Present
Include
|
fixed - the token has a fixed validity period, it cannot be renewed renewable_manual - the token can be renewed, but it must be done manually via renew action renewable_auto - the token is renewed automatically to now+interval every time it is used permanent - the token will be valid forever, unless deleted | |
| Interval | interval | no | Integer | 300 | How long will requested token be valid, in seconds. |
| Label | Name | Type | Description |
|---|---|---|---|
| Token | token | String | |
| Valid_to | valid_to | Datetime | |
| Complete | complete | Boolean | |
| Next_action | next_action | String |
{
"auth": false,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"user": {
"required": true,
"label": "User",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"password": {
"required": true,
"label": "Password",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": true
},
"lifetime": {
"required": true,
"label": "Lifetime",
"description": "fixed - the token has a fixed validity period, it cannot be renewed\nrenewable_manual - the token can be renewed, but it must be done manually via renew action\nrenewable_auto - the token is renewed automatically to now+interval every time it is used\npermanent - the token will be valid forever, unless deleted\n",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto",
"permanent"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"interval": {
"required": false,
"label": "Interval",
"description": "How long will requested token be valid, in seconds.",
"type": "Integer",
"validators": {
},
"default": 300,
"protected": false
}
},
"layout": "hash",
"namespace": "token"
},
"output": {
"parameters": {
"token": {
"required": false,
"label": "Token",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"valid_to": {
"required": false,
"label": "Valid_to",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"complete": {
"required": false,
"label": "Complete",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"next_action": {
"required": false,
"label": "Next_action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "token"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/_auth/token/tokens",
"method": "POST",
"help": "/_auth/token/tokens?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "token"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "token"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/_auth/token/tokens/revoke",
"method": "POST",
"help": "/_auth/token/tokens/revoke?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Token | token | yes | String | Present
|
||
| TOTP code | code | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Token | token | String | |
| Valid_to | valid_to | Datetime | |
| Complete | complete | Boolean | |
| Next_action | next_action | String |
{
"auth": false,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"token": {
"required": true,
"label": "Token",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"code": {
"required": true,
"label": "TOTP code",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "token"
},
"output": {
"parameters": {
"token": {
"required": false,
"label": "Token",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"valid_to": {
"required": false,
"label": "Valid_to",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"complete": {
"required": false,
"label": "Complete",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"next_action": {
"required": false,
"label": "Next_action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "token"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/_auth/token/tokens/totp",
"method": "POST",
"help": "/_auth/token/tokens/totp?method=POST"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
# Get token using username and password
client.authenticate(:token, user: "user", password: "secret")
puts "Token = #{client.auth.token}"
# Next time, the client can authenticate using the token directly
client.authenticate(:token, token: saved_token)
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
// Request a new token
api.authenticate("token", {
user: "user",
password: "secret"
}, function (client, status) {
console.log("Authenticated?", status);
if (status)
console.log("Token is", client.authProvider.token);
});
// Use an existing token
api.authenticate("token", {
token: "qwertyuiop..."
}, function (client, status) {
console.log("Authenticated?", status);
});
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
// Get token using username and password
$api->authenticate("token", ["user" => "user", "password" => "secret"]);
echo "Token = ".$api->getAuthenticationProvider()->getToken();
// Next time, the client can authenticate using the token directly
$api->authenticate("token", ["token" => $savedToken]);
# Get token using username and password and save it to disk
# Note that the client always has to call some action. APIs should provide
# an action to get information about the current user, so that's what we're
# calling now.
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 --auth token --user user --save user current
Password: secret
# Now the token is read from disk and the user does not have to provide username
# nor password and be authenticated
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 user current
# Authenticate using username and password
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0 -o auth_method=token,user=myuser
Password: secret
# If you have generated a token, you can use it
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0 -o auth_method=token,token=yourtoken
# Note that the file system can read config file from haveapi-client, so if
# you set up authentication there, the file system will use it.
# Acquire the token
$ curl --request POST \
--header 'Content-Type: application/json' \
--data-binary "{
\"token\": {
\"user\": \"user\",
\"password\": \"secret\",
\"lifetime\": \"fixed\"
}
}" \
'http://api.vpsfree.cz/_auth/token/tokens'
# Use a previously acquired token
$ curl --request OPTIONS \
--header 'X-HaveAPI-Auth-Token: thetoken' \
'http://api.vpsfree.cz'
POST /_auth/token/tokens HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
{
"token": {
"user": "user",
"password": "secret",
"lifetime": "fixed"
}
}
Follows a list of all resources in this API and their actions.
Browse states of blocking actions
No parameters.
No parameters.
{
"auth": false,
"description": null,
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "action_state"
},
"output": {
"parameters": {
},
"layout": "hash",
"namespace": "action_state"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/action_states/{action_state_id}/cancel",
"method": "POST",
"help": "/v6.0/action_states/{action_state_id}/cancel?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| Order | order | no | String | Include
|
newest |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Finished | finished | Boolean | |
| Status | status | Boolean | Determines whether the action is proceeding or failing |
| Current progress | current | Integer | |
| Total | total | Integer | The action is finished when current equals to total |
| Unit | unit | String | Unit of current and total |
| Can cancel | can_cancel | Boolean | When true, execution of this action can be cancelled |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | When was the progress last updated |
{
"auth": false,
"description": "List states of pending actions",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"newest",
"oldest"
],
"message": "%{value} cannot be used"
}
},
"default": "newest",
"protected": false
}
},
"layout": "hash",
"namespace": "action_state"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"finished": {
"required": false,
"label": "Finished",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": "Determines whether the action is proceeding or failing",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current": {
"required": false,
"label": "Current progress",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total": {
"required": false,
"label": "Total",
"description": "The action is finished when current equals to total",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"unit": {
"required": false,
"label": "Unit",
"description": "Unit of current and total",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"can_cancel": {
"required": false,
"label": "Can cancel",
"description": "When true, execution of this action can be cancelled",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": "When was the progress last updated",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash_list",
"namespace": "action_states"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/action_states",
"method": "GET",
"help": "/v6.0/action_states?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Timeout | timeout | no | Float | 15 | in seconds | |
| Progress | update_in | no | Float | number of seconds after which the state is returned if the progress has changed | ||
| Status | status | no | Boolean | status to check with if update_in is set | ||
| Current | current | no | Integer | progress to check with if update_in is set | ||
| Total | total | no | Integer | progress to check with if update_in is set |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Finished | finished | Boolean | |
| Status | status | Boolean | Determines whether the action is proceeding or failing |
| Current progress | current | Integer | |
| Total | total | Integer | The action is finished when current equals to total |
| Unit | unit | String | Unit of current and total |
| Can cancel | can_cancel | Boolean | When true, execution of this action can be cancelled |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | When was the progress last updated |
{
"auth": false,
"description": "Returns when the action is completed or timeout occurs",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"timeout": {
"required": false,
"label": "Timeout",
"description": "in seconds",
"type": "Float",
"validators": {
},
"default": 15,
"protected": false
},
"update_in": {
"required": false,
"label": "Progress",
"description": "number of seconds after which the state is returned if the progress has changed",
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": "status to check with if update_in is set",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current": {
"required": false,
"label": "Current",
"description": "progress to check with if update_in is set",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total": {
"required": false,
"label": "Total",
"description": "progress to check with if update_in is set",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "action_state"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"finished": {
"required": false,
"label": "Finished",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": "Determines whether the action is proceeding or failing",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current": {
"required": false,
"label": "Current progress",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total": {
"required": false,
"label": "Total",
"description": "The action is finished when current equals to total",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"unit": {
"required": false,
"label": "Unit",
"description": "Unit of current and total",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"can_cancel": {
"required": false,
"label": "Can cancel",
"description": "When true, execution of this action can be cancelled",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": "When was the progress last updated",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "action_state"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/action_states/{action_state_id}/poll",
"method": "GET",
"help": "/v6.0/action_states/{action_state_id}/poll?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Finished | finished | Boolean | |
| Status | status | Boolean | Determines whether the action is proceeding or failing |
| Current progress | current | Integer | |
| Total | total | Integer | The action is finished when current equals to total |
| Unit | unit | String | Unit of current and total |
| Can cancel | can_cancel | Boolean | When true, execution of this action can be cancelled |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | When was the progress last updated |
{
"auth": false,
"description": "Show state of a pending action",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "action_state"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"finished": {
"required": false,
"label": "Finished",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": "Determines whether the action is proceeding or failing",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current": {
"required": false,
"label": "Current progress",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total": {
"required": false,
"label": "Total",
"description": "The action is finished when current equals to total",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"unit": {
"required": false,
"label": "Unit",
"description": "Unit of current and total",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"can_cancel": {
"required": false,
"label": "Can cancel",
"description": "When true, execution of this action can be cancelled",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": "When was the progress last updated",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "action_state"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/action_states/{action_state_id}",
"method": "GET",
"help": "/v6.0/action_states/{action_state_id}?method=GET"
}Manage the API server itself
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Passphrase | passphrase | yes | String | Present
|
No parameters.
{
"auth": true,
"description": "Unlock private key used for signing transactions",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"passphrase": {
"required": true,
"label": "Passphrase",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "api_server"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "api_server"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/api_servers/unlock_transaction_signing_key",
"method": "GET",
"help": "/v6.0/api_servers/unlock_transaction_signing_key?method=GET"
}Manage cluster
No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Nodes_online | nodes_online | Integer | |
| Node_count | node_count | Integer | |
| Vps_running | vps_running | Integer | |
| Vps_stopped | vps_stopped | Integer | |
| Vps_suspended | vps_suspended | Integer | |
| Vps_deleted | vps_deleted | Integer | |
| Vps_count | vps_count | Integer | |
| User_active | user_active | Integer | |
| User_suspended | user_suspended | Integer | |
| User_deleted | user_deleted | Integer | |
| User_count | user_count | Integer | |
| Ipv4_used | ipv4_used | Integer | |
| Ipv4_count | ipv4_count | Integer |
{
"auth": true,
"description": "Full statistics information",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "cluster"
},
"output": {
"parameters": {
"nodes_online": {
"required": false,
"label": "Nodes_online",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"node_count": {
"required": false,
"label": "Node_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_running": {
"required": false,
"label": "Vps_running",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_stopped": {
"required": false,
"label": "Vps_stopped",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_suspended": {
"required": false,
"label": "Vps_suspended",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_deleted": {
"required": false,
"label": "Vps_deleted",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_count": {
"required": false,
"label": "Vps_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_active": {
"required": false,
"label": "User_active",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_suspended": {
"required": false,
"label": "User_suspended",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_deleted": {
"required": false,
"label": "User_deleted",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_count": {
"required": false,
"label": "User_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ipv4_used": {
"required": false,
"label": "Ipv4_used",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ipv4_count": {
"required": false,
"label": "Ipv4_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "cluster"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster/full_stats",
"method": "GET",
"help": "/v6.0/cluster/full_stats?method=GET"
}No parameters.
No parameters.
{
"auth": true,
"description": "Generate ssh keys for VPS migrations where applicable",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "cluster"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "cluster"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/cluster/generate_migration_keys",
"method": "POST",
"help": "/v6.0/cluster/generate_migration_keys?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Number of users | user_count | Integer | |
| Number of VPSes | vps_count | Integer | |
| Number of free public IPv4 addresses | ipv4_left | Integer |
{
"auth": false,
"description": "Public statistics information",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "cluster"
},
"output": {
"parameters": {
"user_count": {
"required": false,
"label": "Number of users",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_count": {
"required": false,
"label": "Number of VPSes",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ipv4_left": {
"required": false,
"label": "Number of free public IPv4 addresses",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": null,
"request": {
},
"response": {
"user_count": 1100,
"vps_count": 1560,
"ipv4_left": 256
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/cluster/public_stats",
"method": "GET",
"help": "/v6.0/cluster/public_stats?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.cluster.public_stats
# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.user_count = 1100
# reply.vps_count = 1560
# reply.ipv4_left = 256
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.cluster.public_stats(function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
// reply.user_count = 1100
// reply.vps_count = 1560
// reply.ipv4_left = 256
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->cluster->public_stats();
// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->user_count = 1100
// $reply->vps_count = 1560
// $reply->ipv4_left = 256
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 cluster public_stats
Number of users: 1100
Number of VPSes: 1560
Number of free public IPv4 addresses: 256
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/cluster/actions/public_stats
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1
# Query the output parameters
$ cat output/user_count
1100
$ cat output/vps_count
1560
$ cat output/ipv4_left
256
$ curl --request GET \
--data-binary "{
\"cluster\": {
}
}" \
'http://api.vpsfree.cz/v6.0/cluster/public_stats'
{
"status": true,
"message": null,
"response": {
"cluster": {
"user_count": 1100,
"vps_count": 1560,
"ipv4_left": 256
}
},
"errors": null
}GET /v6.0/cluster/public_stats HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 175
{
"status": true,
"message": null,
"response": {
"cluster": {
"user_count": 1100,
"vps_count": 1560,
"ipv4_left": 256
}
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Value | value | yes | String | Present
|
Value to be searched for |
| Label | Name | Type | Description |
|---|---|---|---|
| Resource | resource | String | Resource name of the located object |
| ID | id | Integer | Identifier of the located object |
| Attribute | attribute | String | Name of the attribute containing the searched value |
| Value | value | String | Located value |
{
"auth": true,
"description": "Search users and VPSes by IDs, names and owned objects",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"value": {
"required": true,
"label": "Value",
"description": "Value to be searched for",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "cluster"
},
"output": {
"parameters": {
"resource": {
"required": false,
"label": "Resource",
"description": "Resource name of the located object",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"id": {
"required": false,
"label": "ID",
"description": "Identifier of the located object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"attribute": {
"required": false,
"label": "Attribute",
"description": "Name of the attribute containing the searched value",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": "Located value",
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash_list",
"namespace": "clusters"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster/search",
"method": "POST",
"help": "/v6.0/cluster/search?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Lock | lock | yes | Boolean | Present
|
||
| Reason | reason | no | String |
No parameters.
{
"auth": true,
"description": "Set maintenance lock",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"lock": {
"required": true,
"label": "Lock",
"description": null,
"type": "Boolean",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"validators": {
},
"default": "",
"protected": false
}
},
"layout": "hash",
"namespace": "cluster"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "cluster"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster/set_maintenance",
"method": "POST",
"help": "/v6.0/cluster/set_maintenance?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Maintenance_lock | maintenance_lock | Boolean | |
| Maintenance_lock_reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "Cluster information",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "cluster"
},
"output": {
"parameters": {
"maintenance_lock": {
"required": false,
"label": "Maintenance_lock",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"maintenance_lock_reason": {
"required": false,
"label": "Maintenance_lock_reason",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster"
},
"meta": {
"object": null,
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster",
"method": "GET",
"help": "/v6.0/cluster?method=GET"
}Manage environment resources
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Resource name for internal purposes | name | no | String | |||
| Label | label | no | String | |||
| Minimum value | min | no | Integer | When an object is allocating a resource, it must use more than minimum | ||
| Maximum value | max | no | Integer | When an object is allocating a resource, it must not use more than maximum | ||
| Step size | stepsize | no | Integer | Steps in which the objects allocated resource value may be iterated |
No parameters.
{
"auth": true,
"description": "Create an environment resource",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Resource name for internal purposes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"min": {
"required": false,
"label": "Minimum value",
"description": "When an object is allocating a resource, it must use more than minimum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max": {
"required": false,
"label": "Maximum value",
"description": "When an object is allocating a resource, it must not use more than maximum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"stepsize": {
"required": false,
"label": "Step size",
"description": "Steps in which the objects allocated resource value may be iterated",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "cluster_resource"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resources",
"method": "POST",
"help": "/v6.0/cluster_resources?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Resource name for internal purposes | name | String | |
| Label | label | String | |
| Minimum value | min | Integer | When an object is allocating a resource, it must use more than minimum |
| Maximum value | max | Integer | When an object is allocating a resource, it must not use more than maximum |
| Step size | stepsize | Integer | Steps in which the objects allocated resource value may be iterated |
{
"auth": true,
"description": "List environment resources",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Resource name for internal purposes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"min": {
"required": false,
"label": "Minimum value",
"description": "When an object is allocating a resource, it must use more than minimum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max": {
"required": false,
"label": "Maximum value",
"description": "When an object is allocating a resource, it must not use more than maximum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"stepsize": {
"required": false,
"label": "Step size",
"description": "Steps in which the objects allocated resource value may be iterated",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "cluster_resources"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/cluster_resources",
"method": "GET",
"help": "/v6.0/cluster_resources?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Resource name for internal purposes | name | String | |
| Label | label | String | |
| Minimum value | min | Integer | When an object is allocating a resource, it must use more than minimum |
| Maximum value | max | Integer | When an object is allocating a resource, it must not use more than maximum |
| Step size | stepsize | Integer | Steps in which the objects allocated resource value may be iterated |
{
"auth": true,
"description": "Show environment resource",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "cluster_resource"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Resource name for internal purposes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"min": {
"required": false,
"label": "Minimum value",
"description": "When an object is allocating a resource, it must use more than minimum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max": {
"required": false,
"label": "Maximum value",
"description": "When an object is allocating a resource, it must not use more than maximum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"stepsize": {
"required": false,
"label": "Step size",
"description": "Steps in which the objects allocated resource value may be iterated",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resources/{cluster_resource_id}",
"method": "GET",
"help": "/v6.0/cluster_resources/{cluster_resource_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Resource name for internal purposes | name | no | String | |||
| Label | label | no | String | |||
| Minimum value | min | no | Integer | When an object is allocating a resource, it must use more than minimum | ||
| Maximum value | max | no | Integer | When an object is allocating a resource, it must not use more than maximum | ||
| Step size | stepsize | no | Integer | Steps in which the objects allocated resource value may be iterated |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Resource name for internal purposes | name | String | |
| Label | label | String | |
| Minimum value | min | Integer | When an object is allocating a resource, it must use more than minimum |
| Maximum value | max | Integer | When an object is allocating a resource, it must not use more than maximum |
| Step size | stepsize | Integer | Steps in which the objects allocated resource value may be iterated |
{
"auth": true,
"description": "Update an environment resource",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Resource name for internal purposes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"min": {
"required": false,
"label": "Minimum value",
"description": "When an object is allocating a resource, it must use more than minimum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max": {
"required": false,
"label": "Maximum value",
"description": "When an object is allocating a resource, it must not use more than maximum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"stepsize": {
"required": false,
"label": "Step size",
"description": "Steps in which the objects allocated resource value may be iterated",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Resource name for internal purposes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"min": {
"required": false,
"label": "Minimum value",
"description": "When an object is allocating a resource, it must use more than minimum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max": {
"required": false,
"label": "Maximum value",
"description": "When an object is allocating a resource, it must not use more than maximum",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"stepsize": {
"required": false,
"label": "Step size",
"description": "Steps in which the objects allocated resource value may be iterated",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resources/{cluster_resource_id}",
"method": "PUT",
"help": "/v6.0/cluster_resources/{cluster_resource_id}?method=PUT"
}Manage cluster resource packages
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | yes | String | Present
Length
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Environment | environment | Resource | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Create a cluster resource package",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": true,
"label": "Label",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be minimally 2",
"min": 2
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages",
"method": "POST",
"help": "/v6.0/cluster_resource_packages?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete a cluster resource package",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}",
"method": "DELETE",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| Environment | environment | no | Resource | |||
| User | user | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Environment | environment | Resource | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List cluster resource packages",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "cluster_resource_packages"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages",
"method": "GET",
"help": "/v6.0/cluster_resource_packages?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Environment | environment | Resource | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show cluster resource package",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}",
"method": "GET",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | yes | String | Present
Length
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Environment | environment | Resource | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update a cluster resource package",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": true,
"label": "Label",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be minimally 2",
"min": 2
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "cluster_resource_package"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}",
"method": "PUT",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}?method=PUT"
}Manage cluster resource package contents
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| ClusterResource | cluster_resource | no | Resource | |||
| Value | value | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| ClusterResource | cluster_resource | Resource | |
| Value | value | Integer |
{
"auth": true,
"description": "Add item to a cluster resource package",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"cluster_resource": {
"required": null,
"label": "ClusterResource",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resources",
"method": "GET",
"help": "/v6.0/cluster_resources?method=GET"
}
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "item"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cluster_resource": {
"required": null,
"label": "ClusterResource",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resources",
"method": "GET",
"help": "/v6.0/cluster_resources?method=GET"
}
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "item"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items",
"method": "POST",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete an item from a cluster resource package",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "item"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "item"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}",
"method": "DELETE",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| ClusterResource | cluster_resource | Resource | |
| Value | value | Integer |
{
"auth": true,
"description": "List cluster resource package contents",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "item"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cluster_resource": {
"required": null,
"label": "ClusterResource",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resources",
"method": "GET",
"help": "/v6.0/cluster_resources?method=GET"
}
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "items"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items",
"method": "GET",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| ClusterResource | cluster_resource | Resource | |
| Value | value | Integer |
{
"auth": true,
"description": "Show cluster resource package item",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "item"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cluster_resource": {
"required": null,
"label": "ClusterResource",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resources",
"method": "GET",
"help": "/v6.0/cluster_resources?method=GET"
}
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "item"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}",
"method": "GET",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Value | value | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| ClusterResource | cluster_resource | Resource | |
| Value | value | Integer |
{
"auth": true,
"description": "Update item in a cluster resource package",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "item"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cluster_resource": {
"required": null,
"label": "ClusterResource",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resources",
"method": "GET",
"help": "/v6.0/cluster_resources?method=GET"
}
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "item"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}",
"method": "PUT",
"help": "/v6.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}?method=PUT"
}Manage datasets
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | yes | String | Present
Format
|
||
| Parent dataset | dataset | no | Resource | |||
| Automount | automount | no | Boolean | false | Automatically mount newly created datasets under all its parents | |
| Access time | atime | no | Boolean | false | Controls whether the access time for files is updated when they are read | |
| Compression | compression | no | Boolean | true | Toggle data compression in this dataset | |
| Record size | recordsize | no | Integer | 131072 | Specifies a suggested block size for files in the file system | |
| Quota | quota | no | Integer | 0 | Limits the amount of space a dataset and all its descendants can consume | |
| Reference quota | refquota | no | Integer | 0 | Limits the amount of space a dataset can consume | |
| Relative access time | relatime | no | Boolean | false | Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours | |
| Sync | sync | no | String | Include
|
standard | Controls the behavior of synchronous requests |
| NFS share | sharenfs | no | String | Controls NFS sharing |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Parent | parent | Resource | |
| User | user | Resource | Dataset owner |
| Environment | environment | Resource | The environment in which the dataset is |
| Current_history_id | current_history_id | Integer | |
| Access time | atime | Boolean | Controls whether the access time for files is updated when they are read |
| Compression | compression | Boolean | Toggle data compression in this dataset |
| Record size | recordsize | Integer | Specifies a suggested block size for files in the file system |
| Quota | quota | Integer | Limits the amount of space a dataset and all its descendants can consume |
| Reference quota | refquota | Integer | Limits the amount of space a dataset can consume |
| Relative access time | relatime | Boolean | Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours |
| Sync | sync | String | Controls the behavior of synchronous requests |
| NFS share | sharenfs | String | Controls NFS sharing |
| Used space | used | Integer | Amount of space used by dataset |
| Referenced space | referenced | Integer | Amount of space that is accessible to this dataset |
| Available space | avail | Integer | Amount of space left in dataset |
| Export | export | Resource | |
| DatasetExpansion | dataset_expansion | Resource |
{
"auth": true,
"description": "Create a subdataset",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"name": {
"required": true,
"label": "Name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"format": {
"rx": "\\A[a-zA-Z0-9][a-zA-Z0-9_\\-:\\./]{0,254}\\z",
"match": true,
"description": null,
"message": "'%{value}' is not a valid dataset name"
}
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Parent dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "full_name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"automount": {
"required": false,
"label": "Automount",
"description": "Automatically mount newly created datasets under all its parents",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"atime": {
"required": false,
"label": "Access time",
"description": "Controls whether the access time for files is updated when they are read",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"compression": {
"required": false,
"label": "Compression",
"description": "Toggle data compression in this dataset",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"recordsize": {
"required": false,
"label": "Record size",
"description": "Specifies a suggested block size for files in the file system",
"type": "Integer",
"validators": {
},
"default": 131072,
"protected": false
},
"quota": {
"required": false,
"label": "Quota",
"description": "Limits the amount of space a dataset and all its descendants can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"refquota": {
"required": false,
"label": "Reference quota",
"description": "Limits the amount of space a dataset can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"relatime": {
"required": false,
"label": "Relative access time",
"description": "Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Controls the behavior of synchronous requests",
"type": "String",
"validators": {
"include": {
"values": [
"standard",
"disabled"
],
"message": "%{value} cannot be used"
}
},
"default": "standard",
"protected": false
},
"sharenfs": {
"required": false,
"label": "NFS share",
"description": "Controls NFS sharing",
"type": "String",
"validators": {
},
"default": "",
"protected": false
}
},
"layout": "object",
"namespace": "dataset"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"parent": {
"required": null,
"label": "Parent",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": "Dataset owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "The environment in which the dataset is",
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"current_history_id": {
"required": false,
"label": "Current_history_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"atime": {
"required": false,
"label": "Access time",
"description": "Controls whether the access time for files is updated when they are read",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"compression": {
"required": false,
"label": "Compression",
"description": "Toggle data compression in this dataset",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"recordsize": {
"required": false,
"label": "Record size",
"description": "Specifies a suggested block size for files in the file system",
"type": "Integer",
"validators": {
},
"default": 131072,
"protected": false
},
"quota": {
"required": false,
"label": "Quota",
"description": "Limits the amount of space a dataset and all its descendants can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"refquota": {
"required": false,
"label": "Reference quota",
"description": "Limits the amount of space a dataset can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"relatime": {
"required": false,
"label": "Relative access time",
"description": "Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Controls the behavior of synchronous requests",
"type": "String",
"validators": {
"include": {
"values": [
"standard",
"disabled"
],
"message": "%{value} cannot be used"
}
},
"default": "standard",
"protected": false
},
"sharenfs": {
"required": false,
"label": "NFS share",
"description": "Controls NFS sharing",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"used": {
"required": false,
"label": "Used space",
"description": "Amount of space used by dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"referenced": {
"required": false,
"label": "Referenced space",
"description": "Amount of space that is accessible to this dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"avail": {
"required": false,
"label": "Available space",
"description": "Amount of space left in dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"dataset_expansion": {
"required": null,
"label": "DatasetExpansion",
"description": null,
"type": "Resource",
"resource": [
"dataset_expansion"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/dataset_expansions",
"method": "GET",
"help": "/v6.0/dataset_expansions?method=GET"
}
}
},
"layout": "object",
"namespace": "dataset"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets",
"method": "POST",
"help": "/v6.0/datasets?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Destroy a dataset with all its subdatasets and snapshots",
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "dataset"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "dataset"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}",
"method": "DELETE",
"help": "/v6.0/datasets/{dataset_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | no | String | |||
| User | user | no | Resource | Dataset owner |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Parent | parent | Resource | |
| User | user | Resource | Dataset owner |
| Environment | environment | Resource | The environment in which the dataset is |
| Current_history_id | current_history_id | Integer | |
| Access time | atime | Boolean | Controls whether the access time for files is updated when they are read |
| Compression | compression | Boolean | Toggle data compression in this dataset |
| Record size | recordsize | Integer | Specifies a suggested block size for files in the file system |
| Quota | quota | Integer | Limits the amount of space a dataset and all its descendants can consume |
| Reference quota | refquota | Integer | Limits the amount of space a dataset can consume |
| Relative access time | relatime | Boolean | Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours |
| Sync | sync | String | Controls the behavior of synchronous requests |
| NFS share | sharenfs | String | Controls NFS sharing |
| Used space | used | Integer | Amount of space used by dataset |
| Referenced space | referenced | Integer | Amount of space that is accessible to this dataset |
| Available space | avail | Integer | Amount of space left in dataset |
| Export | export | Resource | |
| DatasetExpansion | dataset_expansion | Resource |
{
"auth": true,
"description": "Look up dataset by its name, possibly with a label",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "Dataset owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object",
"namespace": "dataset"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"parent": {
"required": null,
"label": "Parent",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": "Dataset owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "The environment in which the dataset is",
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"current_history_id": {
"required": false,
"label": "Current_history_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"atime": {
"required": false,
"label": "Access time",
"description": "Controls whether the access time for files is updated when they are read",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"compression": {
"required": false,
"label": "Compression",
"description": "Toggle data compression in this dataset",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"recordsize": {
"required": false,
"label": "Record size",
"description": "Specifies a suggested block size for files in the file system",
"type": "Integer",
"validators": {
},
"default": 131072,
"protected": false
},
"quota": {
"required": false,
"label": "Quota",
"description": "Limits the amount of space a dataset and all its descendants can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"refquota": {
"required": false,
"label": "Reference quota",
"description": "Limits the amount of space a dataset can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"relatime": {
"required": false,
"label": "Relative access time",
"description": "Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Controls the behavior of synchronous requests",
"type": "String",
"validators": {
"include": {
"values": [
"standard",
"disabled"
],
"message": "%{value} cannot be used"
}
},
"default": "standard",
"protected": false
},
"sharenfs": {
"required": false,
"label": "NFS share",
"description": "Controls NFS sharing",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"used": {
"required": false,
"label": "Used space",
"description": "Amount of space used by dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"referenced": {
"required": false,
"label": "Referenced space",
"description": "Amount of space that is accessible to this dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"avail": {
"required": false,
"label": "Available space",
"description": "Amount of space left in dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"dataset_expansion": {
"required": null,
"label": "DatasetExpansion",
"description": null,
"type": "Resource",
"resource": [
"dataset_expansion"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/dataset_expansions",
"method": "GET",
"help": "/v6.0/dataset_expansions?method=GET"
}
}
},
"layout": "object",
"namespace": "dataset"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/datasets/find_by_name",
"method": "GET",
"help": "/v6.0/datasets/find_by_name?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| User | user | no | Resource | Dataset owner | ||
| Subtree | dataset | no | Resource | |||
| Role | role | no | String | Include
|
Show only datasets of certain role | |
| To depth | to_depth | no | Integer | Show only datasets to certain depth |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Parent | parent | Resource | |
| User | user | Resource | Dataset owner |
| Environment | environment | Resource | The environment in which the dataset is |
| Current_history_id | current_history_id | Integer | |
| Access time | atime | Boolean | Controls whether the access time for files is updated when they are read |
| Compression | compression | Boolean | Toggle data compression in this dataset |
| Record size | recordsize | Integer | Specifies a suggested block size for files in the file system |
| Quota | quota | Integer | Limits the amount of space a dataset and all its descendants can consume |
| Reference quota | refquota | Integer | Limits the amount of space a dataset can consume |
| Relative access time | relatime | Boolean | Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours |
| Sync | sync | String | Controls the behavior of synchronous requests |
| NFS share | sharenfs | String | Controls NFS sharing |
| Used space | used | Integer | Amount of space used by dataset |
| Referenced space | referenced | Integer | Amount of space that is accessible to this dataset |
| Available space | avail | Integer | Amount of space left in dataset |
| Export | export | Resource | |
| DatasetExpansion | dataset_expansion | Resource |
{
"auth": true,
"description": "List datasets",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "Dataset owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"dataset": {
"required": null,
"label": "Subtree",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"role": {
"required": false,
"label": "Role",
"description": "Show only datasets of certain role",
"type": "String",
"validators": {
"include": {
"values": [
"hypervisor",
"primary",
"backup"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"to_depth": {
"required": false,
"label": "To depth",
"description": "Show only datasets to certain depth",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"parent": {
"required": null,
"label": "Parent",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": "Dataset owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "The environment in which the dataset is",
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"current_history_id": {
"required": false,
"label": "Current_history_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"atime": {
"required": false,
"label": "Access time",
"description": "Controls whether the access time for files is updated when they are read",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"compression": {
"required": false,
"label": "Compression",
"description": "Toggle data compression in this dataset",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"recordsize": {
"required": false,
"label": "Record size",
"description": "Specifies a suggested block size for files in the file system",
"type": "Integer",
"validators": {
},
"default": 131072,
"protected": false
},
"quota": {
"required": false,
"label": "Quota",
"description": "Limits the amount of space a dataset and all its descendants can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"refquota": {
"required": false,
"label": "Reference quota",
"description": "Limits the amount of space a dataset can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"relatime": {
"required": false,
"label": "Relative access time",
"description": "Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Controls the behavior of synchronous requests",
"type": "String",
"validators": {
"include": {
"values": [
"standard",
"disabled"
],
"message": "%{value} cannot be used"
}
},
"default": "standard",
"protected": false
},
"sharenfs": {
"required": false,
"label": "NFS share",
"description": "Controls NFS sharing",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"used": {
"required": false,
"label": "Used space",
"description": "Amount of space used by dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"referenced": {
"required": false,
"label": "Referenced space",
"description": "Amount of space that is accessible to this dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"avail": {
"required": false,
"label": "Available space",
"description": "Amount of space left in dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"dataset_expansion": {
"required": null,
"label": "DatasetExpansion",
"description": null,
"type": "Resource",
"resource": [
"dataset_expansion"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/dataset_expansions",
"method": "GET",
"help": "/v6.0/dataset_expansions?method=GET"
}
}
},
"layout": "object_list",
"namespace": "datasets"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Property | property | yes | String | Present
|
Name of property to inherit from parent, multiple properties may be separated by a comma |
No parameters.
{
"auth": true,
"description": "Inherit dataset property",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"property": {
"required": true,
"label": "Property",
"description": "Name of property to inherit from parent, multiple properties may be separated by a comma",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "dataset"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/inherit",
"method": "POST",
"help": "/v6.0/datasets/{dataset_id}/inherit?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Parent | parent | Resource | |
| User | user | Resource | Dataset owner |
| Environment | environment | Resource | The environment in which the dataset is |
| Current_history_id | current_history_id | Integer | |
| Access time | atime | Boolean | Controls whether the access time for files is updated when they are read |
| Compression | compression | Boolean | Toggle data compression in this dataset |
| Record size | recordsize | Integer | Specifies a suggested block size for files in the file system |
| Quota | quota | Integer | Limits the amount of space a dataset and all its descendants can consume |
| Reference quota | refquota | Integer | Limits the amount of space a dataset can consume |
| Relative access time | relatime | Boolean | Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours |
| Sync | sync | String | Controls the behavior of synchronous requests |
| NFS share | sharenfs | String | Controls NFS sharing |
| Used space | used | Integer | Amount of space used by dataset |
| Referenced space | referenced | Integer | Amount of space that is accessible to this dataset |
| Available space | avail | Integer | Amount of space left in dataset |
| Export | export | Resource | |
| DatasetExpansion | dataset_expansion | Resource |
{
"auth": true,
"description": "Show a dataset",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "dataset"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"parent": {
"required": null,
"label": "Parent",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": "Dataset owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "The environment in which the dataset is",
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"current_history_id": {
"required": false,
"label": "Current_history_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"atime": {
"required": false,
"label": "Access time",
"description": "Controls whether the access time for files is updated when they are read",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"compression": {
"required": false,
"label": "Compression",
"description": "Toggle data compression in this dataset",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"recordsize": {
"required": false,
"label": "Record size",
"description": "Specifies a suggested block size for files in the file system",
"type": "Integer",
"validators": {
},
"default": 131072,
"protected": false
},
"quota": {
"required": false,
"label": "Quota",
"description": "Limits the amount of space a dataset and all its descendants can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"refquota": {
"required": false,
"label": "Reference quota",
"description": "Limits the amount of space a dataset can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"relatime": {
"required": false,
"label": "Relative access time",
"description": "Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Controls the behavior of synchronous requests",
"type": "String",
"validators": {
"include": {
"values": [
"standard",
"disabled"
],
"message": "%{value} cannot be used"
}
},
"default": "standard",
"protected": false
},
"sharenfs": {
"required": false,
"label": "NFS share",
"description": "Controls NFS sharing",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"used": {
"required": false,
"label": "Used space",
"description": "Amount of space used by dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"referenced": {
"required": false,
"label": "Referenced space",
"description": "Amount of space that is accessible to this dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"avail": {
"required": false,
"label": "Available space",
"description": "Amount of space left in dataset",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"dataset_expansion": {
"required": null,
"label": "DatasetExpansion",
"description": null,
"type": "Resource",
"resource": [
"dataset_expansion"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/dataset_expansions",
"method": "GET",
"help": "/v6.0/dataset_expansions?method=GET"
}
}
},
"layout": "object",
"namespace": "dataset"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Access time | atime | no | Boolean | false | Controls whether the access time for files is updated when they are read | |
| Compression | compression | no | Boolean | true | Toggle data compression in this dataset | |
| Record size | recordsize | no | Integer | 131072 | Specifies a suggested block size for files in the file system | |
| Quota | quota | no | Integer | 0 | Limits the amount of space a dataset and all its descendants can consume | |
| Reference quota | refquota | no | Integer | 0 | Limits the amount of space a dataset can consume | |
| Relative access time | relatime | no | Boolean | false | Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours | |
| Sync | sync | no | String | Include
|
standard | Controls the behavior of synchronous requests |
| NFS share | sharenfs | no | String | Controls NFS sharing | ||
| Admin override | admin_override | no | Boolean | Make it possible to assign more resource than the user actually has | ||
| Admin lock type | admin_lock_type | no | String | Include
|
How is the admin lock enforced |
No parameters.
{
"auth": true,
"description": "Update a dataset",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"atime": {
"required": false,
"label": "Access time",
"description": "Controls whether the access time for files is updated when they are read",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"compression": {
"required": false,
"label": "Compression",
"description": "Toggle data compression in this dataset",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"recordsize": {
"required": false,
"label": "Record size",
"description": "Specifies a suggested block size for files in the file system",
"type": "Integer",
"validators": {
},
"default": 131072,
"protected": false
},
"quota": {
"required": false,
"label": "Quota",
"description": "Limits the amount of space a dataset and all its descendants can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"refquota": {
"required": false,
"label": "Reference quota",
"description": "Limits the amount of space a dataset can consume",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"relatime": {
"required": false,
"label": "Relative access time",
"description": "Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Controls the behavior of synchronous requests",
"type": "String",
"validators": {
"include": {
"values": [
"standard",
"disabled"
],
"message": "%{value} cannot be used"
}
},
"default": "standard",
"protected": false
},
"sharenfs": {
"required": false,
"label": "NFS share",
"description": "Controls NFS sharing",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"admin_override": {
"required": false,
"label": "Admin override",
"description": "Make it possible to assign more resource than the user actually has",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"admin_lock_type": {
"required": false,
"label": "Admin lock type",
"description": "How is the admin lock enforced",
"type": "String",
"validators": {
"include": {
"values": [
"no_lock",
"absolute",
"not_less",
"not_more"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "dataset"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}",
"method": "PUT",
"help": "/v6.0/datasets/{dataset_id}?method=PUT"
}Manage dataset plans
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Environment_dataset_plan | environment_dataset_plan | yes | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment_dataset_plan | environment_dataset_plan | Resource |
{
"auth": true,
"description": "Assign new dataset plan",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"environment_dataset_plan": {
"required": true,
"label": "Environment_dataset_plan",
"description": null,
"type": "Resource",
"resource": [
"environment",
"dataset_plan"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments/{environment_id}/dataset_plans",
"method": "GET",
"help": "/v6.0/environments/{environment_id}/dataset_plans?method=GET"
}
}
},
"layout": "object",
"namespace": "plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"environment_dataset_plan": {
"required": true,
"label": "Environment_dataset_plan",
"description": null,
"type": "Resource",
"resource": [
"environment",
"dataset_plan"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments/{environment_id}/dataset_plans",
"method": "GET",
"help": "/v6.0/environments/{environment_id}/dataset_plans?method=GET"
}
}
},
"layout": "object",
"namespace": "plan"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/plans",
"method": "POST",
"help": "/v6.0/datasets/{dataset_id}/plans?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Remove dataset plan",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "plan"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "plan"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/plans/{plan_id}",
"method": "DELETE",
"help": "/v6.0/datasets/{dataset_id}/plans/{plan_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment_dataset_plan | environment_dataset_plan | Resource |
{
"auth": true,
"description": null,
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"environment_dataset_plan": {
"required": true,
"label": "Environment_dataset_plan",
"description": null,
"type": "Resource",
"resource": [
"environment",
"dataset_plan"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments/{environment_id}/dataset_plans",
"method": "GET",
"help": "/v6.0/environments/{environment_id}/dataset_plans?method=GET"
}
}
},
"layout": "object_list",
"namespace": "plans"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/plans",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/plans?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment_dataset_plan | environment_dataset_plan | Resource |
{
"auth": true,
"description": "Show dataset plan",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"environment_dataset_plan": {
"required": true,
"label": "Environment_dataset_plan",
"description": null,
"type": "Resource",
"resource": [
"environment",
"dataset_plan"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments/{environment_id}/dataset_plans",
"method": "GET",
"help": "/v6.0/environments/{environment_id}/dataset_plans?method=GET"
}
}
},
"layout": "object",
"namespace": "plan"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/plans/{plan_id}",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/plans/{plan_id}?method=GET"
}View property history
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | 25 | The number of objects to retrieve | |
| From | from | no | Datetime | |||
| To | to | no | Datetime | |||
| Name | name | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Value | value | Integer | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": 25,
"protected": false
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "property_history"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "property_histories"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/property_history",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/property_history?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Value | value | Integer | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "property_history"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "property_history"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/property_history/{property_history_id}",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/property_history/{property_history_id}?method=GET"
}Manage dataset snapshots
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Dataset | dataset | Resource | |
| Name | name | String | |
| Label | label | String | |
| Created_at | created_at | Datetime | |
| History_id | history_id | Integer | |
| Mount | mount | Resource | |
| Export | export | Resource |
{
"auth": true,
"description": "Create snapshot",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "snapshot"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"history_id": {
"required": false,
"label": "History_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mount": {
"required": null,
"label": "Mount",
"description": null,
"type": "Resource",
"resource": [
"vps",
"mount"
],
"value_id": "id",
"value_label": "mountpoint",
"value": null,
"choices": {
"path": "/v6.0/vpses/{vps_id}/mounts",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/mounts?method=GET"
}
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
}
},
"layout": "object",
"namespace": "snapshot"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "POST",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Destroy a snapshot",
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/snapshots/{snapshot_id}",
"method": "DELETE",
"help": "/v6.0/datasets/{dataset_id}/snapshots/{snapshot_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Dataset | dataset | Resource | |
| Name | name | String | |
| Label | label | String | |
| Created_at | created_at | Datetime | |
| History_id | history_id | Integer | |
| Mount | mount | Resource | |
| Export | export | Resource |
{
"auth": true,
"description": "List snapshots",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "snapshot"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"history_id": {
"required": false,
"label": "History_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mount": {
"required": null,
"label": "Mount",
"description": null,
"type": "Resource",
"resource": [
"vps",
"mount"
],
"value_id": "id",
"value_label": "mountpoint",
"value": null,
"choices": {
"path": "/v6.0/vpses/{vps_id}/mounts",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/mounts?method=GET"
}
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
}
},
"layout": "object_list",
"namespace": "snapshots"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=GET"
}No parameters.
No parameters.
{
"auth": true,
"description": "Rollback to a snapshot",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/snapshots/{snapshot_id}/rollback",
"method": "POST",
"help": "/v6.0/datasets/{dataset_id}/snapshots/{snapshot_id}/rollback?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Dataset | dataset | Resource | |
| Name | name | String | |
| Label | label | String | |
| Created_at | created_at | Datetime | |
| History_id | history_id | Integer | |
| Mount | mount | Resource | |
| Export | export | Resource |
{
"auth": true,
"description": "Show snapshot",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"history_id": {
"required": false,
"label": "History_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mount": {
"required": null,
"label": "Mount",
"description": null,
"type": "Resource",
"resource": [
"vps",
"mount"
],
"value_id": "id",
"value_label": "mountpoint",
"value": null,
"choices": {
"path": "/v6.0/vpses/{vps_id}/mounts",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/mounts?method=GET"
}
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
}
},
"layout": "object",
"namespace": "snapshot"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/datasets/{dataset_id}/snapshots/{snapshot_id}",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots/{snapshot_id}?method=GET"
}Browse dataset expansions
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Dataset | dataset | no | Resource | |||
| Added space | added_space | no | Integer | Number
|
||
| Enable notifications | enable_notifications | no | Boolean | Send emails about the expansion | ||
| Enable shrink | enable_shrink | no | Boolean | Automatically shrink the dataset when possible | ||
| Stop VPS | stop_vps | no | Boolean | Stop the VPS after deadline passes or too many expansions | ||
| Deadline | deadline | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| State | state | String | |
| Original reference quota | original_refquota | Integer | |
| Added space | added_space | Integer | |
| Enable notifications | enable_notifications | Boolean | Send emails about the expansion |
| Enable shrink | enable_shrink | Boolean | Automatically shrink the dataset when possible |
| Stop VPS | stop_vps | Boolean | Stop the VPS after deadline passes or too many expansions |
| Deadline | deadline | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Create dataset expansion",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 1",
"min": 1
}
},
"default": null,
"protected": false
},
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original reference quota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions",
"method": "POST",
"help": "/v6.0/dataset_expansions?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| State | state | String | |
| Original reference quota | original_refquota | Integer | |
| Added space | added_space | Integer | |
| Enable notifications | enable_notifications | Boolean | Send emails about the expansion |
| Enable shrink | enable_shrink | Boolean | Automatically shrink the dataset when possible |
| Stop VPS | stop_vps | Boolean | Stop the VPS after deadline passes or too many expansions |
| Deadline | deadline | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "List dataset expansions",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original reference quota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "dataset_expansions"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions",
"method": "GET",
"help": "/v6.0/dataset_expansions?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Dataset | dataset | no | Resource | |||
| Original reference quota | original_refquota | no | Integer | Number
|
||
| Enable notifications | enable_notifications | no | Boolean | Send emails about the expansion | ||
| Enable shrink | enable_shrink | no | Boolean | Automatically shrink the dataset when possible | ||
| Stop VPS | stop_vps | no | Boolean | Stop the VPS after deadline passes or too many expansions | ||
| Deadline | deadline | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| State | state | String | |
| Original reference quota | original_refquota | Integer | |
| Added space | added_space | Integer | |
| Enable notifications | enable_notifications | Boolean | Send emails about the expansion |
| Enable shrink | enable_shrink | Boolean | Automatically shrink the dataset when possible |
| Stop VPS | stop_vps | Boolean | Stop the VPS after deadline passes or too many expansions |
| Deadline | deadline | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Create dataset expansion for an already expanded dataset",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"original_refquota": {
"required": false,
"label": "Original reference quota",
"description": null,
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 1",
"min": 1
}
},
"default": null,
"protected": false
},
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original reference quota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions/register_expanded",
"method": "POST",
"help": "/v6.0/dataset_expansions/register_expanded?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| State | state | String | |
| Original reference quota | original_refquota | Integer | |
| Added space | added_space | Integer | |
| Enable notifications | enable_notifications | Boolean | Send emails about the expansion |
| Enable shrink | enable_shrink | Boolean | Automatically shrink the dataset when possible |
| Stop VPS | stop_vps | Boolean | Stop the VPS after deadline passes or too many expansions |
| Deadline | deadline | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Show dataset expansion",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "dataset_expansion"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original reference quota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions/{dataset_expansion_id}",
"method": "GET",
"help": "/v6.0/dataset_expansions/{dataset_expansion_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Enable notifications | enable_notifications | no | Boolean | Send emails about the expansion | ||
| Enable shrink | enable_shrink | no | Boolean | Automatically shrink the dataset when possible | ||
| Stop VPS | stop_vps | no | Boolean | Stop the VPS after deadline passes or too many expansions | ||
| Deadline | deadline | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| State | state | String | |
| Original reference quota | original_refquota | Integer | |
| Added space | added_space | Integer | |
| Enable notifications | enable_notifications | Boolean | Send emails about the expansion |
| Enable shrink | enable_shrink | Boolean | Automatically shrink the dataset when possible |
| Stop VPS | stop_vps | Boolean | Stop the VPS after deadline passes or too many expansions |
| Deadline | deadline | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Update dataset expansion",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original reference quota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enable_notifications": {
"required": false,
"label": "Enable notifications",
"description": "Send emails about the expansion",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enable_shrink": {
"required": false,
"label": "Enable shrink",
"description": "Automatically shrink the dataset when possible",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"stop_vps": {
"required": false,
"label": "Stop VPS",
"description": "Stop the VPS after deadline passes or too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"deadline": {
"required": false,
"label": "Deadline",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_expansion"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions/{dataset_expansion_id}",
"method": "PUT",
"help": "/v6.0/dataset_expansions/{dataset_expansion_id}?method=PUT"
}Browse dataset expansion history
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Added space | added_space | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Added space | added_space | Integer | |
| Original refquota | original_refquota | Integer | |
| New refquota | new_refquota | Integer | |
| Created at | created_at | Datetime | |
| Admin | admin | Resource |
{
"auth": true,
"description": "Add extra space to the dataset",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "history"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original refquota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"new_refquota": {
"required": false,
"label": "New refquota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"admin": {
"required": null,
"label": "Admin",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object",
"namespace": "history"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions/{dataset_expansion_id}/history",
"method": "POST",
"help": "/v6.0/dataset_expansions/{dataset_expansion_id}/history?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Added space | added_space | Integer | |
| Original refquota | original_refquota | Integer | |
| New refquota | new_refquota | Integer | |
| Created at | created_at | Datetime | |
| Admin | admin | Resource |
{
"auth": true,
"description": "List dataset expansion history",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "history"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original refquota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"new_refquota": {
"required": false,
"label": "New refquota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"admin": {
"required": null,
"label": "Admin",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object_list",
"namespace": "histories"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions/{dataset_expansion_id}/history",
"method": "GET",
"help": "/v6.0/dataset_expansions/{dataset_expansion_id}/history?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Added space | added_space | Integer | |
| Original refquota | original_refquota | Integer | |
| New refquota | new_refquota | Integer | |
| Created at | created_at | Datetime | |
| Admin | admin | Resource |
{
"auth": true,
"description": "Show dataset expansion history",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "history"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"added_space": {
"required": false,
"label": "Added space",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"original_refquota": {
"required": false,
"label": "Original refquota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"new_refquota": {
"required": false,
"label": "New refquota",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"admin": {
"required": null,
"label": "Admin",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object",
"namespace": "history"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dataset_expansions/{dataset_expansion_id}/history/{history_id}",
"method": "GET",
"help": "/v6.0/dataset_expansions/{dataset_expansion_id}/history/{history_id}?method=GET"
}See dataset plans
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Label | label | String | |
| Description | description | String |
{
"auth": true,
"description": "List dataset plans",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "dataset_plans"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/dataset_plans",
"method": "GET",
"help": "/v6.0/dataset_plans?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Label | label | String | |
| Description | description | String |
{
"auth": true,
"description": "Show dataset plan",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "dataset_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_plan"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dataset_plans/{dataset_plan_id}",
"method": "GET",
"help": "/v6.0/dataset_plans/{dataset_plan_id}?method=GET"
}Manage DNS resolvers
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| IP address | ip_addr | yes | String | Present
|
Multiple addresses separated by comma | |
| Label | label | yes | String | Present
|
||
| Is universal? | is_universal | yes | Boolean | Present
|
Universal resolver is independent on location | |
| Location | location | no | Resource | Location this resolver can be used on |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | DNS resolver ID |
| IP address | ip_addr | String | Multiple addresses separated by comma |
| Label | label | String | |
| Is universal? | is_universal | Boolean | Universal resolver is independent on location |
| Location | location | Resource | Location this resolver can be used on |
{
"auth": true,
"description": "Create a DNS resolver",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"ip_addr": {
"required": true,
"label": "IP address",
"description": "Multiple addresses separated by comma",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"label": {
"required": true,
"label": "Label",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"is_universal": {
"required": true,
"label": "Is universal?",
"description": "Universal resolver is independent on location",
"type": "Boolean",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location this resolver can be used on",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
}
},
"layout": "object",
"namespace": "dns_resolver"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "DNS resolver ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_addr": {
"required": false,
"label": "IP address",
"description": "Multiple addresses separated by comma",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_universal": {
"required": false,
"label": "Is universal?",
"description": "Universal resolver is independent on location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location this resolver can be used on",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
}
},
"layout": "object",
"namespace": "dns_resolver"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dns_resolvers",
"method": "POST",
"help": "/v6.0/dns_resolvers?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Force deletion | force | no | Boolean | Delete the DNS resolver even it is in use. Affected VPSes get a new DNS resolver. |
No parameters.
{
"auth": true,
"description": null,
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
"force": {
"required": false,
"label": "Force deletion",
"description": "Delete the DNS resolver even it is in use. Affected VPSes get a new DNS resolver.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dns_resolver"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "dns_resolver"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dns_resolvers/{dns_resolver_id}",
"method": "DELETE",
"help": "/v6.0/dns_resolvers/{dns_resolver_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| VPS | vps | no | Resource | List DNS resolvers usable for a specific VPS |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | DNS resolver ID |
| IP address | ip_addr | String | Multiple addresses separated by comma |
| Label | label | String | |
| Is universal? | is_universal | Boolean | Universal resolver is independent on location |
| Location | location | Resource | Location this resolver can be used on |
{
"auth": true,
"description": "List DNS resolvers",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": "List DNS resolvers usable for a specific VPS",
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
}
},
"layout": "object",
"namespace": "dns_resolver"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "DNS resolver ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_addr": {
"required": false,
"label": "IP address",
"description": "Multiple addresses separated by comma",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_universal": {
"required": false,
"label": "Is universal?",
"description": "Universal resolver is independent on location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location this resolver can be used on",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
}
},
"layout": "object_list",
"namespace": "dns_resolvers"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": null,
"request": {
},
"response": [
{
"id": 26,
"ip_addr": "8.8.8.8",
"label": "Google DNS",
"is_universal": true,
"location": null
}
],
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.dns_resolver.index
# reply is an instance of HaveAPI::Client::ResourceInstanceList,
# which is a subclass of Arrayimport HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.dns_resolver.index(function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstanceList
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->dns_resolver->index();
// $reply is an instance of \HaveAPI\Client\ResourceInstanceList$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 dns_resolver index
ID: 26
IP address: 8.8.8.8
Label: Google DNS
Is universal?: true
Location: -
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/dns_resolver/actions/index
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request GET \
--data-binary "{
\"dns_resolver\": {
}
}" \
'http://api.vpsfree.cz/v6.0/dns_resolvers'
{
"status": true,
"message": null,
"response": {
"dns_resolvers": [
{
"id": 26,
"ip_addr": "8.8.8.8",
"label": "Google DNS",
"is_universal": true,
"location": null
}
]
},
"errors": null
}GET /v6.0/dns_resolvers HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 257
{
"status": true,
"message": null,
"response": {
"dns_resolvers": [
{
"id": 26,
"ip_addr": "8.8.8.8",
"label": "Google DNS",
"is_universal": true,
"location": null
}
]
},
"errors": null
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | DNS resolver ID |
| IP address | ip_addr | String | Multiple addresses separated by comma |
| Label | label | String | |
| Is universal? | is_universal | Boolean | Universal resolver is independent on location |
| Location | location | Resource | Location this resolver can be used on |
{
"auth": true,
"description": "Show DNS resolver",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "dns_resolver"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "DNS resolver ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_addr": {
"required": false,
"label": "IP address",
"description": "Multiple addresses separated by comma",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_universal": {
"required": false,
"label": "Is universal?",
"description": "Universal resolver is independent on location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location this resolver can be used on",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
}
},
"layout": "object",
"namespace": "dns_resolver"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dns_resolvers/{dns_resolver_id}",
"method": "GET",
"help": "/v6.0/dns_resolvers/{dns_resolver_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| IP address | ip_addr | no | String | Multiple addresses separated by comma | ||
| Label | label | no | String | |||
| Is universal? | is_universal | no | Boolean | Universal resolver is independent on location | ||
| Location | location | no | Resource | Location this resolver can be used on |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | DNS resolver ID |
| IP address | ip_addr | String | Multiple addresses separated by comma |
| Label | label | String | |
| Is universal? | is_universal | Boolean | Universal resolver is independent on location |
| Location | location | Resource | Location this resolver can be used on |
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"ip_addr": {
"required": false,
"label": "IP address",
"description": "Multiple addresses separated by comma",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_universal": {
"required": false,
"label": "Is universal?",
"description": "Universal resolver is independent on location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location this resolver can be used on",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
}
},
"layout": "object",
"namespace": "dns_resolver"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "DNS resolver ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_addr": {
"required": false,
"label": "IP address",
"description": "Multiple addresses separated by comma",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_universal": {
"required": false,
"label": "Is universal?",
"description": "Universal resolver is independent on location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location this resolver can be used on",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
}
},
"layout": "object",
"namespace": "dns_resolver"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/dns_resolvers/{dns_resolver_id}",
"method": "PUT",
"help": "/v6.0/dns_resolvers/{dns_resolver_id}?method=PUT"
}Manage environments
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | Environment label | ||
| Description | description | no | String | Environment description | ||
| Domain | domain | no | String | Format
|
Environment FQDN, should be subject's root domain | |
| Can create a VPS | can_create_vps | no | Boolean | false | ||
| Can destroy a VPS | can_destroy_vps | no | Boolean | false | ||
| Default VPS lifetime | vps_lifetime | no | Integer | 0 | in seconds, 0 is unlimited | |
| Maximum number of VPS per user | max_vps_count | no | Integer | 1 | 0 is unlimited | |
| User owns IP addresses | user_ip_ownership | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Environment ID |
| Label | label | String | Environment label |
| Description | description | String | Environment description |
| Domain | domain | String | Environment FQDN, should be subject's root domain |
| Can create a VPS | can_create_vps | Boolean | |
| Can destroy a VPS | can_destroy_vps | Boolean | |
| Default VPS lifetime | vps_lifetime | Integer | in seconds, 0 is unlimited |
| Maximum number of VPS per user | max_vps_count | Integer | 0 is unlimited |
| User owns IP addresses | user_ip_ownership | Boolean |
{
"auth": true,
"description": "Create new environment",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": "Environment label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Environment description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Environment FQDN, should be subject's root domain",
"type": "String",
"validators": {
"format": {
"rx": "[0-9a-zA-Z\\-\\.]{3,255}",
"match": true,
"description": null,
"message": "invalid format"
}
},
"default": null,
"protected": false
},
"can_create_vps": {
"required": false,
"label": "Can create a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"can_destroy_vps": {
"required": false,
"label": "Can destroy a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"vps_lifetime": {
"required": false,
"label": "Default VPS lifetime",
"description": "in seconds, 0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"max_vps_count": {
"required": false,
"label": "Maximum number of VPS per user",
"description": "0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"user_ip_ownership": {
"required": false,
"label": "User owns IP addresses",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "environment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Environment ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Environment label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Environment description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Environment FQDN, should be subject's root domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"can_create_vps": {
"required": false,
"label": "Can create a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"can_destroy_vps": {
"required": false,
"label": "Can destroy a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"vps_lifetime": {
"required": false,
"label": "Default VPS lifetime",
"description": "in seconds, 0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"max_vps_count": {
"required": false,
"label": "Maximum number of VPS per user",
"description": "0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"user_ip_ownership": {
"required": false,
"label": "User owns IP addresses",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "environment"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": null,
"request": {
"label": "Devel",
"domain": "vpsfree.cz"
},
"response": {
"id": 2
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/environments",
"method": "POST",
"help": "/v6.0/environments?method=POST"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.environment.create({:label=>"Devel", :domain=>"vpsfree.cz"})
# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 2
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.environment.create({
"label": "Devel",
"domain": "vpsfree.cz"
}, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
// reply.id = 2
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->environment->create([
"label" => "Devel",
"domain" => "vpsfree.cz"
]);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 2
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 environment create -- \
--label 'Devel' \
--domain 'vpsfree.cz'
ID: 2
Label: -
Description: -
Domain: -
Can create a VPS: -
Can destroy a VPS: -
Default VPS lifetime: -
Maximum number of VPS per user: -
User owns IP addresses: -
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/environment/actions/create
# Prepare input parameters
$ echo 'Devel' > input/label
$ echo 'vpsfree.cz' > input/domain
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1
# Query the output parameters
$ cat output/id
2
$ curl --request POST \
--data-binary "{
\"environment\": {
\"label\": \"Devel\",
\"domain\": \"vpsfree.cz\"
}
}" \
'http://api.vpsfree.cz/v6.0/environments'
{
"status": true,
"message": null,
"response": {
"environment": {
"id": 2
}
},
"errors": null
}POST /v6.0/environments HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
{
"environment": {
"label": "Devel",
"domain": "vpsfree.cz"
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 119
{
"status": true,
"message": null,
"response": {
"environment": {
"id": 2
}
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| Has hypervisor | has_hypervisor | no | Boolean | List only environments having at least one hypervisor | ||
| Has storage | has_storage | no | Boolean | List only environments having at least one storage |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Environment ID |
| Label | label | String | Environment label |
| Description | description | String | Environment description |
| Domain | domain | String | Environment FQDN, should be subject's root domain |
| Can create a VPS | can_create_vps | Boolean | |
| Can destroy a VPS | can_destroy_vps | Boolean | |
| Default VPS lifetime | vps_lifetime | Integer | in seconds, 0 is unlimited |
| Maximum number of VPS per user | max_vps_count | Integer | 0 is unlimited |
| User owns IP addresses | user_ip_ownership | Boolean | |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "List environments",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"has_hypervisor": {
"required": false,
"label": "Has hypervisor",
"description": "List only environments having at least one hypervisor",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"has_storage": {
"required": false,
"label": "Has storage",
"description": "List only environments having at least one storage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "environment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Environment ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Environment label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Environment description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Environment FQDN, should be subject's root domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"can_create_vps": {
"required": false,
"label": "Can create a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"can_destroy_vps": {
"required": false,
"label": "Can destroy a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"vps_lifetime": {
"required": false,
"label": "Default VPS lifetime",
"description": "in seconds, 0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"max_vps_count": {
"required": false,
"label": "Maximum number of VPS per user",
"description": "0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"user_ip_ownership": {
"required": false,
"label": "User owns IP addresses",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"maintenance_lock": {
"required": false,
"label": "Maintenance lock",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no",
"lock",
"master_lock"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"maintenance_lock_reason": {
"required": false,
"label": "Maintenance reason",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "environments"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": null,
"request": {
},
"response": [
{
"id": 1,
"label": "Production",
"domain": "vpsfree.cz"
}
],
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.environment.index
# reply is an instance of HaveAPI::Client::ResourceInstanceList,
# which is a subclass of Arrayimport HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.environment.index(function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstanceList
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->environment->index();
// $reply is an instance of \HaveAPI\Client\ResourceInstanceList$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 environment index
ID: 1
Label: Production
Description: -
Domain: vpsfree.cz
Can create a VPS: -
Can destroy a VPS: -
Default VPS lifetime: -
Maximum number of VPS per user: -
User owns IP addresses: -
Maintenance lock: -
Maintenance reason: -
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/environment/actions/index
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request GET \
--data-binary "{
\"environment\": {
}
}" \
'http://api.vpsfree.cz/v6.0/environments'
{
"status": true,
"message": null,
"response": {
"environments": [
{
"id": 1,
"label": "Production",
"domain": "vpsfree.cz"
}
]
},
"errors": null
}GET /v6.0/environments HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 201
{
"status": true,
"message": null,
"response": {
"environments": [
{
"id": 1,
"label": "Production",
"domain": "vpsfree.cz"
}
]
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Lock | lock | yes | Boolean | Present
|
||
| Reason | reason | no | String |
No parameters.
{
"auth": true,
"description": "Set maintenance lock",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"lock": {
"required": true,
"label": "Lock",
"description": null,
"type": "Boolean",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"validators": {
},
"default": "",
"protected": false
}
},
"layout": "hash",
"namespace": "environment"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "environment"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/environments/{environment_id}/set_maintenance",
"method": "POST",
"help": "/v6.0/environments/{environment_id}/set_maintenance?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Environment ID |
| Label | label | String | Environment label |
| Description | description | String | Environment description |
| Domain | domain | String | Environment FQDN, should be subject's root domain |
| Can create a VPS | can_create_vps | Boolean | |
| Can destroy a VPS | can_destroy_vps | Boolean | |
| Default VPS lifetime | vps_lifetime | Integer | in seconds, 0 is unlimited |
| Maximum number of VPS per user | max_vps_count | Integer | 0 is unlimited |
| User owns IP addresses | user_ip_ownership | Boolean | |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "Show environment",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "environment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Environment ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Environment label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Environment description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Environment FQDN, should be subject's root domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"can_create_vps": {
"required": false,
"label": "Can create a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"can_destroy_vps": {
"required": false,
"label": "Can destroy a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"vps_lifetime": {
"required": false,
"label": "Default VPS lifetime",
"description": "in seconds, 0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"max_vps_count": {
"required": false,
"label": "Maximum number of VPS per user",
"description": "0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"user_ip_ownership": {
"required": false,
"label": "User owns IP addresses",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"maintenance_lock": {
"required": false,
"label": "Maintenance lock",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no",
"lock",
"master_lock"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"maintenance_lock_reason": {
"required": false,
"label": "Maintenance reason",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "environment"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": [
1
],
"request": {
},
"response": {
"id": 1,
"label": "Production",
"domain": "vpsfree.cz"
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/environments/{environment_id}",
"method": "GET",
"help": "/v6.0/environments/{environment_id}?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.environment.show(1)
# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 1
# reply.label = "Production"
# reply.domain = "vpsfree.cz"
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.environment.show(1, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
// reply.id = 1
// reply.label = "Production"
// reply.domain = "vpsfree.cz"
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->environment->show(1);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 1
// $reply->label = "Production"
// $reply->domain = "vpsfree.cz"
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 environment show 1
ID: 1
Label: Production
Description: -
Domain: vpsfree.cz
Can create a VPS: -
Can destroy a VPS: -
Default VPS lifetime: -
Maximum number of VPS per user: -
User owns IP addresses: -
Maintenance lock: -
Maintenance reason: -
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/environment/actions/show
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1
# Query the output parameters
$ cat output/id
1
$ cat output/label
Production
$ cat output/domain
vpsfree.cz
$ curl --request GET \
--data-binary "{
\"environment\": {
}
}" \
'http://api.vpsfree.cz/v6.0/environments/1'
{
"status": true,
"message": null,
"response": {
"environment": {
"id": 1,
"label": "Production",
"domain": "vpsfree.cz"
}
},
"errors": null
}GET /v6.0/environments/1 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 178
{
"status": true,
"message": null,
"response": {
"environment": {
"id": 1,
"label": "Production",
"domain": "vpsfree.cz"
}
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | Environment label | ||
| Description | description | no | String | Environment description | ||
| Domain | domain | no | String | Format
|
Environment FQDN, should be subject's root domain | |
| Can create a VPS | can_create_vps | no | Boolean | false | ||
| Can destroy a VPS | can_destroy_vps | no | Boolean | false | ||
| Default VPS lifetime | vps_lifetime | no | Integer | 0 | in seconds, 0 is unlimited | |
| Maximum number of VPS per user | max_vps_count | no | Integer | 1 | 0 is unlimited | |
| User owns IP addresses | user_ip_ownership | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Environment ID |
| Label | label | String | Environment label |
| Description | description | String | Environment description |
| Domain | domain | String | Environment FQDN, should be subject's root domain |
| Can create a VPS | can_create_vps | Boolean | |
| Can destroy a VPS | can_destroy_vps | Boolean | |
| Default VPS lifetime | vps_lifetime | Integer | in seconds, 0 is unlimited |
| Maximum number of VPS per user | max_vps_count | Integer | 0 is unlimited |
| User owns IP addresses | user_ip_ownership | Boolean |
{
"auth": true,
"description": "Update environment",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": "Environment label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Environment description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Environment FQDN, should be subject's root domain",
"type": "String",
"validators": {
"format": {
"rx": "[0-9a-zA-Z\\-\\.]{3,255}",
"match": true,
"description": null,
"message": "invalid format"
}
},
"default": null,
"protected": false
},
"can_create_vps": {
"required": false,
"label": "Can create a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"can_destroy_vps": {
"required": false,
"label": "Can destroy a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"vps_lifetime": {
"required": false,
"label": "Default VPS lifetime",
"description": "in seconds, 0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"max_vps_count": {
"required": false,
"label": "Maximum number of VPS per user",
"description": "0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"user_ip_ownership": {
"required": false,
"label": "User owns IP addresses",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "environment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Environment ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Environment label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Environment description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Environment FQDN, should be subject's root domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"can_create_vps": {
"required": false,
"label": "Can create a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"can_destroy_vps": {
"required": false,
"label": "Can destroy a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"vps_lifetime": {
"required": false,
"label": "Default VPS lifetime",
"description": "in seconds, 0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"max_vps_count": {
"required": false,
"label": "Maximum number of VPS per user",
"description": "0 is unlimited",
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"user_ip_ownership": {
"required": false,
"label": "User owns IP addresses",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "environment"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": [
1
],
"request": {
"label": "My new name",
"domain": "new.domain"
},
"response": {
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/environments/{environment_id}",
"method": "PUT",
"help": "/v6.0/environments/{environment_id}?method=PUT"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.environment.update(1, {:label=>"My new name", :domain=>"new.domain"})
# reply is an instance of HaveAPI::Client::ResourceInstance
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.environment.update(1, {
"label": "My new name",
"domain": "new.domain"
}, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->environment->update(1, [
"label" => "My new name",
"domain" => "new.domain"
]);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 environment update 1 -- \
--label 'My new name' \
--domain 'new.domain'# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/environment/actions/update
# Prepare input parameters
$ echo 'My new name' > input/label
$ echo 'new.domain' > input/domain
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request PUT \
--data-binary "{
\"environment\": {
\"label\": \"My new name\",
\"domain\": \"new.domain\"
}
}" \
'http://api.vpsfree.cz/v6.0/environments/1'
{
"status": true,
"message": null,
"response": {
"environment": {
}
},
"errors": null
}PUT /v6.0/environments/1 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
{
"environment": {
"label": "My new name",
"domain": "new.domain"
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 105
{
"status": true,
"message": null,
"response": {
"environment": {
}
},
"errors": null
}Manage environment dataset plans
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Label | label | String | |
| DatasetPlan | dataset_plan | Resource | |
| User add | user_add | Boolean | If true, the user can add this plan to a dataset |
| User remove | user_remove | Boolean | If true, the user can remove this plan from a dataset |
{
"auth": true,
"description": "List dataset plans",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dataset_plan": {
"required": null,
"label": "DatasetPlan",
"description": null,
"type": "Resource",
"resource": [
"dataset_plan"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dataset_plans",
"method": "GET",
"help": "/v6.0/dataset_plans?method=GET"
}
},
"user_add": {
"required": false,
"label": "User add",
"description": "If true, the user can add this plan to a dataset",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"user_remove": {
"required": false,
"label": "User remove",
"description": "If true, the user can remove this plan from a dataset",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "dataset_plans"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/environments/{environment_id}/dataset_plans",
"method": "GET",
"help": "/v6.0/environments/{environment_id}/dataset_plans?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Label | label | String | |
| DatasetPlan | dataset_plan | Resource | |
| User add | user_add | Boolean | If true, the user can add this plan to a dataset |
| User remove | user_remove | Boolean | If true, the user can remove this plan from a dataset |
{
"auth": true,
"description": "Show dataset plan",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "dataset_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dataset_plan": {
"required": null,
"label": "DatasetPlan",
"description": null,
"type": "Resource",
"resource": [
"dataset_plan"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dataset_plans",
"method": "GET",
"help": "/v6.0/dataset_plans?method=GET"
}
},
"user_add": {
"required": false,
"label": "User add",
"description": "If true, the user can add this plan to a dataset",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"user_remove": {
"required": false,
"label": "User remove",
"description": "If true, the user can remove this plan from a dataset",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "dataset_plan"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/environments/{environment_id}/dataset_plans/{dataset_plan_id}",
"method": "GET",
"help": "/v6.0/environments/{environment_id}/dataset_plans/{dataset_plan_id}?method=GET"
}Manage NFS exports
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Dataset | dataset | no | Resource | |||
| Snapshot | snapshot | no | Resource | |||
| All VPS | all_vps | no | Boolean | true | Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export. | |
| Read-write | rw | no | Boolean | true | Allow the export to be mounted as read-write. | |
| Sync | sync | no | Boolean | true | Determines whether the server replies to requests only after the changes have been committed to stable storage. | |
| Subtree check | subtree_check | no | Boolean | false | See man exports(5). | |
| Root squash | root_squash | no | Boolean | false | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. | |
| Threads | threads | no | Integer | Number
|
8 | Number of NFS server threads. |
| Enabled | enabled | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| Export ID | id | Integer | |
| Dataset | dataset | Resource | |
| Snapshot | snapshot | Resource | |
| User | user | Resource | |
| IpAddress | ip_address | Resource | |
| HostIpAddress | host_ip_address | Resource | |
| Path | path | String | |
| All VPS | all_vps | Boolean | Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export. |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
| Threads | threads | Integer | Number of NFS server threads. |
| Enabled | enabled | Boolean | |
| Expiration date | expiration_date | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Create a new export",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"snapshot": {
"required": null,
"label": "Snapshot",
"description": null,
"type": "Resource",
"resource": [
"dataset",
"snapshot"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=GET"
}
},
"all_vps": {
"required": false,
"label": "All VPS",
"description": "Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"threads": {
"required": false,
"label": "Threads",
"description": "Number of NFS server threads.",
"type": "Integer",
"validators": {
"number": {
"message": "has to be in range <1, 64>",
"min": 1,
"max": 64
}
},
"default": 8,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "export"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Export ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"snapshot": {
"required": null,
"label": "Snapshot",
"description": null,
"type": "Resource",
"resource": [
"dataset",
"snapshot"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"host_ip_address": {
"required": null,
"label": "HostIpAddress",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"path": {
"required": false,
"label": "Path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"all_vps": {
"required": false,
"label": "All VPS",
"description": "Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"threads": {
"required": false,
"label": "Threads",
"description": "Number of NFS server threads.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "export"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports",
"method": "POST",
"help": "/v6.0/exports?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete export",
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "export"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "export"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}",
"method": "DELETE",
"help": "/v6.0/exports/{export_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| User | user | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Export ID | id | Integer | |
| Dataset | dataset | Resource | |
| Snapshot | snapshot | Resource | |
| User | user | Resource | |
| IpAddress | ip_address | Resource | |
| HostIpAddress | host_ip_address | Resource | |
| Path | path | String | |
| All VPS | all_vps | Boolean | Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export. |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
| Threads | threads | Integer | Number of NFS server threads. |
| Enabled | enabled | Boolean | |
| Expiration date | expiration_date | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List exports",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object",
"namespace": "export"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Export ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"snapshot": {
"required": null,
"label": "Snapshot",
"description": null,
"type": "Resource",
"resource": [
"dataset",
"snapshot"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"host_ip_address": {
"required": null,
"label": "HostIpAddress",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"path": {
"required": false,
"label": "Path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"all_vps": {
"required": false,
"label": "All VPS",
"description": "Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"threads": {
"required": false,
"label": "Threads",
"description": "Number of NFS server threads.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "exports"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Export ID | id | Integer | |
| Dataset | dataset | Resource | |
| Snapshot | snapshot | Resource | |
| User | user | Resource | |
| IpAddress | ip_address | Resource | |
| HostIpAddress | host_ip_address | Resource | |
| Path | path | String | |
| All VPS | all_vps | Boolean | Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export. |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
| Threads | threads | Integer | Number of NFS server threads. |
| Enabled | enabled | Boolean | |
| Expiration date | expiration_date | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "export"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Export ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"snapshot": {
"required": null,
"label": "Snapshot",
"description": null,
"type": "Resource",
"resource": [
"dataset",
"snapshot"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"host_ip_address": {
"required": null,
"label": "HostIpAddress",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"path": {
"required": false,
"label": "Path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"all_vps": {
"required": false,
"label": "All VPS",
"description": "Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"threads": {
"required": false,
"label": "Threads",
"description": "Number of NFS server threads.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "export"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}",
"method": "GET",
"help": "/v6.0/exports/{export_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| All VPS | all_vps | no | Boolean | Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export. | ||
| Read-write | rw | no | Boolean | Allow the export to be mounted as read-write. | ||
| Sync | sync | no | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. | ||
| Subtree check | subtree_check | no | Boolean | See man exports(5). | ||
| Root squash | root_squash | no | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. | ||
| Threads | threads | no | Integer | Number
|
Number of NFS server threads. | |
| Enabled | enabled | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Export ID | id | Integer | |
| Dataset | dataset | Resource | |
| Snapshot | snapshot | Resource | |
| User | user | Resource | |
| IpAddress | ip_address | Resource | |
| HostIpAddress | host_ip_address | Resource | |
| Path | path | String | |
| All VPS | all_vps | Boolean | Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export. |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
| Threads | threads | Integer | Number of NFS server threads. |
| Enabled | enabled | Boolean | |
| Expiration date | expiration_date | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Edit export",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"all_vps": {
"required": false,
"label": "All VPS",
"description": "Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"threads": {
"required": false,
"label": "Threads",
"description": "Number of NFS server threads.",
"type": "Integer",
"validators": {
"number": {
"message": "has to be in range <1, 64>",
"min": 1,
"max": 64
}
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "export"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Export ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": null,
"type": "Resource",
"resource": [
"dataset"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/datasets",
"method": "GET",
"help": "/v6.0/datasets?method=GET"
}
},
"snapshot": {
"required": null,
"label": "Snapshot",
"description": null,
"type": "Resource",
"resource": [
"dataset",
"snapshot"
],
"value_id": "id",
"value_label": "created_at",
"value": null,
"choices": {
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"host_ip_address": {
"required": null,
"label": "HostIpAddress",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"path": {
"required": false,
"label": "Path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"all_vps": {
"required": false,
"label": "All VPS",
"description": "Let all user's VPS to mount this export. Changes to the user's IP addresses will automatically add or remove allowed hosts on the export.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"threads": {
"required": false,
"label": "Threads",
"description": "Number of NFS server threads.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "export"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}",
"method": "PUT",
"help": "/v6.0/exports/{export_id}?method=PUT"
}Manage allowed hosts
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| IpAddress | ip_address | no | Resource | |||
| Read-write | rw | no | Boolean | Allow the export to be mounted as read-write. | ||
| Sync | sync | no | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. | ||
| Subtree check | subtree_check | no | Boolean | See man exports(5). | ||
| Root squash | root_squash | no | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| IpAddress | ip_address | Resource | |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
{
"auth": true,
"description": "Add a new host",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}/hosts",
"method": "POST",
"help": "/v6.0/exports/{export_id}/hosts?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete host",
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "host"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "host"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}/hosts/{host_id}",
"method": "DELETE",
"help": "/v6.0/exports/{export_id}/hosts/{host_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| IpAddress | ip_address | Resource | |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
{
"auth": true,
"description": "List hosts",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "hosts"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}/hosts",
"method": "GET",
"help": "/v6.0/exports/{export_id}/hosts?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| IpAddress | ip_address | Resource | |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "host"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}/hosts/{host_id}",
"method": "GET",
"help": "/v6.0/exports/{export_id}/hosts/{host_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Read-write | rw | no | Boolean | Allow the export to be mounted as read-write. | ||
| Sync | sync | no | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. | ||
| Subtree check | subtree_check | no | Boolean | See man exports(5). | ||
| Root squash | root_squash | no | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| IpAddress | ip_address | Resource | |
| Read-write | rw | Boolean | Allow the export to be mounted as read-write. |
| Sync | sync | Boolean | Determines whether the server replies to requests only after the changes have been committed to stable storage. |
| Subtree check | subtree_check | Boolean | See man exports(5). |
| Root squash | root_squash | Boolean | Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive. |
{
"auth": true,
"description": "Edit host options",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"rw": {
"required": false,
"label": "Read-write",
"description": "Allow the export to be mounted as read-write.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"sync": {
"required": false,
"label": "Sync",
"description": "Determines whether the server replies to requests only after the changes have been committed to stable storage.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"subtree_check": {
"required": false,
"label": "Subtree check",
"description": "See man exports(5).",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"root_squash": {
"required": false,
"label": "Root squash",
"description": "Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/exports/{export_id}/hosts/{host_id}",
"method": "PUT",
"help": "/v6.0/exports/{export_id}/hosts/{host_id}?method=PUT"
}Browse exports affected by outages
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| Outage | outage | no | Resource | |||
| Export | export | no | Resource | |||
| User | user | no | Resource | |||
| Environment | environment | no | Resource | |||
| Location | location | no | Resource | |||
| Node | node | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| Export | export | Resource | |
| User | user | Resource | |
| Environment | environment | Resource | |
| Location | location | Resource | |
| Node | node | Resource |
{
"auth": true,
"description": "List exports affected by outage",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"outage": {
"required": null,
"label": "Outage",
"description": null,
"type": "Resource",
"resource": [
"outage"
],
"value_id": "id",
"value_label": "begins_at",
"value": null,
"choices": {
"path": "/v6.0/outages",
"method": "GET",
"help": "/v6.0/outages?method=GET"
}
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"location": {
"required": null,
"label": "Location",
"description": null,
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "domain_name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
}
},
"layout": "object",
"namespace": "export_outage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"outage": {
"required": null,
"label": "Outage",
"description": null,
"type": "Resource",
"resource": [
"outage"
],
"value_id": "id",
"value_label": "begins_at",
"value": null,
"choices": {
"path": "/v6.0/outages",
"method": "GET",
"help": "/v6.0/outages?method=GET"
}
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"location": {
"required": null,
"label": "Location",
"description": null,
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "domain_name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
}
},
"layout": "object_list",
"namespace": "export_outages"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/export_outages",
"method": "GET",
"help": "/v6.0/export_outages?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| Export | export | Resource | |
| User | user | Resource | |
| Environment | environment | Resource | |
| Location | location | Resource | |
| Node | node | Resource |
{
"auth": true,
"description": "Show export affected by an outage",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "export_outage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"outage": {
"required": null,
"label": "Outage",
"description": null,
"type": "Resource",
"resource": [
"outage"
],
"value_id": "id",
"value_label": "begins_at",
"value": null,
"choices": {
"path": "/v6.0/outages",
"method": "GET",
"help": "/v6.0/outages?method=GET"
}
},
"export": {
"required": null,
"label": "Export",
"description": null,
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "path",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"location": {
"required": null,
"label": "Location",
"description": null,
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "domain_name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
}
},
"layout": "object",
"namespace": "export_outage"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/export_outages/{export_outage_id}",
"method": "GET",
"help": "/v6.0/export_outages/{export_outage_id}?method=GET"
}Browse and manage help boxes
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Page | page | no | String | |||
| Action | action | no | String | |||
| Language | language | no | Resource | |||
| Content | content | yes | Text | Present
|
||
| Order | order | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Page | page | String | |
| Action | action | String | |
| Language | language | Resource | |
| Content | content | Text | |
| Order | order | Integer |
{
"auth": true,
"description": "Create a help box",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"page": {
"required": false,
"label": "Page",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"action": {
"required": false,
"label": "Action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language",
"description": null,
"type": "Resource",
"resource": [
"language"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}
},
"content": {
"required": true,
"label": "Content",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "help_box"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"page": {
"required": false,
"label": "Page",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"action": {
"required": false,
"label": "Action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language",
"description": null,
"type": "Resource",
"resource": [
"language"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}
},
"content": {
"required": false,
"label": "Content",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "help_box"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/help_boxes",
"method": "POST",
"help": "/v6.0/help_boxes?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete help box",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "help_box"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "help_box"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/help_boxes/{help_box_id}",
"method": "DELETE",
"help": "/v6.0/help_boxes/{help_box_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| Page | page | no | String | |||
| Action | action | no | String | |||
| Language | language | no | Resource | |||
| View | view | no | Boolean | false | When enabled, list help boxes for the current user, including page/action filters |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Page | page | String | |
| Action | action | String | |
| Language | language | Resource | |
| Content | content | Text | |
| Order | order | Integer |
{
"auth": false,
"description": "List help boxes",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"page": {
"required": false,
"label": "Page",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"action": {
"required": false,
"label": "Action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language",
"description": null,
"type": "Resource",
"resource": [
"language"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}
},
"view": {
"required": false,
"label": "View",
"description": "When enabled, list help boxes for the current user, including page/action filters",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
}
},
"layout": "object",
"namespace": "help_box"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"page": {
"required": false,
"label": "Page",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"action": {
"required": false,
"label": "Action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language",
"description": null,
"type": "Resource",
"resource": [
"language"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}
},
"content": {
"required": false,
"label": "Content",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "help_boxes"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/help_boxes",
"method": "GET",
"help": "/v6.0/help_boxes?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Page | page | String | |
| Action | action | String | |
| Language | language | Resource | |
| Content | content | Text | |
| Order | order | Integer |
{
"auth": false,
"description": "Show helpbox",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "help_box"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"page": {
"required": false,
"label": "Page",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"action": {
"required": false,
"label": "Action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language",
"description": null,
"type": "Resource",
"resource": [
"language"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}
},
"content": {
"required": false,
"label": "Content",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "help_box"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/help_boxes/{help_box_id}",
"method": "GET",
"help": "/v6.0/help_boxes/{help_box_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Page | page | no | String | |||
| Action | action | no | String | |||
| Language | language | no | Resource | |||
| Content | content | no | Text | |||
| Order | order | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Page | page | String | |
| Action | action | String | |
| Language | language | Resource | |
| Content | content | Text | |
| Order | order | Integer |
{
"auth": true,
"description": "Update help box",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"page": {
"required": false,
"label": "Page",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"action": {
"required": false,
"label": "Action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language",
"description": null,
"type": "Resource",
"resource": [
"language"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}
},
"content": {
"required": false,
"label": "Content",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "help_box"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"page": {
"required": false,
"label": "Page",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"action": {
"required": false,
"label": "Action",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language",
"description": null,
"type": "Resource",
"resource": [
"language"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}
},
"content": {
"required": false,
"label": "Content",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "help_box"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/help_boxes/{help_box_id}",
"method": "PUT",
"help": "/v6.0/help_boxes/{help_box_id}?method=PUT"
}Manage interface IP addresses
No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| IpAddress | ip_address | Resource | |
| Address | addr | String | |
| Assigned | assigned | Boolean |
{
"auth": true,
"description": "Assign the address to an interface",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "host_ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host_ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/host_ip_addresses/{host_ip_address_id}/assign",
"method": "POST",
"help": "/v6.0/host_ip_addresses/{host_ip_address_id}/assign?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| IpAddress | ip_address | Resource | |
| Address | addr | String | |
| Assigned | assigned | Boolean |
{
"auth": true,
"description": "Remove the address from its interface",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "host_ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host_ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/host_ip_addresses/{host_ip_address_id}/free",
"method": "POST",
"help": "/v6.0/host_ip_addresses/{host_ip_address_id}/free?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| IpAddress | ip_address | no | Resource | |||
| NetworkInterface | network_interface | no | Resource | |||
| VPS | vps | no | Resource | VPS this IP is assigned to, can be null | ||
| IP version | version | no | Integer | 4 or 6 | ||
| Network | network | no | Resource | |||
| Location | location | no | Resource | Location this IP address is available in | ||
| User | user | no | Resource | Filter by owner | ||
| Role | role | no | String | Include
|
||
| Purpose | purpose | no | String | Include
|
||
| Network address | addr | no | String | |||
| Prefix | prefix | no | Integer | |||
| Size | size | no | Integer | |||
| Assigned | assigned | no | Boolean | |||
| Order | order | no | String | Include
|
asc |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| IpAddress | ip_address | Resource | |
| Address | addr | String | |
| Assigned | assigned | Boolean |
{
"auth": true,
"description": "List IP addresses",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": "VPS this IP is assigned to, can be null",
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"version": {
"required": false,
"label": "IP version",
"description": "4 or 6",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"location": {
"required": null,
"label": "Location",
"description": "Location this IP address is available in",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": "Filter by owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"role": {
"required": false,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"public_access",
"private_access"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"purpose": {
"required": false,
"label": "Purpose",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"any",
"vps",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"addr": {
"required": false,
"label": "Network address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"asc",
"interface"
],
"message": "%{value} cannot be used"
}
},
"default": "asc",
"protected": false
}
},
"layout": "object",
"namespace": "host_ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "host_ip_addresses"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| IpAddress | ip_address | Resource | |
| Address | addr | String | |
| Assigned | assigned | Boolean |
{
"auth": true,
"description": "Show interface IP address",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "host_ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "host_ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/host_ip_addresses/{host_ip_address_id}",
"method": "GET",
"help": "/v6.0/host_ip_addresses/{host_ip_address_id}?method=GET"
}Manage incident reports
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| VPS | vps | yes | Resource | |||
| IP address assignment | ip_address_assignment | no | Resource | |||
| Subject | subject | yes | String | Present
|
||
| Text | text | yes | Text | Present
|
||
| Codename | codename | no | String | |||
| CPU limit | cpu_limit | no | Integer | |||
| Detected_at | detected_at | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| User | user | Resource | |
| VPS | vps | Resource | |
| IP address assignment | ip_address_assignment | Resource | |
| Filed_by | filed_by | Resource | |
| Mailbox | mailbox | Resource | |
| Subject | subject | String | |
| Text | text | Text | |
| Codename | codename | String | |
| CPU limit | cpu_limit | Integer | |
| Raw_user_id | raw_user_id | Integer | |
| Raw_vps_id | raw_vps_id | Integer | |
| Detected_at | detected_at | Datetime | |
| Created_at | created_at | Datetime | |
| Reported_at | reported_at | Datetime |
{
"auth": true,
"description": "Create incident report",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"vps": {
"required": true,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"ip_address_assignment": {
"required": null,
"label": "IP address assignment",
"description": null,
"type": "Resource",
"resource": [
"ip_address_assignment"
],
"value_id": "id",
"value_label": "ip_addr",
"value": null,
"choices": {
"path": "/v6.0/ip_address_assignments",
"method": "GET",
"help": "/v6.0/ip_address_assignments?method=GET"
}
},
"subject": {
"required": true,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"text": {
"required": true,
"label": "Text",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"codename": {
"required": false,
"label": "Codename",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"detected_at": {
"required": false,
"label": "Detected_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incident_report"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"ip_address_assignment": {
"required": null,
"label": "IP address assignment",
"description": null,
"type": "Resource",
"resource": [
"ip_address_assignment"
],
"value_id": "id",
"value_label": "ip_addr",
"value": null,
"choices": {
"path": "/v6.0/ip_address_assignments",
"method": "GET",
"help": "/v6.0/ip_address_assignments?method=GET"
}
},
"filed_by": {
"required": null,
"label": "Filed_by",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"mailbox": {
"required": null,
"label": "Mailbox",
"description": null,
"type": "Resource",
"resource": [
"mailbox"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mailboxes",
"method": "GET",
"help": "/v6.0/mailboxes?method=GET"
}
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text": {
"required": false,
"label": "Text",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"codename": {
"required": false,
"label": "Codename",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"raw_user_id": {
"required": false,
"label": "Raw_user_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"raw_vps_id": {
"required": false,
"label": "Raw_vps_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"detected_at": {
"required": false,
"label": "Detected_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"reported_at": {
"required": false,
"label": "Reported_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incident_report"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/incident_reports",
"method": "POST",
"help": "/v6.0/incident_reports?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| User | user | no | Resource | |||
| VPS | vps | no | Resource | |||
| IP address assignment | ip_address_assignment | no | Resource | |||
| Filed_by | filed_by | no | Resource | |||
| Mailbox | mailbox | no | Resource | |||
| Codename | codename | no | String | |||
| IP address | ip_addr | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| User | user | Resource | |
| VPS | vps | Resource | |
| IP address assignment | ip_address_assignment | Resource | |
| Filed_by | filed_by | Resource | |
| Mailbox | mailbox | Resource | |
| Subject | subject | String | |
| Text | text | Text | |
| Codename | codename | String | |
| CPU limit | cpu_limit | Integer | |
| Raw_user_id | raw_user_id | Integer | |
| Raw_vps_id | raw_vps_id | Integer | |
| Detected_at | detected_at | Datetime | |
| Created_at | created_at | Datetime | |
| Reported_at | reported_at | Datetime |
{
"auth": true,
"description": "List incident reports",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"ip_address_assignment": {
"required": null,
"label": "IP address assignment",
"description": null,
"type": "Resource",
"resource": [
"ip_address_assignment"
],
"value_id": "id",
"value_label": "ip_addr",
"value": null,
"choices": {
"path": "/v6.0/ip_address_assignments",
"method": "GET",
"help": "/v6.0/ip_address_assignments?method=GET"
}
},
"filed_by": {
"required": null,
"label": "Filed_by",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"mailbox": {
"required": null,
"label": "Mailbox",
"description": null,
"type": "Resource",
"resource": [
"mailbox"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mailboxes",
"method": "GET",
"help": "/v6.0/mailboxes?method=GET"
}
},
"codename": {
"required": false,
"label": "Codename",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_addr": {
"required": false,
"label": "IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incident_report"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"ip_address_assignment": {
"required": null,
"label": "IP address assignment",
"description": null,
"type": "Resource",
"resource": [
"ip_address_assignment"
],
"value_id": "id",
"value_label": "ip_addr",
"value": null,
"choices": {
"path": "/v6.0/ip_address_assignments",
"method": "GET",
"help": "/v6.0/ip_address_assignments?method=GET"
}
},
"filed_by": {
"required": null,
"label": "Filed_by",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"mailbox": {
"required": null,
"label": "Mailbox",
"description": null,
"type": "Resource",
"resource": [
"mailbox"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mailboxes",
"method": "GET",
"help": "/v6.0/mailboxes?method=GET"
}
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text": {
"required": false,
"label": "Text",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"codename": {
"required": false,
"label": "Codename",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"raw_user_id": {
"required": false,
"label": "Raw_user_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"raw_vps_id": {
"required": false,
"label": "Raw_vps_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"detected_at": {
"required": false,
"label": "Detected_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"reported_at": {
"required": false,
"label": "Reported_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "incident_reports"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/incident_reports",
"method": "GET",
"help": "/v6.0/incident_reports?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| User | user | Resource | |
| VPS | vps | Resource | |
| IP address assignment | ip_address_assignment | Resource | |
| Filed_by | filed_by | Resource | |
| Mailbox | mailbox | Resource | |
| Subject | subject | String | |
| Text | text | Text | |
| Codename | codename | String | |
| CPU limit | cpu_limit | Integer | |
| Raw_user_id | raw_user_id | Integer | |
| Raw_vps_id | raw_vps_id | Integer | |
| Detected_at | detected_at | Datetime | |
| Created_at | created_at | Datetime | |
| Reported_at | reported_at | Datetime |
{
"auth": true,
"description": "Show incident report",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "incident_report"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"ip_address_assignment": {
"required": null,
"label": "IP address assignment",
"description": null,
"type": "Resource",
"resource": [
"ip_address_assignment"
],
"value_id": "id",
"value_label": "ip_addr",
"value": null,
"choices": {
"path": "/v6.0/ip_address_assignments",
"method": "GET",
"help": "/v6.0/ip_address_assignments?method=GET"
}
},
"filed_by": {
"required": null,
"label": "Filed_by",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"mailbox": {
"required": null,
"label": "Mailbox",
"description": null,
"type": "Resource",
"resource": [
"mailbox"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mailboxes",
"method": "GET",
"help": "/v6.0/mailboxes?method=GET"
}
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text": {
"required": false,
"label": "Text",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"codename": {
"required": false,
"label": "Codename",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"raw_user_id": {
"required": false,
"label": "Raw_user_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"raw_vps_id": {
"required": false,
"label": "Raw_vps_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"detected_at": {
"required": false,
"label": "Detected_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"reported_at": {
"required": false,
"label": "Reported_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incident_report"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/incident_reports/{incident_report_id}",
"method": "GET",
"help": "/v6.0/incident_reports/{incident_report_id}?method=GET"
}Browse incoming payments
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | 25 | The number of objects to retrieve | |
| State | state | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Transaction_id | transaction_id | String | |
| State | state | String | |
| Date | date | Datetime | |
| Amount | amount | Integer | |
| Currency | currency | String | |
| Src_amount | src_amount | Integer | |
| Src_currency | src_currency | String | |
| Account_name | account_name | String | |
| User_ident | user_ident | String | |
| User_message | user_message | String | |
| Vs | vs | String | |
| Ks | ks | String | |
| Ss | ss | String | |
| Transaction_type | transaction_type | String | |
| Comment | comment | String | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "List incoming payments",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": 25,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"unmatched",
"processed",
"ignored"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incoming_payment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"transaction_id": {
"required": false,
"label": "Transaction_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"unmatched",
"processed",
"ignored"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"date": {
"required": false,
"label": "Date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"amount": {
"required": false,
"label": "Amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"currency": {
"required": false,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"src_amount": {
"required": false,
"label": "Src_amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"src_currency": {
"required": false,
"label": "Src_currency",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"account_name": {
"required": false,
"label": "Account_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_ident": {
"required": false,
"label": "User_ident",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_message": {
"required": false,
"label": "User_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"vs": {
"required": false,
"label": "Vs",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ks": {
"required": false,
"label": "Ks",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ss": {
"required": false,
"label": "Ss",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"transaction_type": {
"required": false,
"label": "Transaction_type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"comment": {
"required": false,
"label": "Comment",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "incoming_payments"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/incoming_payments",
"method": "GET",
"help": "/v6.0/incoming_payments?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Transaction_id | transaction_id | String | |
| State | state | String | |
| Date | date | Datetime | |
| Amount | amount | Integer | |
| Currency | currency | String | |
| Src_amount | src_amount | Integer | |
| Src_currency | src_currency | String | |
| Account_name | account_name | String | |
| User_ident | user_ident | String | |
| User_message | user_message | String | |
| Vs | vs | String | |
| Ks | ks | String | |
| Ss | ss | String | |
| Transaction_type | transaction_type | String | |
| Comment | comment | String | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Show incoming payment",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "incoming_payment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"transaction_id": {
"required": false,
"label": "Transaction_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"unmatched",
"processed",
"ignored"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"date": {
"required": false,
"label": "Date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"amount": {
"required": false,
"label": "Amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"currency": {
"required": false,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"src_amount": {
"required": false,
"label": "Src_amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"src_currency": {
"required": false,
"label": "Src_currency",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"account_name": {
"required": false,
"label": "Account_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_ident": {
"required": false,
"label": "User_ident",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_message": {
"required": false,
"label": "User_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"vs": {
"required": false,
"label": "Vs",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ks": {
"required": false,
"label": "Ks",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ss": {
"required": false,
"label": "Ss",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"transaction_type": {
"required": false,
"label": "Transaction_type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"comment": {
"required": false,
"label": "Comment",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incoming_payment"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/incoming_payments/{incoming_payment_id}",
"method": "GET",
"help": "/v6.0/incoming_payments/{incoming_payment_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| State | state | yes | String | Include
Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Transaction_id | transaction_id | String | |
| State | state | String | |
| Date | date | Datetime | |
| Amount | amount | Integer | |
| Currency | currency | String | |
| Src_amount | src_amount | Integer | |
| Src_currency | src_currency | String | |
| Account_name | account_name | String | |
| User_ident | user_ident | String | |
| User_message | user_message | String | |
| Vs | vs | String | |
| Ks | ks | String | |
| Ss | ss | String | |
| Transaction_type | transaction_type | String | |
| Comment | comment | String | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Change payment's state",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"state": {
"required": true,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"unmatched",
"processed",
"ignored"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incoming_payment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"transaction_id": {
"required": false,
"label": "Transaction_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"unmatched",
"processed",
"ignored"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"date": {
"required": false,
"label": "Date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"amount": {
"required": false,
"label": "Amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"currency": {
"required": false,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"src_amount": {
"required": false,
"label": "Src_amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"src_currency": {
"required": false,
"label": "Src_currency",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"account_name": {
"required": false,
"label": "Account_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_ident": {
"required": false,
"label": "User_ident",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_message": {
"required": false,
"label": "User_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"vs": {
"required": false,
"label": "Vs",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ks": {
"required": false,
"label": "Ks",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ss": {
"required": false,
"label": "Ss",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"transaction_type": {
"required": false,
"label": "Transaction_type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"comment": {
"required": false,
"label": "Comment",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "incoming_payment"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/incoming_payments/{incoming_payment_id}",
"method": "PUT",
"help": "/v6.0/incoming_payments/{incoming_payment_id}?method=PUT"
}Manage IP addresses
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| NetworkInterface | network_interface | yes | Resource | |||
| Route_via | route_via | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| NetworkInterface | network_interface | Resource | |
| Network | network | Resource | |
| User | user | Resource | |
| Address | addr | String | Address itself |
| Prefix | prefix | Integer | |
| Size | size | Integer | |
| Route_via | route_via | Resource | |
| Charged environment | charged_environment | Resource |
{
"auth": true,
"description": "Route the address to an interface",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"network_interface": {
"required": true,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"charged_environment": {
"required": null,
"label": "Charged environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/ip_addresses/{ip_address_id}/assign",
"method": "POST",
"help": "/v6.0/ip_addresses/{ip_address_id}/assign?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| NetworkInterface | network_interface | yes | Resource | |||
| HostIpAddress | host_ip_address | no | Resource | Host address to assign to the interface, defaults to the first address |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| NetworkInterface | network_interface | Resource | |
| Network | network | Resource | |
| User | user | Resource | |
| Address | addr | String | Address itself |
| Prefix | prefix | Integer | |
| Size | size | Integer | |
| Route_via | route_via | Resource | |
| Charged environment | charged_environment | Resource |
{
"auth": true,
"description": "Route the address to an interface",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"network_interface": {
"required": true,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"host_ip_address": {
"required": null,
"label": "HostIpAddress",
"description": "Host address to assign to the interface, defaults to the first address",
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"charged_environment": {
"required": null,
"label": "Charged environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/ip_addresses/{ip_address_id}/assign_with_host_address",
"method": "POST",
"help": "/v6.0/ip_addresses/{ip_address_id}/assign_with_host_address?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| NetworkInterface | network_interface | no | Resource | |||
| Network | network | yes | Resource | |||
| User | user | no | Resource | |||
| Address | addr | yes | String | Present
|
Address itself | |
| Prefix | prefix | no | Integer | |||
| Size | size | no | Integer | |||
| Route_via | route_via | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| NetworkInterface | network_interface | Resource | |
| Network | network | Resource | |
| User | user | Resource | |
| Address | addr | String | Address itself |
| Prefix | prefix | Integer | |
| Size | size | Integer | |
| Route_via | route_via | Resource | |
| Charged environment | charged_environment | Resource |
{
"auth": true,
"description": "Add an IP address",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": true,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": true,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"charged_environment": {
"required": null,
"label": "Charged environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/ip_addresses",
"method": "POST",
"help": "/v6.0/ip_addresses?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| NetworkInterface | network_interface | Resource | |
| Network | network | Resource | |
| User | user | Resource | |
| Address | addr | String | Address itself |
| Prefix | prefix | Integer | |
| Size | size | Integer | |
| Route_via | route_via | Resource | |
| Charged environment | charged_environment | Resource |
{
"auth": true,
"description": "Remove the route from an interface",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"charged_environment": {
"required": null,
"label": "Charged environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/ip_addresses/{ip_address_id}/free",
"method": "POST",
"help": "/v6.0/ip_addresses/{ip_address_id}/free?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| NetworkInterface | network_interface | no | Resource | |||
| VPS | vps | no | Resource | VPS this IP is assigned to, can be null | ||
| IP version | version | no | Integer | 4 or 6 | ||
| Network | network | no | Resource | |||
| Location | location | no | Resource | Location this IP address is available in | ||
| User | user | no | Resource | Filter by owner | ||
| Assigned to interface | assigned_to_interface | no | Boolean | |||
| Role | role | no | String | Include
|
||
| Purpose | purpose | no | String | Include
|
||
| Address | addr | no | String | Address itself | ||
| Prefix | prefix | no | Integer | |||
| Size | size | no | Integer | |||
| Order | order | no | String | Include
|
asc |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| NetworkInterface | network_interface | Resource | |
| Network | network | Resource | |
| User | user | Resource | |
| Address | addr | String | Address itself |
| Prefix | prefix | Integer | |
| Size | size | Integer | |
| Route_via | route_via | Resource | |
| Charged environment | charged_environment | Resource |
{
"auth": true,
"description": "List IP addresses",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": "VPS this IP is assigned to, can be null",
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"version": {
"required": false,
"label": "IP version",
"description": "4 or 6",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"location": {
"required": null,
"label": "Location",
"description": "Location this IP address is available in",
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": "Filter by owner",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"assigned_to_interface": {
"required": false,
"label": "Assigned to interface",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"role": {
"required": false,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"public_access",
"private_access"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"purpose": {
"required": false,
"label": "Purpose",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"any",
"vps",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"asc",
"interface"
],
"message": "%{value} cannot be used"
}
},
"default": "asc",
"protected": false
}
},
"layout": "object",
"namespace": "ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"charged_environment": {
"required": null,
"label": "Charged environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object_list",
"namespace": "ip_addresses"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
{
"title": "",
"comment": "List IP addresses assigned to VPS with ID 101.",
"path_params": null,
"request": {
"vps": 101
},
"response": [
{
"id": 10,
"addr": "192.168.0.50"
}
],
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}List IP addresses assigned to VPS with ID 101.
require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.ip_address.index({:vps=>101})
# reply is an instance of HaveAPI::Client::ResourceInstanceList,
# which is a subclass of Arrayimport HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.ip_address.index({
"vps": 101
}, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstanceList
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->ip_address->index([
"vps" => 101
]);
// $reply is an instance of \HaveAPI\Client\ResourceInstanceList$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 ip_address index -- \
--vps '101'
ID: 10
NetworkInterface: -
Network: -
User: -
Address: 192.168.0.50
Prefix: -
Size: -
Route_via: -
Charged environment: -
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/ip_address/actions/index
# Prepare input parameters
$ echo '101' > input/vps
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request GET \
--data-binary "{
\"ip_address\": {
\"vps\": 101
}
}" \
'http://api.vpsfree.cz/v6.0/ip_addresses?vps=101'
{
"status": true,
"message": null,
"response": {
"ip_addresses": [
{
"id": 10,
"addr": "192.168.0.50"
}
]
},
"errors": null
}GET /v6.0/ip_addresses?vps=101 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 171
{
"status": true,
"message": null,
"response": {
"ip_addresses": [
{
"id": 10,
"addr": "192.168.0.50"
}
]
},
"errors": null
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| NetworkInterface | network_interface | Resource | |
| Network | network | Resource | |
| User | user | Resource | |
| Address | addr | String | Address itself |
| Prefix | prefix | Integer | |
| Size | size | Integer | |
| Route_via | route_via | Resource | |
| Charged environment | charged_environment | Resource |
{
"auth": true,
"description": "Show IP address",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"charged_environment": {
"required": null,
"label": "Charged environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/ip_addresses/{ip_address_id}",
"method": "GET",
"help": "/v6.0/ip_addresses/{ip_address_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| User | user | no | Resource | |||
| Environment | environment | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| NetworkInterface | network_interface | Resource | |
| Network | network | Resource | |
| User | user | Resource | |
| Address | addr | String | Address itself |
| Prefix | prefix | Integer | |
| Size | size | Integer | |
| Route_via | route_via | Resource | |
| Charged environment | charged_environment | Resource |
{
"auth": true,
"description": "Update IP address",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "IP address ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"network_interface": {
"required": null,
"label": "NetworkInterface",
"description": null,
"type": "Resource",
"resource": [
"network_interface"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"addr": {
"required": false,
"label": "Address",
"description": "Address itself",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"route_via": {
"required": null,
"label": "Route_via",
"description": null,
"type": "Resource",
"resource": [
"host_ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/host_ip_addresses",
"method": "GET",
"help": "/v6.0/host_ip_addresses?method=GET"
}
},
"charged_environment": {
"required": null,
"label": "Charged environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "ip_address"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"action_state_id": {
"required": false,
"label": "Action state ID",
"description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/ip_addresses/{ip_address_id}",
"method": "PUT",
"help": "/v6.0/ip_addresses/{ip_address_id}?method=PUT"
}Browse IP address assignments
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| IpAddress | ip_address | no | Resource | |||
| Ip_addr | ip_addr | no | String | |||
| Ip_prefix | ip_prefix | no | Integer | |||
| User | user | no | Resource | |||
| VPS | vps | no | Resource | |||
| Assigned_by_chain | assigned_by_chain | no | Resource | |||
| Unassigned_by_chain | unassigned_by_chain | no | Resource | |||
| Reconstructed | reconstructed | no | Boolean | |||
| Location | location | no | Resource | |||
| Network | network | no | Resource | |||
| Ip_version | ip_version | no | Integer | Include
|
||
| Order | order | no | String | Include
|
newest | |
| Active | active | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| IpAddress | ip_address | Resource | |
| Ip_addr | ip_addr | String | |
| Ip_prefix | ip_prefix | Integer | |
| User | user | Resource | |
| Raw_user_id | raw_user_id | Integer | |
| VPS | vps | Resource | |
| Raw_vps_id | raw_vps_id | Integer | |
| From_date | from_date | Datetime | |
| To_date | to_date | Datetime | |
| Assigned_by_chain | assigned_by_chain | Resource | |
| Unassigned_by_chain | unassigned_by_chain | Resource | |
| Reconstructed | reconstructed | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List IP address assignments",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"ip_addr": {
"required": false,
"label": "Ip_addr",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_prefix": {
"required": false,
"label": "Ip_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"assigned_by_chain": {
"required": null,
"label": "Assigned_by_chain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"unassigned_by_chain": {
"required": null,
"label": "Unassigned_by_chain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"reconstructed": {
"required": false,
"label": "Reconstructed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": null,
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"network": {
"required": null,
"label": "Network",
"description": null,
"type": "Resource",
"resource": [
"network"
],
"value_id": "id",
"value_label": "address",
"value": null,
"choices": {
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}
},
"ip_version": {
"required": false,
"label": "Ip_version",
"description": null,
"type": "Integer",
"validators": {
"include": {
"values": [
4,
6
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"newest",
"oldest"
],
"message": "%{value} cannot be used"
}
},
"default": "newest",
"protected": false
},
"active": {
"required": false,
"label": "Active",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "ip_address_assignment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"ip_addr": {
"required": false,
"label": "Ip_addr",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_prefix": {
"required": false,
"label": "Ip_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"raw_user_id": {
"required": false,
"label": "Raw_user_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"raw_vps_id": {
"required": false,
"label": "Raw_vps_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"from_date": {
"required": false,
"label": "From_date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"to_date": {
"required": false,
"label": "To_date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"assigned_by_chain": {
"required": null,
"label": "Assigned_by_chain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"unassigned_by_chain": {
"required": null,
"label": "Unassigned_by_chain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"reconstructed": {
"required": false,
"label": "Reconstructed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "ip_address_assignments"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/ip_address_assignments",
"method": "GET",
"help": "/v6.0/ip_address_assignments?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| IpAddress | ip_address | Resource | |
| Ip_addr | ip_addr | String | |
| Ip_prefix | ip_prefix | Integer | |
| User | user | Resource | |
| Raw_user_id | raw_user_id | Integer | |
| VPS | vps | Resource | |
| Raw_vps_id | raw_vps_id | Integer | |
| From_date | from_date | Datetime | |
| To_date | to_date | Datetime | |
| Assigned_by_chain | assigned_by_chain | Resource | |
| Unassigned_by_chain | unassigned_by_chain | Resource | |
| Reconstructed | reconstructed | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show IP address assignment",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "ip_address_assignment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ip_address": {
"required": null,
"label": "IpAddress",
"description": null,
"type": "Resource",
"resource": [
"ip_address"
],
"value_id": "id",
"value_label": "addr",
"value": null,
"choices": {
"path": "/v6.0/ip_addresses",
"method": "GET",
"help": "/v6.0/ip_addresses?method=GET"
}
},
"ip_addr": {
"required": false,
"label": "Ip_addr",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_prefix": {
"required": false,
"label": "Ip_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "login",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"raw_user_id": {
"required": false,
"label": "Raw_user_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": null,
"type": "Resource",
"resource": [
"vps"
],
"value_id": "id",
"value_label": "hostname",
"value": null,
"choices": {
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}
},
"raw_vps_id": {
"required": false,
"label": "Raw_vps_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"from_date": {
"required": false,
"label": "From_date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"to_date": {
"required": false,
"label": "To_date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"assigned_by_chain": {
"required": null,
"label": "Assigned_by_chain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"unassigned_by_chain": {
"required": null,
"label": "Unassigned_by_chain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"reconstructed": {
"required": false,
"label": "Reconstructed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "ip_address_assignment"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/ip_address_assignments/{ip_address_assignment_id}",
"method": "GET",
"help": "/v6.0/ip_address_assignments/{ip_address_assignment_id}?method=GET"
}Available languages
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Code | code | String | |
| Label | label | String |
{
"auth": false,
"description": "List languages",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "language"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"code": {
"required": false,
"label": "Code",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "languages"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
],
"path": "/v6.0/languages",
"method": "GET",
"help": "/v6.0/languages?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Code | code | String | |
| Label | label | String |
{
"auth": true,
"description": "Show language",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "language"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"code": {
"required": false,
"label": "Code",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "language"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"path": "/v6.0/languages/{language_id}",
"method": "GET",
"help": "/v6.0/languages/{language_id}?method=GET"
}Manage locations
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | Location label | ||
| Description | description | no | String | Location description | ||
| Has IPv6 | has_ipv6 | no | Boolean | Include
|
True if location has IPv6 addresses | |
| Remote console server | remote_console_server | no | String | Format
|
URL to HTTP remote console server | |
| Domain | domain | no | String | Format
|
Location domain, subdomain at environment domain | |
| Environment | environment | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Location ID |
| Label | label | String | Location label |
| Description | description | String | Location description |
| Has IPv6 | has_ipv6 | Boolean | True if location has IPv6 addresses |
| Remote console server | remote_console_server | String | URL to HTTP remote console server |
| Domain | domain | String | Location domain, subdomain at environment domain |
| Environment | environment | Resource |
{
"auth": true,
"description": "Create new location",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": "Location label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Location description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"has_ipv6": {
"required": false,
"label": "Has IPv6",
"description": "True if location has IPv6 addresses",
"type": "Boolean",
"validators": {
"include": {
"values": [
true,
false
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"remote_console_server": {
"required": false,
"label": "Remote console server",
"description": "URL to HTTP remote console server",
"type": "String",
"validators": {
"format": {
"rx": "\\A(https?://.+)?\\Z",
"match": true,
"description": null,
"message": "invalid format"
}
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Location domain, subdomain at environment domain",
"type": "String",
"validators": {
"format": {
"rx": "[[0-9a-zA-Z\\-\\.]{3,255}]",
"match": true,
"description": null,
"message": "invalid format"
}
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "location"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Location ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Location label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Location description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"has_ipv6": {
"required": false,
"label": "Has IPv6",
"description": "True if location has IPv6 addresses",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"remote_console_server": {
"required": false,
"label": "Remote console server",
"description": "URL to HTTP remote console server",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Location domain, subdomain at environment domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
}
},
"layout": "object",
"namespace": "location"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": null,
"request": {
"label": "Brno",
"has_ipv6": true,
"remote_console_server": "",
"domain": "brq"
},
"response": {
"id": 2
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/locations",
"method": "POST",
"help": "/v6.0/locations?method=POST"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.location.create({:label=>"Brno", :has_ipv6=>true, :remote_console_server=>"", :domain=>"brq"})
# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 2
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.location.create({
"label": "Brno",
"has_ipv6": true,
"remote_console_server": "",
"domain": "brq"
}, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
// reply.id = 2
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->location->create([
"label" => "Brno",
"has_ipv6" => true,
"remote_console_server" => "",
"domain" => "brq"
]);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 2
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 location create -- \
--label 'Brno' \
--has-ipv6 \
--remote-console-server '' \
--domain 'brq'
ID: 2
Label: -
Description: -
Has IPv6: -
Remote console server: -
Domain: -
Environment: -
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=6.0
# Change to action directory
$ cd /mnt/api.vpsfree.cz/location/actions/create
# Prepare input parameters
$ echo 'Brno' > input/label
$ echo 'true' > input/has_ipv6
$ echo '' > input/remote_console_server
$ echo 'brq' > input/domain
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1
# Query the output parameters
$ cat output/id
2
$ curl --request POST \
--data-binary "{
\"location\": {
\"label\": \"Brno\",
\"has_ipv6\": true,
\"remote_console_server\": \"\",
\"domain\": \"brq\"
}
}" \
'http://api.vpsfree.cz/v6.0/locations'
{
"status": true,
"message": null,
"response": {
"location": {
"id": 2
}
},
"errors": null
}POST /v6.0/locations HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
{
"location": {
"label": "Brno",
"has_ipv6": true,
"remote_console_server": "",
"domain": "brq"
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 116
{
"status": true,
"message": null,
"response": {
"location": {
"id": 2
}
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Offset | offset | no | Integer | The offset of the first object | ||
| Limit | limit | no | Integer | The number of objects to retrieve | ||
| Environment | environment | no | Resource | Filter locations by environment | ||
| Has hypervisor | has_hypervisor | no | Boolean | List only locations having at least one hypervisor node | ||
| Has storage | has_storage | no | Boolean | List only locations having at least one storage node | ||
| Hypervisor type | hypervisor_type | no | String | Include
|
List only locations having at least one node of this type | |
| Shares IPv4 networks with location | shares_v4_networks_with | no | Resource | |||
| Shares IPv4 networks with location | shares_v6_networks_with | no | Resource | |||
| Shares IPv4 networks with location | shares_any_networks_with | no | Resource | |||
| Shared network primary | shares_networks_primary | no | Boolean | Filter locations with shared networks that are primary in the other location |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Location ID |
| Label | label | String | Location label |
| Description | description | String | Location description |
| Has IPv6 | has_ipv6 | Boolean | True if location has IPv6 addresses |
| Remote console server | remote_console_server | String | URL to HTTP remote console server |
| Domain | domain | String | Location domain, subdomain at environment domain |
| Environment | environment | Resource | |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": false,
"description": "List locations",
"aliases": [
"list"
],
"blocking": false,
"input": {
"parameters": {
"offset": {
"required": false,
"label": "Offset",
"description": "The offset of the first object",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": "The number of objects to retrieve",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": "Filter locations by environment",
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"has_hypervisor": {
"required": false,
"label": "Has hypervisor",
"description": "List only locations having at least one hypervisor node",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"has_storage": {
"required": false,
"label": "Has storage",
"description": "List only locations having at least one storage node",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "List only locations having at least one node of this type",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"shares_v4_networks_with": {
"required": null,
"label": "Shares IPv4 networks with location",
"description": null,
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"shares_v6_networks_with": {
"required": null,
"label": "Shares IPv4 networks with location",
"description": null,
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"shares_any_networks_with": {
"required": null,
"label": "Shares IPv4 networks with location",
"description": null,
"type": "Resource",
"resource": [
"location"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}
},
"shares_networks_primary": {
"required": false,
"label": "Shared network primary",
"description": "Filter locations with shared networks that are primary in the other location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "location"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Location ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Location label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": "Location description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"has_ipv6": {
"required": false,
"label": "Has IPv6",
"description": "True if location has IPv6 addresses",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"remote_console_server": {
"required": false,
"label": "Remote console server",
"description": "URL to HTTP remote console server",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain": {
"required": false,
"label": "Domain",
"description": "Location domain, subdomain at environment domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"environment": {
"required": null,
"label": "Environment",
"description": null,
"type": "Resource",
"resource": [
"environment"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/environments",
"method": "GET",
"help": "/v6.0/environments?method=GET"
}
},
"maintenance_lock": {
"required": false,
"label": "Maintenance lock",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no",
"lock",
"master_lock"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"maintenance_lock_reason": {
"required": false,
"label": "Maintenance reason",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "locations"
},
"meta": {
"object": {
"input": null,
"output": {
"parameters": {
"path_params": {
"required": false,
"label": "URL parameters",
"description": "An array of parameters needed to resolve URL to this object",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"resolved": {
"required": false,
"label": "Resolved",
"description": "True if the association is resolved",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
},
"global": {
"input": {
"parameters": {
"no": {
"required": false,
"label": "Disable metadata",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Return the count of all items",
"description": null,
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"includes": {
"required": false,
"label": "Included associations",
"description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
},
"output": {
"parameters": {
"total_count": {
"required": false,
"label": "Total count of all items",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": false
}
}
},
"examples": [
{
"title": "",
"comment": null,
"path_params": null,
"request": {
},
"response": [
{
"label": "Prague",
"has_ipv6": true,
"remote_console_server": "https://console.vpsadmin.mydomain.com",
"domain": "prg"
}
],
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}