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.23.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": [
],
"scope": "token#renew",
"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
|
||
| Scope | scope | no | String | all | ||
| Lifetime | lifetime | yes | String | Include
Present
|
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
},
"scope": {
"required": false,
"label": "Scope",
"description": null,
"type": "String",
"validators": {
},
"default": "all",
"protected": false
},
"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": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto",
"permanent"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"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": [
],
"scope": "token#request",
"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": [
],
"scope": "token#revoke",
"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": [
],
"scope": "token#totp",
"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", scope: "scope")
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",
scope: "scope"
}, 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", "scope" => "scope"]);
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 --scope scope --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\",
\"scope\": \"scope\",
\"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",
"scope": "scope",
"lifetime": "fixed"
}
}
OAuth2 authorization provider. While OAuth2 support in HaveAPI clients is limited, it is possible to use your API as an authentication source and to use OAuth2 tokens to access the API. HaveAPI partially implements RFC 6749: authorization response type "code" and token grant types "authorization_code" and "refresh_token". Other response and grant types are not supported at this time. The access token can be passed as bearer token according to RFC 6750, or using a custom HTTP header when the Authorization header is not practical. The access and refresh tokens can be revoked as per RFC 7009.
# OAuth2 is not supported by HaveAPI Ruby client.import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
// The JavaScript client must be configured with OAuth2 access token, it does not
// support the authorization procedure to obtain a new access token.
var accessToken = {
access_token: "the access token"
};
// The client is authenticated immediately, no need for a callback
api.authenticate("oauth2", {access_token: accessToken});
// OAuth2 requires session
session_start();
// Client instance
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
// Check if we already have an access token
if (isset($_SESSION["access_token"])) {
// We're already authenticated, reuse the existing access token
$api->authenticate("oauth2", ["access_token" => $_SESSION["access_token"]]);
} else {
// Follow the OAuth2 authorization process to get an access token using
// authorization code
$api->authenticate("oauth2", [
// Client id and secret are given by the API server
"client_id" => "your client id",
"client_secret" => "your client secret",
// This example code should run on the URL below
"redirect_uri" => "https://your-client.tld/oauth2-callback",
// Scopes are specific to the API implementation
"scope" => "all",
]);
$provider = $api->getAuthenticationProvider();
// We don't have authorization code yet, request one
if (!isset($_GET['code'])) {
// Redirect the user to the authorization endpoint
$provider->requestAuthorizationCode();
exit;
} else {
// Request access token using the token endpoint
$provider->requestAccessToken();
// Store the access token in the session
$_SESSION['access_token'] = $provider->jsonSerialize();
}
}
# OAuth2 is not supported by HaveAPI Ruby CLI.# OAuth2 is not supported by haveapi-fs.# See RFC 6749 for authorization process and RFC 6750 for access token usage.# 1) Request authorization code
GET /_auth/oauth2/authorize?response_type=code&client_id=$client_id&state=$state&redirect_uri=$client_redirect_uri HTTP/1.1
Host: api.vpsfree.cz
# 2) The user logs in using this API
# 3) The API then redirects the user back to the client application
GET $client_redirect_uri?code=$authorization_code&state=$state
Host: client-application
# 4) The client application requests access token
POST /_auth/oauth2/token
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code&code=$authorization_code&redirect_uri=$client_redirect_uri&client_id=$client_id&client_secret=$client_secret
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": [
],
"scope": "action_state#cancel",
"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": [
],
"scope": "action_state#index",
"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": [
],
"scope": "action_state#poll",
"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": [
],
"scope": "action_state#show",
"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": [
],
"scope": "api_server#unlock_transaction_signing_key",
"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": [
],
"scope": "cluster#full_stats",
"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": [
],
"scope": "cluster#generate_migration_keys",
"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
}
],
"scope": "cluster#public_stats",
"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": [
],
"scope": "cluster#search",
"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": [
],
"scope": "cluster#set_maintenance",
"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": [
],
"scope": "cluster#show",
"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": [
],
"scope": "cluster_resource#create",
"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": [
],
"scope": "cluster_resource#index",
"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": [
],
"scope": "cluster_resource#show",
"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": [
],
"scope": "cluster_resource#update",
"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": [
],
"scope": "cluster_resource_package#create",
"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": [
],
"scope": "cluster_resource_package#delete",
"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": [
],
"scope": "cluster_resource_package#index",
"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": [
],
"scope": "cluster_resource_package#show",
"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": [
],
"scope": "cluster_resource_package#update",
"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": [
],
"scope": "cluster_resource_package.item#create",
"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": [
],
"scope": "cluster_resource_package.item#delete",
"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": [
],
"scope": "cluster_resource_package.item#index",
"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": [
],
"scope": "cluster_resource_package.item#show",
"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": [
],
"scope": "cluster_resource_package.item#update",
"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"
}Browse vpsAdmin components
| 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 | |
| Name | name | String | |
| Label | label | String | |
| Description | description | Text |
{
"auth": false,
"description": "List vpsAdmin components",
"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": "component"
},
"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
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "components"
},
"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": [
],
"scope": "component#index",
"path": "/v6.0/components",
"method": "GET",
"help": "/v6.0/components?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Label | label | String | |
| Description | description | Text |
{
"auth": false,
"description": "Show vpsAdmin component",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "component"
},
"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
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"description": {
"required": false,
"label": "Description",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "component"
},
"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": [
],
"scope": "component#show",
"path": "/v6.0/components/{component_id}",
"method": "GET",
"help": "/v6.0/components/{component_id}?method=GET"
}Manage datasets
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | yes | String | Format
Present
|
||
| 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 |
| Used compression ratio | compressratio | Float | Compression ratio for used space of this dataset |
| Referenced compression ratio | refcompressratio | Float | Compression ratio for referenced space of this 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": {
"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"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"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
},
"compressratio": {
"required": false,
"label": "Used compression ratio",
"description": "Compression ratio for used space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
},
"refcompressratio": {
"required": false,
"label": "Referenced compression ratio",
"description": "Compression ratio for referenced space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.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": [
],
"scope": "dataset#create",
"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": [
],
"scope": "dataset#delete",
"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 |
| Used compression ratio | compressratio | Float | Compression ratio for used space of this dataset |
| Referenced compression ratio | refcompressratio | Float | Compression ratio for referenced space of this 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
},
"compressratio": {
"required": false,
"label": "Used compression ratio",
"description": "Compression ratio for used space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
},
"refcompressratio": {
"required": false,
"label": "Referenced compression ratio",
"description": "Compression ratio for referenced space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.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": [
],
"scope": "dataset#find_by_name",
"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 |
| Used compression ratio | compressratio | Float | Compression ratio for used space of this dataset |
| Referenced compression ratio | refcompressratio | Float | Compression ratio for referenced space of this 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
},
"compressratio": {
"required": false,
"label": "Used compression ratio",
"description": "Compression ratio for used space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
},
"refcompressratio": {
"required": false,
"label": "Referenced compression ratio",
"description": "Compression ratio for referenced space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.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": [
],
"scope": "dataset#index",
"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": [
],
"scope": "dataset#inherit",
"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 |
| Used compression ratio | compressratio | Float | Compression ratio for used space of this dataset |
| Referenced compression ratio | refcompressratio | Float | Compression ratio for referenced space of this 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
},
"compressratio": {
"required": false,
"label": "Used compression ratio",
"description": "Compression ratio for used space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
},
"refcompressratio": {
"required": false,
"label": "Referenced compression ratio",
"description": "Compression ratio for referenced space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.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": [
],
"scope": "dataset#show",
"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": [
],
"scope": "dataset#update",
"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": [
],
"scope": "dataset.plan#create",
"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": [
],
"scope": "dataset.plan#delete",
"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": [
],
"scope": "dataset.plan#index",
"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": [
],
"scope": "dataset.plan#show",
"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": [
],
"scope": "dataset.property_history#index",
"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": [
],
"scope": "dataset.property_history#show",
"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": [
],
"scope": "dataset.snapshot#create",
"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": [
],
"scope": "dataset.snapshot#delete",
"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": [
],
"scope": "dataset.snapshot#index",
"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": [
],
"scope": "dataset.snapshot#rollback",
"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": [
],
"scope": "dataset.snapshot#show",
"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 extra space is used too long or there are too many expansions | ||
| Max_over_refquota_seconds | max_over_refquota_seconds | no | Integer |
| 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 extra space is used too long or there are too many expansions |
| Over_refquota_seconds | over_refquota_seconds | Integer | |
| Max_over_refquota_seconds | max_over_refquota_seconds | Integer | |
| 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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"description": null,
"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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"over_refquota_seconds": {
"required": false,
"label": "Over_refquota_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"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": "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": [
],
"scope": "dataset_expansion#create",
"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 extra space is used too long or there are too many expansions |
| Over_refquota_seconds | over_refquota_seconds | Integer | |
| Max_over_refquota_seconds | max_over_refquota_seconds | Integer | |
| 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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"over_refquota_seconds": {
"required": false,
"label": "Over_refquota_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"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": "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": [
],
"scope": "dataset_expansion#index",
"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 extra space is used too long or there are too many expansions | ||
| Max_over_refquota_seconds | max_over_refquota_seconds | no | Integer |
| 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 extra space is used too long or there are too many expansions |
| Over_refquota_seconds | over_refquota_seconds | Integer | |
| Max_over_refquota_seconds | max_over_refquota_seconds | Integer | |
| 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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"description": null,
"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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"over_refquota_seconds": {
"required": false,
"label": "Over_refquota_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"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": "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": [
],
"scope": "dataset_expansion#register_expanded",
"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 extra space is used too long or there are too many expansions |
| Over_refquota_seconds | over_refquota_seconds | Integer | |
| Max_over_refquota_seconds | max_over_refquota_seconds | Integer | |
| 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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"over_refquota_seconds": {
"required": false,
"label": "Over_refquota_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"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": "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": [
],
"scope": "dataset_expansion#show",
"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 extra space is used too long or there are too many expansions | ||
| Max_over_refquota_seconds | max_over_refquota_seconds | no | Integer |
| 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 extra space is used too long or there are too many expansions |
| Over_refquota_seconds | over_refquota_seconds | Integer | |
| Max_over_refquota_seconds | max_over_refquota_seconds | Integer | |
| 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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"description": null,
"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 extra space is used too long or there are too many expansions",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"over_refquota_seconds": {
"required": false,
"label": "Over_refquota_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_over_refquota_seconds": {
"required": false,
"label": "Max_over_refquota_seconds",
"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": "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": [
],
"scope": "dataset_expansion#update",
"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": [
],
"scope": "dataset_expansion.history#create",
"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": [
],
"scope": "dataset_expansion.history#index",
"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": [
],
"scope": "dataset_expansion.history#show",
"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": [
],
"scope": "dataset_plan#index",
"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": [
],
"scope": "dataset_plan#show",
"path": "/v6.0/dataset_plans/{dataset_plan_id}",
"method": "GET",
"help": "/v6.0/dataset_plans/{dataset_plan_id}?method=GET"
}Internal debug actions
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Limit | limit | no | Integer | 10 |
| Label | Name | Type | Description |
|---|---|---|---|
| Size | size | Integer | |
| Sample | sample | Custom |
{
"auth": true,
"description": "List largest Ruby arrays",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"limit": {
"required": false,
"label": "Limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
}
},
"layout": "hash",
"namespace": "debug"
},
"output": {
"parameters": {
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"sample": {
"required": false,
"label": "Sample",
"description": null,
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash_list",
"namespace": "debugs"
},
"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": [
],
"scope": "debug#array_top",
"path": "/v6.0/debugs/array_top",
"method": "GET",
"help": "/v6.0/debugs/array_top?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Limit | limit | no | Integer | 10 |
| Label | Name | Type | Description |
|---|---|---|---|
| Size | size | Integer | |
| Sample | sample | Custom |
{
"auth": true,
"description": "List largest Ruby hashes",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"limit": {
"required": false,
"label": "Limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
}
},
"layout": "hash",
"namespace": "debug"
},
"output": {
"parameters": {
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"sample": {
"required": false,
"label": "Sample",
"description": null,
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash_list",
"namespace": "debugs"
},
"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": [
],
"scope": "debug#hash_top",
"path": "/v6.0/debugs/hash_top",
"method": "GET",
"help": "/v6.0/debugs/hash_top?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Object | object | String | |
| Count | count | Integer |
{
"auth": true,
"description": "List Ruby objects and their counts",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "debug"
},
"output": {
"parameters": {
"object": {
"required": false,
"label": "Object",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash_list",
"namespace": "debugs"
},
"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": [
],
"scope": "debug#list_object_counts",
"path": "/v6.0/debugs/list_object_counts",
"method": "GET",
"help": "/v6.0/debugs/list_object_counts?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": [
],
"scope": "dns_resolver#create",
"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": true,
"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": {
"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": [
],
"scope": "dns_resolver#delete",
"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
}
],
"scope": "dns_resolver#index",
"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": [
],
"scope": "dns_resolver#show",
"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": true,
"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": {
"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": [
],
"scope": "dns_resolver#update",
"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
}
],
"scope": "environment#create",
"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
}
],
"scope": "environment#index",
"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": [
],
"scope": "environment#set_maintenance",
"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
}
],
"scope": "environment#show",
"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
}
],
"scope": "environment#update",
"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": [
],
"scope": "environment.dataset_plan#index",
"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": [
],
"scope": "environment.dataset_plan#show",
"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": [
],
"scope": "export#create",
"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": [
],
"scope": "export#delete",
"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": [
],
"scope": "export#index",
"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": [
],
"scope": "export#show",
"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": [
],
"scope": "export#update",
"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": [
],
"scope": "export.host#create",
"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": [
],
"scope": "export.host#delete",
"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": [
],
"scope": "export.host#index",
"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": [
],
"scope": "export.host#show",
"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": [
],
"scope": "export.host#update",
"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": [
],
"scope": "export_outage#index",
"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": [
],
"scope": "export_outage#show",
"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": [
],
"scope": "help_box#create",
"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": [
],
"scope": "help_box#delete",
"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": [
],
"scope": "help_box#index",
"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": [
],
"scope": "help_box#show",
"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": [
],
"scope": "help_box#update",
"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 | |
| User_created | user_created | 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
},
"user_created": {
"required": false,
"label": "User_created",
"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": [
],
"scope": "host_ip_address#assign",
"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"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| IpAddress | ip_address | yes | Resource | |||
| Network address | addr | yes | String | Present
|
||
| Assigned | assigned | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| IpAddress | ip_address | Resource | |
| Address | addr | String | |
| Assigned | assigned | Boolean | |
| User_created | user_created | Boolean |
{
"auth": true,
"description": "Add host IP address",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"ip_address": {
"required": true,
"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": true,
"label": "Network address",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"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
},
"user_created": {
"required": false,
"label": "User_created",
"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": [
],
"scope": "host_ip_address#create",
"path": "/v6.0/host_ip_addresses",
"method": "POST",
"help": "/v6.0/host_ip_addresses?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete host IP address",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "host_ip_address"
},
"output": {
"parameters": {
},
"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": [
],
"scope": "host_ip_address#delete",
"path": "/v6.0/host_ip_addresses/{host_ip_address_id}",
"method": "DELETE",
"help": "/v6.0/host_ip_addresses/{host_ip_address_id}?method=DELETE"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | IP address ID |
| IpAddress | ip_address | Resource | |
| Address | addr | String | |
| Assigned | assigned | Boolean | |
| User_created | user_created | 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
},
"user_created": {
"required": false,
"label": "User_created",
"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": [
],
"scope": "host_ip_address#free",
"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 | |
| User_created | user_created | 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
},
"user_created": {
"required": false,
"label": "User_created",
"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": [
],
"scope": "host_ip_address#index",
"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 | |
| User_created | user_created | 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
},
"user_created": {
"required": false,
"label": "User_created",
"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": [
],
"scope": "host_ip_address#show",
"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": [
],
"scope": "incident_report#create",
"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": [
],
"scope": "incident_report#index",
"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": [
],
"scope": "incident_report#show",
"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": [
],
"scope": "incoming_payment#index",
"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": [
],
"scope": "incoming_payment#show",
"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": [
],
"scope": "incoming_payment#update",
"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": [
],
"scope": "ip_address#assign",
"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": [
],
"scope": "ip_address#assign_with_host_address",
"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": [
],
"scope": "ip_address#create",
"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": [
],
"scope": "ip_address#free",
"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
}
],
"scope": "ip_address#index",
"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": [
],
"scope": "ip_address#show",
"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": [
],
"scope": "ip_address#update",
"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": [
],
"scope": "ip_address_assignment#index",
"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": [
],
"scope": "ip_address_assignment#show",
"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": [
],
"scope": "language#index",
"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": [
],
"scope": "language#show",
"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": "\\A[0-9a-zA-Z\\-.]{3,255}\\Z",
"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
}
],
"scope": "location#create",
"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
}
],
"scope": "location#index",
"path": "/v6.0/locations",
"method": "GET",
"help": "/v6.0/locations?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.location.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.location.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->location->index();
// $reply is an instance of \HaveAPI\Client\ResourceInstanceList$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 location index
ID: -
Label: Prague
Description: -
Has IPv6: true
Remote console server: https://console.vpsadmin.mydomain.com
Domain: prg
Environment: -
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/location/actions/index
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request GET \
--data-binary "{
\"location\": {
}
}" \
'http://api.vpsfree.cz/v6.0/locations'
{
"status": true,
"message": null,
"response": {
"locations": [
{
"label": "Prague",
"has_ipv6": true,
"remote_console_server": "https://console.vpsadmin.mydomain.com",
"domain": "prg"
}
]
},
"errors": null
}GET /v6.0/locations 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: 270
{
"status": true,
"message": null,
"response": {
"locations": [
{
"label": "Prague",
"has_ipv6": true,
"remote_console_server": "https://console.vpsadmin.mydomain.com",
"domain": "prg"
}
]
},
"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": "location"
},
"output": {
"parameters": {
},
"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
}
},
"layout": "hash",
"namespace": false
},
"output": null
}
},
"examples": [
],
"scope": "location#set_maintenance",
"path": "/v6.0/locations/{location_id}/set_maintenance",
"method": "POST",
"help": "/v6.0/locations/{location_id}/set_maintenance?method=POST"
}No parameters.
| 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": true,
"description": "Show location",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"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",
"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": [
2
],
"request": {
},
"response": {
"id": 2,
"label": "Brno",
"has_ipv6": true,
"remote_console_server": "",
"domain": "brq"
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "location#show",
"path": "/v6.0/locations/{location_id}",
"method": "GET",
"help": "/v6.0/locations/{location_id}?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.location.show(2)
# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 2
# reply.label = "Brno"
# reply.has_ipv6 = true
# reply.remote_console_server = ""
# reply.domain = "brq"
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.location.show(2, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
// reply.id = 2
// reply.label = "Brno"
// reply.has_ipv6 = true
// reply.remote_console_server = ""
// reply.domain = "brq"
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->location->show(2);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 2
// $reply->label = "Brno"
// $reply->has_ipv6 = true
// $reply->remote_console_server = ""
// $reply->domain = "brq"
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 location show 2
ID: 2
Label: Brno
Description: -
Has IPv6: true
Remote console server: -
Domain: brq
Environment: -
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/location/actions/show
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1
# Query the output parameters
$ cat output/id
2
$ cat output/label
Brno
$ cat output/has_ipv6
1
$ cat output/remote_console_server
$ cat output/domain
brq
$ curl --request GET \
--data-binary "{
\"location\": {
}
}" \
'http://api.vpsfree.cz/v6.0/locations/2'
{
"status": true,
"message": null,
"response": {
"location": {
"id": 2,
"label": "Brno",
"has_ipv6": true,
"remote_console_server": "",
"domain": "brq"
}
},
"errors": null
}GET /v6.0/locations/2 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: 221
{
"status": true,
"message": null,
"response": {
"location": {
"id": 2,
"label": "Brno",
"has_ipv6": true,
"remote_console_server": "",
"domain": "brq"
}
},
"errors": null
}| 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 |
No parameters.
{
"auth": true,
"description": "Update location",
"aliases": [
],
"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": "\\A[0-9a-zA-Z\\-.]{3,255}\\Z",
"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": {
},
"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": [
2
],
"request": {
"label": "Ostrava",
"has_ipv6": true,
"remote_console_server": "",
"domain": "ova",
"environment": 1
},
"response": {
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "location#update",
"path": "/v6.0/locations/{location_id}",
"method": "PUT",
"help": "/v6.0/locations/{location_id}?method=PUT"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.location.update(2, {:label=>"Ostrava",
:has_ipv6=>true,
:remote_console_server=>"",
:domain=>"ova",
:environment=>1})
# 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.location.update(2, {
"label": "Ostrava",
"has_ipv6": true,
"remote_console_server": "",
"domain": "ova",
"environment": 1
}, 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->location->update(2, [
"label" => "Ostrava",
"has_ipv6" => true,
"remote_console_server" => "",
"domain" => "ova",
"environment" => 1
]);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 location update 2 -- \
--label 'Ostrava' \
--has-ipv6 \
--remote-console-server '' \
--domain 'ova' \
--environment '1'# 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/update
# Prepare input parameters
$ echo 'Ostrava' > input/label
$ echo 'true' > input/has_ipv6
$ echo '' > input/remote_console_server
$ echo 'ova' > input/domain
$ echo '1' > input/environment
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request PUT \
--data-binary "{
\"location\": {
\"label\": \"Ostrava\",
\"has_ipv6\": true,
\"remote_console_server\": \"\",
\"domain\": \"ova\",
\"environment\": 1
}
}" \
'http://api.vpsfree.cz/v6.0/locations/2'
{
"status": true,
"message": null,
"response": {
"location": {
}
},
"errors": null
}PUT /v6.0/locations/2 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
{
"location": {
"label": "Ostrava",
"has_ipv6": true,
"remote_console_server": "",
"domain": "ova",
"environment": 1
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 102
{
"status": true,
"message": null,
"response": {
"location": {
}
},
"errors": null
}Manage location networks
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Location | location | no | Resource | |||
| Network | network | no | Resource | |||
| Primary | primary | no | Boolean | |||
| Priority | priority | no | Integer | |||
| Autopick | autopick | no | Boolean | |||
| Userpick | userpick | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Location | location | Resource | |
| Network | network | Resource | |
| Primary | primary | Boolean | |
| Priority | priority | Integer | |
| Autopick | autopick | Boolean | |
| Userpick | userpick | Boolean |
{
"auth": true,
"description": "Add network to a location",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"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"
}
},
"primary": {
"required": false,
"label": "Primary",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"autopick": {
"required": false,
"label": "Autopick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"userpick": {
"required": false,
"label": "Userpick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "location_network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"primary": {
"required": false,
"label": "Primary",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"autopick": {
"required": false,
"label": "Autopick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"userpick": {
"required": false,
"label": "Userpick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "location_network"
},
"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": [
],
"scope": "location_network#create",
"path": "/v6.0/location_networks",
"method": "POST",
"help": "/v6.0/location_networks?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Remove network from a location",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "location_network"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "location_network"
},
"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": [
],
"scope": "location_network#delete",
"path": "/v6.0/location_networks/{location_network_id}",
"method": "DELETE",
"help": "/v6.0/location_networks/{location_network_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 | ||
| Location | location | no | Resource | |||
| Network | network | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Location | location | Resource | |
| Network | network | Resource | |
| Primary | primary | Boolean | |
| Priority | priority | Integer | |
| Autopick | autopick | Boolean | |
| Userpick | userpick | Boolean |
{
"auth": true,
"description": "List location networks",
"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
},
"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"
}
}
},
"layout": "object",
"namespace": "location_network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"primary": {
"required": false,
"label": "Primary",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"autopick": {
"required": false,
"label": "Autopick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"userpick": {
"required": false,
"label": "Userpick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "location_networks"
},
"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": [
],
"scope": "location_network#index",
"path": "/v6.0/location_networks",
"method": "GET",
"help": "/v6.0/location_networks?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Location | location | Resource | |
| Network | network | Resource | |
| Primary | primary | Boolean | |
| Priority | priority | Integer | |
| Autopick | autopick | Boolean | |
| Userpick | userpick | Boolean |
{
"auth": true,
"description": "Show a location network",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "location_network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"primary": {
"required": false,
"label": "Primary",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"autopick": {
"required": false,
"label": "Autopick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"userpick": {
"required": false,
"label": "Userpick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "location_network"
},
"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": [
],
"scope": "location_network#show",
"path": "/v6.0/location_networks/{location_network_id}",
"method": "GET",
"help": "/v6.0/location_networks/{location_network_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Primary | primary | no | Boolean | |||
| Priority | priority | no | Integer | |||
| Autopick | autopick | no | Boolean | |||
| Userpick | userpick | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Location | location | Resource | |
| Network | network | Resource | |
| Primary | primary | Boolean | |
| Priority | priority | Integer | |
| Autopick | autopick | Boolean | |
| Userpick | userpick | Boolean |
{
"auth": true,
"description": "Update a location network",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"primary": {
"required": false,
"label": "Primary",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"autopick": {
"required": false,
"label": "Autopick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"userpick": {
"required": false,
"label": "Userpick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "location_network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"primary": {
"required": false,
"label": "Primary",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"autopick": {
"required": false,
"label": "Autopick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"userpick": {
"required": false,
"label": "Userpick",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "location_network"
},
"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": [
],
"scope": "location_network#update",
"path": "/v6.0/location_networks/{location_network_id}",
"method": "PUT",
"help": "/v6.0/location_networks/{location_network_id}?method=PUT"
}Browse sent mails
| 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 |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| To | to | String | |
| Cc | cc | String | |
| Bcc | bcc | String | |
| From | from | String | |
| Reply_to | reply_to | String | |
| Return_path | return_path | String | |
| Message_id | message_id | String | |
| In_reply_to | in_reply_to | String | |
| References | references | String | |
| Subject | subject | String | |
| Text_plain | text_plain | String | |
| Text_html | text_html | String | |
| MailTemplate | mail_template | Resource | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "List mails",
"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
}
},
"layout": "object",
"namespace": "mail_log"
},
"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"
}
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"message_id": {
"required": false,
"label": "Message_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"in_reply_to": {
"required": false,
"label": "In_reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"references": {
"required": false,
"label": "References",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_template": {
"required": null,
"label": "MailTemplate",
"description": null,
"type": "Resource",
"resource": [
"mail_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mail_templates",
"method": "GET",
"help": "/v6.0/mail_templates?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "mail_logs"
},
"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": [
],
"scope": "mail_log#index",
"path": "/v6.0/mail_logs",
"method": "GET",
"help": "/v6.0/mail_logs?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| To | to | String | |
| Cc | cc | String | |
| Bcc | bcc | String | |
| From | from | String | |
| Reply_to | reply_to | String | |
| Return_path | return_path | String | |
| Message_id | message_id | String | |
| In_reply_to | in_reply_to | String | |
| References | references | String | |
| Subject | subject | String | |
| Text_plain | text_plain | String | |
| Text_html | text_html | String | |
| MailTemplate | mail_template | Resource | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "View mail",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mail_log"
},
"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"
}
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"message_id": {
"required": false,
"label": "Message_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"in_reply_to": {
"required": false,
"label": "In_reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"references": {
"required": false,
"label": "References",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_template": {
"required": null,
"label": "MailTemplate",
"description": null,
"type": "Resource",
"resource": [
"mail_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mail_templates",
"method": "GET",
"help": "/v6.0/mail_templates?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_log"
},
"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": [
],
"scope": "mail_log#show",
"path": "/v6.0/mail_logs/{mail_log_id}",
"method": "GET",
"help": "/v6.0/mail_logs/{mail_log_id}?method=GET"
}Manage mail recipients
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | Human-friendly label | ||
| To | to | no | String | |||
| Cc | cc | no | String | |||
| Bcc | bcc | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | Human-friendly label |
| To | to | String | |
| Cc | cc | String | |
| Bcc | bcc | String |
{
"auth": true,
"description": "Create a mail recipient",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_recipient"
},
"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": [
],
"scope": "mail_recipient#create",
"path": "/v6.0/mail_recipients",
"method": "POST",
"help": "/v6.0/mail_recipients?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete a mail recipient",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mail_recipient"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "mail_recipient"
},
"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": [
],
"scope": "mail_recipient#delete",
"path": "/v6.0/mail_recipients/{mail_recipient_id}",
"method": "DELETE",
"help": "/v6.0/mail_recipients/{mail_recipient_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 | |
| Label | label | String | Human-friendly label |
| To | to | String | |
| Cc | cc | String | |
| Bcc | bcc | String |
{
"auth": true,
"description": "List mail recipients",
"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": "mail_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "mail_recipients"
},
"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": [
],
"scope": "mail_recipient#index",
"path": "/v6.0/mail_recipients",
"method": "GET",
"help": "/v6.0/mail_recipients?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | Human-friendly label |
| To | to | String | |
| Cc | cc | String | |
| Bcc | bcc | String |
{
"auth": true,
"description": "View mail recipient",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mail_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_recipient"
},
"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": [
],
"scope": "mail_recipient#show",
"path": "/v6.0/mail_recipients/{mail_recipient_id}",
"method": "GET",
"help": "/v6.0/mail_recipients/{mail_recipient_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | Human-friendly label | ||
| To | to | no | String | |||
| Cc | cc | no | String | |||
| Bcc | bcc | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | Human-friendly label |
| To | to | String | |
| Cc | cc | String | |
| Bcc | bcc | String |
{
"auth": true,
"description": "Update a mail recipient",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cc": {
"required": false,
"label": "Cc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"bcc": {
"required": false,
"label": "Bcc",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_recipient"
},
"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": [
],
"scope": "mail_recipient#update",
"path": "/v6.0/mail_recipients/{mail_recipient_id}",
"method": "PUT",
"help": "/v6.0/mail_recipients/{mail_recipient_id}?method=PUT"
}Manage mail templates
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | no | String | Template identifier | ||
| Label | label | no | String | Human-friendly label | ||
| Template_id | template_id | no | String | |||
| User_visibility | user_visibility | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | Template identifier |
| Label | label | String | Human-friendly label |
| Template_id | template_id | String | |
| User_visibility | user_visibility | String | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Create a mail template",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Name",
"description": "Template identifier",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"template_id": {
"required": false,
"label": "Template_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_visibility": {
"required": false,
"label": "User_visibility",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"default",
"visible",
"invisible"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template identifier",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"template_id": {
"required": false,
"label": "Template_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_visibility": {
"required": false,
"label": "User_visibility",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"default",
"visible",
"invisible"
],
"message": "%{value} cannot be used"
}
},
"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": "mail_template"
},
"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": [
],
"scope": "mail_template#create",
"path": "/v6.0/mail_templates",
"method": "POST",
"help": "/v6.0/mail_templates?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete a mail template",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mail_template"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "mail_template"
},
"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": [
],
"scope": "mail_template#delete",
"path": "/v6.0/mail_templates/{mail_template_id}",
"method": "DELETE",
"help": "/v6.0/mail_templates/{mail_template_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 | |
| Name | name | String | Template identifier |
| Label | label | String | Human-friendly label |
| Template_id | template_id | String | |
| User_visibility | user_visibility | String | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List mail templates",
"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": "mail_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template identifier",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"template_id": {
"required": false,
"label": "Template_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_visibility": {
"required": false,
"label": "User_visibility",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"default",
"visible",
"invisible"
],
"message": "%{value} cannot be used"
}
},
"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": "mail_templates"
},
"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": [
],
"scope": "mail_template#index",
"path": "/v6.0/mail_templates",
"method": "GET",
"help": "/v6.0/mail_templates?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | Template identifier |
| Label | label | String | Human-friendly label |
| Template_id | template_id | String | |
| User_visibility | user_visibility | String | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "View mail template",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mail_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template identifier",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"template_id": {
"required": false,
"label": "Template_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_visibility": {
"required": false,
"label": "User_visibility",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"default",
"visible",
"invisible"
],
"message": "%{value} cannot be used"
}
},
"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": "mail_template"
},
"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": [
],
"scope": "mail_template#show",
"path": "/v6.0/mail_templates/{mail_template_id}",
"method": "GET",
"help": "/v6.0/mail_templates/{mail_template_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | no | String | Template identifier | ||
| Label | label | no | String | Human-friendly label | ||
| Template_id | template_id | no | String | |||
| User_visibility | user_visibility | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | Template identifier |
| Label | label | String | Human-friendly label |
| Template_id | template_id | String | |
| User_visibility | user_visibility | String | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update a mail template",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Name",
"description": "Template identifier",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"template_id": {
"required": false,
"label": "Template_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_visibility": {
"required": false,
"label": "User_visibility",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"default",
"visible",
"invisible"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template identifier",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"template_id": {
"required": false,
"label": "Template_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_visibility": {
"required": false,
"label": "User_visibility",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"default",
"visible",
"invisible"
],
"message": "%{value} cannot be used"
}
},
"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": "mail_template"
},
"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": [
],
"scope": "mail_template#update",
"path": "/v6.0/mail_templates/{mail_template_id}",
"method": "PUT",
"help": "/v6.0/mail_templates/{mail_template_id}?method=PUT"
}Manage mail recipients
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| MailRecipient | mail_recipient | yes | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| MailRecipient | mail_recipient | Resource |
{
"auth": true,
"description": "Create a mail recipient",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"mail_recipient": {
"required": true,
"label": "MailRecipient",
"description": null,
"type": "Resource",
"resource": [
"mail_recipient"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mail_recipients",
"method": "GET",
"help": "/v6.0/mail_recipients?method=GET"
}
}
},
"layout": "object",
"namespace": "recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_recipient": {
"required": null,
"label": "MailRecipient",
"description": null,
"type": "Resource",
"resource": [
"mail_recipient"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mail_recipients",
"method": "GET",
"help": "/v6.0/mail_recipients?method=GET"
}
}
},
"layout": "object",
"namespace": "recipient"
},
"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": [
],
"scope": "mail_template.recipient#create",
"path": "/v6.0/mail_templates/{mail_template_id}/recipients",
"method": "POST",
"help": "/v6.0/mail_templates/{mail_template_id}/recipients?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete a mail recipient",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "recipient"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "recipient"
},
"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": [
],
"scope": "mail_template.recipient#delete",
"path": "/v6.0/mail_templates/{mail_template_id}/recipients/{recipient_id}",
"method": "DELETE",
"help": "/v6.0/mail_templates/{mail_template_id}/recipients/{recipient_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 | |
| MailRecipient | mail_recipient | Resource |
{
"auth": true,
"description": "List mail recipients",
"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": "recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_recipient": {
"required": null,
"label": "MailRecipient",
"description": null,
"type": "Resource",
"resource": [
"mail_recipient"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mail_recipients",
"method": "GET",
"help": "/v6.0/mail_recipients?method=GET"
}
}
},
"layout": "object_list",
"namespace": "recipients"
},
"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": [
],
"scope": "mail_template.recipient#index",
"path": "/v6.0/mail_templates/{mail_template_id}/recipients",
"method": "GET",
"help": "/v6.0/mail_templates/{mail_template_id}/recipients?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| MailRecipient | mail_recipient | Resource |
{
"auth": true,
"description": "View mail recipient",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_recipient": {
"required": null,
"label": "MailRecipient",
"description": null,
"type": "Resource",
"resource": [
"mail_recipient"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/mail_recipients",
"method": "GET",
"help": "/v6.0/mail_recipients?method=GET"
}
}
},
"layout": "object",
"namespace": "recipient"
},
"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": [
],
"scope": "mail_template.recipient#show",
"path": "/v6.0/mail_templates/{mail_template_id}/recipients/{recipient_id}",
"method": "GET",
"help": "/v6.0/mail_templates/{mail_template_id}/recipients/{recipient_id}?method=GET"
}Manage mail templates
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Language | language | no | Resource | |||
| From | from | no | String | |||
| Reply_to | reply_to | no | String | |||
| Return_path | return_path | no | String | |||
| Subject | subject | no | String | |||
| Text_plain | text_plain | no | Text | |||
| Text_html | text_html | no | Text |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Language | language | Resource | |
| From | from | String | |
| Reply_to | reply_to | String | |
| Return_path | return_path | String | |
| Subject | subject | String | |
| Text_plain | text_plain | Text | |
| Text_html | text_html | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Create a mail template translation",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"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"
}
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "translation"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "Text",
"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": "translation"
},
"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": [
],
"scope": "mail_template.translation#create",
"path": "/v6.0/mail_templates/{mail_template_id}/translations",
"method": "POST",
"help": "/v6.0/mail_templates/{mail_template_id}/translations?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete a mail template translation",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "translation"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "translation"
},
"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": [
],
"scope": "mail_template.translation#delete",
"path": "/v6.0/mail_templates/{mail_template_id}/translations/{translation_id}",
"method": "DELETE",
"help": "/v6.0/mail_templates/{mail_template_id}/translations/{translation_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 | |
| Language | language | Resource | |
| From | from | String | |
| Reply_to | reply_to | String | |
| Return_path | return_path | String | |
| Subject | subject | String | |
| Text_plain | text_plain | Text | |
| Text_html | text_html | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List mail template translations",
"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": "translation"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "Text",
"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": "translations"
},
"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": [
],
"scope": "mail_template.translation#index",
"path": "/v6.0/mail_templates/{mail_template_id}/translations",
"method": "GET",
"help": "/v6.0/mail_templates/{mail_template_id}/translations?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Language | language | Resource | |
| From | from | String | |
| Reply_to | reply_to | String | |
| Return_path | return_path | String | |
| Subject | subject | String | |
| Text_plain | text_plain | Text | |
| Text_html | text_html | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show a mail template translation",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "translation"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "Text",
"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": "translation"
},
"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": [
],
"scope": "mail_template.translation#show",
"path": "/v6.0/mail_templates/{mail_template_id}/translations/{translation_id}",
"method": "GET",
"help": "/v6.0/mail_templates/{mail_template_id}/translations/{translation_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Language | language | no | Resource | |||
| From | from | no | String | |||
| Reply_to | reply_to | no | String | |||
| Return_path | return_path | no | String | |||
| Subject | subject | no | String | |||
| Text_plain | text_plain | no | Text | |||
| Text_html | text_html | no | Text |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Language | language | Resource | |
| From | from | String | |
| Reply_to | reply_to | String | |
| Return_path | return_path | String | |
| Subject | subject | String | |
| Text_plain | text_plain | Text | |
| Text_html | text_html | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update a mail template translation",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"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"
}
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "translation"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"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"
}
},
"from": {
"required": false,
"label": "From",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reply_to": {
"required": false,
"label": "Reply_to",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"return_path": {
"required": false,
"label": "Return_path",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"subject": {
"required": false,
"label": "Subject",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"text_plain": {
"required": false,
"label": "Text_plain",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"text_html": {
"required": false,
"label": "Text_html",
"description": null,
"type": "Text",
"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": "translation"
},
"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": [
],
"scope": "mail_template.translation#update",
"path": "/v6.0/mail_templates/{mail_template_id}/translations/{translation_id}",
"method": "PUT",
"help": "/v6.0/mail_templates/{mail_template_id}/translations/{translation_id}?method=PUT"
}Manage mailboxes
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | |||
| Server | server | no | String | |||
| Port | port | no | Integer | |||
| User | user | no | String | |||
| Password | password | no | String | |||
| Enable_ssl | enable_ssl | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Label | label | String | |
| Server | server | String | |
| Port | port | Integer | |
| User | user | String | |
| Enable_ssl | enable_ssl | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Create a mailbox",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"server": {
"required": false,
"label": "Server",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"port": {
"required": false,
"label": "Port",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": false,
"label": "User",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"password": {
"required": false,
"label": "Password",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enable_ssl": {
"required": false,
"label": "Enable_ssl",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "mailbox"
},
"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
},
"server": {
"required": false,
"label": "Server",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"port": {
"required": false,
"label": "Port",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": false,
"label": "User",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enable_ssl": {
"required": false,
"label": "Enable_ssl",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"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": "mailbox"
},
"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": [
],
"scope": "mailbox#create",
"path": "/v6.0/mailboxes",
"method": "POST",
"help": "/v6.0/mailboxes?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete mailbox",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mailbox"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "mailbox"
},
"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": [
],
"scope": "mailbox#delete",
"path": "/v6.0/mailboxes/{mailbox_id}",
"method": "DELETE",
"help": "/v6.0/mailboxes/{mailbox_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 | |
| Label | label | String | |
| Server | server | String | |
| Port | port | Integer | |
| User | user | String | |
| Enable_ssl | enable_ssl | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List mailboxes",
"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": "mailbox"
},
"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
},
"server": {
"required": false,
"label": "Server",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"port": {
"required": false,
"label": "Port",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": false,
"label": "User",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enable_ssl": {
"required": false,
"label": "Enable_ssl",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"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": "mailboxes"
},
"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": [
],
"scope": "mailbox#index",
"path": "/v6.0/mailboxes",
"method": "GET",
"help": "/v6.0/mailboxes?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Label | label | String | |
| Server | server | String | |
| Port | port | Integer | |
| User | user | String | |
| Enable_ssl | enable_ssl | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show mailbox",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mailbox"
},
"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
},
"server": {
"required": false,
"label": "Server",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"port": {
"required": false,
"label": "Port",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": false,
"label": "User",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enable_ssl": {
"required": false,
"label": "Enable_ssl",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"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": "mailbox"
},
"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": [
],
"scope": "mailbox#show",
"path": "/v6.0/mailboxes/{mailbox_id}",
"method": "GET",
"help": "/v6.0/mailboxes/{mailbox_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | |||
| Server | server | no | String | |||
| Port | port | no | Integer | |||
| User | user | no | String | |||
| Password | password | no | String | |||
| Enable_ssl | enable_ssl | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Label | label | String | |
| Server | server | String | |
| Port | port | Integer | |
| User | user | String | |
| Enable_ssl | enable_ssl | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update mailbox",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"server": {
"required": false,
"label": "Server",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"port": {
"required": false,
"label": "Port",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": false,
"label": "User",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"password": {
"required": false,
"label": "Password",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enable_ssl": {
"required": false,
"label": "Enable_ssl",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "mailbox"
},
"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
},
"server": {
"required": false,
"label": "Server",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"port": {
"required": false,
"label": "Port",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": false,
"label": "User",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enable_ssl": {
"required": false,
"label": "Enable_ssl",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"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": "mailbox"
},
"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": [
],
"scope": "mailbox#update",
"path": "/v6.0/mailboxes/{mailbox_id}",
"method": "PUT",
"help": "/v6.0/mailboxes/{mailbox_id}?method=PUT"
}Manage mailbox handlers
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Class_name | class_name | no | String | |||
| Order | order | no | Integer | |||
| Continue | continue | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Class_name | class_name | String | |
| Order | order | Integer | |
| Continue | continue | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Add mailbox handler",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"class_name": {
"required": false,
"label": "Class_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"continue": {
"required": false,
"label": "Continue",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "handler"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"class_name": {
"required": false,
"label": "Class_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"continue": {
"required": false,
"label": "Continue",
"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": "handler"
},
"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": [
],
"scope": "mailbox.handler#create",
"path": "/v6.0/mailboxes/{mailbox_id}/handler",
"method": "POST",
"help": "/v6.0/mailboxes/{mailbox_id}/handler?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete mailbox handler",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "handler"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "handler"
},
"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": [
],
"scope": "mailbox.handler#delete",
"path": "/v6.0/mailboxes/{mailbox_id}/handler/{handler_id}",
"method": "DELETE",
"help": "/v6.0/mailboxes/{mailbox_id}/handler/{handler_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 | |
| Class_name | class_name | String | |
| Order | order | Integer | |
| Continue | continue | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List mailbox handlers",
"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": "handler"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"class_name": {
"required": false,
"label": "Class_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"continue": {
"required": false,
"label": "Continue",
"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": "handlers"
},
"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": [
],
"scope": "mailbox.handler#index",
"path": "/v6.0/mailboxes/{mailbox_id}/handler",
"method": "GET",
"help": "/v6.0/mailboxes/{mailbox_id}/handler?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Class_name | class_name | String | |
| Order | order | Integer | |
| Continue | continue | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show mailbox handler",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "handler"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"class_name": {
"required": false,
"label": "Class_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"continue": {
"required": false,
"label": "Continue",
"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": "handler"
},
"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": [
],
"scope": "mailbox.handler#show",
"path": "/v6.0/mailboxes/{mailbox_id}/handler/{handler_id}",
"method": "GET",
"help": "/v6.0/mailboxes/{mailbox_id}/handler/{handler_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Class_name | class_name | no | String | |||
| Order | order | no | Integer | |||
| Continue | continue | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Class_name | class_name | String | |
| Order | order | Integer | |
| Continue | continue | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update mailbox handler",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"class_name": {
"required": false,
"label": "Class_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"continue": {
"required": false,
"label": "Continue",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "handler"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"class_name": {
"required": false,
"label": "Class_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"continue": {
"required": false,
"label": "Continue",
"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": "handler"
},
"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": [
],
"scope": "mailbox.handler#update",
"path": "/v6.0/mailboxes/{mailbox_id}/handler/{handler_id}",
"method": "PUT",
"help": "/v6.0/mailboxes/{mailbox_id}/handler/{handler_id}?method=PUT"
}Manage /metrics endpoint access tokens
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| User | user | no | Resource | |||
| Metric prefix | metric_prefix | no | String | Length
Format
|
vpsadmin_ | Prefix added to all metrics |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Access token | access_token | String | |
| Metric prefix | metric_prefix | String | Prefix added to all metrics |
| Use count | use_count | Integer | |
| Last use | last_use | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Create a new access token",
"aliases": [
"new"
],
"blocking": false,
"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"
}
},
"metric_prefix": {
"required": false,
"label": "Metric prefix",
"description": "Prefix added to all metrics",
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 30",
"max": 30
},
"format": {
"rx": "\\A[a-zA-Z_]+\\z",
"match": true,
"description": null,
"message": "only allows letters and underscore"
}
},
"default": "vpsadmin_",
"protected": false
}
},
"layout": "object",
"namespace": "metrics_access_token"
},
"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"
}
},
"access_token": {
"required": false,
"label": "Access token",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"metric_prefix": {
"required": false,
"label": "Metric prefix",
"description": "Prefix added to all metrics",
"type": "String",
"validators": {
},
"default": "vpsadmin_",
"protected": false
},
"use_count": {
"required": false,
"label": "Use count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"last_use": {
"required": false,
"label": "Last use",
"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": "metrics_access_token"
},
"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": [
],
"scope": "metrics_access_token#create",
"path": "/v6.0/metrics_access_tokens",
"method": "POST",
"help": "/v6.0/metrics_access_tokens?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete access token",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "metrics_access_token"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "metrics_access_token"
},
"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": [
],
"scope": "metrics_access_token#delete",
"path": "/v6.0/metrics_access_tokens/{metrics_access_token_id}",
"method": "DELETE",
"help": "/v6.0/metrics_access_tokens/{metrics_access_token_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 |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Access token | access_token | String | |
| Metric prefix | metric_prefix | String | Prefix added to all metrics |
| Use count | use_count | Integer | |
| Last use | last_use | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_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": 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": "metrics_access_token"
},
"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"
}
},
"access_token": {
"required": false,
"label": "Access token",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"metric_prefix": {
"required": false,
"label": "Metric prefix",
"description": "Prefix added to all metrics",
"type": "String",
"validators": {
},
"default": "vpsadmin_",
"protected": false
},
"use_count": {
"required": false,
"label": "Use count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"last_use": {
"required": false,
"label": "Last use",
"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": "metrics_access_tokens"
},
"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": [
],
"scope": "metrics_access_token#index",
"path": "/v6.0/metrics_access_tokens",
"method": "GET",
"help": "/v6.0/metrics_access_tokens?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Access token | access_token | String | |
| Metric prefix | metric_prefix | String | Prefix added to all metrics |
| Use count | use_count | Integer | |
| Last use | last_use | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "metrics_access_token"
},
"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"
}
},
"access_token": {
"required": false,
"label": "Access token",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"metric_prefix": {
"required": false,
"label": "Metric prefix",
"description": "Prefix added to all metrics",
"type": "String",
"validators": {
},
"default": "vpsadmin_",
"protected": false
},
"use_count": {
"required": false,
"label": "Use count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"last_use": {
"required": false,
"label": "Last use",
"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": "metrics_access_token"
},
"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": [
],
"scope": "metrics_access_token#show",
"path": "/v6.0/metrics_access_tokens/{metrics_access_token_id}",
"method": "GET",
"help": "/v6.0/metrics_access_tokens/{metrics_access_token_id}?method=GET"
}View migration plans
No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| Stop_on_error | stop_on_error | Boolean | |
| Send_mail | send_mail | Boolean | |
| Concurrency | concurrency | Integer | |
| Reason | reason | String | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "Cancel execution of a migration plan",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "migration_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"running",
"cancelling",
"failing",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"stop_on_error": {
"required": false,
"label": "Stop_on_error",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"concurrency": {
"required": false,
"label": "Concurrency",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"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"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "migration_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": [
],
"scope": "migration_plan#cancel",
"path": "/v6.0/migration_plans/{migration_plan_id}/cancel",
"method": "POST",
"help": "/v6.0/migration_plans/{migration_plan_id}/cancel?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Stop_on_error | stop_on_error | no | Boolean | true | ||
| Send_mail | send_mail | no | Boolean | true | ||
| Concurrency | concurrency | no | Integer | 10 | ||
| Reason | reason | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| Stop_on_error | stop_on_error | Boolean | |
| Send_mail | send_mail | Boolean | |
| Concurrency | concurrency | Integer | |
| Reason | reason | String | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "Create a custom migration plan",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"stop_on_error": {
"required": false,
"label": "Stop_on_error",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"concurrency": {
"required": false,
"label": "Concurrency",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "migration_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"running",
"cancelling",
"failing",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"stop_on_error": {
"required": false,
"label": "Stop_on_error",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"concurrency": {
"required": false,
"label": "Concurrency",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"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"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "migration_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": [
],
"scope": "migration_plan#create",
"path": "/v6.0/migration_plans",
"method": "POST",
"help": "/v6.0/migration_plans?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete staged migration plan",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "migration_plan"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "migration_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": [
],
"scope": "migration_plan#delete",
"path": "/v6.0/migration_plans/{migration_plan_id}",
"method": "DELETE",
"help": "/v6.0/migration_plans/{migration_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 | ||
| State | state | no | String | Include
|
||
| User | user | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| Stop_on_error | stop_on_error | Boolean | |
| Send_mail | send_mail | Boolean | |
| Concurrency | concurrency | Integer | |
| Reason | reason | String | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "List migration 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
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"running",
"cancelling",
"failing",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object",
"namespace": "migration_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"running",
"cancelling",
"failing",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"stop_on_error": {
"required": false,
"label": "Stop_on_error",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"concurrency": {
"required": false,
"label": "Concurrency",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"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"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "migration_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": [
],
"scope": "migration_plan#index",
"path": "/v6.0/migration_plans",
"method": "GET",
"help": "/v6.0/migration_plans?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| Stop_on_error | stop_on_error | Boolean | |
| Send_mail | send_mail | Boolean | |
| Concurrency | concurrency | Integer | |
| Reason | reason | String | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "Show a migration plan",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "migration_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"running",
"cancelling",
"failing",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"stop_on_error": {
"required": false,
"label": "Stop_on_error",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"concurrency": {
"required": false,
"label": "Concurrency",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"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"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "migration_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": [
],
"scope": "migration_plan#show",
"path": "/v6.0/migration_plans/{migration_plan_id}",
"method": "GET",
"help": "/v6.0/migration_plans/{migration_plan_id}?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| Stop_on_error | stop_on_error | Boolean | |
| Send_mail | send_mail | Boolean | |
| Concurrency | concurrency | Integer | |
| Reason | reason | String | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "Begin execution of a migration plan",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "migration_plan"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"running",
"cancelling",
"failing",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"stop_on_error": {
"required": false,
"label": "Stop_on_error",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"concurrency": {
"required": false,
"label": "Concurrency",
"description": null,
"type": "Integer",
"validators": {
},
"default": 10,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"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"
}
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "migration_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": [
],
"scope": "migration_plan#start",
"path": "/v6.0/migration_plans/{migration_plan_id}/start",
"method": "POST",
"help": "/v6.0/migration_plans/{migration_plan_id}/start?method=POST"
}VPS migrations
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| VPS | vps | yes | Resource | |||
| Dst_node | dst_node | yes | Resource | |||
| Maintenance_window | maintenance_window | no | Boolean | true | ||
| Cleanup_data | cleanup_data | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| TransactionChain | transaction_chain | Resource | |
| Src_node | src_node | Resource | |
| VPS | vps | Resource | |
| Dst_node | dst_node | Resource | |
| Maintenance_window | maintenance_window | Boolean | |
| Cleanup_data | cleanup_data | Boolean | |
| Created_at | created_at | Datetime | |
| Started_at | started_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "Schedule VPS migration",
"aliases": [
"new"
],
"blocking": false,
"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"
}
},
"dst_node": {
"required": true,
"label": "Dst_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"
}
},
"maintenance_window": {
"required": false,
"label": "Maintenance_window",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"cleanup_data": {
"required": false,
"label": "Cleanup_data",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "vps_migration"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"running",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"transaction_chain": {
"required": null,
"label": "TransactionChain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"src_node": {
"required": null,
"label": "Src_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"
}
},
"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"
}
},
"dst_node": {
"required": null,
"label": "Dst_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"
}
},
"maintenance_window": {
"required": false,
"label": "Maintenance_window",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"cleanup_data": {
"required": false,
"label": "Cleanup_data",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"started_at": {
"required": false,
"label": "Started_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps_migration"
},
"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": [
],
"scope": "migration_plan.vps_migration#create",
"path": "/v6.0/migration_plans/{migration_plan_id}/vps_migrations",
"method": "POST",
"help": "/v6.0/migration_plans/{migration_plan_id}/vps_migrations?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 | ||
| State | state | no | String | Include
|
||
| Src_node | src_node | no | Resource | |||
| Dst_node | dst_node | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| TransactionChain | transaction_chain | Resource | |
| Src_node | src_node | Resource | |
| VPS | vps | Resource | |
| Dst_node | dst_node | Resource | |
| Maintenance_window | maintenance_window | Boolean | |
| Cleanup_data | cleanup_data | Boolean | |
| Created_at | created_at | Datetime | |
| Started_at | started_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "List scheduled VPS migrations",
"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
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"running",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"src_node": {
"required": null,
"label": "Src_node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"dst_node": {
"required": null,
"label": "Dst_node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
}
},
"layout": "object",
"namespace": "vps_migration"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"running",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"transaction_chain": {
"required": null,
"label": "TransactionChain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"src_node": {
"required": null,
"label": "Src_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"
}
},
"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"
}
},
"dst_node": {
"required": null,
"label": "Dst_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"
}
},
"maintenance_window": {
"required": false,
"label": "Maintenance_window",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"cleanup_data": {
"required": false,
"label": "Cleanup_data",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"started_at": {
"required": false,
"label": "Started_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "vps_migrations"
},
"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": [
],
"scope": "migration_plan.vps_migration#index",
"path": "/v6.0/migration_plans/{migration_plan_id}/vps_migrations",
"method": "GET",
"help": "/v6.0/migration_plans/{migration_plan_id}/vps_migrations?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| TransactionChain | transaction_chain | Resource | |
| Src_node | src_node | Resource | |
| VPS | vps | Resource | |
| Dst_node | dst_node | Resource | |
| Maintenance_window | maintenance_window | Boolean | |
| Cleanup_data | cleanup_data | Boolean | |
| Created_at | created_at | Datetime | |
| Started_at | started_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "Show a migration plan",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "vps_migration"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"queued",
"running",
"cancelled",
"done",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"transaction_chain": {
"required": null,
"label": "TransactionChain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"src_node": {
"required": null,
"label": "Src_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"
}
},
"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"
}
},
"dst_node": {
"required": null,
"label": "Dst_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"
}
},
"maintenance_window": {
"required": false,
"label": "Maintenance_window",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"cleanup_data": {
"required": false,
"label": "Cleanup_data",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"started_at": {
"required": false,
"label": "Started_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps_migration"
},
"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": [
],
"scope": "migration_plan.vps_migration#show",
"path": "/v6.0/migration_plans/{migration_plan_id}/vps_migrations/{vps_migration_id}",
"method": "GET",
"help": "/v6.0/migration_plans/{migration_plan_id}/vps_migrations/{vps_migration_id}?method=GET"
}Browser monitored events
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Until | until | no | Datetime |
No parameters.
{
"auth": true,
"description": null,
"aliases": [
"ack"
],
"blocking": false,
"input": {
"parameters": {
"until": {
"required": false,
"label": "Until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "monitored_event"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "monitored_event"
},
"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": [
],
"scope": "monitored_event#acknowledge",
"path": "/v6.0/monitored_events/{monitored_event_id}/acknowledge",
"method": "POST",
"help": "/v6.0/monitored_events/{monitored_event_id}/acknowledge?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Until | until | no | Datetime |
No parameters.
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"until": {
"required": false,
"label": "Until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "monitored_event"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "monitored_event"
},
"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": [
],
"scope": "monitored_event#ignore",
"path": "/v6.0/monitored_events/{monitored_event_id}/ignore",
"method": "POST",
"help": "/v6.0/monitored_events/{monitored_event_id}/ignore?method=POST"
}| 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 | |
| Monitor | monitor | no | String | |||
| Object_name | object_name | no | String | |||
| Object_id | object_id | no | Integer | |||
| State | state | no | String | Include
|
||
| User | user | no | Resource | |||
| Order | order | no | String | Include
|
latest |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Monitor | monitor | String | |
| Label | label | String | |
| Issue | issue | String | |
| Object_name | object_name | String | |
| Object_id | object_id | Integer | |
| State | state | String | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime | |
| Saved_until | saved_until | 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
},
"monitor": {
"required": false,
"label": "Monitor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_name": {
"required": false,
"label": "Object_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_id": {
"required": false,
"label": "Object_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"monitoring",
"confirmed",
"unconfirmed",
"acknowledged",
"ignored",
"closed"
],
"message": "%{value} cannot be used"
}
},
"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"
}
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"oldest",
"latest",
"longest",
"shortest"
],
"message": "%{value} cannot be used"
}
},
"default": "latest",
"protected": false
}
},
"layout": "object",
"namespace": "monitored_event"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"monitor": {
"required": false,
"label": "Monitor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"issue": {
"required": false,
"label": "Issue",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_name": {
"required": false,
"label": "Object_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_id": {
"required": false,
"label": "Object_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"monitoring",
"confirmed",
"unconfirmed",
"acknowledged",
"ignored",
"closed"
],
"message": "%{value} cannot be used"
}
},
"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"
}
},
"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
},
"saved_until": {
"required": false,
"label": "Saved_until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "monitored_events"
},
"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": [
],
"scope": "monitored_event#index",
"path": "/v6.0/monitored_events",
"method": "GET",
"help": "/v6.0/monitored_events?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Monitor | monitor | String | |
| Label | label | String | |
| Issue | issue | String | |
| Object_name | object_name | String | |
| Object_id | object_id | Integer | |
| State | state | String | |
| User | user | Resource | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime | |
| Saved_until | saved_until | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "monitored_event"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"monitor": {
"required": false,
"label": "Monitor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"issue": {
"required": false,
"label": "Issue",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_name": {
"required": false,
"label": "Object_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_id": {
"required": false,
"label": "Object_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"monitoring",
"confirmed",
"unconfirmed",
"acknowledged",
"ignored",
"closed"
],
"message": "%{value} cannot be used"
}
},
"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"
}
},
"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
},
"saved_until": {
"required": false,
"label": "Saved_until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "monitored_event"
},
"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": [
],
"scope": "monitored_event#show",
"path": "/v6.0/monitored_events/{monitored_event_id}",
"method": "GET",
"help": "/v6.0/monitored_events/{monitored_event_id}?method=GET"
}Browse monitored event logs
| 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 | |
| Passed | passed | no | Boolean | |||
| Order | order | no | String | Include
|
oldest |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Passed | passed | Boolean | |
| Value | value | Custom | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "List event logs",
"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
},
"passed": {
"required": false,
"label": "Passed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"oldest",
"latest"
],
"message": "%{value} cannot be used"
}
},
"default": "oldest",
"protected": false
}
},
"layout": "object",
"namespace": "log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"passed": {
"required": false,
"label": "Passed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Custom",
"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": "logs"
},
"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": [
],
"scope": "monitored_event.log#index",
"path": "/v6.0/monitored_events/{monitored_event_id}/logs",
"method": "GET",
"help": "/v6.0/monitored_events/{monitored_event_id}/logs?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Passed | passed | Boolean | |
| Value | value | Custom | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"passed": {
"required": false,
"label": "Passed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "log"
},
"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": [
],
"scope": "monitored_event.log#show",
"path": "/v6.0/monitored_events/{monitored_event_id}/logs/{log_id}",
"method": "GET",
"help": "/v6.0/monitored_events/{monitored_event_id}/logs/{log_id}?method=GET"
}Manage networks
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Count | count | yes | Integer | Number
Present
|
||
| User | user | no | Resource | Owner of new IP addresses | ||
| Environment | environment | no | Resource | Environment to which the addresses are charged |
| Label | Name | Type | Description |
|---|---|---|---|
| Count | count | Integer | Number of added IP addresses |
{
"auth": true,
"description": "Add IP addresses to a managed network",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"count": {
"required": true,
"label": "Count",
"description": null,
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 1",
"min": 1
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "Owner of new IP addresses",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "Environment to which the addresses are charged",
"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": "network"
},
"output": {
"parameters": {
"count": {
"required": false,
"label": "Count",
"description": "Number of added IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "network"
},
"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": [
],
"scope": "network#add_addresses",
"path": "/v6.0/networks/{network_id}/add_addresses",
"method": "POST",
"help": "/v6.0/networks/{network_id}/add_addresses?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | |||
| Ip_version | ip_version | yes | Integer | Present
Include
|
||
| Address | address | yes | String | Present
|
||
| Prefix | prefix | yes | Integer | Present
|
||
| Role | role | yes | String | Include
Present
|
||
| Managed | managed | yes | Boolean | Present
|
||
| Split_access | split_access | no | String | Include
|
||
| Split_prefix | split_prefix | yes | Integer | Present
|
||
| Purpose | purpose | yes | String | Include
Present
|
||
| Add_ip_addresses | add_ip_addresses | no | Boolean | false | Add all IP addresses from this network to the database now |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Primary_location | primary_location | Resource | |
| Label | label | String | |
| Ip_version | ip_version | Integer | |
| Address | address | String | |
| Prefix | prefix | Integer | |
| Role | role | String | |
| Managed | managed | Boolean | |
| Split_access | split_access | String | |
| Split_prefix | split_prefix | Integer | |
| Purpose | purpose | String | |
| Size | size | Integer | Number of possible host IP addresses |
| Used | used | Integer | Number of IP addresses present in vpsAdmin |
| Assigned | assigned | Integer | Number of IP addresses assigned to VPSes |
| Owned | owned | Integer | Number of IP addresses owned by some users |
| Taken | taken | Integer | Number of owned and assigned IP addresses |
{
"auth": true,
"description": "Add a new network",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_version": {
"required": true,
"label": "Ip_version",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"include": {
"values": [
4,
6
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"prefix": {
"required": true,
"label": "Prefix",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"role": {
"required": true,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"public_access",
"private_access"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"managed": {
"required": true,
"label": "Managed",
"description": null,
"type": "Boolean",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"split_access": {
"required": false,
"label": "Split_access",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no_access",
"user_split",
"owner_split"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"split_prefix": {
"required": true,
"label": "Split_prefix",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"purpose": {
"required": true,
"label": "Purpose",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"any",
"vps",
"export"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"add_ip_addresses": {
"required": false,
"label": "Add_ip_addresses",
"description": "Add all IP addresses from this network to the database now",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
}
},
"layout": "object",
"namespace": "network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"primary_location": {
"required": null,
"label": "Primary_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_version": {
"required": false,
"label": "Ip_version",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"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
},
"managed": {
"required": false,
"label": "Managed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"split_access": {
"required": false,
"label": "Split_access",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no_access",
"user_split",
"owner_split"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"split_prefix": {
"required": false,
"label": "Split_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"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
},
"size": {
"required": false,
"label": "Size",
"description": "Number of possible host IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used": {
"required": false,
"label": "Used",
"description": "Number of IP addresses present in vpsAdmin",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": "Number of IP addresses assigned to VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"owned": {
"required": false,
"label": "Owned",
"description": "Number of IP addresses owned by some users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"taken": {
"required": false,
"label": "Taken",
"description": "Number of owned and assigned IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network"
},
"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": [
],
"scope": "network#create",
"path": "/v6.0/networks",
"method": "POST",
"help": "/v6.0/networks?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 | ||
| Location | location | no | Resource | |||
| Purpose | purpose | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Primary_location | primary_location | Resource | |
| Label | label | String | |
| Ip_version | ip_version | Integer | |
| Address | address | String | |
| Prefix | prefix | Integer | |
| Role | role | String | |
| Managed | managed | Boolean | |
| Split_access | split_access | String | |
| Split_prefix | split_prefix | Integer | |
| Purpose | purpose | String | |
| Size | size | Integer | Number of possible host IP addresses |
| Used | used | Integer | Number of IP addresses present in vpsAdmin |
| Assigned | assigned | Integer | Number of IP addresses assigned to VPSes |
| Owned | owned | Integer | Number of IP addresses owned by some users |
| Taken | taken | Integer | Number of owned and assigned IP addresses |
{
"auth": true,
"description": "List networks",
"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
},
"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"
}
},
"purpose": {
"required": false,
"label": "Purpose",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"any",
"vps",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"primary_location": {
"required": null,
"label": "Primary_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_version": {
"required": false,
"label": "Ip_version",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"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
},
"managed": {
"required": false,
"label": "Managed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"split_access": {
"required": false,
"label": "Split_access",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no_access",
"user_split",
"owner_split"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"split_prefix": {
"required": false,
"label": "Split_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"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
},
"size": {
"required": false,
"label": "Size",
"description": "Number of possible host IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used": {
"required": false,
"label": "Used",
"description": "Number of IP addresses present in vpsAdmin",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": "Number of IP addresses assigned to VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"owned": {
"required": false,
"label": "Owned",
"description": "Number of IP addresses owned by some users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"taken": {
"required": false,
"label": "Taken",
"description": "Number of owned and assigned IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "networks"
},
"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": [
],
"scope": "network#index",
"path": "/v6.0/networks",
"method": "GET",
"help": "/v6.0/networks?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Primary_location | primary_location | Resource | |
| Label | label | String | |
| Ip_version | ip_version | Integer | |
| Address | address | String | |
| Prefix | prefix | Integer | |
| Role | role | String | |
| Managed | managed | Boolean | |
| Split_access | split_access | String | |
| Split_prefix | split_prefix | Integer | |
| Purpose | purpose | String | |
| Size | size | Integer | Number of possible host IP addresses |
| Used | used | Integer | Number of IP addresses present in vpsAdmin |
| Assigned | assigned | Integer | Number of IP addresses assigned to VPSes |
| Owned | owned | Integer | Number of IP addresses owned by some users |
| Taken | taken | Integer | Number of owned and assigned IP addresses |
{
"auth": true,
"description": "Show a network",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"primary_location": {
"required": null,
"label": "Primary_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_version": {
"required": false,
"label": "Ip_version",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"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
},
"managed": {
"required": false,
"label": "Managed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"split_access": {
"required": false,
"label": "Split_access",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no_access",
"user_split",
"owner_split"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"split_prefix": {
"required": false,
"label": "Split_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"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
},
"size": {
"required": false,
"label": "Size",
"description": "Number of possible host IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used": {
"required": false,
"label": "Used",
"description": "Number of IP addresses present in vpsAdmin",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": "Number of IP addresses assigned to VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"owned": {
"required": false,
"label": "Owned",
"description": "Number of IP addresses owned by some users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"taken": {
"required": false,
"label": "Taken",
"description": "Number of owned and assigned IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network"
},
"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": [
],
"scope": "network#show",
"path": "/v6.0/networks/{network_id}",
"method": "GET",
"help": "/v6.0/networks/{network_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | |||
| Ip_version | ip_version | no | Integer | Include
|
||
| Address | address | no | String | |||
| Prefix | prefix | no | Integer | |||
| Role | role | no | String | Include
|
||
| Managed | managed | no | Boolean | |||
| Split_access | split_access | no | String | Include
|
||
| Split_prefix | split_prefix | no | Integer | |||
| Purpose | purpose | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Primary_location | primary_location | Resource | |
| Label | label | String | |
| Ip_version | ip_version | Integer | |
| Address | address | String | |
| Prefix | prefix | Integer | |
| Role | role | String | |
| Managed | managed | Boolean | |
| Split_access | split_access | String | |
| Split_prefix | split_prefix | Integer | |
| Purpose | purpose | String | |
| Size | size | Integer | Number of possible host IP addresses |
| Used | used | Integer | Number of IP addresses present in vpsAdmin |
| Assigned | assigned | Integer | Number of IP addresses assigned to VPSes |
| Owned | owned | Integer | Number of IP addresses owned by some users |
| Taken | taken | Integer | Number of owned and assigned IP addresses |
{
"auth": true,
"description": "Update a network",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"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
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"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
},
"managed": {
"required": false,
"label": "Managed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"split_access": {
"required": false,
"label": "Split_access",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no_access",
"user_split",
"owner_split"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"split_prefix": {
"required": false,
"label": "Split_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"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
}
},
"layout": "object",
"namespace": "network"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"primary_location": {
"required": null,
"label": "Primary_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_version": {
"required": false,
"label": "Ip_version",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"prefix": {
"required": false,
"label": "Prefix",
"description": null,
"type": "Integer",
"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
},
"managed": {
"required": false,
"label": "Managed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"split_access": {
"required": false,
"label": "Split_access",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"no_access",
"user_split",
"owner_split"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"split_prefix": {
"required": false,
"label": "Split_prefix",
"description": null,
"type": "Integer",
"validators": {
},
"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
},
"size": {
"required": false,
"label": "Size",
"description": "Number of possible host IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used": {
"required": false,
"label": "Used",
"description": "Number of IP addresses present in vpsAdmin",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"assigned": {
"required": false,
"label": "Assigned",
"description": "Number of IP addresses assigned to VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"owned": {
"required": false,
"label": "Owned",
"description": "Number of IP addresses owned by some users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"taken": {
"required": false,
"label": "Taken",
"description": "Number of owned and assigned IP addresses",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network"
},
"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": [
],
"scope": "network#update",
"path": "/v6.0/networks/{network_id}",
"method": "PUT",
"help": "/v6.0/networks/{network_id}?method=PUT"
}Manage VPS network interfaces
| 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 | VPS the interface is assigned to, can be null | ||
| Location | location | no | Resource | Location this IP address is available in | ||
| User | user | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Interface ID |
| VPS | vps | Resource | VPS the interface is assigned to, can be null |
| Name | name | String | |
| Type | type | String | |
| MAC Address | mac | String | |
| Max outgoing data throughput | max_tx | Integer | |
| Max incoming data throughput | max_rx | Integer |
{
"auth": true,
"description": "List network interfaces",
"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": "VPS the interface 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"
}
},
"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": 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": "network_interface"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Interface ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": "VPS the interface 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"
}
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"venet",
"veth_bridge",
"veth_routed"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"mac": {
"required": false,
"label": "MAC Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max outgoing data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max incoming data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "network_interfaces"
},
"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": [
],
"scope": "network_interface#index",
"path": "/v6.0/network_interfaces",
"method": "GET",
"help": "/v6.0/network_interfaces?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Interface ID |
| VPS | vps | Resource | VPS the interface is assigned to, can be null |
| Name | name | String | |
| Type | type | String | |
| MAC Address | mac | String | |
| Max outgoing data throughput | max_tx | Integer | |
| Max incoming data throughput | max_rx | Integer |
{
"auth": true,
"description": "Show a network interface",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "network_interface"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Interface ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": "VPS the interface 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"
}
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"venet",
"veth_bridge",
"veth_routed"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"mac": {
"required": false,
"label": "MAC Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max outgoing data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max incoming data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network_interface"
},
"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": [
],
"scope": "network_interface#show",
"path": "/v6.0/network_interfaces/{network_interface_id}",
"method": "GET",
"help": "/v6.0/network_interfaces/{network_interface_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | no | String | Format
|
||
| Max outgoing data throughput | max_tx | no | Integer | |||
| Max incoming data throughput | max_rx | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Interface ID |
| VPS | vps | Resource | VPS the interface is assigned to, can be null |
| Name | name | String | |
| Type | type | String | |
| MAC Address | mac | String | |
| Max outgoing data throughput | max_tx | Integer | |
| Max incoming data throughput | max_rx | Integer |
{
"auth": true,
"description": "Modify a network interface",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z\\-_.0-9]{1,30}\\z",
"match": true,
"description": null,
"message": "bad format"
}
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max outgoing data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max incoming data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network_interface"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Interface ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": null,
"label": "VPS",
"description": "VPS the interface 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"
}
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"venet",
"veth_bridge",
"veth_routed"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"mac": {
"required": false,
"label": "MAC Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max outgoing data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max incoming data throughput",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network_interface"
},
"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": [
],
"scope": "network_interface#update",
"path": "/v6.0/network_interfaces/{network_interface_id}",
"method": "PUT",
"help": "/v6.0/network_interfaces/{network_interface_id}?method=PUT"
}Network interface accounting
| 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 | |
| User | user | no | Resource | |||
| Environment | environment | no | Resource | |||
| Location | location | no | Resource | |||
| Node | node | no | Resource | |||
| VPS | vps | no | Resource | |||
| Year | year | no | Integer | |||
| Month | month | no | Integer | |||
| From | from | no | Datetime | |||
| To | to | no | Datetime | |||
| Order | order | no | String | Include
|
created_at |
| Label | Name | Type | Description |
|---|---|---|---|
| NetworkInterface | network_interface | Resource | |
| Bytes_in | bytes_in | Integer | |
| Bytes_out | bytes_out | Integer | |
| Packets_in | packets_in | Integer | |
| Packets_out | packets_out | Integer | |
| Year | year | Integer | |
| Month | month | Integer | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List network interface accounting",
"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
},
"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"
}
},
"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"
}
},
"year": {
"required": false,
"label": "Year",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"month": {
"required": false,
"label": "Month",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"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
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"created_at",
"updated_at",
"descending",
"ascending"
],
"message": "%{value} cannot be used"
}
},
"default": "created_at",
"protected": false
}
},
"layout": "object",
"namespace": "network_interface_accounting"
},
"output": {
"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"
}
},
"bytes_in": {
"required": false,
"label": "Bytes_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bytes_out": {
"required": false,
"label": "Bytes_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_in": {
"required": false,
"label": "Packets_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_out": {
"required": false,
"label": "Packets_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"year": {
"required": false,
"label": "Year",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"month": {
"required": false,
"label": "Month",
"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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "network_interface_accountings"
},
"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": [
],
"scope": "network_interface_accounting#index",
"path": "/v6.0/network_interface_accountings",
"method": "GET",
"help": "/v6.0/network_interface_accountings?method=GET"
}| 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 | |
| Environment | environment | no | Resource | |||
| Location | location | no | Resource | |||
| Node | node | no | Resource | |||
| Year | year | no | Integer | |||
| Month | month | no | Integer | |||
| From | from | no | Datetime | |||
| To | to | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| User | user | Resource | |
| Bytes_in | bytes_in | Integer | |
| Bytes_out | bytes_out | Integer | |
| Packets_in | packets_in | Integer | |
| Packets_out | packets_out | Integer | |
| Year | year | Integer | |
| Month | month | Integer |
{
"auth": true,
"description": "Summed users' traffic",
"aliases": [
],
"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
},
"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": "label",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"year": {
"required": false,
"label": "Year",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"month": {
"required": false,
"label": "Month",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"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
}
},
"layout": "object",
"namespace": "network_interface_accounting"
},
"output": {
"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"
}
},
"bytes_in": {
"required": false,
"label": "Bytes_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bytes_out": {
"required": false,
"label": "Bytes_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_in": {
"required": false,
"label": "Packets_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_out": {
"required": false,
"label": "Packets_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"year": {
"required": false,
"label": "Year",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"month": {
"required": false,
"label": "Month",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "network_interface_accountings"
},
"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": [
],
"scope": "network_interface_accounting#user_top",
"path": "/v6.0/network_interface_accountings/user_top",
"method": "GET",
"help": "/v6.0/network_interface_accountings/user_top?method=GET"
}View current network interface traffic
| 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 | |
| User | user | no | Resource | |||
| Environment | environment | no | Resource | |||
| Location | location | no | Resource | |||
| Node | node | no | Resource | |||
| VPS | vps | no | Resource | |||
| NetworkInterface | network_interface | no | Resource | |||
| Order | order | no | String | -bytes |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| NetworkInterface | network_interface | Resource | |
| Bytes | bytes | Integer | |
| Bytes_in | bytes_in | Integer | |
| Bytes_out | bytes_out | Integer | |
| Packets | packets | Integer | |
| Packets_in | packets_in | Integer | |
| Packets_out | packets_out | Integer | |
| Delta | delta | Integer | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List current network interface traffic",
"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
},
"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"
}
},
"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"
}
},
"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"
}
},
"order": {
"required": false,
"label": "Order",
"description": null,
"type": "String",
"validators": {
},
"default": "-bytes",
"protected": false
}
},
"layout": "object",
"namespace": "network_interface_monitor"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"bytes": {
"required": false,
"label": "Bytes",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bytes_in": {
"required": false,
"label": "Bytes_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bytes_out": {
"required": false,
"label": "Bytes_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets": {
"required": false,
"label": "Packets",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_in": {
"required": false,
"label": "Packets_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_out": {
"required": false,
"label": "Packets_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"delta": {
"required": false,
"label": "Delta",
"description": null,
"type": "Integer",
"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": "network_interface_monitors"
},
"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": [
],
"scope": "network_interface_monitor#index",
"path": "/v6.0/network_interface_monitors",
"method": "GET",
"help": "/v6.0/network_interface_monitors?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| NetworkInterface | network_interface | Resource | |
| Bytes | bytes | Integer | |
| Bytes_in | bytes_in | Integer | |
| Bytes_out | bytes_out | Integer | |
| Packets | packets | Integer | |
| Packets_in | packets_in | Integer | |
| Packets_out | packets_out | Integer | |
| Delta | delta | Integer | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show current network interface traffic",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "network_interface_monitor"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"bytes": {
"required": false,
"label": "Bytes",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bytes_in": {
"required": false,
"label": "Bytes_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bytes_out": {
"required": false,
"label": "Bytes_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets": {
"required": false,
"label": "Packets",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_in": {
"required": false,
"label": "Packets_in",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"packets_out": {
"required": false,
"label": "Packets_out",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"delta": {
"required": false,
"label": "Delta",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "network_interface_monitor"
},
"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": [
],
"scope": "network_interface_monitor#show",
"path": "/v6.0/network_interface_monitors/{network_interface_monitor_id}",
"method": "GET",
"help": "/v6.0/network_interface_monitors/{network_interface_monitor_id}?method=GET"
}Browse and manage news
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Message | message | yes | Text | Present
|
||
| Published at | published_at | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Message | message | Text | |
| Published at | published_at | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Publish news",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"message": {
"required": true,
"label": "Message",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"published_at": {
"required": false,
"label": "Published at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "news_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"message": {
"required": false,
"label": "Message",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"published_at": {
"required": false,
"label": "Published 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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "news_log"
},
"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": [
],
"scope": "news_log#create",
"path": "/v6.0/news_logs",
"method": "POST",
"help": "/v6.0/news_logs?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete news",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "news_log"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "news_log"
},
"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": [
],
"scope": "news_log#delete",
"path": "/v6.0/news_logs/{news_log_id}",
"method": "DELETE",
"help": "/v6.0/news_logs/{news_log_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 | ||
| Since | since | no | Datetime | List news published later than this date |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Message | message | Text | |
| Published at | published_at | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": false,
"description": "List news",
"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
},
"since": {
"required": false,
"label": "Since",
"description": "List news published later than this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "news_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"message": {
"required": false,
"label": "Message",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"published_at": {
"required": false,
"label": "Published 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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "news_logs"
},
"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": [
],
"scope": "news_log#index",
"path": "/v6.0/news_logs",
"method": "GET",
"help": "/v6.0/news_logs?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Message | message | Text | |
| Published at | published_at | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": false,
"description": "Show news",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "news_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"message": {
"required": false,
"label": "Message",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"published_at": {
"required": false,
"label": "Published 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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "news_log"
},
"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": [
],
"scope": "news_log#show",
"path": "/v6.0/news_logs/{news_log_id}",
"method": "GET",
"help": "/v6.0/news_logs/{news_log_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Message | message | yes | Text | Present
|
||
| Published at | published_at | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Message | message | Text | |
| Published at | published_at | Datetime | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update news",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"message": {
"required": true,
"label": "Message",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"published_at": {
"required": false,
"label": "Published at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "news_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"message": {
"required": false,
"label": "Message",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"published_at": {
"required": false,
"label": "Published 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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "news_log"
},
"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": [
],
"scope": "news_log#update",
"path": "/v6.0/news_logs/{news_log_id}",
"method": "PUT",
"help": "/v6.0/news_logs/{news_log_id}?method=PUT"
}Manage nodes
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| ID | id | no | Integer | Node ID | ||
| Name | name | yes | String | Present
Format
|
Node name | |
| Role | type | yes | String | Present
Include
|
node, storage or mailer | |
| Hypervisor type | hypervisor_type | no | String | Include
|
vpsadminos | |
| Location | location | yes | Resource | Location node is placed in | ||
| IPv4 address | ip_addr | yes | String | Present
Format
|
Node's IP address | |
| Max tx | max_tx | no | Integer | Maximum output throughput | ||
| Max tx | max_rx | no | Integer | Maximum input throughput | ||
| Cpus | cpus | yes | Integer | Present
|
||
| Total_memory | total_memory | yes | Integer | Present
|
||
| Total_swap | total_swap | yes | Integer | Present
|
||
| Max_vps | max_vps | no | Integer | |||
| Maintenance | maintenance | no | Boolean | Put the node into maintenance mode |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Node ID |
| Active | active | Boolean | |
| Name | name | String | Node name |
| Domain name | domain_name | String | Node name including location domain |
| FQDN | fqdn | String | |
| Role | type | String | node, storage or mailer |
| Hypervisor type | hypervisor_type | String | vpsadminos |
| Location | location | Resource | Location node is placed in |
| IPv4 address | ip_addr | String | Node's IP address |
| Max tx | max_tx | Integer | Maximum output throughput |
| Max tx | max_rx | Integer | Maximum input throughput |
| Cpus | cpus | Integer | |
| Total_memory | total_memory | Integer | |
| Total_swap | total_swap | Integer | |
| Max_vps | max_vps | Integer | |
| Status | status | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Cpu_guest | cpu_guest | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Arc_c_max | arc_c_max | Integer | |
| Arc_c | arc_c | Integer | |
| Arc_size | arc_size | Integer | |
| Arc_hitpercent | arc_hitpercent | Integer | |
| Version | version | String | |
| Kernel | kernel | String | |
| Cgroup version | cgroup_version | String | |
| Pool_state | pool_state | String | |
| Pool_scan | pool_scan | String | |
| Pool_scan_percent | pool_scan_percent | Float | |
| Pool_checked_at | pool_checked_at | Datetime | |
| Pool_status | pool_status | Boolean |
{
"auth": true,
"description": "Create a new node",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Node ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": true,
"label": "Name",
"description": "Node name",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"format": {
"rx": "\\A[a-zA-Z0-9.\\-_]+\\Z",
"match": true,
"description": null,
"message": "invalid format"
}
},
"default": null,
"protected": false
},
"type": {
"required": true,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"include": {
"values": [
"node",
"storage",
"mailer"
],
"message": "%{value} is not a valid node role"
}
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"location": {
"required": true,
"label": "Location",
"description": "Location node is placed 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"
}
},
"ip_addr": {
"required": true,
"label": "IPv4 address",
"description": "Node's IP address",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"format": {
"rx": "\\A\\d+\\.\\d+\\.\\d+\\.\\d+\\Z",
"match": true,
"description": null,
"message": "not a valid IPv4 address"
}
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max tx",
"description": "Maximum output throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max tx",
"description": "Maximum input throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": true,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"total_memory": {
"required": true,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"total_swap": {
"required": true,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"max_vps": {
"required": false,
"label": "Max_vps",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"maintenance": {
"required": false,
"label": "Maintenance",
"description": "Put the node into maintenance mode",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "node"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Node ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"active": {
"required": false,
"label": "Active",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Node name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain_name": {
"required": false,
"label": "Domain name",
"description": "Node name including location domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"fqdn": {
"required": false,
"label": "FQDN",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location node is placed 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"
}
},
"ip_addr": {
"required": false,
"label": "IPv4 address",
"description": "Node's IP address",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max tx",
"description": "Maximum output throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max tx",
"description": "Maximum input throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_vps": {
"required": false,
"label": "Max_vps",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_guest": {
"required": false,
"label": "Cpu_guest",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c_max": {
"required": false,
"label": "Arc_c_max",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c": {
"required": false,
"label": "Arc_c",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_size": {
"required": false,
"label": "Arc_size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_hitpercent": {
"required": false,
"label": "Arc_hitpercent",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"kernel": {
"required": false,
"label": "Kernel",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_invalid",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_state": {
"required": false,
"label": "Pool_state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan": {
"required": false,
"label": "Pool_scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan_percent": {
"required": false,
"label": "Pool_scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"pool_checked_at": {
"required": false,
"label": "Pool_checked_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"pool_status": {
"required": false,
"label": "Pool_status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "node"
},
"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": [
],
"scope": "node#create",
"path": "/v6.0/nodes",
"method": "POST",
"help": "/v6.0/nodes?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Target node | dst_node | yes | Resource | |||
| Stop on error | stop_on_error | no | Boolean | true | ||
| Maintenance_window | maintenance_window | no | Boolean | true | Run migrations in every VPS's maintenance window | |
| Concurrency | concurrency | no | Integer | 1 | How many migrations run concurrently | |
| Cleanup_data | cleanup_data | no | Boolean | true | ||
| Send_mail | send_mail | no | Boolean | true | ||
| Reason | reason | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Migration_plan_id | migration_plan_id | Integer |
{
"auth": true,
"description": "Evacuate node",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"dst_node": {
"required": true,
"label": "Target node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"stop_on_error": {
"required": false,
"label": "Stop on error",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"maintenance_window": {
"required": false,
"label": "Maintenance_window",
"description": "Run migrations in every VPS's maintenance window",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"concurrency": {
"required": false,
"label": "Concurrency",
"description": "How many migrations run concurrently",
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"cleanup_data": {
"required": false,
"label": "Cleanup_data",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "node"
},
"output": {
"parameters": {
"migration_plan_id": {
"required": false,
"label": "Migration_plan_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "node"
},
"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": [
],
"scope": "node#evacuate",
"path": "/v6.0/nodes/{node_id}/evacuate",
"method": "POST",
"help": "/v6.0/nodes/{node_id}/evacuate?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 | ||
| Location | location | no | Resource | Location node is placed in | ||
| Environment | environment | no | Resource | |||
| Role | type | no | String | Include
|
node, storage or mailer | |
| Hypervisor type | hypervisor_type | no | String | Include
|
vpsadminos | |
| State | state | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Node ID |
| Active | active | Boolean | |
| Name | name | String | Node name |
| Domain name | domain_name | String | Node name including location domain |
| FQDN | fqdn | String | |
| Role | type | String | node, storage or mailer |
| Hypervisor type | hypervisor_type | String | vpsadminos |
| Location | location | Resource | Location node is placed in |
| IPv4 address | ip_addr | String | Node's IP address |
| Max tx | max_tx | Integer | Maximum output throughput |
| Max tx | max_rx | Integer | Maximum input throughput |
| Cpus | cpus | Integer | |
| Total_memory | total_memory | Integer | |
| Total_swap | total_swap | Integer | |
| Max_vps | max_vps | Integer | |
| Status | status | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Cpu_guest | cpu_guest | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Arc_c_max | arc_c_max | Integer | |
| Arc_c | arc_c | Integer | |
| Arc_size | arc_size | Integer | |
| Arc_hitpercent | arc_hitpercent | Integer | |
| Version | version | String | |
| Kernel | kernel | String | |
| Cgroup version | cgroup_version | String | |
| Pool_state | pool_state | String | |
| Pool_scan | pool_scan | String | |
| Pool_scan_percent | pool_scan_percent | Float | |
| Pool_checked_at | pool_checked_at | Datetime | |
| Pool_status | pool_status | Boolean | |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "List nodes",
"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
},
"location": {
"required": null,
"label": "Location",
"description": "Location node is placed 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"
}
},
"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"
}
},
"type": {
"required": false,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
"include": {
"values": [
"node",
"storage",
"mailer"
],
"message": "%{value} is not a valid node role"
}
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"all",
"active",
"inactive"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "node"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Node ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"active": {
"required": false,
"label": "Active",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Node name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain_name": {
"required": false,
"label": "Domain name",
"description": "Node name including location domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"fqdn": {
"required": false,
"label": "FQDN",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location node is placed 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"
}
},
"ip_addr": {
"required": false,
"label": "IPv4 address",
"description": "Node's IP address",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max tx",
"description": "Maximum output throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max tx",
"description": "Maximum input throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_vps": {
"required": false,
"label": "Max_vps",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_guest": {
"required": false,
"label": "Cpu_guest",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c_max": {
"required": false,
"label": "Arc_c_max",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c": {
"required": false,
"label": "Arc_c",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_size": {
"required": false,
"label": "Arc_size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_hitpercent": {
"required": false,
"label": "Arc_hitpercent",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"kernel": {
"required": false,
"label": "Kernel",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_invalid",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_state": {
"required": false,
"label": "Pool_state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan": {
"required": false,
"label": "Pool_scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan_percent": {
"required": false,
"label": "Pool_scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"pool_checked_at": {
"required": false,
"label": "Pool_checked_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"pool_status": {
"required": false,
"label": "Pool_status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"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": "nodes"
},
"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,
"name": "node1",
"type": "node",
"location": {
"id": 1,
"label": "The Location"
},
"ip_addr": "192.168.0.10",
"maintenance_lock": "no"
}
],
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "node#index",
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.node.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.node.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->node->index();
// $reply is an instance of \HaveAPI\Client\ResourceInstanceList$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 node index
ID: 1
Active: -
Name: node1
Domain name: -
FQDN: -
Role: node
Hypervisor type: -
Location: The Location (#1)
IPv4 address: 192.168.0.10
Max tx: -
Max tx: -
Cpus: -
Total_memory: -
Total_swap: -
Max_vps: -
Status: -
Uptime: -
Loadavg: -
Process count: -
Cpu_user: -
Cpu_nice: -
Cpu_system: -
Cpu_idle: -
Cpu_iowait: -
Cpu_irq: -
Cpu_softirq: -
Cpu_guest: -
Used memory: -
Used swap: -
Arc_c_max: -
Arc_c: -
Arc_size: -
Arc_hitpercent: -
Version: -
Kernel: -
Cgroup version: -
Pool_state: -
Pool_scan: -
Pool_scan_percent: -
Pool_checked_at: -
Pool_status: -
Maintenance lock: no
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/node/actions/index
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request GET \
--data-binary "{
\"node\": {
}
}" \
'http://api.vpsfree.cz/v6.0/nodes'
{
"status": true,
"message": null,
"response": {
"nodes": [
{
"id": 1,
"name": "node1",
"type": "node",
"location": {
"id": 1,
"label": "The Location"
},
"ip_addr": "192.168.0.10",
"maintenance_lock": "no"
}
]
},
"errors": null
}GET /v6.0/nodes 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: 335
{
"status": true,
"message": null,
"response": {
"nodes": [
{
"id": 1,
"name": "node1",
"type": "node",
"location": {
"id": 1,
"label": "The Location"
},
"ip_addr": "192.168.0.10",
"maintenance_lock": "no"
}
]
},
"errors": null
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Node ID |
| Active | active | Boolean | |
| Name | name | String | Node name |
| Domain name | domain_name | String | Node name including location domain |
| FQDN | fqdn | String | |
| Role | type | String | node, storage or mailer |
| Hypervisor type | hypervisor_type | String | vpsadminos |
| Location | location | Resource | Location node is placed in |
| IPv4 address | ip_addr | String | Node's IP address |
| Max tx | max_tx | Integer | Maximum output throughput |
| Max tx | max_rx | Integer | Maximum input throughput |
| Cpus | cpus | Integer | |
| Total_memory | total_memory | Integer | |
| Total_swap | total_swap | Integer | |
| Max_vps | max_vps | Integer | |
| Status | status | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Cpu_guest | cpu_guest | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Arc_c_max | arc_c_max | Integer | |
| Arc_c | arc_c | Integer | |
| Arc_size | arc_size | Integer | |
| Arc_hitpercent | arc_hitpercent | Integer | |
| Version | version | String | |
| Kernel | kernel | String | |
| Cgroup version | cgroup_version | String | |
| Pool_state | pool_state | String | |
| Pool_scan | pool_scan | String | |
| Pool_scan_percent | pool_scan_percent | Float | |
| Pool_checked_at | pool_checked_at | Datetime | |
| Pool_status | pool_status | Boolean | |
| Last report | last_report | Datetime | |
| Running VPS | vps_running | Integer | Number of running VPSes |
| Stopped VPS | vps_stopped | Integer | Number of stopped VPSes |
| Deleted VPS | vps_deleted | Integer | Number of lazily deleted VPSes |
| Total VPS | vps_total | Integer | Total number of VPSes |
| Free VPS slots | vps_free | Integer | Number of free VPS slots |
| Max VPS slots | vps_max | Integer | Number of running VPSes |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "List all nodes with some additional information",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "node"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Node ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"active": {
"required": false,
"label": "Active",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Node name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain_name": {
"required": false,
"label": "Domain name",
"description": "Node name including location domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"fqdn": {
"required": false,
"label": "FQDN",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location node is placed 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"
}
},
"ip_addr": {
"required": false,
"label": "IPv4 address",
"description": "Node's IP address",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max tx",
"description": "Maximum output throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max tx",
"description": "Maximum input throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_vps": {
"required": false,
"label": "Max_vps",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_guest": {
"required": false,
"label": "Cpu_guest",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c_max": {
"required": false,
"label": "Arc_c_max",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c": {
"required": false,
"label": "Arc_c",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_size": {
"required": false,
"label": "Arc_size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_hitpercent": {
"required": false,
"label": "Arc_hitpercent",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"kernel": {
"required": false,
"label": "Kernel",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_invalid",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_state": {
"required": false,
"label": "Pool_state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan": {
"required": false,
"label": "Pool_scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan_percent": {
"required": false,
"label": "Pool_scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"pool_checked_at": {
"required": false,
"label": "Pool_checked_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"pool_status": {
"required": false,
"label": "Pool_status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_report": {
"required": false,
"label": "Last report",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"vps_running": {
"required": false,
"label": "Running VPS",
"description": "Number of running VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_stopped": {
"required": false,
"label": "Stopped VPS",
"description": "Number of stopped VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_deleted": {
"required": false,
"label": "Deleted VPS",
"description": "Number of lazily deleted VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_total": {
"required": false,
"label": "Total VPS",
"description": "Total number of VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_free": {
"required": false,
"label": "Free VPS slots",
"description": "Number of free VPS slots",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_max": {
"required": false,
"label": "Max VPS slots",
"description": "Number of running VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"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": "nodes"
},
"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": [
],
"scope": "node#overview_list",
"path": "/v6.0/nodes/overview_list",
"method": "GET",
"help": "/v6.0/nodes/overview_list?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Status | status | Boolean | |
| Node name | name | String | |
| FQDN | fqdn | String | |
| Location | location | Resource | Location node is placed in |
| Last report | last_report | Datetime | |
| VPS count | vps_count | Integer | |
| Free VPS slots | vps_free | Integer | |
| Kernel | kernel | String | |
| Role | type | String | node, storage or mailer |
| Hypervisor type | hypervisor_type | String | vpsadminos |
| CPU idle | cpu_idle | Float | |
| Cgroup version | cgroup_version | String | |
| Pool_state | pool_state | String | |
| Pool_scan | pool_scan | String | |
| Pool_scan_percent | pool_scan_percent | Float | |
| Pool_checked_at | pool_checked_at | Datetime | |
| Pool_status | pool_status | Boolean | |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": false,
"description": "Public node status",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "node"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Node name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"fqdn": {
"required": false,
"label": "FQDN",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location node is placed 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"
}
},
"last_report": {
"required": false,
"label": "Last report",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"vps_count": {
"required": false,
"label": "VPS count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_free": {
"required": false,
"label": "Free VPS slots",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"kernel": {
"required": false,
"label": "Kernel",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "CPU idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_invalid",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_state": {
"required": false,
"label": "Pool_state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan": {
"required": false,
"label": "Pool_scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan_percent": {
"required": false,
"label": "Pool_scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"pool_checked_at": {
"required": false,
"label": "Pool_checked_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"pool_status": {
"required": false,
"label": "Pool_status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"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": "nodes"
},
"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": {
},
"response": [
{
"status": true,
"name": "node1.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-20T08:30:50+01:00",
"vps_count": 68,
"vps_free": 12,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 65.3
},
{
"status": false,
"name": "node2.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-14T06:41:23+01:00",
"vps_count": 0,
"vps_free": 80,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 100.0,
"maintenance_lock": "lock",
"maintenance_lock_reason": "HW upgrade"
},
{
"status": true,
"name": "node3.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-20T08:30:46+01:00",
"vps_count": 65,
"vps_free": 15,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 72.6
}
],
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "node#public_status",
"path": "/v6.0/nodes/public_status",
"method": "GET",
"help": "/v6.0/nodes/public_status?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.node.public_status
# 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.node.public_status(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->node->public_status();
// $reply is an instance of \HaveAPI\Client\ResourceInstanceList$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 node public_status
Id Status Node name FQDN Location Last report VPS count Free VPS slots Kernel Role Hypervisor type CPU idle Cgroup version Pool_state Pool_scan Pool_scan_percent Pool_checked_at Pool_status Maintenance lock Maintenance reason
- true node1.prg - Prague (#1) 2016-11-20T08:30:50+01:00 68 12 2.6.32-042stab120.6 - - 65.3 - - - - - - - -
- - node2.prg - Prague (#1) 2016-11-14T06:41:23+01:00 0 80 2.6.32-042stab120.6 - - 100.0 - - - - - - lock HW upgrade
- true node3.prg - Prague (#1) 2016-11-20T08:30:46+01:00 65 15 2.6.32-042stab120.6 - - 72.6 - - - - - - - -
# 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/node/actions/public_status
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request GET \
--data-binary "{
\"node\": {
}
}" \
'http://api.vpsfree.cz/v6.0/nodes/public_status'
{
"status": true,
"message": null,
"response": {
"nodes": [
{
"status": true,
"name": "node1.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-20T08:30:50+01:00",
"vps_count": 68,
"vps_free": 12,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 65.3
},
{
"status": false,
"name": "node2.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-14T06:41:23+01:00",
"vps_count": 0,
"vps_free": 80,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 100.0,
"maintenance_lock": "lock",
"maintenance_lock_reason": "HW upgrade"
},
{
"status": true,
"name": "node3.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-20T08:30:46+01:00",
"vps_count": 65,
"vps_free": 15,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 72.6
}
]
},
"errors": null
}GET /v6.0/nodes/public_status 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: 1135
{
"status": true,
"message": null,
"response": {
"nodes": [
{
"status": true,
"name": "node1.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-20T08:30:50+01:00",
"vps_count": 68,
"vps_free": 12,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 65.3
},
{
"status": false,
"name": "node2.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-14T06:41:23+01:00",
"vps_count": 0,
"vps_free": 80,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 100.0,
"maintenance_lock": "lock",
"maintenance_lock_reason": "HW upgrade"
},
{
"status": true,
"name": "node3.prg",
"location": {
"id": 1,
"label": "Prague"
},
"last_report": "2016-11-20T08:30:46+01:00",
"vps_count": 65,
"vps_free": 15,
"kernel": "2.6.32-042stab120.6",
"cpu_idle": 72.6
}
]
},
"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": "node"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "node"
},
"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": [
],
"scope": "node#set_maintenance",
"path": "/v6.0/nodes/{node_id}/set_maintenance",
"method": "POST",
"help": "/v6.0/nodes/{node_id}/set_maintenance?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | Node ID |
| Active | active | Boolean | |
| Name | name | String | Node name |
| Domain name | domain_name | String | Node name including location domain |
| FQDN | fqdn | String | |
| Role | type | String | node, storage or mailer |
| Hypervisor type | hypervisor_type | String | vpsadminos |
| Location | location | Resource | Location node is placed in |
| IPv4 address | ip_addr | String | Node's IP address |
| Max tx | max_tx | Integer | Maximum output throughput |
| Max tx | max_rx | Integer | Maximum input throughput |
| Cpus | cpus | Integer | |
| Total_memory | total_memory | Integer | |
| Total_swap | total_swap | Integer | |
| Max_vps | max_vps | Integer | |
| Status | status | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Cpu_guest | cpu_guest | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Arc_c_max | arc_c_max | Integer | |
| Arc_c | arc_c | Integer | |
| Arc_size | arc_size | Integer | |
| Arc_hitpercent | arc_hitpercent | Integer | |
| Version | version | String | |
| Kernel | kernel | String | |
| Cgroup version | cgroup_version | String | |
| Pool_state | pool_state | String | |
| Pool_scan | pool_scan | String | |
| Pool_scan_percent | pool_scan_percent | Float | |
| Pool_checked_at | pool_checked_at | Datetime | |
| Pool_status | pool_status | Boolean | |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "Show node",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "node"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "Node ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"active": {
"required": false,
"label": "Active",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Node name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"domain_name": {
"required": false,
"label": "Domain name",
"description": "Node name including location domain",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"fqdn": {
"required": false,
"label": "FQDN",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location node is placed 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"
}
},
"ip_addr": {
"required": false,
"label": "IPv4 address",
"description": "Node's IP address",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max tx",
"description": "Maximum output throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max tx",
"description": "Maximum input throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_vps": {
"required": false,
"label": "Max_vps",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_guest": {
"required": false,
"label": "Cpu_guest",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c_max": {
"required": false,
"label": "Arc_c_max",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c": {
"required": false,
"label": "Arc_c",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_size": {
"required": false,
"label": "Arc_size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_hitpercent": {
"required": false,
"label": "Arc_hitpercent",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"kernel": {
"required": false,
"label": "Kernel",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_invalid",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_state": {
"required": false,
"label": "Pool_state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan": {
"required": false,
"label": "Pool_scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"pool_scan_percent": {
"required": false,
"label": "Pool_scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"pool_checked_at": {
"required": false,
"label": "Pool_checked_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"pool_status": {
"required": false,
"label": "Pool_status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"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": "node"
},
"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": [
2
],
"request": {
},
"response": {
"id": 2,
"name": "node2",
"type": "node",
"location": {
"id": 1,
"label": "The Location"
},
"ip_addr": "192.168.0.11",
"maintenance_lock": "no"
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "node#show",
"path": "/v6.0/nodes/{node_id}",
"method": "GET",
"help": "/v6.0/nodes/{node_id}?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.node.show(2)
# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 2
# reply.name = "node2"
# reply.type = "node"
# reply.location = HaveAPI::Client::ResourceInstance(resource: location, id: 1, label: "The Location")
# reply.ip_addr = "192.168.0.11"
# reply.maintenance_lock = "no"
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.node.show(2, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
// reply.id = 2
// reply.name = "node2"
// reply.type = "node"
// reply.location = HaveAPI.Client.ResourceInstance(resource: location, id: 1, label: "The Location")
// reply.ip_addr = "192.168.0.11"
// reply.maintenance_lock = "no"
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->node->show(2);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 2
// $reply->name = "node2"
// $reply->type = "node"
// $reply->location = \HaveAPI\Client\ResourceInstance(resource: location, id: 1, label: "The Location")
// $reply->ip_addr = "192.168.0.11"
// $reply->maintenance_lock = "no"
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 node show 2
ID: 2
Active: -
Name: node2
Domain name: -
FQDN: -
Role: node
Hypervisor type: -
Location: The Location (#1)
IPv4 address: 192.168.0.11
Max tx: -
Max tx: -
Cpus: -
Total_memory: -
Total_swap: -
Max_vps: -
Status: -
Uptime: -
Loadavg: -
Process count: -
Cpu_user: -
Cpu_nice: -
Cpu_system: -
Cpu_idle: -
Cpu_iowait: -
Cpu_irq: -
Cpu_softirq: -
Cpu_guest: -
Used memory: -
Used swap: -
Arc_c_max: -
Arc_c: -
Arc_size: -
Arc_hitpercent: -
Version: -
Kernel: -
Cgroup version: -
Pool_state: -
Pool_scan: -
Pool_scan_percent: -
Pool_checked_at: -
Pool_status: -
Maintenance lock: no
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/node/actions/show
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1
# Query the output parameters
$ cat output/id
2
$ cat output/name
node2
$ cat output/type
node
$ cat output/location
{:id=>1, :label=>"The Location"}
$ cat output/ip_addr
192.168.0.11
$ cat output/maintenance_lock
no
$ curl --request GET \
--data-binary "{
\"node\": {
}
}" \
'http://api.vpsfree.cz/v6.0/nodes/2'
{
"status": true,
"message": null,
"response": {
"node": {
"id": 2,
"name": "node2",
"type": "node",
"location": {
"id": 1,
"label": "The Location"
},
"ip_addr": "192.168.0.11",
"maintenance_lock": "no"
}
},
"errors": null
}GET /v6.0/nodes/2 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: 300
{
"status": true,
"message": null,
"response": {
"node": {
"id": 2,
"name": "node2",
"type": "node",
"location": {
"id": 1,
"label": "The Location"
},
"ip_addr": "192.168.0.11",
"maintenance_lock": "no"
}
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Active | active | no | Boolean | |||
| Name | name | no | String | Format
|
Node name | |
| FQDN | fqdn | no | String | |||
| Role | type | no | String | Include
|
node, storage or mailer | |
| Hypervisor type | hypervisor_type | no | String | Include
|
vpsadminos | |
| Location | location | no | Resource | Location node is placed in | ||
| IPv4 address | ip_addr | no | String | Format
|
Node's IP address | |
| Max tx | max_tx | no | Integer | Maximum output throughput | ||
| Max tx | max_rx | no | Integer | Maximum input throughput | ||
| Cpus | cpus | no | Integer | |||
| Total_memory | total_memory | no | Integer | |||
| Total_swap | total_swap | no | Integer | |||
| Max_vps | max_vps | no | Integer |
No parameters.
{
"auth": true,
"description": "Update node",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"active": {
"required": false,
"label": "Active",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Node name",
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9.\\-_]+\\Z",
"match": true,
"description": null,
"message": "invalid format"
}
},
"default": null,
"protected": false
},
"fqdn": {
"required": false,
"label": "FQDN",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Role",
"description": "node, storage or mailer",
"type": "String",
"validators": {
"include": {
"values": [
"node",
"storage",
"mailer"
],
"message": "%{value} is not a valid node role"
}
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor type",
"description": "vpsadminos",
"type": "String",
"validators": {
"include": {
"values": [
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"location": {
"required": null,
"label": "Location",
"description": "Location node is placed 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"
}
},
"ip_addr": {
"required": false,
"label": "IPv4 address",
"description": "Node's IP address",
"type": "String",
"validators": {
"format": {
"rx": "\\A\\d+\\.\\d+\\.\\d+\\.\\d+\\Z",
"match": true,
"description": null,
"message": "not a valid IPv4 address"
}
},
"default": null,
"protected": false
},
"max_tx": {
"required": false,
"label": "Max tx",
"description": "Maximum output throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_rx": {
"required": false,
"label": "Max tx",
"description": "Maximum input throughput",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"max_vps": {
"required": false,
"label": "Max_vps",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "node"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "node"
},
"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": [
2
],
"request": {
"name": "node2",
"type": "storage",
"location": 1,
"ip_addr": "192.168.0.11"
},
"response": {
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "node#update",
"path": "/v6.0/nodes/{node_id}",
"method": "PUT",
"help": "/v6.0/nodes/{node_id}?method=PUT"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.node.update(2, {:name=>"node2", :type=>"storage", :location=>1, :ip_addr=>"192.168.0.11"})
# 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.node.update(2, {
"name": "node2",
"type": "storage",
"location": 1,
"ip_addr": "192.168.0.11"
}, 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->node->update(2, [
"name" => "node2",
"type" => "storage",
"location" => 1,
"ip_addr" => "192.168.0.11"
]);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 node update 2 -- \
--name 'node2' \
--type 'storage' \
--location '1' \
--ip-addr '192.168.0.11'# 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/node/actions/update
# Prepare input parameters
$ echo 'node2' > input/name
$ echo 'storage' > input/type
$ echo '1' > input/location
$ echo '192.168.0.11' > input/ip_addr
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request PUT \
--data-binary "{
\"node\": {
\"name\": \"node2\",
\"type\": \"storage\",
\"location\": 1,
\"ip_addr\": \"192.168.0.11\"
}
}" \
'http://api.vpsfree.cz/v6.0/nodes/2'
{
"status": true,
"message": null,
"response": {
"node": {
}
},
"errors": null
}PUT /v6.0/nodes/2 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
{
"node": {
"name": "node2",
"type": "storage",
"location": 1,
"ip_addr": "192.168.0.11"
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 98
{
"status": true,
"message": null,
"response": {
"node": {
}
},
"errors": null
}View node statuses in time
| 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 |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpus | cpus | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Cpu_guest | cpu_guest | Float | |
| Total_memory | total_memory | Integer | |
| Used memory | used_memory | Integer | in MB |
| Total_swap | total_swap | Integer | |
| Used swap | used_swap | Integer | in MB |
| Arc_c_max | arc_c_max | Integer | |
| Arc_c | arc_c | Integer | |
| Arc_size | arc_size | Integer | |
| Arc_hitpercent | arc_hitpercent | Float | |
| Version | version | String | |
| Kernel | kernel | String | |
| 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
}
},
"layout": "object",
"namespace": "status"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_guest": {
"required": false,
"label": "Cpu_guest",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c_max": {
"required": false,
"label": "Arc_c_max",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c": {
"required": false,
"label": "Arc_c",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_size": {
"required": false,
"label": "Arc_size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_hitpercent": {
"required": false,
"label": "Arc_hitpercent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"kernel": {
"required": false,
"label": "Kernel",
"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": "statuses"
},
"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": [
],
"scope": "node.status#index",
"path": "/v6.0/nodes/{node_id}/statuses",
"method": "GET",
"help": "/v6.0/nodes/{node_id}/statuses?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpus | cpus | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Cpu_guest | cpu_guest | Float | |
| Total_memory | total_memory | Integer | |
| Used memory | used_memory | Integer | in MB |
| Total_swap | total_swap | Integer | |
| Used swap | used_swap | Integer | in MB |
| Arc_c_max | arc_c_max | Integer | |
| Arc_c | arc_c | Integer | |
| Arc_size | arc_size | Integer | |
| Arc_hitpercent | arc_hitpercent | Float | |
| Version | version | String | |
| Kernel | kernel | String | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "status"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_guest": {
"required": false,
"label": "Cpu_guest",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c_max": {
"required": false,
"label": "Arc_c_max",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_c": {
"required": false,
"label": "Arc_c",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_size": {
"required": false,
"label": "Arc_size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"arc_hitpercent": {
"required": false,
"label": "Arc_hitpercent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"kernel": {
"required": false,
"label": "Kernel",
"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": "status"
},
"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": [
],
"scope": "node.status#show",
"path": "/v6.0/nodes/{node_id}/statuses/{status_id}",
"method": "GET",
"help": "/v6.0/nodes/{node_id}/statuses/{status_id}?method=GET"
}Manage OAuth2 clients
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | yes | String | Present
|
||
| Client_id | client_id | yes | String | Present
|
||
| Redirect_uri | redirect_uri | yes | String | Present
|
||
| Access_token_lifetime | access_token_lifetime | no | String | Include
|
||
| Access_token_seconds | access_token_seconds | no | Integer | |||
| Refresh_token_seconds | refresh_token_seconds | no | Integer | |||
| Issue_refresh_token | issue_refresh_token | no | Boolean | |||
| Allow_single_sign_on | allow_single_sign_on | no | Boolean | |||
| Client_secret | client_secret | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Client_id | client_id | String | |
| Redirect_uri | redirect_uri | String | |
| Access_token_lifetime | access_token_lifetime | String | |
| Access_token_seconds | access_token_seconds | Integer | |
| Refresh_token_seconds | refresh_token_seconds | Integer | |
| Issue_refresh_token | issue_refresh_token | Boolean | |
| Allow_single_sign_on | allow_single_sign_on | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Create an OAuth2 client",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": true,
"label": "Name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"client_id": {
"required": true,
"label": "Client_id",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"redirect_uri": {
"required": true,
"label": "Redirect_uri",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"access_token_lifetime": {
"required": false,
"label": "Access_token_lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"access_token_seconds": {
"required": false,
"label": "Access_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"refresh_token_seconds": {
"required": false,
"label": "Refresh_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"issue_refresh_token": {
"required": false,
"label": "Issue_refresh_token",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"allow_single_sign_on": {
"required": false,
"label": "Allow_single_sign_on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"client_secret": {
"required": true,
"label": "Client_secret",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "oauth2_client"
},
"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
},
"client_id": {
"required": false,
"label": "Client_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"redirect_uri": {
"required": false,
"label": "Redirect_uri",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"access_token_lifetime": {
"required": false,
"label": "Access_token_lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"access_token_seconds": {
"required": false,
"label": "Access_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"refresh_token_seconds": {
"required": false,
"label": "Refresh_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"issue_refresh_token": {
"required": false,
"label": "Issue_refresh_token",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"allow_single_sign_on": {
"required": false,
"label": "Allow_single_sign_on",
"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": "oauth2_client"
},
"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": [
],
"scope": "oauth2_client#create",
"path": "/v6.0/oauth2_clients",
"method": "POST",
"help": "/v6.0/oauth2_clients?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": null,
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "oauth2_client"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "oauth2_client"
},
"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": [
],
"scope": "oauth2_client#delete",
"path": "/v6.0/oauth2_clients/{oauth2_client_id}",
"method": "DELETE",
"help": "/v6.0/oauth2_clients/{oauth2_client_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 | |
| Name | name | String | |
| Client_id | client_id | String | |
| Redirect_uri | redirect_uri | String | |
| Access_token_lifetime | access_token_lifetime | String | |
| Access_token_seconds | access_token_seconds | Integer | |
| Refresh_token_seconds | refresh_token_seconds | Integer | |
| Issue_refresh_token | issue_refresh_token | Boolean | |
| Allow_single_sign_on | allow_single_sign_on | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List OAuth2 clients",
"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": "oauth2_client"
},
"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
},
"client_id": {
"required": false,
"label": "Client_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"redirect_uri": {
"required": false,
"label": "Redirect_uri",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"access_token_lifetime": {
"required": false,
"label": "Access_token_lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"access_token_seconds": {
"required": false,
"label": "Access_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"refresh_token_seconds": {
"required": false,
"label": "Refresh_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"issue_refresh_token": {
"required": false,
"label": "Issue_refresh_token",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"allow_single_sign_on": {
"required": false,
"label": "Allow_single_sign_on",
"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": "oauth2_clients"
},
"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": [
],
"scope": "oauth2_client#index",
"path": "/v6.0/oauth2_clients",
"method": "GET",
"help": "/v6.0/oauth2_clients?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Client_id | client_id | String | |
| Redirect_uri | redirect_uri | String | |
| Access_token_lifetime | access_token_lifetime | String | |
| Access_token_seconds | access_token_seconds | Integer | |
| Refresh_token_seconds | refresh_token_seconds | Integer | |
| Issue_refresh_token | issue_refresh_token | Boolean | |
| Allow_single_sign_on | allow_single_sign_on | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show OAuth2 client",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "oauth2_client"
},
"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
},
"client_id": {
"required": false,
"label": "Client_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"redirect_uri": {
"required": false,
"label": "Redirect_uri",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"access_token_lifetime": {
"required": false,
"label": "Access_token_lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"access_token_seconds": {
"required": false,
"label": "Access_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"refresh_token_seconds": {
"required": false,
"label": "Refresh_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"issue_refresh_token": {
"required": false,
"label": "Issue_refresh_token",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"allow_single_sign_on": {
"required": false,
"label": "Allow_single_sign_on",
"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": "oauth2_client"
},
"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": [
],
"scope": "oauth2_client#show",
"path": "/v6.0/oauth2_clients/{oauth2_client_id}",
"method": "GET",
"help": "/v6.0/oauth2_clients/{oauth2_client_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | no | String | |||
| Client_id | client_id | no | String | |||
| Redirect_uri | redirect_uri | no | String | |||
| Access_token_lifetime | access_token_lifetime | no | String | Include
|
||
| Access_token_seconds | access_token_seconds | no | Integer | |||
| Refresh_token_seconds | refresh_token_seconds | no | Integer | |||
| Issue_refresh_token | issue_refresh_token | no | Boolean | |||
| Allow_single_sign_on | allow_single_sign_on | no | Boolean | |||
| Client_secret | client_secret | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Client_id | client_id | String | |
| Redirect_uri | redirect_uri | String | |
| Access_token_lifetime | access_token_lifetime | String | |
| Access_token_seconds | access_token_seconds | Integer | |
| Refresh_token_seconds | refresh_token_seconds | Integer | |
| Issue_refresh_token | issue_refresh_token | Boolean | |
| Allow_single_sign_on | allow_single_sign_on | Boolean | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_id": {
"required": false,
"label": "Client_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"redirect_uri": {
"required": false,
"label": "Redirect_uri",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"access_token_lifetime": {
"required": false,
"label": "Access_token_lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"access_token_seconds": {
"required": false,
"label": "Access_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"refresh_token_seconds": {
"required": false,
"label": "Refresh_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"issue_refresh_token": {
"required": false,
"label": "Issue_refresh_token",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"allow_single_sign_on": {
"required": false,
"label": "Allow_single_sign_on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"client_secret": {
"required": false,
"label": "Client_secret",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "oauth2_client"
},
"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
},
"client_id": {
"required": false,
"label": "Client_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"redirect_uri": {
"required": false,
"label": "Redirect_uri",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"access_token_lifetime": {
"required": false,
"label": "Access_token_lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"access_token_seconds": {
"required": false,
"label": "Access_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"refresh_token_seconds": {
"required": false,
"label": "Refresh_token_seconds",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"issue_refresh_token": {
"required": false,
"label": "Issue_refresh_token",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"allow_single_sign_on": {
"required": false,
"label": "Allow_single_sign_on",
"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": "oauth2_client"
},
"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": [
],
"scope": "oauth2_client#update",
"path": "/v6.0/oauth2_clients/{oauth2_client_id}",
"method": "PUT",
"help": "/v6.0/oauth2_clients/{oauth2_client_id}?method=PUT"
}Browse object's history
| 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 | |||
| UserSession | user_session | no | Resource | |||
| Object | object | no | String | |||
| Object_id | object_id | no | Integer | |||
| Event_type | event_type | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| UserSession | user_session | Resource | |
| Object | object | String | |
| Object_id | object_id | Integer | |
| Event_type | event_type | String | |
| Event_data | event_data | Custom | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "List object 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
},
"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"
}
},
"user_session": {
"required": null,
"label": "UserSession",
"description": null,
"type": "Resource",
"resource": [
"user_session"
],
"value_id": "id",
"value_label": "api_ip_addr",
"value": null,
"choices": {
"path": "/v6.0/user_sessions",
"method": "GET",
"help": "/v6.0/user_sessions?method=GET"
}
},
"object": {
"required": false,
"label": "Object",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_id": {
"required": false,
"label": "Object_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"event_type": {
"required": false,
"label": "Event_type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "object_history"
},
"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"
}
},
"user_session": {
"required": null,
"label": "UserSession",
"description": null,
"type": "Resource",
"resource": [
"user_session"
],
"value_id": "id",
"value_label": "api_ip_addr",
"value": null,
"choices": {
"path": "/v6.0/user_sessions",
"method": "GET",
"help": "/v6.0/user_sessions?method=GET"
}
},
"object": {
"required": false,
"label": "Object",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_id": {
"required": false,
"label": "Object_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"event_type": {
"required": false,
"label": "Event_type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"event_data": {
"required": false,
"label": "Event_data",
"description": null,
"type": "Custom",
"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": "object_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": [
],
"scope": "object_history#index",
"path": "/v6.0/object_histories",
"method": "GET",
"help": "/v6.0/object_histories?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| UserSession | user_session | Resource | |
| Object | object | String | |
| Object_id | object_id | Integer | |
| Event_type | event_type | String | |
| Event_data | event_data | Custom | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Show object history event",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "object_history"
},
"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"
}
},
"user_session": {
"required": null,
"label": "UserSession",
"description": null,
"type": "Resource",
"resource": [
"user_session"
],
"value_id": "id",
"value_label": "api_ip_addr",
"value": null,
"choices": {
"path": "/v6.0/user_sessions",
"method": "GET",
"help": "/v6.0/user_sessions?method=GET"
}
},
"object": {
"required": false,
"label": "Object",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_id": {
"required": false,
"label": "Object_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"event_type": {
"required": false,
"label": "Event_type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"event_data": {
"required": false,
"label": "Event_data",
"description": null,
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "object_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": [
],
"scope": "object_history#show",
"path": "/v6.0/object_histories/{object_history_id}",
"method": "GET",
"help": "/v6.0/object_histories/{object_history_id}?method=GET"
}Out-of-memory kill reports
| 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 | |||
| User | user | no | Resource | |||
| Node | node | no | Resource | |||
| Location | location | no | Resource | |||
| Environment | environment | no | Resource | |||
| Cgroup | cgroup | no | String | |||
| Since | since | no | Datetime | |||
| Until | until | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| VPS | vps | Resource | |
| Cgroup | cgroup | String | |
| Invoked_by_pid | invoked_by_pid | Integer | |
| Invoked_by_name | invoked_by_name | String | |
| Killed_pid | killed_pid | Integer | |
| Killed_name | killed_name | String | |
| Count | count | Integer | |
| Created_at | created_at | Datetime | |
| Reported_at | reported_at | Datetime |
{
"auth": true,
"description": "List OOM kill 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
},
"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"
}
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?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"
}
},
"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"
}
},
"cgroup": {
"required": false,
"label": "Cgroup",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"since": {
"required": false,
"label": "Since",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"until": {
"required": false,
"label": "Until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "oom_report"
},
"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"
}
},
"cgroup": {
"required": false,
"label": "Cgroup",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"invoked_by_pid": {
"required": false,
"label": "Invoked_by_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"invoked_by_name": {
"required": false,
"label": "Invoked_by_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"killed_pid": {
"required": false,
"label": "Killed_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"killed_name": {
"required": false,
"label": "Killed_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"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
},
"reported_at": {
"required": false,
"label": "Reported_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "oom_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": [
],
"scope": "oom_report#index",
"path": "/v6.0/oom_reports",
"method": "GET",
"help": "/v6.0/oom_reports?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| VPS | vps | Resource | |
| Cgroup | cgroup | String | |
| Invoked_by_pid | invoked_by_pid | Integer | |
| Invoked_by_name | invoked_by_name | String | |
| Killed_pid | killed_pid | Integer | |
| Killed_name | killed_name | String | |
| Count | count | Integer | |
| Created_at | created_at | Datetime | |
| Reported_at | reported_at | Datetime |
{
"auth": true,
"description": "Show OOM kill report",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "oom_report"
},
"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"
}
},
"cgroup": {
"required": false,
"label": "Cgroup",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"invoked_by_pid": {
"required": false,
"label": "Invoked_by_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"invoked_by_name": {
"required": false,
"label": "Invoked_by_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"killed_pid": {
"required": false,
"label": "Killed_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"killed_name": {
"required": false,
"label": "Killed_name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"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
},
"reported_at": {
"required": false,
"label": "Reported_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "oom_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": [
],
"scope": "oom_report#show",
"path": "/v6.0/oom_reports/{oom_report_id}",
"method": "GET",
"help": "/v6.0/oom_reports/{oom_report_id}?method=GET"
}Memory stats
| 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 | |
| Parameter | parameter | String | |
| Value | value | Integer |
{
"auth": true,
"description": "List memory stats",
"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": "stat"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"parameter": {
"required": false,
"label": "Parameter",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "stats"
},
"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": [
],
"scope": "oom_report.stat#index",
"path": "/v6.0/oom_reports/{oom_report_id}/stats",
"method": "GET",
"help": "/v6.0/oom_reports/{oom_report_id}/stats?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Parameter | parameter | String | |
| Value | value | Integer |
{
"auth": true,
"description": "Show memory stat",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "stat"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"parameter": {
"required": false,
"label": "Parameter",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "stats"
},
"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": [
],
"scope": "oom_report.stat#show",
"path": "/v6.0/oom_reports/{oom_report_id}/stats/{stat_id}",
"method": "GET",
"help": "/v6.0/oom_reports/{oom_report_id}/stats/{stat_id}?method=GET"
}Task list
| 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 | |
| Name | name | String | |
| Host_pid | host_pid | Integer | |
| Vps_pid | vps_pid | Integer | |
| Vps_uid | vps_uid | Integer | |
| Tgid | tgid | Integer | |
| Total_vm | total_vm | Integer | |
| Rss | rss | Integer | |
| Pgtables_bytes | pgtables_bytes | Integer | |
| Swapents | swapents | Integer | |
| Oom_score_adj | oom_score_adj | Integer |
{
"auth": true,
"description": "List tasks",
"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": "task"
},
"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
},
"host_pid": {
"required": false,
"label": "Host_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_pid": {
"required": false,
"label": "Vps_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_uid": {
"required": false,
"label": "Vps_uid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"tgid": {
"required": false,
"label": "Tgid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_vm": {
"required": false,
"label": "Total_vm",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"rss": {
"required": false,
"label": "Rss",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"pgtables_bytes": {
"required": false,
"label": "Pgtables_bytes",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swapents": {
"required": false,
"label": "Swapents",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"oom_score_adj": {
"required": false,
"label": "Oom_score_adj",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "tasks"
},
"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": [
],
"scope": "oom_report.task#index",
"path": "/v6.0/oom_reports/{oom_report_id}/tasks",
"method": "GET",
"help": "/v6.0/oom_reports/{oom_report_id}/tasks?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Host_pid | host_pid | Integer | |
| Vps_pid | vps_pid | Integer | |
| Vps_uid | vps_uid | Integer | |
| Tgid | tgid | Integer | |
| Total_vm | total_vm | Integer | |
| Rss | rss | Integer | |
| Pgtables_bytes | pgtables_bytes | Integer | |
| Swapents | swapents | Integer | |
| Oom_score_adj | oom_score_adj | Integer |
{
"auth": true,
"description": "Show task",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "task"
},
"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
},
"host_pid": {
"required": false,
"label": "Host_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_pid": {
"required": false,
"label": "Vps_pid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"vps_uid": {
"required": false,
"label": "Vps_uid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"tgid": {
"required": false,
"label": "Tgid",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_vm": {
"required": false,
"label": "Total_vm",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"rss": {
"required": false,
"label": "Rss",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"pgtables_bytes": {
"required": false,
"label": "Pgtables_bytes",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swapents": {
"required": false,
"label": "Swapents",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"oom_score_adj": {
"required": false,
"label": "Oom_score_adj",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "tasks"
},
"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": [
],
"scope": "oom_report.task#show",
"path": "/v6.0/oom_reports/{oom_report_id}/tasks/{task_id}",
"method": "GET",
"help": "/v6.0/oom_reports/{oom_report_id}/tasks/{task_id}?method=GET"
}Memory usage
| 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 | |
| Memtype | memtype | String | |
| Usage | usage | Integer | |
| Limit | limit | Integer | |
| Failcnt | failcnt | Integer |
{
"auth": true,
"description": "List memory usages",
"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": "usage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"memtype": {
"required": false,
"label": "Memtype",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"usage": {
"required": false,
"label": "Usage",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"failcnt": {
"required": false,
"label": "Failcnt",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "usages"
},
"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": [
],
"scope": "oom_report.usage#index",
"path": "/v6.0/oom_reports/{oom_report_id}/usages",
"method": "GET",
"help": "/v6.0/oom_reports/{oom_report_id}/usages?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Memtype | memtype | String | |
| Usage | usage | Integer | |
| Limit | limit | Integer | |
| Failcnt | failcnt | Integer |
{
"auth": true,
"description": "Show memory usage",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "usage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"memtype": {
"required": false,
"label": "Memtype",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"usage": {
"required": false,
"label": "Usage",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"limit": {
"required": false,
"label": "Limit",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"failcnt": {
"required": false,
"label": "Failcnt",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "usages"
},
"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": [
],
"scope": "oom_report.usage#show",
"path": "/v6.0/oom_reports/{oom_report_id}/usages/{usage_id}",
"method": "GET",
"help": "/v6.0/oom_reports/{oom_report_id}/usages/{usage_id}?method=GET"
}Manage OS templates
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | yes | String | Present
|
Human-friendly label | |
| Info | info | no | Text | Information about template | ||
| Enabled | enabled | no | Boolean | Enable/disable template usage | ||
| Supported | supported | no | Boolean | Is template known to work? | ||
| Order | order | no | Integer | Template order | ||
| Hypervisor_type | hypervisor_type | no | String | Include
|
vpsadminos | |
| Cgroup_version | cgroup_version | no | String | Include
|
cgroup_any | |
| Vendor | vendor | yes | String | Present
|
||
| Variant | variant | yes | String | Present
|
||
| Arch | arch | yes | String | Present
|
||
| Distribution | distribution | yes | String | Present
|
||
| Version | version | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | OS template ID |
| Name | name | String | Template file name |
| Label | label | String | Human-friendly label |
| Info | info | Text | Information about template |
| Enabled | enabled | Boolean | Enable/disable template usage |
| Supported | supported | Boolean | Is template known to work? |
| Order | order | Integer | Template order |
| Hypervisor_type | hypervisor_type | String | |
| Cgroup_version | cgroup_version | String | |
| Vendor | vendor | String | |
| Variant | variant | String | |
| Arch | arch | String | |
| Distribution | distribution | String | |
| Version | version | String |
{
"auth": true,
"description": null,
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": true,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "Information about template",
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": "Enable/disable template usage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"supported": {
"required": false,
"label": "Supported",
"description": "Is template known to work?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": "Template order",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor_type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"openvz",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "vpsadminos",
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"vendor": {
"required": true,
"label": "Vendor",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"variant": {
"required": true,
"label": "Variant",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"arch": {
"required": true,
"label": "Arch",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"distribution": {
"required": true,
"label": "Distribution",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"version": {
"required": true,
"label": "Version",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "os_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "OS template ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template file name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "Information about template",
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": "Enable/disable template usage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"supported": {
"required": false,
"label": "Supported",
"description": "Is template known to work?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": "Template order",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor_type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"openvz",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "vpsadminos",
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"vendor": {
"required": false,
"label": "Vendor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"variant": {
"required": false,
"label": "Variant",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"arch": {
"required": false,
"label": "Arch",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"distribution": {
"required": false,
"label": "Distribution",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "os_template"
},
"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": [
],
"scope": "os_template#create",
"path": "/v6.0/os_templates",
"method": "POST",
"help": "/v6.0/os_templates?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": null,
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "os_template"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "os_template"
},
"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": [
],
"scope": "os_template#delete",
"path": "/v6.0/os_templates/{os_template_id}",
"method": "DELETE",
"help": "/v6.0/os_templates/{os_template_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 | ||
| Location | location | no | Resource | |||
| Hypervisor_type | hypervisor_type | no | String | Include
|
vpsadminos | |
| Cgroup_version | cgroup_version | no | String | Include
|
cgroup_any |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | OS template ID |
| Name | name | String | Template file name |
| Label | label | String | Human-friendly label |
| Info | info | Text | Information about template |
| Enabled | enabled | Boolean | Enable/disable template usage |
| Supported | supported | Boolean | Is template known to work? |
| Order | order | Integer | Template order |
| Hypervisor_type | hypervisor_type | String | |
| Cgroup_version | cgroup_version | String | |
| Vendor | vendor | String | |
| Variant | variant | String | |
| Arch | arch | String | |
| Distribution | distribution | String | |
| Version | version | String |
{
"auth": false,
"description": "List OS templates",
"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
},
"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"
}
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor_type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"openvz",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "vpsadminos",
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
}
},
"layout": "object",
"namespace": "os_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "OS template ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template file name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "Information about template",
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": "Enable/disable template usage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"supported": {
"required": false,
"label": "Supported",
"description": "Is template known to work?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": "Template order",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor_type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"openvz",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "vpsadminos",
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"vendor": {
"required": false,
"label": "Vendor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"variant": {
"required": false,
"label": "Variant",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"arch": {
"required": false,
"label": "Arch",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"distribution": {
"required": false,
"label": "Distribution",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "os_templates"
},
"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": [
],
"scope": "os_template#index",
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | OS template ID |
| Name | name | String | Template file name |
| Label | label | String | Human-friendly label |
| Info | info | Text | Information about template |
| Enabled | enabled | Boolean | Enable/disable template usage |
| Supported | supported | Boolean | Is template known to work? |
| Order | order | Integer | Template order |
| Hypervisor_type | hypervisor_type | String | |
| Cgroup_version | cgroup_version | String | |
| Vendor | vendor | String | |
| Variant | variant | String | |
| Arch | arch | String | |
| Distribution | distribution | String | |
| Version | version | String |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "os_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "OS template ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template file name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "Information about template",
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": "Enable/disable template usage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"supported": {
"required": false,
"label": "Supported",
"description": "Is template known to work?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": "Template order",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor_type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"openvz",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "vpsadminos",
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"vendor": {
"required": false,
"label": "Vendor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"variant": {
"required": false,
"label": "Variant",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"arch": {
"required": false,
"label": "Arch",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"distribution": {
"required": false,
"label": "Distribution",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "os_template"
},
"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": [
],
"scope": "os_template#show",
"path": "/v6.0/os_templates/{os_template_id}",
"method": "GET",
"help": "/v6.0/os_templates/{os_template_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | Human-friendly label | ||
| Info | info | no | Text | Information about template | ||
| Enabled | enabled | no | Boolean | Enable/disable template usage | ||
| Supported | supported | no | Boolean | Is template known to work? | ||
| Order | order | no | Integer | Template order | ||
| Hypervisor_type | hypervisor_type | no | String | Include
|
vpsadminos | |
| Cgroup_version | cgroup_version | no | String | Include
|
cgroup_any | |
| Vendor | vendor | no | String | |||
| Variant | variant | no | String | |||
| Arch | arch | no | String | |||
| Distribution | distribution | no | String | |||
| Version | version | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | OS template ID |
| Name | name | String | Template file name |
| Label | label | String | Human-friendly label |
| Info | info | Text | Information about template |
| Enabled | enabled | Boolean | Enable/disable template usage |
| Supported | supported | Boolean | Is template known to work? |
| Order | order | Integer | Template order |
| Hypervisor_type | hypervisor_type | String | |
| Cgroup_version | cgroup_version | String | |
| Vendor | vendor | String | |
| Variant | variant | String | |
| Arch | arch | String | |
| Distribution | distribution | String | |
| Version | version | String |
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "Information about template",
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": "Enable/disable template usage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"supported": {
"required": false,
"label": "Supported",
"description": "Is template known to work?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": "Template order",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor_type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"openvz",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "vpsadminos",
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"vendor": {
"required": false,
"label": "Vendor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"variant": {
"required": false,
"label": "Variant",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"arch": {
"required": false,
"label": "Arch",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"distribution": {
"required": false,
"label": "Distribution",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "os_template"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": "OS template ID",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "Template file name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly label",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "Information about template",
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": "Enable/disable template usage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"supported": {
"required": false,
"label": "Supported",
"description": "Is template known to work?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"order": {
"required": false,
"label": "Order",
"description": "Template order",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"hypervisor_type": {
"required": false,
"label": "Hypervisor_type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"openvz",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "vpsadminos",
"protected": false
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"vendor": {
"required": false,
"label": "Vendor",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"variant": {
"required": false,
"label": "Variant",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"arch": {
"required": false,
"label": "Arch",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"distribution": {
"required": false,
"label": "Distribution",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"version": {
"required": false,
"label": "Version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "os_template"
},
"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": [
],
"scope": "os_template#update",
"path": "/v6.0/os_templates/{os_template_id}",
"method": "PUT",
"help": "/v6.0/os_templates/{os_template_id}?method=PUT"
}Report and browse outages
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Begins at | begins_at | yes | Datetime | Present
|
||
| Finished at | finished_at | no | Datetime | |||
| Duration | duration | yes | Integer | Present
|
Outage duration in minutes | |
| Type | type | yes | String | Include
Present
|
||
| Impact | impact | yes | String | Include
Present
|
||
| Auto-resolve | auto_resolve | no | Boolean | true | ||
| English summary | en_summary | yes | String | Present
|
||
| English description | en_description | no | String | |||
| Česky summary | cs_summary | yes | String | Present
|
||
| Česky description | cs_description | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Begins at | begins_at | Datetime | |
| Finished at | finished_at | Datetime | |
| Duration | duration | Integer | Outage duration in minutes |
| Type | type | String | |
| State | state | String | |
| Impact | impact | String | |
| Auto-resolve | auto_resolve | Boolean | |
| English summary | en_summary | String | |
| English description | en_description | String | |
| Česky summary | cs_summary | String | |
| Česky description | cs_description | String | |
| Affected | affected | Boolean | True if the current user is affected by the outage |
| Affected users | affected_user_count | Integer | Number of affected users |
| Directly affected VPSes | affected_direct_vps_count | Integer | Number of directly affected VPSes |
| Indirectly affected VPSes | affected_indirect_vps_count | Integer | Number of indirectly affected VPSes |
| Affected exports | affected_export_count | Integer | Number of affected exoirts |
{
"auth": true,
"description": "Stage a new outage",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"begins_at": {
"required": true,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": true,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"type": {
"required": true,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"impact": {
"required": true,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"auto_resolve": {
"required": false,
"label": "Auto-resolve",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"en_summary": {
"required": true,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": true,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "outage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"auto_resolve": {
"required": false,
"label": "Auto-resolve",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"affected": {
"required": false,
"label": "Affected",
"description": "True if the current user is affected by the outage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"affected_user_count": {
"required": false,
"label": "Affected users",
"description": "Number of affected users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_direct_vps_count": {
"required": false,
"label": "Directly affected VPSes",
"description": "Number of directly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_indirect_vps_count": {
"required": false,
"label": "Indirectly affected VPSes",
"description": "Number of indirectly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_export_count": {
"required": false,
"label": "Affected exports",
"description": "Number of affected exoirts",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "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": [
],
"scope": "outage#create",
"path": "/v6.0/outages",
"method": "POST",
"help": "/v6.0/outages?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 | ||
| Type | type | no | String | Include
|
||
| State | state | no | String | Include
|
||
| Impact | impact | no | String | Include
|
||
| Affected | affected | no | Boolean | True if the current user is affected by the outage | ||
| Recent_since | recent_since | no | Datetime | Filter announced or recently reported outages | ||
| User | user | no | Resource | Filter outages affecting a specific user | ||
| VPS | vps | no | Resource | Filter outages affecting a specific VPS | ||
| Export | export | no | Resource | Filter outages affecting a specific export | ||
| Handled by | handled_by | no | Resource | Filter outages handled by user | ||
| Environment | environment | no | Resource | Filter outages by environment | ||
| Location | location | no | Resource | Filter outages by location | ||
| Node | node | no | Resource | Filter outages by node | ||
| Component | component | no | Resource | Filter outages by vpsAdmin component | ||
| Entity name | entity_name | no | String | Filter outages by entity name | ||
| Entity ID | entity_id | no | Integer | Filter outages by entity ID | ||
| Order | order | no | String | Include
|
newest | |
| Since | since | no | Datetime | Filter outages reported since specified date |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Begins at | begins_at | Datetime | |
| Finished at | finished_at | Datetime | |
| Duration | duration | Integer | Outage duration in minutes |
| Type | type | String | |
| State | state | String | |
| Impact | impact | String | |
| Auto-resolve | auto_resolve | Boolean | |
| English summary | en_summary | String | |
| English description | en_description | String | |
| Česky summary | cs_summary | String | |
| Česky description | cs_description | String | |
| Affected | affected | Boolean | True if the current user is affected by the outage |
| Affected users | affected_user_count | Integer | Number of affected users |
| Directly affected VPSes | affected_direct_vps_count | Integer | Number of directly affected VPSes |
| Indirectly affected VPSes | affected_indirect_vps_count | Integer | Number of indirectly affected VPSes |
| Affected exports | affected_export_count | Integer | Number of affected exoirts |
{
"auth": false,
"description": "List outages",
"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
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"affected": {
"required": false,
"label": "Affected",
"description": "True if the current user is affected by the outage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"recent_since": {
"required": false,
"label": "Recent_since",
"description": "Filter announced or recently reported outages",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "Filter outages affecting a specific user",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"vps": {
"required": null,
"label": "VPS",
"description": "Filter outages affecting 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"
}
},
"export": {
"required": null,
"label": "Export",
"description": "Filter outages affecting a specific export",
"type": "Resource",
"resource": [
"export"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/exports",
"method": "GET",
"help": "/v6.0/exports?method=GET"
}
},
"handled_by": {
"required": null,
"label": "Handled by",
"description": "Filter outages handled by user",
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "Filter outages 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"
}
},
"location": {
"required": null,
"label": "Location",
"description": "Filter outages by location",
"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": "Filter outages by node",
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"component": {
"required": null,
"label": "Component",
"description": "Filter outages by vpsAdmin component",
"type": "Resource",
"resource": [
"component"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/components",
"method": "GET",
"help": "/v6.0/components?method=GET"
}
},
"entity_name": {
"required": false,
"label": "Entity name",
"description": "Filter outages by entity name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"entity_id": {
"required": false,
"label": "Entity ID",
"description": "Filter outages by entity ID",
"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
},
"since": {
"required": false,
"label": "Since",
"description": "Filter outages reported since specified date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "outage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"auto_resolve": {
"required": false,
"label": "Auto-resolve",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"affected": {
"required": false,
"label": "Affected",
"description": "True if the current user is affected by the outage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"affected_user_count": {
"required": false,
"label": "Affected users",
"description": "Number of affected users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_direct_vps_count": {
"required": false,
"label": "Directly affected VPSes",
"description": "Number of directly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_indirect_vps_count": {
"required": false,
"label": "Indirectly affected VPSes",
"description": "Number of indirectly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_export_count": {
"required": false,
"label": "Affected exports",
"description": "Number of affected exoirts",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "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": [
],
"scope": "outage#index",
"path": "/v6.0/outages",
"method": "GET",
"help": "/v6.0/outages?method=GET"
}No parameters.
No parameters.
{
"auth": true,
"description": "Rebuilt the list of affected vpses, use after changing affected entities",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "outage"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "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": [
],
"scope": "outage#rebuild_affected_vps",
"path": "/v6.0/outages/{outage_id}/rebuild_affected_vps",
"method": "POST",
"help": "/v6.0/outages/{outage_id}/rebuild_affected_vps?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Begins at | begins_at | Datetime | |
| Finished at | finished_at | Datetime | |
| Duration | duration | Integer | Outage duration in minutes |
| Type | type | String | |
| State | state | String | |
| Impact | impact | String | |
| Auto-resolve | auto_resolve | Boolean | |
| English summary | en_summary | String | |
| English description | en_description | String | |
| Česky summary | cs_summary | String | |
| Česky description | cs_description | String | |
| Affected | affected | Boolean | True if the current user is affected by the outage |
| Affected users | affected_user_count | Integer | Number of affected users |
| Directly affected VPSes | affected_direct_vps_count | Integer | Number of directly affected VPSes |
| Indirectly affected VPSes | affected_indirect_vps_count | Integer | Number of indirectly affected VPSes |
| Affected exports | affected_export_count | Integer | Number of affected exoirts |
{
"auth": false,
"description": "Show outage details",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "outage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"auto_resolve": {
"required": false,
"label": "Auto-resolve",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"affected": {
"required": false,
"label": "Affected",
"description": "True if the current user is affected by the outage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"affected_user_count": {
"required": false,
"label": "Affected users",
"description": "Number of affected users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_direct_vps_count": {
"required": false,
"label": "Directly affected VPSes",
"description": "Number of directly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_indirect_vps_count": {
"required": false,
"label": "Indirectly affected VPSes",
"description": "Number of indirectly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_export_count": {
"required": false,
"label": "Affected exports",
"description": "Number of affected exoirts",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "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": [
],
"scope": "outage#show",
"path": "/v6.0/outages/{outage_id}",
"method": "GET",
"help": "/v6.0/outages/{outage_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Begins at | begins_at | no | Datetime | |||
| Finished at | finished_at | no | Datetime | |||
| Duration | duration | no | Integer | Outage duration in minutes | ||
| Type | type | no | String | Include
|
||
| Impact | impact | no | String | Include
|
||
| Auto-resolve | auto_resolve | no | Boolean | true | ||
| English summary | en_summary | no | String | |||
| English description | en_description | no | String | |||
| Česky summary | cs_summary | no | String | |||
| Česky description | cs_description | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Begins at | begins_at | Datetime | |
| Finished at | finished_at | Datetime | |
| Duration | duration | Integer | Outage duration in minutes |
| Type | type | String | |
| State | state | String | |
| Impact | impact | String | |
| Auto-resolve | auto_resolve | Boolean | |
| English summary | en_summary | String | |
| English description | en_description | String | |
| Česky summary | cs_summary | String | |
| Česky description | cs_description | String | |
| Affected | affected | Boolean | True if the current user is affected by the outage |
| Affected users | affected_user_count | Integer | Number of affected users |
| Directly affected VPSes | affected_direct_vps_count | Integer | Number of directly affected VPSes |
| Indirectly affected VPSes | affected_indirect_vps_count | Integer | Number of indirectly affected VPSes |
| Affected exports | affected_export_count | Integer | Number of affected exoirts |
{
"auth": true,
"description": "Update an outage",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"auto_resolve": {
"required": false,
"label": "Auto-resolve",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "outage"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"auto_resolve": {
"required": false,
"label": "Auto-resolve",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"affected": {
"required": false,
"label": "Affected",
"description": "True if the current user is affected by the outage",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"affected_user_count": {
"required": false,
"label": "Affected users",
"description": "Number of affected users",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_direct_vps_count": {
"required": false,
"label": "Directly affected VPSes",
"description": "Number of directly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_indirect_vps_count": {
"required": false,
"label": "Indirectly affected VPSes",
"description": "Number of indirectly affected VPSes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"affected_export_count": {
"required": false,
"label": "Affected exports",
"description": "Number of affected exoirts",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "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": [
],
"scope": "outage#update",
"path": "/v6.0/outages/{outage_id}",
"method": "PUT",
"help": "/v6.0/outages/{outage_id}?method=PUT"
}Outage entities
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Name | name | no | String | |||
| Entity_id | entity_id | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Entity_id | entity_id | Integer | |
| Label | label | String |
{
"auth": true,
"description": "Add a new outage entity",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"entity_id": {
"required": false,
"label": "Entity_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entity"
},
"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
},
"entity_id": {
"required": false,
"label": "Entity_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entity"
},
"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": [
],
"scope": "outage.entity#create",
"path": "/v6.0/outages/{outage_id}/entities",
"method": "POST",
"help": "/v6.0/outages/{outage_id}/entities?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Remove an outage entity",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "entity"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "entity"
},
"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": [
],
"scope": "outage.entity#delete",
"path": "/v6.0/outages/{outage_id}/entities/{entity_id}",
"method": "DELETE",
"help": "/v6.0/outages/{outage_id}/entities/{entity_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 | |
| Name | name | String | |
| Entity_id | entity_id | Integer | |
| Label | label | String |
{
"auth": false,
"description": "List outage entities",
"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": "entity"
},
"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
},
"entity_id": {
"required": false,
"label": "Entity_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "entities"
},
"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": [
],
"scope": "outage.entity#index",
"path": "/v6.0/outages/{outage_id}/entities",
"method": "GET",
"help": "/v6.0/outages/{outage_id}/entities?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Entity_id | entity_id | Integer | |
| Label | label | String |
{
"auth": false,
"description": "Show an outage entity",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "entity"
},
"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
},
"entity_id": {
"required": false,
"label": "Entity_id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entity"
},
"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": [
],
"scope": "outage.entity#show",
"path": "/v6.0/outages/{outage_id}/entities/{entity_id}",
"method": "GET",
"help": "/v6.0/outages/{outage_id}/entities/{entity_id}?method=GET"
}Outage handlers
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| User | user | no | Resource | |||
| Full name | full_name | no | String | |||
| Note | note | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Full name | full_name | String | |
| Note | note | String |
{
"auth": true,
"description": "Add a new outage handler",
"aliases": [
"new"
],
"blocking": false,
"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"
}
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Note",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "handler"
},
"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"
}
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Note",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "handler"
},
"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": [
],
"scope": "outage.handler#create",
"path": "/v6.0/outages/{outage_id}/handlers",
"method": "POST",
"help": "/v6.0/outages/{outage_id}/handlers?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Remove an outage handler",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "handler"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "handler"
},
"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": [
],
"scope": "outage.handler#delete",
"path": "/v6.0/outages/{outage_id}/handlers/{handler_id}",
"method": "DELETE",
"help": "/v6.0/outages/{outage_id}/handlers/{handler_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 | |
| User | user | Resource | |
| Full name | full_name | String | |
| Note | note | String |
{
"auth": false,
"description": "List outage entities",
"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": "handler"
},
"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"
}
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Note",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "handlers"
},
"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": [
],
"scope": "outage.handler#index",
"path": "/v6.0/outages/{outage_id}/handlers",
"method": "GET",
"help": "/v6.0/outages/{outage_id}/handlers?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Full name | full_name | String | |
| Note | note | String |
{
"auth": false,
"description": "Show an outage handler",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "handler"
},
"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"
}
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Note",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "handler"
},
"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": [
],
"scope": "outage.handler#show",
"path": "/v6.0/outages/{outage_id}/handlers/{handler_id}",
"method": "GET",
"help": "/v6.0/outages/{outage_id}/handlers/{handler_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Note | note | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Full name | full_name | String | |
| Note | note | String |
{
"auth": true,
"description": "Update an outage handler",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"note": {
"required": true,
"label": "Note",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "handler"
},
"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"
}
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Note",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "handler"
},
"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": [
],
"scope": "outage.handler#update",
"path": "/v6.0/outages/{outage_id}/handlers/{handler_id}",
"method": "PUT",
"help": "/v6.0/outages/{outage_id}/handlers/{handler_id}?method=PUT"
}Browse outage updates
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Outage | outage | no | Resource | |||
| Begins at | begins_at | no | Datetime | |||
| Finished at | finished_at | no | Datetime | |||
| Duration | duration | no | Integer | Outage duration in minutes | ||
| State | state | no | String | Include
|
||
| Impact | impact | no | String | Include
|
||
| English summary | en_summary | no | String | |||
| English description | en_description | no | String | |||
| Česky summary | cs_summary | no | String | |||
| Česky description | cs_description | no | String | |||
| Send mail | send_mail | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| Type | type | String | |
| Begins at | begins_at | Datetime | |
| Finished at | finished_at | Datetime | |
| Duration | duration | Integer | Outage duration in minutes |
| State | state | String | |
| Impact | impact | String | |
| English summary | en_summary | String | |
| English description | en_description | String | |
| Česky summary | cs_summary | String | |
| Česky description | cs_description | String | |
| Reported by | reported_by | Resource | |
| Reporter's name | reporter_name | String | |
| Reported at | created_at | Datetime |
{
"auth": true,
"description": "Create outage update",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"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"
}
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "outage_update"
},
"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"
}
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reported_by": {
"required": null,
"label": "Reported 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"
}
},
"reporter_name": {
"required": false,
"label": "Reporter's name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Reported at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "outage_update"
},
"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": [
],
"scope": "outage_update#create",
"path": "/v6.0/outage_updates",
"method": "POST",
"help": "/v6.0/outage_updates?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 | ||
| Outage | outage | no | Resource | |||
| Reported by | reported_by | no | Resource | |||
| Since | since | no | Datetime | Filter updates reported since specified date |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| Type | type | String | |
| Begins at | begins_at | Datetime | |
| Finished at | finished_at | Datetime | |
| Duration | duration | Integer | Outage duration in minutes |
| State | state | String | |
| Impact | impact | String | |
| English summary | en_summary | String | |
| English description | en_description | String | |
| Česky summary | cs_summary | String | |
| Česky description | cs_description | String | |
| Reported by | reported_by | Resource | |
| Reporter's name | reporter_name | String | |
| Reported at | created_at | Datetime |
{
"auth": false,
"description": "List outage updates",
"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"
}
},
"reported_by": {
"required": null,
"label": "Reported 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"
}
},
"since": {
"required": false,
"label": "Since",
"description": "Filter updates reported since specified date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "outage_update"
},
"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"
}
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reported_by": {
"required": null,
"label": "Reported 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"
}
},
"reporter_name": {
"required": false,
"label": "Reporter's name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Reported at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "outage_updates"
},
"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": [
],
"scope": "outage_update#index",
"path": "/v6.0/outage_updates",
"method": "GET",
"help": "/v6.0/outage_updates?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| Type | type | String | |
| Begins at | begins_at | Datetime | |
| Finished at | finished_at | Datetime | |
| Duration | duration | Integer | Outage duration in minutes |
| State | state | String | |
| Impact | impact | String | |
| English summary | en_summary | String | |
| English description | en_description | String | |
| Česky summary | cs_summary | String | |
| Česky description | cs_description | String | |
| Reported by | reported_by | Resource | |
| Reporter's name | reporter_name | String | |
| Reported at | created_at | Datetime |
{
"auth": false,
"description": "Show outage update",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "outage_update"
},
"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"
}
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"maintenance",
"outage"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"begins_at": {
"required": false,
"label": "Begins at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"duration": {
"required": false,
"label": "Duration",
"description": "Outage duration in minutes",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"announced",
"resolved",
"cancelled"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"impact": {
"required": false,
"label": "Impact",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"tbd",
"system_restart",
"system_reset",
"network",
"performance",
"unavailability",
"export"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"en_summary": {
"required": false,
"label": "English summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"en_description": {
"required": false,
"label": "English description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_summary": {
"required": false,
"label": "Česky summary",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"cs_description": {
"required": false,
"label": "Česky description",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"reported_by": {
"required": null,
"label": "Reported 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"
}
},
"reporter_name": {
"required": false,
"label": "Reporter's name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Reported at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "outage_update"
},
"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": [
],
"scope": "outage_update#show",
"path": "/v6.0/outage_updates/{outage_update_id}",
"method": "GET",
"help": "/v6.0/outage_updates/{outage_update_id}?method=GET"
}View payment statistics
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Year | year | yes | Integer | Present
|
||
| Month | month | yes | Integer | Present
|
||
| Select | select | yes | String | Include
Present
|
||
| Duration | duration | yes | Integer | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| User_count | user_count | Integer | |
| Estimated_income | estimated_income | Integer |
{
"auth": true,
"description": "Estimate income for selected month and duration",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"year": {
"required": true,
"label": "Year",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"month": {
"required": true,
"label": "Month",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"select": {
"required": true,
"label": "Select",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"exactly_until",
"all_until"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"duration": {
"required": true,
"label": "Duration",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "payment_stats"
},
"output": {
"parameters": {
"user_count": {
"required": false,
"label": "User_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"estimated_income": {
"required": false,
"label": "Estimated_income",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "payment_stats"
},
"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": [
],
"scope": "payment_stats#estimate_income",
"path": "/v6.0/payment_stat/estimate_income",
"method": "GET",
"help": "/v6.0/payment_stat/estimate_income?method=GET"
}Manage storage pools
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Node | node | no | Resource | |||
| Label | label | no | String | |||
| Filesystem | filesystem | no | String | |||
| Role | role | no | String | Include
|
||
| Is_open | is_open | no | Boolean | |||
| Refquota check | refquota_check | no | Boolean | |||
| Max_datasets | max_datasets | no | Integer | |||
| State | state | no | String | Include
|
||
| Scan | scan | no | String | Include
|
||
| Scan_percent | scan_percent | no | Float | |||
| Checked_at | checked_at | no | Datetime | |||
| 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 | |
| Node | node | Resource | |
| Label | label | String | |
| Name | name | String | |
| Filesystem | filesystem | String | |
| Role | role | String | |
| Is_open | is_open | Boolean | |
| Refquota check | refquota_check | Boolean | |
| Max_datasets | max_datasets | Integer | |
| State | state | String | |
| Scan | scan | String | |
| Scan_percent | scan_percent | Float | |
| Checked_at | checked_at | Datetime | |
| 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 |
| Used compression ratio | compressratio | Float | Compression ratio for used space of this dataset |
| Referenced compression ratio | refcompressratio | Float | Compression ratio for referenced space of this dataset |
{
"auth": true,
"description": "Create a new storage pool",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"filesystem": {
"required": false,
"label": "Filesystem",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"role": {
"required": false,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"hypervisor",
"primary",
"backup"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"refquota_check": {
"required": false,
"label": "Refquota check",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_datasets": {
"required": false,
"label": "Max_datasets",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan": {
"required": false,
"label": "Scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan_percent": {
"required": false,
"label": "Scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"checked_at": {
"required": false,
"label": "Checked_at",
"description": null,
"type": "Datetime",
"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
}
},
"layout": "object",
"namespace": "pool"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"filesystem": {
"required": false,
"label": "Filesystem",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"role": {
"required": false,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"hypervisor",
"primary",
"backup"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"refquota_check": {
"required": false,
"label": "Refquota check",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_datasets": {
"required": false,
"label": "Max_datasets",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan": {
"required": false,
"label": "Scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan_percent": {
"required": false,
"label": "Scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"checked_at": {
"required": false,
"label": "Checked_at",
"description": null,
"type": "Datetime",
"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
},
"compressratio": {
"required": false,
"label": "Used compression ratio",
"description": "Compression ratio for used space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
},
"refcompressratio": {
"required": false,
"label": "Referenced compression ratio",
"description": "Compression ratio for referenced space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
}
},
"layout": "object",
"namespace": "pool"
},
"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": [
],
"scope": "pool#create",
"path": "/v6.0/pools",
"method": "POST",
"help": "/v6.0/pools?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 | ||
| Node | node | no | Resource | |||
| Label | label | no | String | |||
| Name | name | no | String | |||
| Filesystem | filesystem | no | String | |||
| Role | role | no | String | Include
|
||
| Is_open | is_open | no | Boolean | |||
| Refquota check | refquota_check | no | Boolean | |||
| Max_datasets | max_datasets | no | Integer | |||
| State | state | no | String | Include
|
||
| Scan | scan | no | String | Include
|
||
| Scan_percent | scan_percent | no | Float | |||
| Checked_at | checked_at | no | Datetime | |||
| 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 | |
| Node | node | Resource | |
| Label | label | String | |
| Name | name | String | |
| Filesystem | filesystem | String | |
| Role | role | String | |
| Is_open | is_open | Boolean | |
| Refquota check | refquota_check | Boolean | |
| Max_datasets | max_datasets | Integer | |
| State | state | String | |
| Scan | scan | String | |
| Scan_percent | scan_percent | Float | |
| Checked_at | checked_at | Datetime | |
| 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 |
| Used compression ratio | compressratio | Float | Compression ratio for used space of this dataset |
| Referenced compression ratio | refcompressratio | Float | Compression ratio for referenced space of this dataset |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "List storage pools",
"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
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"filesystem": {
"required": false,
"label": "Filesystem",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"role": {
"required": false,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"hypervisor",
"primary",
"backup"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"refquota_check": {
"required": false,
"label": "Refquota check",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_datasets": {
"required": false,
"label": "Max_datasets",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan": {
"required": false,
"label": "Scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan_percent": {
"required": false,
"label": "Scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"checked_at": {
"required": false,
"label": "Checked_at",
"description": null,
"type": "Datetime",
"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
}
},
"layout": "object",
"namespace": "pool"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"filesystem": {
"required": false,
"label": "Filesystem",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"role": {
"required": false,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"hypervisor",
"primary",
"backup"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"refquota_check": {
"required": false,
"label": "Refquota check",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_datasets": {
"required": false,
"label": "Max_datasets",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan": {
"required": false,
"label": "Scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan_percent": {
"required": false,
"label": "Scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"checked_at": {
"required": false,
"label": "Checked_at",
"description": null,
"type": "Datetime",
"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
},
"compressratio": {
"required": false,
"label": "Used compression ratio",
"description": "Compression ratio for used space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
},
"refcompressratio": {
"required": false,
"label": "Referenced compression ratio",
"description": "Compression ratio for referenced space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"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": "pools"
},
"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": [
],
"scope": "pool#index",
"path": "/v6.0/pools",
"method": "GET",
"help": "/v6.0/pools?method=GET"
}| 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": "pool"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "pool"
},
"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": [
],
"scope": "pool#set_maintenance",
"path": "/v6.0/pools/{pool_id}/set_maintenance",
"method": "POST",
"help": "/v6.0/pools/{pool_id}/set_maintenance?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Node | node | Resource | |
| Label | label | String | |
| Name | name | String | |
| Filesystem | filesystem | String | |
| Role | role | String | |
| Is_open | is_open | Boolean | |
| Refquota check | refquota_check | Boolean | |
| Max_datasets | max_datasets | Integer | |
| State | state | String | |
| Scan | scan | String | |
| Scan_percent | scan_percent | Float | |
| Checked_at | checked_at | Datetime | |
| 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 |
| Used compression ratio | compressratio | Float | Compression ratio for used space of this dataset |
| Referenced compression ratio | refcompressratio | Float | Compression ratio for referenced space of this dataset |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String |
{
"auth": true,
"description": "Show storage pool",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "pool"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"filesystem": {
"required": false,
"label": "Filesystem",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"role": {
"required": false,
"label": "Role",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"hypervisor",
"primary",
"backup"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"refquota_check": {
"required": false,
"label": "Refquota check",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"max_datasets": {
"required": false,
"label": "Max_datasets",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"online",
"degraded",
"suspended",
"faulted",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan": {
"required": false,
"label": "Scan",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"unknown",
"none",
"scrub",
"resilver",
"error"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"scan_percent": {
"required": false,
"label": "Scan_percent",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"checked_at": {
"required": false,
"label": "Checked_at",
"description": null,
"type": "Datetime",
"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
},
"compressratio": {
"required": false,
"label": "Used compression ratio",
"description": "Compression ratio for used space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"protected": false
},
"refcompressratio": {
"required": false,
"label": "Referenced compression ratio",
"description": "Compression ratio for referenced space of this dataset",
"type": "Float",
"validators": {
},
"default": 1.0,
"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": "pool"
},
"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": [
],
"scope": "pool#show",
"path": "/v6.0/pools/{pool_id}",
"method": "GET",
"help": "/v6.0/pools/{pool_id}?method=GET"
}Manage download links of dataset snapshots
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Snapshot | snapshot | yes | Resource | |||
| From snapshot | from_snapshot | no | Resource | |||
| Format | format | no | String | Include
|
archive | |
| Send_mail | send_mail | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Snapshot | snapshot | Resource | |
| From snapshot | from_snapshot | Resource | |
| Format | format | String | |
| File name | file_name | String | |
| Url | url | String | URL at which the archive can be downloaded |
| Size | size | Integer | Size of the archive in MiB |
| Sha256sum | sha256sum | String | Control checksum |
| Ready | ready | Boolean | True if the archive is complete and ready for download |
| Expiration date | expiration_date | Datetime | The archive is deleted when expiration date passes |
{
"auth": true,
"description": "Download a snapshot",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"snapshot": {
"required": true,
"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"
}
},
"from_snapshot": {
"required": null,
"label": "From 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"
}
},
"format": {
"required": false,
"label": "Format",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"archive",
"stream",
"incremental_stream"
],
"message": "%{value} cannot be used"
}
},
"default": "archive",
"protected": false
},
"send_mail": {
"required": false,
"label": "Send_mail",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "snapshot_download"
},
"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"
}
},
"snapshot": {
"required": true,
"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"
}
},
"from_snapshot": {
"required": null,
"label": "From 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"
}
},
"format": {
"required": false,
"label": "Format",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"archive",
"stream",
"incremental_stream"
],
"message": "%{value} cannot be used"
}
},
"default": "archive",
"protected": false
},
"file_name": {
"required": false,
"label": "File name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"url": {
"required": false,
"label": "Url",
"description": "URL at which the archive can be downloaded",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": "Size of the archive in MiB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"sha256sum": {
"required": false,
"label": "Sha256sum",
"description": "Control checksum",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ready": {
"required": false,
"label": "Ready",
"description": "True if the archive is complete and ready for download",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": "The archive is deleted when expiration date passes",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "snapshot_download"
},
"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": [
],
"scope": "snapshot_download#create",
"path": "/v6.0/snapshot_downloads",
"method": "POST",
"help": "/v6.0/snapshot_downloads?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete download link",
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot_download"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot_download"
},
"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": [
],
"scope": "snapshot_download#delete",
"path": "/v6.0/snapshot_downloads/{snapshot_download_id}",
"method": "DELETE",
"help": "/v6.0/snapshot_downloads/{snapshot_download_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 | ||
| Dataset | dataset | no | Resource | |||
| Snapshot | snapshot | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Snapshot | snapshot | Resource | |
| From snapshot | from_snapshot | Resource | |
| Format | format | String | |
| File name | file_name | String | |
| Url | url | String | URL at which the archive can be downloaded |
| Size | size | Integer | Size of the archive in MiB |
| Sha256sum | sha256sum | String | Control checksum |
| Ready | ready | Boolean | True if the archive is complete and ready for download |
| Expiration date | expiration_date | Datetime | The archive is deleted when expiration date passes |
{
"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
},
"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": "label",
"value": null,
"choices": {
"path": "/v6.0/datasets/{dataset_id}/snapshots",
"method": "GET",
"help": "/v6.0/datasets/{dataset_id}/snapshots?method=GET"
}
}
},
"layout": "object",
"namespace": "snapshot_download"
},
"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"
}
},
"snapshot": {
"required": true,
"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"
}
},
"from_snapshot": {
"required": null,
"label": "From 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"
}
},
"format": {
"required": false,
"label": "Format",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"archive",
"stream",
"incremental_stream"
],
"message": "%{value} cannot be used"
}
},
"default": "archive",
"protected": false
},
"file_name": {
"required": false,
"label": "File name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"url": {
"required": false,
"label": "Url",
"description": "URL at which the archive can be downloaded",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": "Size of the archive in MiB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"sha256sum": {
"required": false,
"label": "Sha256sum",
"description": "Control checksum",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ready": {
"required": false,
"label": "Ready",
"description": "True if the archive is complete and ready for download",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": "The archive is deleted when expiration date passes",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "snapshot_downloads"
},
"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": [
],
"scope": "snapshot_download#index",
"path": "/v6.0/snapshot_downloads",
"method": "GET",
"help": "/v6.0/snapshot_downloads?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Snapshot | snapshot | Resource | |
| From snapshot | from_snapshot | Resource | |
| Format | format | String | |
| File name | file_name | String | |
| Url | url | String | URL at which the archive can be downloaded |
| Size | size | Integer | Size of the archive in MiB |
| Sha256sum | sha256sum | String | Control checksum |
| Ready | ready | Boolean | True if the archive is complete and ready for download |
| Expiration date | expiration_date | Datetime | The archive is deleted when expiration date passes |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "snapshot_download"
},
"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"
}
},
"snapshot": {
"required": true,
"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"
}
},
"from_snapshot": {
"required": null,
"label": "From 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"
}
},
"format": {
"required": false,
"label": "Format",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"archive",
"stream",
"incremental_stream"
],
"message": "%{value} cannot be used"
}
},
"default": "archive",
"protected": false
},
"file_name": {
"required": false,
"label": "File name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"url": {
"required": false,
"label": "Url",
"description": "URL at which the archive can be downloaded",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": "Size of the archive in MiB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"sha256sum": {
"required": false,
"label": "Sha256sum",
"description": "Control checksum",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ready": {
"required": false,
"label": "Ready",
"description": "True if the archive is complete and ready for download",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": "The archive is deleted when expiration date passes",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "snapshot_download"
},
"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": [
],
"scope": "snapshot_download#show",
"path": "/v6.0/snapshot_downloads/{snapshot_download_id}",
"method": "GET",
"help": "/v6.0/snapshot_downloads/{snapshot_download_id}?method=GET"
}Query and set system configuration
| 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 | ||
| Category | category | no | String | Format
|
| Label | Name | Type | Description |
|---|---|---|---|
| Category | category | String | |
| Name | name | String | |
| Type | type | String | |
| Value | value | Custom | |
| Label | label | String | |
| Description | description | String | |
| Min_user_level | min_user_level | Integer |
{
"auth": false,
"description": "List configuration variables",
"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
},
"category": {
"required": false,
"label": "Category",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9_]{1,75}\\z",
"match": true,
"description": null,
"message": "bad format"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "system_config"
},
"output": {
"parameters": {
"category": {
"required": false,
"label": "Category",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Custom",
"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
},
"min_user_level": {
"required": false,
"label": "Min_user_level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "system_configs"
},
"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": [
],
"scope": "system_config#index",
"path": "/v6.0/system_configs",
"method": "GET",
"help": "/v6.0/system_configs?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Category | category | String | |
| Name | name | String | |
| Type | type | String | |
| Value | value | Custom | |
| Label | label | String | |
| Description | description | String | |
| Min_user_level | min_user_level | Integer |
{
"auth": false,
"description": "Show configuration variable",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "system_config"
},
"output": {
"parameters": {
"category": {
"required": false,
"label": "Category",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Custom",
"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
},
"min_user_level": {
"required": false,
"label": "Min_user_level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "system_config"
},
"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": [
],
"scope": "system_config#show",
"path": "/v6.0/system_configs/{category}/{name}",
"method": "GET",
"help": "/v6.0/system_configs/{category}/{name}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Value | value | no | Custom |
| Label | Name | Type | Description |
|---|---|---|---|
| Category | category | String | |
| Name | name | String | |
| Type | type | String | |
| Value | value | Custom | |
| Label | label | String | |
| Description | description | String | |
| Min_user_level | min_user_level | Integer |
{
"auth": true,
"description": "Update configuration variable",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "system_config"
},
"output": {
"parameters": {
"category": {
"required": false,
"label": "Category",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"value": {
"required": false,
"label": "Value",
"description": null,
"type": "Custom",
"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
},
"min_user_level": {
"required": false,
"label": "Min_user_level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "system_config"
},
"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": [
],
"scope": "system_config#update",
"path": "/v6.0/system_configs/{category}/{name}",
"method": "PUT",
"help": "/v6.0/system_configs/{category}/{name}?method=PUT"
}Access transactions linked in a chain
| 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 | |
| Transaction chain | transaction_chain | no | Resource | |||
| Node | node | no | Resource | |||
| Type | type | no | Integer | |||
| Success | success | no | Integer | |||
| Done | done | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| TransactionChain | transaction_chain | Resource | |
| Node | node | Resource | |
| User | user | Resource | |
| Type | type | Integer | |
| Name | name | String | |
| VPS | vps | Resource | |
| Depends on | depends_on | Resource | |
| Urgent | urgent | Boolean | |
| Priority | priority | Integer | |
| Success | success | Integer | |
| Done | done | String | |
| Input | input | String | |
| Output | output | String | |
| Created_at | created_at | Datetime | |
| Started_at | started_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "List transactions",
"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
},
"transaction_chain": {
"required": null,
"label": "Transaction 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"
}
},
"node": {
"required": null,
"label": "Node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"success": {
"required": false,
"label": "Success",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"done": {
"required": false,
"label": "Done",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"waiting",
"done",
"staged"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "transaction"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"transaction_chain": {
"required": null,
"label": "TransactionChain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?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"
}
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"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"
}
},
"depends_on": {
"required": null,
"label": "Depends on",
"description": null,
"type": "Resource",
"resource": [
"transaction"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transactions",
"method": "GET",
"help": "/v6.0/transactions?method=GET"
}
},
"urgent": {
"required": false,
"label": "Urgent",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"success": {
"required": false,
"label": "Success",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"done": {
"required": false,
"label": "Done",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"waiting",
"done",
"staged"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"input": {
"required": false,
"label": "Input",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"output": {
"required": false,
"label": "Output",
"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
},
"started_at": {
"required": false,
"label": "Started_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "transactions"
},
"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": [
],
"scope": "transaction#index",
"path": "/v6.0/transactions",
"method": "GET",
"help": "/v6.0/transactions?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| TransactionChain | transaction_chain | Resource | |
| Node | node | Resource | |
| User | user | Resource | |
| Type | type | Integer | |
| Name | name | String | |
| VPS | vps | Resource | |
| Depends on | depends_on | Resource | |
| Urgent | urgent | Boolean | |
| Priority | priority | Integer | |
| Success | success | Integer | |
| Done | done | String | |
| Input | input | String | |
| Output | output | String | |
| Created_at | created_at | Datetime | |
| Started_at | started_at | Datetime | |
| Finished_at | finished_at | Datetime |
{
"auth": true,
"description": "Show transaction",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "transaction"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"transaction_chain": {
"required": null,
"label": "TransactionChain",
"description": null,
"type": "Resource",
"resource": [
"transaction_chain"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": null,
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?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"
}
},
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": null,
"type": "String",
"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"
}
},
"depends_on": {
"required": null,
"label": "Depends on",
"description": null,
"type": "Resource",
"resource": [
"transaction"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/transactions",
"method": "GET",
"help": "/v6.0/transactions?method=GET"
}
},
"urgent": {
"required": false,
"label": "Urgent",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"priority": {
"required": false,
"label": "Priority",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"success": {
"required": false,
"label": "Success",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"done": {
"required": false,
"label": "Done",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"waiting",
"done",
"staged"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"input": {
"required": false,
"label": "Input",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"output": {
"required": false,
"label": "Output",
"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
},
"started_at": {
"required": false,
"label": "Started_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"finished_at": {
"required": false,
"label": "Finished_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "transaction"
},
"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": [
],
"scope": "transaction#show",
"path": "/v6.0/transactions/{transaction_id}",
"method": "GET",
"help": "/v6.0/transactions/{transaction_id}?method=GET"
}Access transaction chains
| 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 | |
| Name | name | no | String | For internal use only | ||
| State | state | no | String | Include
|
||
| User | user | no | Resource | |||
| User session | user_session | no | Resource | |||
| Class name | class_name | no | String | Search by concerned class name | ||
| Row id | row_id | no | Integer | Search by concerned row id |
| Label | Name | Type | Description |
|---|---|---|---|
| Chain ID | id | Integer | |
| Name | name | String | For internal use only |
| Label | label | String | Human-friendly name |
| State | state | String | |
| Size | size | Integer | Number of transactions in the chain |
| Progress | progress | Integer | How many transactions are finished |
| User | user | Resource | |
| Creation date | created_at | Datetime | |
| Concerns | concerns | Custom |
{
"auth": true,
"description": "List transaction chains",
"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
},
"name": {
"required": false,
"label": "Name",
"description": "For internal use only",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"queued",
"done",
"rollbacking",
"failed",
"fatal",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"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"
}
},
"user_session": {
"required": null,
"label": "User session",
"description": null,
"type": "Resource",
"resource": [
"user_session"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_sessions",
"method": "GET",
"help": "/v6.0/user_sessions?method=GET"
}
},
"class_name": {
"required": false,
"label": "Class name",
"description": "Search by concerned class name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"row_id": {
"required": false,
"label": "Row id",
"description": "Search by concerned row id",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "transaction_chain"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Chain ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "For internal use only",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"queued",
"done",
"rollbacking",
"failed",
"fatal",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": "Number of transactions in the chain",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"progress": {
"required": false,
"label": "Progress",
"description": "How many transactions are finished",
"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"
}
},
"created_at": {
"required": false,
"label": "Creation date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"concerns": {
"required": false,
"label": "Concerns",
"description": null,
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "transaction_chains"
},
"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": [
],
"scope": "transaction_chain#index",
"path": "/v6.0/transaction_chains",
"method": "GET",
"help": "/v6.0/transaction_chains?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Chain ID | id | Integer | |
| Name | name | String | For internal use only |
| Label | label | String | Human-friendly name |
| State | state | String | |
| Size | size | Integer | Number of transactions in the chain |
| Progress | progress | Integer | How many transactions are finished |
| User | user | Resource | |
| Creation date | created_at | Datetime | |
| Concerns | concerns | Custom |
{
"auth": true,
"description": "Show transaction chain",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "transaction_chain"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Chain ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"name": {
"required": false,
"label": "Name",
"description": "For internal use only",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": "Human-friendly name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"staged",
"queued",
"done",
"rollbacking",
"failed",
"fatal",
"resolved"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": "Number of transactions in the chain",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"progress": {
"required": false,
"label": "Progress",
"description": "How many transactions are finished",
"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"
}
},
"created_at": {
"required": false,
"label": "Creation date",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"concerns": {
"required": false,
"label": "Concerns",
"description": null,
"type": "Custom",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "transaction_chain"
},
"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": [
],
"scope": "transaction_chain#show",
"path": "/v6.0/transaction_chains/{transaction_chain_id}",
"method": "GET",
"help": "/v6.0/transaction_chains/{transaction_chain_id}?method=GET"
}Manage users
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Login | login | no | String | Format
|
||
| Full name | full_name | no | String | First and last name | ||
| no | String | |||||
| Address | address | no | String | |||
| Access level | level | no | Integer | |||
| Info | info | no | String | |||
| Enabled mailer | mailer_enabled | no | Boolean | true | ||
| Password reset | password_reset | no | Boolean | |||
| Lock-out | lockout | no | Boolean | |||
| Language of e-mails | language | no | Resource | |||
| Enable single sign-on | enable_single_sign_on | no | Boolean | |||
| Preferred session length | preferred_session_length | no | Integer | |||
| Preferred logout all | preferred_logout_all | no | Boolean | |||
| Password | password | no | String | The password must be at least 8 characters long | ||
| Create a VPS | vps | no | Boolean | |||
| Node | node | no | Resource | Node VPS will run on | ||
| Environment | environment | no | Resource | Environment in which to create the VPS | ||
| Location | location | no | Resource | Location in which to create the VPS | ||
| OS template | os_template | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| User ID | id | Integer | |
| Login | login | String | |
| Full name | full_name | String | First and last name |
| String | |||
| Address | address | String | |
| Access level | level | Integer | |
| Info | info | String | |
| Enabled mailer | mailer_enabled | Boolean | |
| Password reset | password_reset | Boolean | |
| Lock-out | lockout | Boolean | |
| Language of e-mails | language | Resource | |
| Enable single sign-on | enable_single_sign_on | Boolean | |
| Preferred session length | preferred_session_length | Integer | |
| Preferred logout all | preferred_logout_all | Boolean | |
| Last activity | last_activity_at | Datetime | |
| DokuWiki groups | dokuwiki_groups | String | Comma-separated list of DokuWiki groups |
| Created at | created_at | Datetime | |
| Object state | object_state | String | |
| Expiration | expiration_date | Datetime | A date after which the state will progress |
| Remind after | remind_after_date | Datetime | Mail warnings are silenced until this date |
{
"auth": true,
"description": "Create new user",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9.-]{2,63}\\z",
"match": true,
"description": null,
"message": "not a valid login"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"password": {
"required": false,
"label": "Password",
"description": "The password must be at least 8 characters long",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"vps": {
"required": false,
"label": "Create a VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "Environment in which to create the VPS",
"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": "Location in which to create the VPS",
"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"
}
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
}
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "User ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_activity_at": {
"required": false,
"label": "Last activity",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"dokuwiki_groups": {
"required": false,
"label": "DokuWiki groups",
"description": "Comma-separated list of DokuWiki groups",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user"
},
"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": [
],
"scope": "user#create",
"path": "/v6.0/users",
"method": "POST",
"help": "/v6.0/users?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| User ID | id | Integer | |
| Login | login | String | |
| Full name | full_name | String | First and last name |
| String | |||
| Address | address | String | |
| Access level | level | Integer | |
| Info | info | String | |
| Enabled mailer | mailer_enabled | Boolean | |
| Password reset | password_reset | Boolean | |
| Lock-out | lockout | Boolean | |
| Language of e-mails | language | Resource | |
| Enable single sign-on | enable_single_sign_on | Boolean | |
| Preferred session length | preferred_session_length | Integer | |
| Preferred logout all | preferred_logout_all | Boolean | |
| Last activity | last_activity_at | Datetime | |
| DokuWiki groups | dokuwiki_groups | String | Comma-separated list of DokuWiki groups |
| Created at | created_at | Datetime | |
| Object state | object_state | String | |
| Expiration | expiration_date | Datetime | A date after which the state will progress |
| Remind after | remind_after_date | Datetime | Mail warnings are silenced until this date |
| Monthly payment | monthly_payment | Integer | |
| Paid until | paid_until | Datetime |
{
"auth": true,
"description": "Get user that is authenticated during this request",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "User ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_activity_at": {
"required": false,
"label": "Last activity",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"dokuwiki_groups": {
"required": false,
"label": "DokuWiki groups",
"description": "Comma-separated list of DokuWiki groups",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"monthly_payment": {
"required": false,
"label": "Monthly payment",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"paid_until": {
"required": false,
"label": "Paid until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user"
},
"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": [
],
"scope": "user#current",
"path": "/v6.0/users/current",
"method": "GET",
"help": "/v6.0/users/current?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Object state | object_state | no | String | Include
|
soft_delete | |
| Expiration | expiration_date | no | Datetime | A date after which the state will progress | ||
| Remind after | remind_after_date | no | Datetime | Mail warnings are silenced until this date | ||
| Reason | change_reason | no | String | Reason for the state change. May be mailed to the user. |
No parameters.
{
"auth": true,
"description": null,
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": "soft_delete",
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": false,
"label": "Reason",
"description": "Reason for the state change. May be mailed to the user.",
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "user"
},
"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": [
],
"scope": "user#delete",
"path": "/v6.0/users/{user_id}",
"method": "DELETE",
"help": "/v6.0/users/{user_id}?method=DELETE"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Instructions | instructions | String |
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
"instructions": {
"required": false,
"label": "Instructions",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "user"
},
"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": [
],
"scope": "user#get_payment_instructions",
"path": "/v6.0/users/{user_id}/get_payment_instructions",
"method": "GET",
"help": "/v6.0/users/{user_id}/get_payment_instructions?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 | ||
| Login | login | no | String | Format
|
||
| Full name | full_name | no | String | First and last name | ||
| no | String | |||||
| Address | address | no | String | |||
| Access level | level | no | Integer | |||
| Info | info | no | String | |||
| Enabled mailer | mailer_enabled | no | Boolean | true | ||
| Password reset | password_reset | no | Boolean | |||
| Lock-out | lockout | no | Boolean | |||
| Language of e-mails | language | no | Resource | |||
| Enable single sign-on | enable_single_sign_on | no | Boolean | |||
| Preferred session length | preferred_session_length | no | Integer | |||
| Preferred logout all | preferred_logout_all | no | Boolean | |||
| Admin | admin | no | Boolean | Filter users with administrator privileges | ||
| Object state | object_state | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| User ID | id | Integer | |
| Login | login | String | |
| Full name | full_name | String | First and last name |
| String | |||
| Address | address | String | |
| Access level | level | Integer | |
| Info | info | String | |
| Enabled mailer | mailer_enabled | Boolean | |
| Password reset | password_reset | Boolean | |
| Lock-out | lockout | Boolean | |
| Language of e-mails | language | Resource | |
| Enable single sign-on | enable_single_sign_on | Boolean | |
| Preferred session length | preferred_session_length | Integer | |
| Preferred logout all | preferred_logout_all | Boolean | |
| Last activity | last_activity_at | Datetime | |
| DokuWiki groups | dokuwiki_groups | String | Comma-separated list of DokuWiki groups |
| Created at | created_at | Datetime | |
| Object state | object_state | String | |
| Expiration | expiration_date | Datetime | A date after which the state will progress |
| Remind after | remind_after_date | Datetime | Mail warnings are silenced until this date |
| Monthly payment | monthly_payment | Integer | |
| Paid until | paid_until | Datetime |
{
"auth": true,
"description": "List users",
"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
},
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9.-]{2,63}\\z",
"match": true,
"description": null,
"message": "not a valid login"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"admin": {
"required": false,
"label": "Admin",
"description": "Filter users with administrator privileges",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "User ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_activity_at": {
"required": false,
"label": "Last activity",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"dokuwiki_groups": {
"required": false,
"label": "DokuWiki groups",
"description": "Comma-separated list of DokuWiki groups",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"monthly_payment": {
"required": false,
"label": "Monthly payment",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"paid_until": {
"required": false,
"label": "Paid until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "users"
},
"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": [
],
"scope": "user#index",
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| User ID | id | Integer | |
| Login | login | String | |
| Full name | full_name | String | First and last name |
| String | |||
| Address | address | String | |
| Access level | level | Integer | |
| Info | info | String | |
| Enabled mailer | mailer_enabled | Boolean | |
| Password reset | password_reset | Boolean | |
| Lock-out | lockout | Boolean | |
| Language of e-mails | language | Resource | |
| Enable single sign-on | enable_single_sign_on | Boolean | |
| Preferred session length | preferred_session_length | Integer | |
| Preferred logout all | preferred_logout_all | Boolean | |
| Last activity | last_activity_at | Datetime | |
| DokuWiki groups | dokuwiki_groups | String | Comma-separated list of DokuWiki groups |
| Created at | created_at | Datetime | |
| Object state | object_state | String | |
| Expiration | expiration_date | Datetime | A date after which the state will progress |
| Remind after | remind_after_date | Datetime | Mail warnings are silenced until this date |
| Monthly payment | monthly_payment | Integer | |
| Paid until | paid_until | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "User ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_activity_at": {
"required": false,
"label": "Last activity",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"dokuwiki_groups": {
"required": false,
"label": "DokuWiki groups",
"description": "Comma-separated list of DokuWiki groups",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"monthly_payment": {
"required": false,
"label": "Monthly payment",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"paid_until": {
"required": false,
"label": "Paid until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user"
},
"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": [
],
"scope": "user#show",
"path": "/v6.0/users/{user_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}?method=GET"
}No parameters.
No parameters.
{
"auth": true,
"description": "Update last activity",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "user"
},
"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": [
],
"scope": "user#touch",
"path": "/v6.0/users/{user_id}/touch",
"method": "GET",
"help": "/v6.0/users/{user_id}/touch?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Login | login | no | String | Format
|
||
| Full name | full_name | no | String | First and last name | ||
| no | String | |||||
| Address | address | no | String | |||
| Access level | level | no | Integer | |||
| Info | info | no | String | |||
| Enabled mailer | mailer_enabled | no | Boolean | true | ||
| Password reset | password_reset | no | Boolean | |||
| Lock-out | lockout | no | Boolean | |||
| Language of e-mails | language | no | Resource | |||
| Enable single sign-on | enable_single_sign_on | no | Boolean | |||
| Preferred session length | preferred_session_length | no | Integer | |||
| Preferred logout all | preferred_logout_all | no | Boolean | |||
| Current password | password | no | String | The password must be at least 8 characters long | ||
| Password | new_password | no | String | The password must be at least 8 characters long | ||
| Object state | object_state | no | String | Include
|
||
| Expiration | expiration_date | no | Datetime | A date after which the state will progress | ||
| Remind after | remind_after_date | no | Datetime | Mail warnings are silenced until this date | ||
| Reason | change_reason | no | String | Reason for the state change. May be mailed to the user. |
| Label | Name | Type | Description |
|---|---|---|---|
| User ID | id | Integer | |
| Login | login | String | |
| Full name | full_name | String | First and last name |
| String | |||
| Address | address | String | |
| Access level | level | Integer | |
| Info | info | String | |
| Enabled mailer | mailer_enabled | Boolean | |
| Password reset | password_reset | Boolean | |
| Lock-out | lockout | Boolean | |
| Language of e-mails | language | Resource | |
| Enable single sign-on | enable_single_sign_on | Boolean | |
| Preferred session length | preferred_session_length | Integer | |
| Preferred logout all | preferred_logout_all | Boolean | |
| Last activity | last_activity_at | Datetime | |
| DokuWiki groups | dokuwiki_groups | String | Comma-separated list of DokuWiki groups |
| Created at | created_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9.-]{2,63}\\z",
"match": true,
"description": null,
"message": "not a valid login"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"password": {
"required": false,
"label": "Current password",
"description": "The password must be at least 8 characters long",
"type": "String",
"validators": {
},
"default": null,
"protected": true
},
"new_password": {
"required": false,
"label": "Password",
"description": "The password must be at least 8 characters long",
"type": "String",
"validators": {
},
"default": null,
"protected": true
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": false,
"label": "Reason",
"description": "Reason for the state change. May be mailed to the user.",
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "User ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": "First and last name",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"level": {
"required": false,
"label": "Access level",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mailer_enabled": {
"required": false,
"label": "Enabled mailer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"password_reset": {
"required": false,
"label": "Password reset",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lockout": {
"required": false,
"label": "Lock-out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"language": {
"required": null,
"label": "Language of e-mails",
"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"
}
},
"enable_single_sign_on": {
"required": false,
"label": "Enable single sign-on",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"preferred_session_length": {
"required": false,
"label": "Preferred session length",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"preferred_logout_all": {
"required": false,
"label": "Preferred logout all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_activity_at": {
"required": false,
"label": "Last activity",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"dokuwiki_groups": {
"required": false,
"label": "DokuWiki groups",
"description": "Comma-separated list of DokuWiki groups",
"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": "user"
},
"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": [
],
"scope": "user#update",
"path": "/v6.0/users/{user_id}",
"method": "PUT",
"help": "/v6.0/users/{user_id}?method=PUT"
}Manage user's cluster resources
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Environment | environment | no | Resource | |||
| ClusterResource | cluster_resource | no | Resource | |||
| Value | value | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment | environment | Resource | |
| ClusterResource | cluster_resource | Resource | |
| Value | value | Integer | |
| Used | used | Integer | Number of used resource units |
| Free | free | Integer | Number of free resource units |
{
"auth": true,
"description": "Create a cluster resource for user",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"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"
}
},
"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": "cluster_resource"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"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
},
"used": {
"required": false,
"label": "Used",
"description": "Number of used resource units",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"free": {
"required": false,
"label": "Free",
"description": "Number of free resource units ",
"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": [
],
"scope": "user.cluster_resource#create",
"path": "/v6.0/users/{user_id}/cluster_resources",
"method": "POST",
"help": "/v6.0/users/{user_id}/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 | ||
| Environment | environment | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment | environment | Resource | |
| ClusterResource | cluster_resource | Resource | |
| Value | value | Integer | |
| Used | used | Integer | Number of used resource units |
| Free | free | Integer | Number of free resource units |
{
"auth": true,
"description": "List user cluster 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
},
"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": "cluster_resource"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"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
},
"used": {
"required": false,
"label": "Used",
"description": "Number of used resource units",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"free": {
"required": false,
"label": "Free",
"description": "Number of free resource units ",
"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": [
],
"scope": "user.cluster_resource#index",
"path": "/v6.0/users/{user_id}/cluster_resources",
"method": "GET",
"help": "/v6.0/users/{user_id}/cluster_resources?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment | environment | Resource | |
| ClusterResource | cluster_resource | Resource | |
| Value | value | Integer | |
| Used | used | Integer | Number of used resource units |
| Free | free | Integer | Number of free resource units |
{
"auth": true,
"description": "Show user cluster 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
},
"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"
}
},
"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
},
"used": {
"required": false,
"label": "Used",
"description": "Number of used resource units",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"free": {
"required": false,
"label": "Free",
"description": "Number of free resource units ",
"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": [
],
"scope": "user.cluster_resource#show",
"path": "/v6.0/users/{user_id}/cluster_resources/{cluster_resource_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}/cluster_resources/{cluster_resource_id}?method=GET"
}User settings per environment
| 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 |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Environment | environment | Resource | |
| 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 |
| Default | default | Boolean | If true, the user config is inherited from the environment config |
{
"auth": true,
"description": "List settings per environment",
"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"
}
}
},
"layout": "object",
"namespace": "environment_config"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"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"
}
},
"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
},
"default": {
"required": false,
"label": "Default",
"description": "If true, the user config is inherited from the environment config",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object_list",
"namespace": "environment_configs"
},
"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": [
],
"scope": "user.environment_config#index",
"path": "/v6.0/users/{user_id}/environment_configs",
"method": "GET",
"help": "/v6.0/users/{user_id}/environment_configs?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| Environment | environment | Resource | |
| 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 |
| Default | default | Boolean | If true, the user config is inherited from the environment config |
{
"auth": true,
"description": "Show settings in an environment",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "environment_config"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "ID",
"description": null,
"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"
}
},
"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
},
"default": {
"required": false,
"label": "Default",
"description": "If true, the user config is inherited from the environment config",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "environment_config"
},
"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": [
],
"scope": "user.environment_config#show",
"path": "/v6.0/users/{user_id}/environment_configs/{environment_config_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}/environment_configs/{environment_config_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| 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 | |
| Default | default | no | Boolean | true | If true, the user config is inherited from the environment config |
No parameters.
{
"auth": true,
"description": "Change settings in an environment",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"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
},
"default": {
"required": false,
"label": "Default",
"description": "If true, the user config is inherited from the environment config",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "environment_config"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "environment_config"
},
"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": [
],
"scope": "user.environment_config#update",
"path": "/v6.0/users/{user_id}/environment_configs/{environment_config_id}",
"method": "PUT",
"help": "/v6.0/users/{user_id}/environment_configs/{environment_config_id}?method=PUT"
}Manage user mail recipients
| 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 | String | |
| Label | label | String | |
| Description | description | String | |
| To | to | String |
{
"auth": true,
"description": "List user mail role recipients",
"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": "mail_role_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "String",
"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
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "mail_role_recipients"
},
"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": [
],
"scope": "user.mail_role_recipient#index",
"path": "/v6.0/users/{user_id}/mail_role_recipients",
"method": "GET",
"help": "/v6.0/users/{user_id}/mail_role_recipients?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | String | |
| Label | label | String | |
| Description | description | String | |
| To | to | String |
{
"auth": true,
"description": "Show user mail role recipient",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mail_role_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "String",
"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
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_role_recipient"
},
"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": [
],
"scope": "user.mail_role_recipient#show",
"path": "/v6.0/users/{user_id}/mail_role_recipients/{mail_role_recipient_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}/mail_role_recipients/{mail_role_recipient_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| To | to | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | String | |
| Label | label | String | |
| Description | description | String | |
| To | to | String |
{
"auth": true,
"description": "Update user mail role recipient",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_role_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "String",
"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
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_role_recipient"
},
"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": [
],
"scope": "user.mail_role_recipient#update",
"path": "/v6.0/users/{user_id}/mail_role_recipients/{mail_role_recipient_id}",
"method": "PUT",
"help": "/v6.0/users/{user_id}/mail_role_recipients/{mail_role_recipient_id}?method=PUT"
}Manage user mail recipients
| 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 | String | |
| Label | label | String | |
| Description | description | String | |
| To | to | String | |
| Enabled | enabled | Boolean |
{
"auth": true,
"description": "List user mail template recipients",
"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": "mail_template_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "String",
"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
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "mail_template_recipients"
},
"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": [
],
"scope": "user.mail_template_recipient#index",
"path": "/v6.0/users/{user_id}/mail_template_recipients",
"method": "GET",
"help": "/v6.0/users/{user_id}/mail_template_recipients?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | String | |
| Label | label | String | |
| Description | description | String | |
| To | to | String | |
| Enabled | enabled | Boolean |
{
"auth": true,
"description": "Show user mail template recipient",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mail_template_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "String",
"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
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_template_recipient"
},
"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": [
],
"scope": "user.mail_template_recipient#show",
"path": "/v6.0/users/{user_id}/mail_template_recipients/{mail_template_recipient_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}/mail_template_recipients/{mail_template_recipient_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| To | to | no | String | |||
| Enabled | enabled | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | String | |
| Label | label | String | |
| Description | description | String | |
| To | to | String | |
| Enabled | enabled | Boolean |
{
"auth": true,
"description": "Update user mail template recipient",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_template_recipient"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "String",
"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
},
"to": {
"required": false,
"label": "To",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mail_template_recipient"
},
"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": [
],
"scope": "user.mail_template_recipient#update",
"path": "/v6.0/users/{user_id}/mail_template_recipients/{mail_template_recipient_id}",
"method": "PUT",
"help": "/v6.0/users/{user_id}/mail_template_recipients/{mail_template_recipient_id}?method=PUT"
}Manage public keys
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | yes | String | Present
Length
|
||
| Public key | key | yes | Text | Present
Format
Length
|
||
| Auto add | auto_add | no | Boolean | false | Add this key automatically into newly created VPS |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Public key | key | Text | |
| Auto add | auto_add | Boolean | Add this key automatically into newly created VPS |
| Fingerprint | fingerprint | String | MD5 fingerprint |
| Comment | comment | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime |
{
"auth": true,
"description": "Store a public key",
"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 maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"key": {
"required": true,
"label": "Public key",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"format": {
"rx": "\\A[^\\n]+\\z",
"match": true,
"description": null,
"message": "must not contain line breaks"
},
"length": {
"message": "length has to be maximally 5000",
"max": 5000
}
},
"default": null,
"protected": false
},
"auto_add": {
"required": false,
"label": "Auto add",
"description": "Add this key automatically into newly created VPS",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
}
},
"layout": "object",
"namespace": "public_key"
},
"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
},
"key": {
"required": false,
"label": "Public key",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"auto_add": {
"required": false,
"label": "Auto add",
"description": "Add this key automatically into newly created VPS",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"fingerprint": {
"required": false,
"label": "Fingerprint",
"description": "MD5 fingerprint",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "public_key"
},
"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": [
],
"scope": "user.public_key#create",
"path": "/v6.0/users/{user_id}/public_keys",
"method": "POST",
"help": "/v6.0/users/{user_id}/public_keys?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete public key",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "public_key"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "public_key"
},
"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": [
],
"scope": "user.public_key#delete",
"path": "/v6.0/users/{user_id}/public_keys/{public_key_id}",
"method": "DELETE",
"help": "/v6.0/users/{user_id}/public_keys/{public_key_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 | |
| Label | label | String | |
| Public key | key | Text | |
| Auto add | auto_add | Boolean | Add this key automatically into newly created VPS |
| Fingerprint | fingerprint | String | MD5 fingerprint |
| Comment | comment | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime |
{
"auth": true,
"description": "List saved public keys",
"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": "public_key"
},
"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
},
"key": {
"required": false,
"label": "Public key",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"auto_add": {
"required": false,
"label": "Auto add",
"description": "Add this key automatically into newly created VPS",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"fingerprint": {
"required": false,
"label": "Fingerprint",
"description": "MD5 fingerprint",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "public_keys"
},
"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": [
],
"scope": "user.public_key#index",
"path": "/v6.0/users/{user_id}/public_keys",
"method": "GET",
"help": "/v6.0/users/{user_id}/public_keys?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Public key | key | Text | |
| Auto add | auto_add | Boolean | Add this key automatically into newly created VPS |
| Fingerprint | fingerprint | String | MD5 fingerprint |
| Comment | comment | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime |
{
"auth": true,
"description": "Show saved public key",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "public_key"
},
"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
},
"key": {
"required": false,
"label": "Public key",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"auto_add": {
"required": false,
"label": "Auto add",
"description": "Add this key automatically into newly created VPS",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"fingerprint": {
"required": false,
"label": "Fingerprint",
"description": "MD5 fingerprint",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "public_key"
},
"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": [
],
"scope": "user.public_key#show",
"path": "/v6.0/users/{user_id}/public_keys/{public_key_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}/public_keys/{public_key_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | Length
|
||
| Public key | key | no | Text | Format
Length
|
||
| Auto add | auto_add | no | Boolean | Add this key automatically into newly created VPS |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Public key | key | Text | |
| Auto add | auto_add | Boolean | Add this key automatically into newly created VPS |
| Fingerprint | fingerprint | String | MD5 fingerprint |
| Comment | comment | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime |
{
"auth": true,
"description": "Update a public key",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"key": {
"required": false,
"label": "Public key",
"description": null,
"type": "Text",
"validators": {
"format": {
"rx": "\\A[^\\n]+\\z",
"match": true,
"description": null,
"message": "must not contain line breaks"
},
"length": {
"message": "length has to be maximally 5000",
"max": 5000
}
},
"default": null,
"protected": false
},
"auto_add": {
"required": false,
"label": "Auto add",
"description": "Add this key automatically into newly created VPS",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "public_key"
},
"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
},
"key": {
"required": false,
"label": "Public key",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"auto_add": {
"required": false,
"label": "Auto add",
"description": "Add this key automatically into newly created VPS",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"fingerprint": {
"required": false,
"label": "Fingerprint",
"description": "MD5 fingerprint",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "public_key"
},
"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": [
],
"scope": "user.public_key#update",
"path": "/v6.0/users/{user_id}/public_keys/{public_key_id}",
"method": "PUT",
"help": "/v6.0/users/{user_id}/public_keys/{public_key_id}?method=PUT"
}Browse object's state log
| 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 | |
| State | state | String | |
| Changed_at | changed_at | Datetime | |
| Expiration | expiration | Datetime | |
| Remind_after | remind_after | Datetime | |
| User | user | Resource | |
| Reason | reason | Text |
{
"auth": true,
"description": "List object state changes",
"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": "state_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"changed_at": {
"required": false,
"label": "Changed_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"expiration": {
"required": false,
"label": "Expiration",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after": {
"required": false,
"label": "Remind_after",
"description": null,
"type": "Datetime",
"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"
}
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "state_logs"
},
"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": [
],
"scope": "user.state_log#index",
"path": "/v6.0/users/{user_id}/state_logs",
"method": "GET",
"help": "/v6.0/users/{user_id}/state_logs?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| Changed_at | changed_at | Datetime | |
| Expiration | expiration | Datetime | |
| Remind_after | remind_after | Datetime | |
| User | user | Resource | |
| Reason | reason | Text |
{
"auth": true,
"description": "Show object state change",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "state_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"changed_at": {
"required": false,
"label": "Changed_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"expiration": {
"required": false,
"label": "Expiration",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after": {
"required": false,
"label": "Remind_after",
"description": null,
"type": "Datetime",
"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"
}
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "state_log"
},
"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": [
],
"scope": "user.state_log#show",
"path": "/v6.0/users/{user_id}/state_logs/{state_log_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}/state_logs/{state_log_id}?method=GET"
}Manage TOTP devices
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| TOTP code | code | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Recovery_code | recovery_code | String |
{
"auth": true,
"description": "Confirm device",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"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": "totp_device"
},
"output": {
"parameters": {
"recovery_code": {
"required": false,
"label": "Recovery_code",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "totp_device"
},
"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": [
],
"scope": "user.totp_device#confirm",
"path": "/v6.0/users/{user_id}/totp_devices/{totp_device_id}/confirm",
"method": "POST",
"help": "/v6.0/users/{user_id}/totp_devices/{totp_device_id}/confirm?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Confirmed | confirmed | Boolean | |
| Enabled | enabled | Boolean | |
| Last_use_at | last_use_at | Datetime | |
| Use_count | use_count | Integer | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime | |
| Secret | secret | String | |
| Provisioning_uri | provisioning_uri | String |
{
"auth": true,
"description": "Create a new TOTP device",
"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"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "totp_device"
},
"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
},
"confirmed": {
"required": false,
"label": "Confirmed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_use_at": {
"required": false,
"label": "Last_use_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"use_count": {
"required": false,
"label": "Use_count",
"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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"secret": {
"required": false,
"label": "Secret",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"provisioning_uri": {
"required": false,
"label": "Provisioning_uri",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "totp_device"
},
"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": [
],
"scope": "user.totp_device#create",
"path": "/v6.0/users/{user_id}/totp_devices",
"method": "POST",
"help": "/v6.0/users/{user_id}/totp_devices?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete TOTP device",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "totp_device"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "totp_device"
},
"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": [
],
"scope": "user.totp_device#delete",
"path": "/v6.0/users/{user_id}/totp_devices/{totp_device_id}",
"method": "DELETE",
"help": "/v6.0/users/{user_id}/totp_devices/{totp_device_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 | ||
| Confirmed | confirmed | no | Boolean | |||
| Enabled | enabled | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Confirmed | confirmed | Boolean | |
| Enabled | enabled | Boolean | |
| Last_use_at | last_use_at | Datetime | |
| Use_count | use_count | Integer | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List configured TOTP devices",
"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
},
"confirmed": {
"required": false,
"label": "Confirmed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "totp_device"
},
"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
},
"confirmed": {
"required": false,
"label": "Confirmed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_use_at": {
"required": false,
"label": "Last_use_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"use_count": {
"required": false,
"label": "Use_count",
"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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "totp_devices"
},
"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": [
],
"scope": "user.totp_device#index",
"path": "/v6.0/users/{user_id}/totp_devices",
"method": "GET",
"help": "/v6.0/users/{user_id}/totp_devices?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Confirmed | confirmed | Boolean | |
| Enabled | enabled | Boolean | |
| Last_use_at | last_use_at | Datetime | |
| Use_count | use_count | Integer | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show configured TOTP device",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "totp_device"
},
"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
},
"confirmed": {
"required": false,
"label": "Confirmed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_use_at": {
"required": false,
"label": "Last_use_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"use_count": {
"required": false,
"label": "Use_count",
"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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "totp_device"
},
"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": [
],
"scope": "user.totp_device#show",
"path": "/v6.0/users/{user_id}/totp_devices/{totp_device_id}",
"method": "GET",
"help": "/v6.0/users/{user_id}/totp_devices/{totp_device_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | no | String | |||
| Enabled | enabled | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Label | label | String | |
| Confirmed | confirmed | Boolean | |
| Enabled | enabled | Boolean | |
| Last_use_at | last_use_at | Datetime | |
| Use_count | use_count | Integer | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update device label",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "totp_device"
},
"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
},
"confirmed": {
"required": false,
"label": "Confirmed",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"last_use_at": {
"required": false,
"label": "Last_use_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"use_count": {
"required": false,
"label": "Use_count",
"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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "totp_device"
},
"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": [
],
"scope": "user.totp_device#update",
"path": "/v6.0/users/{user_id}/totp_devices/{totp_device_id}",
"method": "PUT",
"help": "/v6.0/users/{user_id}/totp_devices/{totp_device_id}?method=PUT"
}Manage user's payment settings
| 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 | |
| Monthly_payment | monthly_payment | Integer | |
| Paid_until | paid_until | Datetime |
{
"auth": true,
"description": "List user accounts",
"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": "user_account"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"monthly_payment": {
"required": false,
"label": "Monthly_payment",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"paid_until": {
"required": false,
"label": "Paid_until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "user_accounts"
},
"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": [
],
"scope": "user_account#index",
"path": "/v6.0/user_accounts",
"method": "GET",
"help": "/v6.0/user_accounts?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Monthly_payment | monthly_payment | Integer | |
| Paid_until | paid_until | Datetime |
{
"auth": true,
"description": "Show user account",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_account"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"monthly_payment": {
"required": false,
"label": "Monthly_payment",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"paid_until": {
"required": false,
"label": "Paid_until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_account"
},
"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": [
],
"scope": "user_account#show",
"path": "/v6.0/user_accounts/{user_account_id}",
"method": "GET",
"help": "/v6.0/user_accounts/{user_account_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Monthly_payment | monthly_payment | no | Integer | |||
| Paid_until | paid_until | no | Datetime |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Monthly_payment | monthly_payment | Integer | |
| Paid_until | paid_until | Datetime |
{
"auth": true,
"description": "Update user account",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"monthly_payment": {
"required": false,
"label": "Monthly_payment",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"paid_until": {
"required": false,
"label": "Paid_until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_account"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"monthly_payment": {
"required": false,
"label": "Monthly_payment",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"paid_until": {
"required": false,
"label": "Paid_until",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_account"
},
"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": [
],
"scope": "user_account#update",
"path": "/v6.0/user_accounts/{user_account_id}",
"method": "PUT",
"help": "/v6.0/user_accounts/{user_account_id}?method=PUT"
}Manage user cluster resource packages
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Environment | environment | yes | Resource | |||
| User | user | yes | Resource | |||
| ClusterResourcePackage | cluster_resource_package | yes | Resource | |||
| Comment | comment | yes | Text | Present
|
||
| From personal package | from_personal | no | Boolean | false | Substract the added resources from the personal package |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment | environment | Resource | |
| User | user | Resource | |
| ClusterResourcePackage | cluster_resource_package | Resource | |
| Added_by | added_by | Resource | |
| Label | label | String | |
| Is_personal | is_personal | Boolean | |
| Comment | comment | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Assign cluster resource package to user",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"environment": {
"required": true,
"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": true,
"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"
}
},
"cluster_resource_package": {
"required": true,
"label": "ClusterResourcePackage",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource_package"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resource_packages",
"method": "GET",
"help": "/v6.0/cluster_resource_packages?method=GET"
}
},
"comment": {
"required": true,
"label": "Comment",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"from_personal": {
"required": false,
"label": "From personal package",
"description": "Substract the added resources from the personal package",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
}
},
"layout": "object",
"namespace": "user_cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"cluster_resource_package": {
"required": null,
"label": "ClusterResourcePackage",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource_package"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resource_packages",
"method": "GET",
"help": "/v6.0/cluster_resource_packages?method=GET"
}
},
"added_by": {
"required": null,
"label": "Added_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_personal": {
"required": false,
"label": "Is_personal",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"comment": {
"required": false,
"label": "Comment",
"description": null,
"type": "Text",
"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": "user_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": [
],
"scope": "user_cluster_resource_package#create",
"path": "/v6.0/user_cluster_resource_packages",
"method": "POST",
"help": "/v6.0/user_cluster_resource_packages?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Remove cluster resource package from user",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_cluster_resource_package"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "user_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": [
],
"scope": "user_cluster_resource_package#delete",
"path": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}",
"method": "DELETE",
"help": "/v6.0/user_cluster_resource_packages/{user_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 | |||
| ClusterResourcePackage | cluster_resource_package | no | Resource | |||
| Added_by | added_by | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment | environment | Resource | |
| User | user | Resource | |
| ClusterResourcePackage | cluster_resource_package | Resource | |
| Added_by | added_by | Resource | |
| Label | label | String | |
| Is_personal | is_personal | Boolean | |
| Comment | comment | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "List user 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"
}
},
"cluster_resource_package": {
"required": null,
"label": "ClusterResourcePackage",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource_package"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resource_packages",
"method": "GET",
"help": "/v6.0/cluster_resource_packages?method=GET"
}
},
"added_by": {
"required": null,
"label": "Added_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"
}
}
},
"layout": "object",
"namespace": "user_cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"cluster_resource_package": {
"required": null,
"label": "ClusterResourcePackage",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource_package"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resource_packages",
"method": "GET",
"help": "/v6.0/cluster_resource_packages?method=GET"
}
},
"added_by": {
"required": null,
"label": "Added_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_personal": {
"required": false,
"label": "Is_personal",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"comment": {
"required": false,
"label": "Comment",
"description": null,
"type": "Text",
"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": "user_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": [
],
"scope": "user_cluster_resource_package#index",
"path": "/v6.0/user_cluster_resource_packages",
"method": "GET",
"help": "/v6.0/user_cluster_resource_packages?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment | environment | Resource | |
| User | user | Resource | |
| ClusterResourcePackage | cluster_resource_package | Resource | |
| Added_by | added_by | Resource | |
| Label | label | String | |
| Is_personal | is_personal | Boolean | |
| Comment | comment | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Show user cluster resource package",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"cluster_resource_package": {
"required": null,
"label": "ClusterResourcePackage",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource_package"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resource_packages",
"method": "GET",
"help": "/v6.0/cluster_resource_packages?method=GET"
}
},
"added_by": {
"required": null,
"label": "Added_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_personal": {
"required": false,
"label": "Is_personal",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"comment": {
"required": false,
"label": "Comment",
"description": null,
"type": "Text",
"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": "user_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": [
],
"scope": "user_cluster_resource_package#show",
"path": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}",
"method": "GET",
"help": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Comment | comment | yes | Text | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Environment | environment | Resource | |
| User | user | Resource | |
| ClusterResourcePackage | cluster_resource_package | Resource | |
| Added_by | added_by | Resource | |
| Label | label | String | |
| Is_personal | is_personal | Boolean | |
| Comment | comment | Text | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": "Update user cluster resource package",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"comment": {
"required": true,
"label": "Comment",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_cluster_resource_package"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"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"
}
},
"cluster_resource_package": {
"required": null,
"label": "ClusterResourcePackage",
"description": null,
"type": "Resource",
"resource": [
"cluster_resource_package"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/cluster_resource_packages",
"method": "GET",
"help": "/v6.0/cluster_resource_packages?method=GET"
}
},
"added_by": {
"required": null,
"label": "Added_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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"is_personal": {
"required": false,
"label": "Is_personal",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"comment": {
"required": false,
"label": "Comment",
"description": null,
"type": "Text",
"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": "user_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": [
],
"scope": "user_cluster_resource_package#update",
"path": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}",
"method": "PUT",
"help": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}?method=PUT"
}View user cluster resource package contents
| 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 user 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": [
],
"scope": "user_cluster_resource_package.item#index",
"path": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}/items",
"method": "GET",
"help": "/v6.0/user_cluster_resource_packages/{user_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": [
],
"scope": "user_cluster_resource_package.item#show",
"path": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}/items/{item_id}",
"method": "GET",
"help": "/v6.0/user_cluster_resource_packages/{user_cluster_resource_package_id}/items/{item_id}?method=GET"
}Browse user namespaces
| 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 | |||
| Block count | block_count | no | Integer | |||
| Size | size | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| User | user | Resource | |
| Offset | offset | Integer | |
| Block count | block_count | Integer | |
| Size | size | Integer |
{
"auth": true,
"description": "List user namespaces",
"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"
}
},
"block_count": {
"required": false,
"label": "Block count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_namespace"
},
"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"
}
},
"offset": {
"required": false,
"label": "Offset",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"block_count": {
"required": false,
"label": "Block count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "user_namespaces"
},
"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": [
],
"scope": "user_namespace#index",
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| ID | id | Integer | |
| User | user | Resource | |
| Offset | offset | Integer | |
| Block count | block_count | Integer | |
| Size | size | Integer |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_namespace"
},
"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"
}
},
"offset": {
"required": false,
"label": "Offset",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"block_count": {
"required": false,
"label": "Block count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"size": {
"required": false,
"label": "Size",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_namespace"
},
"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": [
],
"scope": "user_namespace#show",
"path": "/v6.0/user_namespaces/{user_namespace_id}",
"method": "GET",
"help": "/v6.0/user_namespaces/{user_namespace_id}?method=GET"
}Browse user namespace maps
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| UserNamespace | user_namespace | yes | Resource | |||
| Label | label | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Map ID | id | Integer | |
| UserNamespace | user_namespace | Resource | |
| Label | label | String |
{
"auth": true,
"description": "Create user namespace map",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"user_namespace": {
"required": true,
"label": "UserNamespace",
"description": null,
"type": "Resource",
"resource": [
"user_namespace"
],
"value_id": "id",
"value_label": "id",
"value": null,
"choices": {
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}
},
"label": {
"required": true,
"label": "Label",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_namespace_map"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Map ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_namespace": {
"required": null,
"label": "UserNamespace",
"description": null,
"type": "Resource",
"resource": [
"user_namespace"
],
"value_id": "id",
"value_label": "id",
"value": null,
"choices": {
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_namespace_map"
},
"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": [
],
"scope": "user_namespace_map#create",
"path": "/v6.0/user_namespace_maps",
"method": "POST",
"help": "/v6.0/user_namespace_maps?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete user namespace map",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_namespace_map"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "user_namespace_map"
},
"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": [
],
"scope": "user_namespace_map#delete",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}",
"method": "DELETE",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_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 | |||
| UserNamespace | user_namespace | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Map ID | id | Integer | |
| UserNamespace | user_namespace | Resource | |
| Label | label | String |
{
"auth": true,
"description": "List user namespace maps",
"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"
}
},
"user_namespace": {
"required": null,
"label": "UserNamespace",
"description": null,
"type": "Resource",
"resource": [
"user_namespace"
],
"value_id": "id",
"value_label": "id",
"value": null,
"choices": {
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}
}
},
"layout": "object",
"namespace": "user_namespace_map"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Map ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_namespace": {
"required": null,
"label": "UserNamespace",
"description": null,
"type": "Resource",
"resource": [
"user_namespace"
],
"value_id": "id",
"value_label": "id",
"value": null,
"choices": {
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "user_namespace_maps"
},
"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": [
],
"scope": "user_namespace_map#index",
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Map ID | id | Integer | |
| UserNamespace | user_namespace | Resource | |
| Label | label | String |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_namespace_map"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Map ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_namespace": {
"required": null,
"label": "UserNamespace",
"description": null,
"type": "Resource",
"resource": [
"user_namespace"
],
"value_id": "id",
"value_label": "id",
"value": null,
"choices": {
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_namespace_map"
},
"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": [
],
"scope": "user_namespace_map#show",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}",
"method": "GET",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| UserNamespace | user_namespace | yes | Resource | |||
| Label | label | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Map ID | id | Integer | |
| UserNamespace | user_namespace | Resource | |
| Label | label | String |
{
"auth": true,
"description": "Edit user namespace map",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"user_namespace": {
"required": true,
"label": "UserNamespace",
"description": null,
"type": "Resource",
"resource": [
"user_namespace"
],
"value_id": "id",
"value_label": "id",
"value": null,
"choices": {
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}
},
"label": {
"required": true,
"label": "Label",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_namespace_map"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Map ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user_namespace": {
"required": null,
"label": "UserNamespace",
"description": null,
"type": "Resource",
"resource": [
"user_namespace"
],
"value_id": "id",
"value_label": "id",
"value": null,
"choices": {
"path": "/v6.0/user_namespaces",
"method": "GET",
"help": "/v6.0/user_namespaces?method=GET"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_namespace_map"
},
"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": [
],
"scope": "user_namespace_map#update",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}",
"method": "PUT",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_id}?method=PUT"
}Browse user namespace map entries
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Kind | kind | yes | String | Include
Present
|
||
| Vps_id | vps_id | yes | Integer | Present
Number
|
Beginning of the ID range within VPS | |
| Ns_id | ns_id | yes | Integer | Present
Number
|
Beginning of the ID range within the user namespace | |
| Count | count | yes | Integer | Present
Number
|
Number of mapped IDs |
| Label | Name | Type | Description |
|---|---|---|---|
| Entry ID | id | Integer | |
| Kind | kind | String | |
| Vps_id | vps_id | Integer | Beginning of the ID range within VPS |
| Ns_id | ns_id | Integer | Beginning of the ID range within the user namespace |
| Count | count | Integer | Number of mapped IDs |
{
"auth": true,
"description": "Create a new map entry",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"kind": {
"required": true,
"label": "Kind",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"uid",
"gid"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"vps_id": {
"required": true,
"label": "Vps_id",
"description": "Beginning of the ID range within VPS",
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": null,
"protected": false
},
"ns_id": {
"required": true,
"label": "Ns_id",
"description": "Beginning of the ID range within the user namespace",
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": null,
"protected": false
},
"count": {
"required": true,
"label": "Count",
"description": "Number of mapped IDs",
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"number": {
"message": "has to be minimally 1",
"min": 1
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entry"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Entry ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"kind": {
"required": false,
"label": "Kind",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"uid",
"gid"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"vps_id": {
"required": false,
"label": "Vps_id",
"description": "Beginning of the ID range within VPS",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ns_id": {
"required": false,
"label": "Ns_id",
"description": "Beginning of the ID range within the user namespace",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"description": "Number of mapped IDs",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entry"
},
"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": [
],
"scope": "user_namespace_map.entry#create",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries",
"method": "POST",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete map entry",
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "entry"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "entry"
},
"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": [
],
"scope": "user_namespace_map.entry#delete",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}",
"method": "DELETE",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_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 |
|---|---|---|---|
| Entry ID | id | Integer | |
| Kind | kind | String | |
| Vps_id | vps_id | Integer | Beginning of the ID range within VPS |
| Ns_id | ns_id | Integer | Beginning of the ID range within the user namespace |
| Count | count | Integer | Number of mapped IDs |
{
"auth": true,
"description": "List map entries",
"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": "entry"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Entry ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"kind": {
"required": false,
"label": "Kind",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"uid",
"gid"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"vps_id": {
"required": false,
"label": "Vps_id",
"description": "Beginning of the ID range within VPS",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ns_id": {
"required": false,
"label": "Ns_id",
"description": "Beginning of the ID range within the user namespace",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"description": "Number of mapped IDs",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "entries"
},
"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": [
],
"scope": "user_namespace_map.entry#index",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries",
"method": "GET",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Entry ID | id | Integer | |
| Kind | kind | String | |
| Vps_id | vps_id | Integer | Beginning of the ID range within VPS |
| Ns_id | ns_id | Integer | Beginning of the ID range within the user namespace |
| Count | count | Integer | Number of mapped IDs |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "entry"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Entry ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"kind": {
"required": false,
"label": "Kind",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"uid",
"gid"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"vps_id": {
"required": false,
"label": "Vps_id",
"description": "Beginning of the ID range within VPS",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ns_id": {
"required": false,
"label": "Ns_id",
"description": "Beginning of the ID range within the user namespace",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"description": "Number of mapped IDs",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entry"
},
"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": [
],
"scope": "user_namespace_map.entry#show",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}",
"method": "GET",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Vps_id | vps_id | no | Integer | Number
|
Beginning of the ID range within VPS | |
| Ns_id | ns_id | no | Integer | Number
|
Beginning of the ID range within the user namespace | |
| Count | count | no | Integer | Number
|
Number of mapped IDs |
| Label | Name | Type | Description |
|---|---|---|---|
| Entry ID | id | Integer | |
| Kind | kind | String | |
| Vps_id | vps_id | Integer | Beginning of the ID range within VPS |
| Ns_id | ns_id | Integer | Beginning of the ID range within the user namespace |
| Count | count | Integer | Number of mapped IDs |
{
"auth": true,
"description": "Edit map entry",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"vps_id": {
"required": false,
"label": "Vps_id",
"description": "Beginning of the ID range within VPS",
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": null,
"protected": false
},
"ns_id": {
"required": false,
"label": "Ns_id",
"description": "Beginning of the ID range within the user namespace",
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"description": "Number of mapped IDs",
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 1",
"min": 1
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entry"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Entry ID",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"kind": {
"required": false,
"label": "Kind",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"uid",
"gid"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"vps_id": {
"required": false,
"label": "Vps_id",
"description": "Beginning of the ID range within VPS",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ns_id": {
"required": false,
"label": "Ns_id",
"description": "Beginning of the ID range within the user namespace",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"count": {
"required": false,
"label": "Count",
"description": "Number of mapped IDs",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "entry"
},
"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": [
],
"scope": "user_namespace_map.entry#update",
"path": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}",
"method": "PUT",
"help": "/v6.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}?method=PUT"
}Browse users 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 | |||
| User | user | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| User | user | Resource | |
| Vps_count | vps_count | Integer | |
| Export_count | export_count | Integer |
{
"auth": true,
"description": "List users 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"
}
},
"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": "user_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"
}
},
"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_count": {
"required": false,
"label": "Vps_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"export_count": {
"required": false,
"label": "Export_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "user_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": [
],
"scope": "user_outage#index",
"path": "/v6.0/user_outages",
"method": "GET",
"help": "/v6.0/user_outages?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| User | user | Resource | |
| Vps_count | vps_count | Integer | |
| Export_count | export_count | Integer |
{
"auth": true,
"description": "Show user affected by an outage",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_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"
}
},
"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_count": {
"required": false,
"label": "Vps_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"export_count": {
"required": false,
"label": "Export_count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_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": [
],
"scope": "user_outage#show",
"path": "/v6.0/user_outages/{user_outage_id}",
"method": "GET",
"help": "/v6.0/user_outages/{user_outage_id}?method=GET"
}Manage user's payment settings
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| IncomingPayment | incoming_payment | no | Resource | |||
| User | user | yes | Resource | |||
| Amount | amount | no | Integer | Number
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| IncomingPayment | incoming_payment | Resource | |
| User | user | Resource | |
| Amount | amount | Integer | |
| Accounted_by | accounted_by | Resource | |
| From_date | from_date | Datetime | |
| To_date | to_date | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Create a user payment",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"incoming_payment": {
"required": null,
"label": "IncomingPayment",
"description": null,
"type": "Resource",
"resource": [
"incoming_payment"
],
"value_id": "id",
"value_label": "transaction_id",
"value": null,
"choices": {
"path": "/v6.0/incoming_payments",
"method": "GET",
"help": "/v6.0/incoming_payments?method=GET"
}
},
"user": {
"required": true,
"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"
}
},
"amount": {
"required": false,
"label": "Amount",
"description": null,
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 1",
"min": 1
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_payment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"incoming_payment": {
"required": null,
"label": "IncomingPayment",
"description": null,
"type": "Resource",
"resource": [
"incoming_payment"
],
"value_id": "id",
"value_label": "transaction_id",
"value": null,
"choices": {
"path": "/v6.0/incoming_payments",
"method": "GET",
"help": "/v6.0/incoming_payments?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"
}
},
"amount": {
"required": false,
"label": "Amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"accounted_by": {
"required": null,
"label": "Accounted_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"
}
},
"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
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_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": {
"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": [
],
"scope": "user_payment#create",
"path": "/v6.0/user_payments",
"method": "POST",
"help": "/v6.0/user_payments?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 | |||
| Accounted_by | accounted_by | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| IncomingPayment | incoming_payment | Resource | |
| User | user | Resource | |
| Amount | amount | Integer | |
| Accounted_by | accounted_by | Resource | |
| From_date | from_date | Datetime | |
| To_date | to_date | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "List user 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": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
},
"accounted_by": {
"required": null,
"label": "Accounted_by",
"description": null,
"type": "Resource",
"resource": [
"user"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users",
"method": "GET",
"help": "/v6.0/users?method=GET"
}
}
},
"layout": "object",
"namespace": "user_payment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"incoming_payment": {
"required": null,
"label": "IncomingPayment",
"description": null,
"type": "Resource",
"resource": [
"incoming_payment"
],
"value_id": "id",
"value_label": "transaction_id",
"value": null,
"choices": {
"path": "/v6.0/incoming_payments",
"method": "GET",
"help": "/v6.0/incoming_payments?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"
}
},
"amount": {
"required": false,
"label": "Amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"accounted_by": {
"required": null,
"label": "Accounted_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"
}
},
"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
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "user_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": [
],
"scope": "user_payment#index",
"path": "/v6.0/user_payments",
"method": "GET",
"help": "/v6.0/user_payments?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| IncomingPayment | incoming_payment | Resource | |
| User | user | Resource | |
| Amount | amount | Integer | |
| Accounted_by | accounted_by | Resource | |
| From_date | from_date | Datetime | |
| To_date | to_date | Datetime | |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": "Show user payment",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_payment"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"incoming_payment": {
"required": null,
"label": "IncomingPayment",
"description": null,
"type": "Resource",
"resource": [
"incoming_payment"
],
"value_id": "id",
"value_label": "transaction_id",
"value": null,
"choices": {
"path": "/v6.0/incoming_payments",
"method": "GET",
"help": "/v6.0/incoming_payments?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"
}
},
"amount": {
"required": false,
"label": "Amount",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"accounted_by": {
"required": null,
"label": "Accounted_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"
}
},
"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
},
"created_at": {
"required": false,
"label": "Created_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_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": [
],
"scope": "user_payment#show",
"path": "/v6.0/user_payments/{user_payment_id}",
"method": "GET",
"help": "/v6.0/user_payments/{user_payment_id}?method=GET"
}Request change of personal information
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Change reason | change_reason | yes | String | Present
Length
|
Why do you wish to make the change? | |
| Full name | full_name | no | String | Length
|
||
| no | String | Format
|
||||
| Address | address | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| State | state | String | |
| API IP address | api_ip_addr | String | |
| API IP PTR | api_ip_ptr | String | |
| Client IP address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| Admin | admin | Resource | |
| Admin's response | admin_response | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | |
| Label | label | String | |
| Change reason | change_reason | String | Why do you wish to make the change? |
| Full name | full_name | String | |
| String | |||
| Address | address | String |
{
"auth": true,
"description": null,
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"change_reason": {
"required": true,
"label": "Change reason",
"description": "Why do you wish to make the change?",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be minimally 2",
"min": 2
}
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "@",
"match": true,
"description": null,
"message": "not a valid e-mail address"
}
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "change"
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "API IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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"
}
},
"admin_response": {
"required": false,
"label": "Admin's response",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": true,
"label": "Change reason",
"description": "Why do you wish to make the change?",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "change"
},
"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": [
],
"scope": "user_request.change#create",
"path": "/v6.0/user_request/changes",
"method": "POST",
"help": "/v6.0/user_request/changes?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 | |||
| State | state | no | String | Include
|
||
| API IP address | api_ip_addr | no | String | |||
| Client IP address | client_ip_addr | no | String | |||
| Client IP PTR | client_ip_ptr | no | String | |||
| Admin | admin | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| State | state | String | |
| API IP address | api_ip_addr | String | |
| API IP PTR | api_ip_ptr | String | |
| Client IP address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| Admin | admin | Resource | |
| Admin's response | admin_response | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | |
| Label | label | String | |
| Change reason | change_reason | String | Why do you wish to make the change? |
| Full name | full_name | String | |
| String | |||
| Address | address | String |
{
"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
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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": "change"
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "API IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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"
}
},
"admin_response": {
"required": false,
"label": "Admin's response",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": true,
"label": "Change reason",
"description": "Why do you wish to make the change?",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "changes"
},
"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": [
],
"scope": "user_request.change#index",
"path": "/v6.0/user_request/changes",
"method": "GET",
"help": "/v6.0/user_request/changes?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Action | action | yes | String | Include
Present
|
||
| Reason | reason | no | Text | |||
| Change reason | change_reason | no | String | Length
|
Why do you wish to make the change? | |
| Full name | full_name | no | String | Length
|
||
| no | String | Format
|
||||
| Address | address | no | String |
No parameters.
{
"auth": true,
"description": "Resolve user request",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"action": {
"required": true,
"label": "Action",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"approve",
"deny",
"ignore",
"request_correction"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": false,
"label": "Change reason",
"description": "Why do you wish to make the change?",
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be minimally 2",
"min": 2
}
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "@",
"match": true,
"description": null,
"message": "not a valid e-mail address"
}
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "change"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "change"
},
"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": [
],
"scope": "user_request.change#resolve",
"path": "/v6.0/user_request/changes/{change_id}/resolve",
"method": "POST",
"help": "/v6.0/user_request/changes/{change_id}/resolve?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| State | state | String | |
| API IP address | api_ip_addr | String | |
| API IP PTR | api_ip_ptr | String | |
| Client IP address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| Admin | admin | Resource | |
| Admin's response | admin_response | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | |
| Label | label | String | |
| Change reason | change_reason | String | Why do you wish to make the change? |
| Full name | full_name | String | |
| String | |||
| Address | address | String |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "change"
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "API IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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"
}
},
"admin_response": {
"required": false,
"label": "Admin's response",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": true,
"label": "Change reason",
"description": "Why do you wish to make the change?",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "change"
},
"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": [
],
"scope": "user_request.change#show",
"path": "/v6.0/user_request/changes/{change_id}",
"method": "GET",
"help": "/v6.0/user_request/changes/{change_id}?method=GET"
}Request account registration
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Login | login | yes | String | Present
Format
|
||
| Full name | full_name | yes | String | Present
Length
|
||
| Organization name | org_name | no | String | Length
|
||
| Organization ID | org_id | no | String | Length
|
||
| yes | String | Present
Length
Format
|
||||
| Address | address | yes | Text | Present
Length
|
||
| Year of birth | year_of_birth | yes | Integer | Present
|
||
| How did you learn about us? | how | no | String | Length
|
||
| Notes | note | no | String | Length
|
||
| Distribution | os_template | yes | Resource | |||
| Location | location | yes | Resource | |||
| Currency | currency | yes | String | Include
Present
Length
|
||
| Language | language | yes | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| State | state | String | |
| API IP address | api_ip_addr | String | |
| API IP PTR | api_ip_ptr | String | |
| Client IP address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| Admin | admin | Resource | |
| Admin's response | admin_response | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | |
| Label | label | String | |
| Login | login | String | |
| Full name | full_name | String | |
| Organization name | org_name | String | |
| Organization ID | org_id | String | |
| String | |||
| Address | address | Text | |
| Year of birth | year_of_birth | Integer | |
| How did you learn about us? | how | String | |
| Notes | note | String | |
| Distribution | os_template | Resource | |
| Location | location | Resource | |
| Currency | currency | String | |
| Language | language | Resource | |
| Ip_checked | ip_checked | Boolean | |
| Ip_request_id | ip_request_id | String | |
| Ip_success | ip_success | Boolean | |
| Ip_message | ip_message | String | |
| Ip_errors | ip_errors | String | |
| Ip_proxy | ip_proxy | Boolean | |
| Ip_crawler | ip_crawler | Boolean | |
| Ip_recent_abuse | ip_recent_abuse | Boolean | |
| Ip_vpn | ip_vpn | Boolean | |
| Ip_tor | ip_tor | Boolean | |
| Ip_fraud_score | ip_fraud_score | Integer | |
| Mail_checked | mail_checked | Boolean | |
| Mail_request_id | mail_request_id | String | |
| Mail_success | mail_success | Boolean | |
| Mail_message | mail_message | String | |
| Mail_errors | mail_errors | String | |
| Mail_valid | mail_valid | Boolean | |
| Mail_disposable | mail_disposable | Boolean | |
| Mail_timed_out | mail_timed_out | Boolean | |
| Mail_deliverability | mail_deliverability | String | |
| Mail_catch_all | mail_catch_all | Boolean | |
| Mail_leaked | mail_leaked | Boolean | |
| Mail_suspect | mail_suspect | Boolean | |
| Mail_smtp_score | mail_smtp_score | Integer | |
| Mail_overall_score | mail_overall_score | Integer | |
| Mail_fraud_score | mail_fraud_score | Integer | |
| Mail_dns_valid | mail_dns_valid | Boolean | |
| Mail_honeypot | mail_honeypot | Boolean | |
| Mail_spam_trap_score | mail_spam_trap_score | String | |
| Mail_recent_abuse | mail_recent_abuse | Boolean | |
| Mail_frequent_complainer | mail_frequent_complainer | Boolean |
{
"auth": false,
"description": null,
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"login": {
"required": true,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"format": {
"rx": "\\A[a-zA-Z0-9.-]{2,63}\\z",
"match": true,
"description": null,
"message": "not a valid login"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": true,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 30",
"max": 30
}
},
"default": null,
"protected": false
},
"email": {
"required": true,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 255",
"max": 255
},
"format": {
"rx": "@",
"match": true,
"description": null,
"message": "not a valid e-mail address"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": true,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"os_template": {
"required": true,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": true,
"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"
}
},
"currency": {
"required": true,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 10",
"max": 10
}
},
"default": null,
"protected": false
},
"language": {
"required": true,
"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"
}
}
},
"layout": "object",
"namespace": "registration"
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "API IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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"
}
},
"admin_response": {
"required": false,
"label": "Admin's response",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": true,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": true,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": true,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": true,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": true,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": true,
"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"
}
},
"currency": {
"required": true,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"language": {
"required": true,
"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"
}
},
"ip_checked": {
"required": false,
"label": "Ip_checked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_request_id": {
"required": false,
"label": "Ip_request_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_success": {
"required": false,
"label": "Ip_success",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_message": {
"required": false,
"label": "Ip_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_errors": {
"required": false,
"label": "Ip_errors",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_proxy": {
"required": false,
"label": "Ip_proxy",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_crawler": {
"required": false,
"label": "Ip_crawler",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_recent_abuse": {
"required": false,
"label": "Ip_recent_abuse",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_vpn": {
"required": false,
"label": "Ip_vpn",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_tor": {
"required": false,
"label": "Ip_tor",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_fraud_score": {
"required": false,
"label": "Ip_fraud_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_checked": {
"required": false,
"label": "Mail_checked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_request_id": {
"required": false,
"label": "Mail_request_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_success": {
"required": false,
"label": "Mail_success",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_message": {
"required": false,
"label": "Mail_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_errors": {
"required": false,
"label": "Mail_errors",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_valid": {
"required": false,
"label": "Mail_valid",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_disposable": {
"required": false,
"label": "Mail_disposable",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_timed_out": {
"required": false,
"label": "Mail_timed_out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_deliverability": {
"required": false,
"label": "Mail_deliverability",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_catch_all": {
"required": false,
"label": "Mail_catch_all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_leaked": {
"required": false,
"label": "Mail_leaked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_suspect": {
"required": false,
"label": "Mail_suspect",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_smtp_score": {
"required": false,
"label": "Mail_smtp_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_overall_score": {
"required": false,
"label": "Mail_overall_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_fraud_score": {
"required": false,
"label": "Mail_fraud_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_dns_valid": {
"required": false,
"label": "Mail_dns_valid",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_honeypot": {
"required": false,
"label": "Mail_honeypot",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_spam_trap_score": {
"required": false,
"label": "Mail_spam_trap_score",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_recent_abuse": {
"required": false,
"label": "Mail_recent_abuse",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_frequent_complainer": {
"required": false,
"label": "Mail_frequent_complainer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "registration"
},
"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": [
],
"scope": "user_request.registration#create",
"path": "/v6.0/user_request/registrations",
"method": "POST",
"help": "/v6.0/user_request/registrations?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 | |||
| State | state | no | String | Include
|
||
| API IP address | api_ip_addr | no | String | |||
| Client IP address | client_ip_addr | no | String | |||
| Client IP PTR | client_ip_ptr | no | String | |||
| Admin | admin | no | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| State | state | String | |
| API IP address | api_ip_addr | String | |
| API IP PTR | api_ip_ptr | String | |
| Client IP address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| Admin | admin | Resource | |
| Admin's response | admin_response | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | |
| Label | label | String | |
| Login | login | String | |
| Full name | full_name | String | |
| Organization name | org_name | String | |
| Organization ID | org_id | String | |
| String | |||
| Address | address | Text | |
| Year of birth | year_of_birth | Integer | |
| How did you learn about us? | how | String | |
| Notes | note | String | |
| Distribution | os_template | Resource | |
| Location | location | Resource | |
| Currency | currency | String | |
| Language | language | Resource | |
| Ip_checked | ip_checked | Boolean | |
| Ip_request_id | ip_request_id | String | |
| Ip_success | ip_success | Boolean | |
| Ip_message | ip_message | String | |
| Ip_errors | ip_errors | String | |
| Ip_proxy | ip_proxy | Boolean | |
| Ip_crawler | ip_crawler | Boolean | |
| Ip_recent_abuse | ip_recent_abuse | Boolean | |
| Ip_vpn | ip_vpn | Boolean | |
| Ip_tor | ip_tor | Boolean | |
| Ip_fraud_score | ip_fraud_score | Integer | |
| Mail_checked | mail_checked | Boolean | |
| Mail_request_id | mail_request_id | String | |
| Mail_success | mail_success | Boolean | |
| Mail_message | mail_message | String | |
| Mail_errors | mail_errors | String | |
| Mail_valid | mail_valid | Boolean | |
| Mail_disposable | mail_disposable | Boolean | |
| Mail_timed_out | mail_timed_out | Boolean | |
| Mail_deliverability | mail_deliverability | String | |
| Mail_catch_all | mail_catch_all | Boolean | |
| Mail_leaked | mail_leaked | Boolean | |
| Mail_suspect | mail_suspect | Boolean | |
| Mail_smtp_score | mail_smtp_score | Integer | |
| Mail_overall_score | mail_overall_score | Integer | |
| Mail_fraud_score | mail_fraud_score | Integer | |
| Mail_dns_valid | mail_dns_valid | Boolean | |
| Mail_honeypot | mail_honeypot | Boolean | |
| Mail_spam_trap_score | mail_spam_trap_score | String | |
| Mail_recent_abuse | mail_recent_abuse | Boolean | |
| Mail_frequent_complainer | mail_frequent_complainer | Boolean |
{
"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
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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": "registration"
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "API IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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"
}
},
"admin_response": {
"required": false,
"label": "Admin's response",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": true,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": true,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": true,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": true,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": true,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": true,
"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"
}
},
"currency": {
"required": true,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"language": {
"required": true,
"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"
}
},
"ip_checked": {
"required": false,
"label": "Ip_checked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_request_id": {
"required": false,
"label": "Ip_request_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_success": {
"required": false,
"label": "Ip_success",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_message": {
"required": false,
"label": "Ip_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_errors": {
"required": false,
"label": "Ip_errors",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_proxy": {
"required": false,
"label": "Ip_proxy",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_crawler": {
"required": false,
"label": "Ip_crawler",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_recent_abuse": {
"required": false,
"label": "Ip_recent_abuse",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_vpn": {
"required": false,
"label": "Ip_vpn",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_tor": {
"required": false,
"label": "Ip_tor",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_fraud_score": {
"required": false,
"label": "Ip_fraud_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_checked": {
"required": false,
"label": "Mail_checked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_request_id": {
"required": false,
"label": "Mail_request_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_success": {
"required": false,
"label": "Mail_success",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_message": {
"required": false,
"label": "Mail_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_errors": {
"required": false,
"label": "Mail_errors",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_valid": {
"required": false,
"label": "Mail_valid",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_disposable": {
"required": false,
"label": "Mail_disposable",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_timed_out": {
"required": false,
"label": "Mail_timed_out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_deliverability": {
"required": false,
"label": "Mail_deliverability",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_catch_all": {
"required": false,
"label": "Mail_catch_all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_leaked": {
"required": false,
"label": "Mail_leaked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_suspect": {
"required": false,
"label": "Mail_suspect",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_smtp_score": {
"required": false,
"label": "Mail_smtp_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_overall_score": {
"required": false,
"label": "Mail_overall_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_fraud_score": {
"required": false,
"label": "Mail_fraud_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_dns_valid": {
"required": false,
"label": "Mail_dns_valid",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_honeypot": {
"required": false,
"label": "Mail_honeypot",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_spam_trap_score": {
"required": false,
"label": "Mail_spam_trap_score",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_recent_abuse": {
"required": false,
"label": "Mail_recent_abuse",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_frequent_complainer": {
"required": false,
"label": "Mail_frequent_complainer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "registrations"
},
"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": [
],
"scope": "user_request.registration#index",
"path": "/v6.0/user_request/registrations",
"method": "GET",
"help": "/v6.0/user_request/registrations?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Admin's response | admin_response | String | |
| Login | login | String | |
| Full name | full_name | String | |
| Organization name | org_name | String | |
| Organization ID | org_id | String | |
| String | |||
| Address | address | Text | |
| Year of birth | year_of_birth | Integer | |
| How did you learn about us? | how | String | |
| Notes | note | String | |
| Distribution | os_template | Resource | |
| Location | location | Resource | |
| Currency | currency | String | |
| Language | language | Resource |
{
"auth": false,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "registration"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"admin_response": {
"required": false,
"label": "Admin's response",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": true,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": true,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": true,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": true,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": true,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": true,
"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"
}
},
"currency": {
"required": true,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"language": {
"required": true,
"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"
}
}
},
"layout": "object",
"namespace": "registration"
},
"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": [
],
"scope": "user_request.registration#preview",
"path": "/v6.0/user_request/registrations/{registration_id}/{token}",
"method": "GET",
"help": "/v6.0/user_request/registrations/{registration_id}/{token}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Action | action | yes | String | Include
Present
|
||
| Reason | reason | no | Text | |||
| Login | login | no | String | Format
|
||
| Full name | full_name | no | String | Length
|
||
| Organization name | org_name | no | String | Length
|
||
| Organization ID | org_id | no | String | Length
|
||
| no | String | Length
Format
|
||||
| Address | address | no | Text | Length
|
||
| Year of birth | year_of_birth | no | Integer | |||
| How did you learn about us? | how | no | String | Length
|
||
| Notes | note | no | String | Length
|
||
| Distribution | os_template | no | Resource | |||
| Location | location | no | Resource | |||
| Currency | currency | no | String | Include
Length
|
||
| Language | language | no | Resource | |||
| Activate account | activate | no | Boolean | true | ||
| Node | node | no | Resource | Create the new VPS on this node | ||
| Create VPS | create_vps | no | Boolean | true |
No parameters.
{
"auth": true,
"description": "Resolve user request",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"action": {
"required": true,
"label": "Action",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"approve",
"deny",
"ignore",
"request_correction"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": false,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9.-]{2,63}\\z",
"match": true,
"description": null,
"message": "not a valid login"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": false,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 30",
"max": 30
}
},
"default": null,
"protected": false
},
"email": {
"required": false,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 255",
"max": 255
},
"format": {
"rx": "@",
"match": true,
"description": null,
"message": "not a valid e-mail address"
}
},
"default": null,
"protected": false
},
"address": {
"required": false,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": false,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"os_template": {
"required": false,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": false,
"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"
}
},
"currency": {
"required": false,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"length": {
"message": "length has to be maximally 10",
"max": 10
}
},
"default": null,
"protected": false
},
"language": {
"required": false,
"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"
}
},
"activate": {
"required": false,
"label": "Activate account",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"node": {
"required": null,
"label": "Node",
"description": "Create the new VPS on this node",
"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"
}
},
"create_vps": {
"required": false,
"label": "Create VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "registration"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "registration"
},
"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": [
],
"scope": "user_request.registration#resolve",
"path": "/v6.0/user_request/registrations/{registration_id}/resolve",
"method": "POST",
"help": "/v6.0/user_request/registrations/{registration_id}/resolve?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| State | state | String | |
| API IP address | api_ip_addr | String | |
| API IP PTR | api_ip_ptr | String | |
| Client IP address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| Admin | admin | Resource | |
| Admin's response | admin_response | String | |
| Created at | created_at | Datetime | |
| Updated at | updated_at | Datetime | |
| Label | label | String | |
| Login | login | String | |
| Full name | full_name | String | |
| Organization name | org_name | String | |
| Organization ID | org_id | String | |
| String | |||
| Address | address | Text | |
| Year of birth | year_of_birth | Integer | |
| How did you learn about us? | how | String | |
| Notes | note | String | |
| Distribution | os_template | Resource | |
| Location | location | Resource | |
| Currency | currency | String | |
| Language | language | Resource | |
| Ip_checked | ip_checked | Boolean | |
| Ip_request_id | ip_request_id | String | |
| Ip_success | ip_success | Boolean | |
| Ip_message | ip_message | String | |
| Ip_errors | ip_errors | String | |
| Ip_proxy | ip_proxy | Boolean | |
| Ip_crawler | ip_crawler | Boolean | |
| Ip_recent_abuse | ip_recent_abuse | Boolean | |
| Ip_vpn | ip_vpn | Boolean | |
| Ip_tor | ip_tor | Boolean | |
| Ip_fraud_score | ip_fraud_score | Integer | |
| Mail_checked | mail_checked | Boolean | |
| Mail_request_id | mail_request_id | String | |
| Mail_success | mail_success | Boolean | |
| Mail_message | mail_message | String | |
| Mail_errors | mail_errors | String | |
| Mail_valid | mail_valid | Boolean | |
| Mail_disposable | mail_disposable | Boolean | |
| Mail_timed_out | mail_timed_out | Boolean | |
| Mail_deliverability | mail_deliverability | String | |
| Mail_catch_all | mail_catch_all | Boolean | |
| Mail_leaked | mail_leaked | Boolean | |
| Mail_suspect | mail_suspect | Boolean | |
| Mail_smtp_score | mail_smtp_score | Integer | |
| Mail_overall_score | mail_overall_score | Integer | |
| Mail_fraud_score | mail_fraud_score | Integer | |
| Mail_dns_valid | mail_dns_valid | Boolean | |
| Mail_honeypot | mail_honeypot | Boolean | |
| Mail_spam_trap_score | mail_spam_trap_score | String | |
| Mail_recent_abuse | mail_recent_abuse | Boolean | |
| Mail_frequent_complainer | mail_frequent_complainer | Boolean |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "registration"
},
"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"
}
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"awaiting",
"approved",
"denied",
"ignored",
"pending_correction"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "API IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "API IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"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"
}
},
"admin_response": {
"required": false,
"label": "Admin's response",
"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
},
"updated_at": {
"required": false,
"label": "Updated at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": true,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": true,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": true,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": true,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": true,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": true,
"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"
}
},
"currency": {
"required": true,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"language": {
"required": true,
"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"
}
},
"ip_checked": {
"required": false,
"label": "Ip_checked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_request_id": {
"required": false,
"label": "Ip_request_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_success": {
"required": false,
"label": "Ip_success",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_message": {
"required": false,
"label": "Ip_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_errors": {
"required": false,
"label": "Ip_errors",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"ip_proxy": {
"required": false,
"label": "Ip_proxy",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_crawler": {
"required": false,
"label": "Ip_crawler",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_recent_abuse": {
"required": false,
"label": "Ip_recent_abuse",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_vpn": {
"required": false,
"label": "Ip_vpn",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_tor": {
"required": false,
"label": "Ip_tor",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ip_fraud_score": {
"required": false,
"label": "Ip_fraud_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_checked": {
"required": false,
"label": "Mail_checked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_request_id": {
"required": false,
"label": "Mail_request_id",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_success": {
"required": false,
"label": "Mail_success",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_message": {
"required": false,
"label": "Mail_message",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_errors": {
"required": false,
"label": "Mail_errors",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_valid": {
"required": false,
"label": "Mail_valid",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_disposable": {
"required": false,
"label": "Mail_disposable",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_timed_out": {
"required": false,
"label": "Mail_timed_out",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_deliverability": {
"required": false,
"label": "Mail_deliverability",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_catch_all": {
"required": false,
"label": "Mail_catch_all",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_leaked": {
"required": false,
"label": "Mail_leaked",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_suspect": {
"required": false,
"label": "Mail_suspect",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_smtp_score": {
"required": false,
"label": "Mail_smtp_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_overall_score": {
"required": false,
"label": "Mail_overall_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_fraud_score": {
"required": false,
"label": "Mail_fraud_score",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"mail_dns_valid": {
"required": false,
"label": "Mail_dns_valid",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_honeypot": {
"required": false,
"label": "Mail_honeypot",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_spam_trap_score": {
"required": false,
"label": "Mail_spam_trap_score",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mail_recent_abuse": {
"required": false,
"label": "Mail_recent_abuse",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"mail_frequent_complainer": {
"required": false,
"label": "Mail_frequent_complainer",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "registration"
},
"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": [
],
"scope": "user_request.registration#show",
"path": "/v6.0/user_request/registrations/{registration_id}",
"method": "GET",
"help": "/v6.0/user_request/registrations/{registration_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Login | login | yes | String | Present
Format
|
||
| Full name | full_name | yes | String | Present
Length
|
||
| Organization name | org_name | no | String | Length
|
||
| Organization ID | org_id | no | String | Length
|
||
| yes | String | Present
Length
Format
|
||||
| Address | address | yes | Text | Present
Length
|
||
| Year of birth | year_of_birth | yes | Integer | Present
|
||
| How did you learn about us? | how | no | String | Length
|
||
| Notes | note | no | String | Length
|
||
| Distribution | os_template | yes | Resource | |||
| Location | location | yes | Resource | |||
| Currency | currency | yes | String | Include
Present
Length
|
||
| Language | language | yes | Resource |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Login | login | String | |
| Full name | full_name | String | |
| Organization name | org_name | String | |
| Organization ID | org_id | String | |
| String | |||
| Address | address | Text | |
| Year of birth | year_of_birth | Integer | |
| How did you learn about us? | how | String | |
| Notes | note | String | |
| Distribution | os_template | Resource | |
| Location | location | Resource | |
| Currency | currency | String | |
| Language | language | Resource |
{
"auth": false,
"description": null,
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"login": {
"required": true,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"format": {
"rx": "\\A[a-zA-Z0-9.-]{2,63}\\z",
"match": true,
"description": null,
"message": "not a valid login"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": true,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 255",
"max": 255
}
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 30",
"max": 30
}
},
"default": null,
"protected": false
},
"email": {
"required": true,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 255",
"max": 255
},
"format": {
"rx": "@",
"match": true,
"description": null,
"message": "not a valid e-mail address"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": true,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
"length": {
"message": "length has to be maximally 500",
"max": 500
}
},
"default": null,
"protected": false
},
"os_template": {
"required": true,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": true,
"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"
}
},
"currency": {
"required": true,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"length": {
"message": "length has to be maximally 10",
"max": 10
}
},
"default": null,
"protected": false
},
"language": {
"required": true,
"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"
}
}
},
"layout": "object",
"namespace": "registration"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"login": {
"required": true,
"label": "Login",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"full_name": {
"required": true,
"label": "Full name",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"org_name": {
"required": false,
"label": "Organization name",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"org_id": {
"required": false,
"label": "Organization ID",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"email": {
"required": true,
"label": "E-mail",
"description": null,
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"address": {
"required": true,
"label": "Address",
"description": null,
"type": "Text",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"year_of_birth": {
"required": true,
"label": "Year of birth",
"description": null,
"type": "Integer",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"how": {
"required": false,
"label": "How did you learn about us?",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"note": {
"required": false,
"label": "Notes",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": true,
"label": "Distribution",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"location": {
"required": true,
"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"
}
},
"currency": {
"required": true,
"label": "Currency",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"eur",
"czk"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"language": {
"required": true,
"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"
}
}
},
"layout": "object",
"namespace": "registration"
},
"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": [
],
"scope": "user_request.registration#update",
"path": "/v6.0/user_request/registrations/{registration_id}/{token}",
"method": "PUT",
"help": "/v6.0/user_request/registrations/{registration_id}/{token}?method=PUT"
}Browse user sessions
No parameters.
No parameters.
{
"auth": true,
"description": "Close user session, revoke access token",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_session"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "user_session"
},
"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": [
],
"scope": "user_session#close",
"path": "/v6.0/user_sessions/{user_session_id}",
"method": "POST",
"help": "/v6.0/user_sessions/{user_session_id}?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| User | user | yes | Resource | |||
| Label | label | no | String | |||
| Scope | scope | no | String | all | ||
| Token lifetime | token_lifetime | yes | String | Include
Present
|
||
| Token interval | token_interval | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Label | label | String | |
| Authentication type | auth_type | String | |
| IP Address | api_ip_addr | String | |
| IP PTR | api_ip_ptr | String | |
| Client IP Address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| User agent | user_agent | String | |
| Client version | client_version | String | |
| Scope | scope | String | |
| Authentication token fragment | token_fragment | String | |
| Token lifetime | token_lifetime | String | |
| Token interval | token_interval | Integer | |
| Created at | created_at | Datetime | |
| Last request at | last_request_at | Datetime | |
| Request count | request_count | Integer | |
| Closed at | closed_at | Datetime | |
| Admin | admin | Resource | |
| Token_full | token_full | String |
{
"auth": true,
"description": "Create a new session for token authentication",
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
"user": {
"required": true,
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"scope": {
"required": false,
"label": "Scope",
"description": null,
"type": "String",
"validators": {
},
"default": "all",
"protected": false
},
"token_lifetime": {
"required": true,
"label": "Token lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto",
"permanent"
],
"message": "%{value} cannot be used"
},
"present": {
"empty": false,
"message": "must be present and non-empty"
}
},
"default": null,
"protected": false
},
"token_interval": {
"required": false,
"label": "Token interval",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_session"
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"auth_type": {
"required": false,
"label": "Authentication type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"basic",
"token",
"oauth2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_agent": {
"required": false,
"label": "User agent",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_version": {
"required": false,
"label": "Client version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"scope": {
"required": false,
"label": "Scope",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_fragment": {
"required": false,
"label": "Authentication token fragment",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_lifetime": {
"required": false,
"label": "Token lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto",
"permanent"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"token_interval": {
"required": false,
"label": "Token interval",
"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
},
"last_request_at": {
"required": false,
"label": "Last request at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"request_count": {
"required": false,
"label": "Request count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closed_at": {
"required": false,
"label": "Closed 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"
}
},
"token_full": {
"required": false,
"label": "Token_full",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_session"
},
"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": [
],
"scope": "user_session#create",
"path": "/v6.0/user_sessions",
"method": "POST",
"help": "/v6.0/user_sessions?method=POST"
}| 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 | |
| User | user | no | Resource | |||
| Authentication type | auth_type | no | String | Include
|
||
| IP Address | api_ip_addr | no | String | |||
| Client IP Address | client_ip_addr | no | String | |||
| User agent | user_agent | no | String | |||
| Client version | client_version | no | String | |||
| Authentication token fragment | token_fragment | no | String | |||
| Admin | admin | no | Resource | |||
| IP Address | ip_addr | no | String | Search both API and client IP address | ||
| State | state | no | String | Include
|
all |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Label | label | String | |
| Authentication type | auth_type | String | |
| IP Address | api_ip_addr | String | |
| IP PTR | api_ip_ptr | String | |
| Client IP Address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| User agent | user_agent | String | |
| Client version | client_version | String | |
| Scope | scope | String | |
| Authentication token fragment | token_fragment | String | |
| Token lifetime | token_lifetime | String | |
| Token interval | token_interval | Integer | |
| Created at | created_at | Datetime | |
| Last request at | last_request_at | Datetime | |
| Request count | request_count | Integer | |
| Closed at | closed_at | Datetime | |
| Admin | admin | Resource |
{
"auth": true,
"description": "List user sessions",
"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
},
"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"
}
},
"auth_type": {
"required": false,
"label": "Authentication type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"basic",
"token",
"oauth2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_agent": {
"required": false,
"label": "User agent",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_version": {
"required": false,
"label": "Client version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_fragment": {
"required": false,
"label": "Authentication token fragment",
"description": null,
"type": "String",
"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"
}
},
"ip_addr": {
"required": false,
"label": "IP Address",
"description": "Search both API and client IP address",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"all",
"open",
"closed"
],
"message": "%{value} cannot be used"
}
},
"default": "all",
"protected": false
}
},
"layout": "object",
"namespace": "user_session"
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"auth_type": {
"required": false,
"label": "Authentication type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"basic",
"token",
"oauth2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_agent": {
"required": false,
"label": "User agent",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_version": {
"required": false,
"label": "Client version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"scope": {
"required": false,
"label": "Scope",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_fragment": {
"required": false,
"label": "Authentication token fragment",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_lifetime": {
"required": false,
"label": "Token lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto",
"permanent"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"token_interval": {
"required": false,
"label": "Token interval",
"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
},
"last_request_at": {
"required": false,
"label": "Last request at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"request_count": {
"required": false,
"label": "Request count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closed_at": {
"required": false,
"label": "Closed 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": "user_sessions"
},
"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": [
],
"scope": "user_session#index",
"path": "/v6.0/user_sessions",
"method": "GET",
"help": "/v6.0/user_sessions?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Label | label | String | |
| Authentication type | auth_type | String | |
| IP Address | api_ip_addr | String | |
| IP PTR | api_ip_ptr | String | |
| Client IP Address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| User agent | user_agent | String | |
| Client version | client_version | String | |
| Scope | scope | String | |
| Authentication token fragment | token_fragment | String | |
| Token lifetime | token_lifetime | String | |
| Token interval | token_interval | Integer | |
| Created at | created_at | Datetime | |
| Last request at | last_request_at | Datetime | |
| Request count | request_count | Integer | |
| Closed at | closed_at | Datetime | |
| Admin | admin | Resource |
{
"auth": true,
"description": "Show a user session",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "user_session"
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"auth_type": {
"required": false,
"label": "Authentication type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"basic",
"token",
"oauth2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_agent": {
"required": false,
"label": "User agent",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_version": {
"required": false,
"label": "Client version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"scope": {
"required": false,
"label": "Scope",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_fragment": {
"required": false,
"label": "Authentication token fragment",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_lifetime": {
"required": false,
"label": "Token lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto",
"permanent"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"token_interval": {
"required": false,
"label": "Token interval",
"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
},
"last_request_at": {
"required": false,
"label": "Last request at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"request_count": {
"required": false,
"label": "Request count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closed_at": {
"required": false,
"label": "Closed 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": "user_session"
},
"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": [
],
"scope": "user_session#show",
"path": "/v6.0/user_sessions/{user_session_id}",
"method": "GET",
"help": "/v6.0/user_sessions/{user_session_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Label | label | yes | String | Present
|
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| User | user | Resource | |
| Label | label | String | |
| Authentication type | auth_type | String | |
| IP Address | api_ip_addr | String | |
| IP PTR | api_ip_ptr | String | |
| Client IP Address | client_ip_addr | String | |
| Client IP PTR | client_ip_ptr | String | |
| User agent | user_agent | String | |
| Client version | client_version | String | |
| Scope | scope | String | |
| Authentication token fragment | token_fragment | String | |
| Token lifetime | token_lifetime | String | |
| Token interval | token_interval | Integer | |
| Created at | created_at | Datetime | |
| Last request at | last_request_at | Datetime | |
| Request count | request_count | Integer | |
| Closed at | closed_at | Datetime | |
| Admin | admin | Resource |
{
"auth": true,
"description": "Update user session",
"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"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "user_session"
},
"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"
}
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"auth_type": {
"required": false,
"label": "Authentication type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"basic",
"token",
"oauth2"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"api_ip_addr": {
"required": false,
"label": "IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"api_ip_ptr": {
"required": false,
"label": "IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_addr": {
"required": false,
"label": "Client IP Address",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_ip_ptr": {
"required": false,
"label": "Client IP PTR",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"user_agent": {
"required": false,
"label": "User agent",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"client_version": {
"required": false,
"label": "Client version",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"scope": {
"required": false,
"label": "Scope",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_fragment": {
"required": false,
"label": "Authentication token fragment",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"token_lifetime": {
"required": false,
"label": "Token lifetime",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"fixed",
"renewable_manual",
"renewable_auto",
"permanent"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"token_interval": {
"required": false,
"label": "Token interval",
"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
},
"last_request_at": {
"required": false,
"label": "Last request at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"request_count": {
"required": false,
"label": "Request count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closed_at": {
"required": false,
"label": "Closed 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": "user_session"
},
"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": [
],
"scope": "user_session#update",
"path": "/v6.0/user_sessions/{user_session_id}",
"method": "PUT",
"help": "/v6.0/user_sessions/{user_session_id}?method=PUT"
}Manage VPS
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| OS template | os_template | no | Resource | |||
| Rootfs mountpoint | mount_root_dataset | no | String |
No parameters.
{
"auth": true,
"description": "Boot VPS from OS template",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"mount_root_dataset": {
"required": false,
"label": "Rootfs mountpoint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#boot",
"path": "/v6.0/vpses/{vps_id}/boot",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/boot?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Environment | environment | no | Resource | Clone to environment | ||
| Location | location | no | Resource | Clone to location | ||
| Node | node | no | Resource | Clone to node | ||
| User | user | no | Resource | The owner of the cloned VPS | ||
| Address location | address_location | no | Resource | Location to select IP addresses from | ||
| Platform | platform | no | String | Include
|
same | |
| Subdatasets | subdatasets | no | Boolean | true | ||
| Dataset plans | dataset_plans | no | Boolean | true | ||
| Resources | resources | no | Boolean | true | Clone resources such as memory and CPU | |
| Features | features | no | Boolean | true | ||
| Hostname | hostname | no | String | Format
|
||
| Stop | stop | no | Boolean | true | Do a consistent clone - original VPS is stopped before making a snapshot | |
| Keep snapshots | keep_snapshots | no | Boolean | false | Keep snapshots created during the cloning process |
| Label | Name | Type | Description |
|---|---|---|---|
| VPS id | id | Integer | |
| User | user | Resource | VPS owner |
| Hostname | hostname | String | VPS hostname |
| Manage hostname | manage_hostname | Boolean | Determines whether vpsAdmin sets VPS hostname or not |
| OS template | os_template | Resource | |
| Cgroup_version | cgroup_version | String | |
| Info | info | String | VPS description |
| DNS resolver | dns_resolver | Resource | DNS resolver the VPS will use |
| Node | node | Resource | Node VPS will run on |
| UID/GID mapping | user_namespace_map | Resource | |
| Auto-start | autostart_enable | Boolean | Start VPS on node boot? |
| Auto-start priority | autostart_priority | Integer | 0 is the highest priority, greater numbers have lower priority |
| On start all | onstartall | Boolean | Start VPS on start all action? |
| Config | config | String | Custom configuration options |
| CPU limit | cpu_limit | Integer | Limit of maximum CPU usage |
| Start menu timeout | start_menu_timeout | Integer | Number of seconds the start menu waits for the user |
| Allow admin modifications | allow_admin_modifications | Boolean | |
| Dataset | dataset | Resource | Dataset the VPS resides in |
| Pool | pool | Resource | Storage pool the VPS resides in |
| Created at | created_at | Datetime | |
| Memory | memory | Integer | Minimally 512, maximally 16384, step size is 1 |
| Swap | swap | Integer | Minimally 0, maximally 12288, step size is 1 |
| CPU | cpu | Integer | Minimally 1, maximally 8, step size is 1 |
| Disk space | diskspace | Integer | Minimally 1024, maximally 10485760, step size is 1 |
| Running | is_running | Boolean | |
| In rescue mode | in_rescue_mode | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Used disk space | used_diskspace | Integer | in MB |
{
"auth": true,
"description": "Clone VPS",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"environment": {
"required": null,
"label": "Environment",
"description": "Clone to 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"
}
},
"location": {
"required": null,
"label": "Location",
"description": "Clone to location",
"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": "Clone to node",
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"user": {
"required": null,
"label": "User",
"description": "The owner of the cloned VPS",
"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"
}
},
"address_location": {
"required": null,
"label": "Address location",
"description": "Location to select IP addresses from",
"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"
}
},
"platform": {
"required": false,
"label": "Platform",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"same",
"vpsadminos"
],
"message": "%{value} cannot be used"
}
},
"default": "same",
"protected": false
},
"subdatasets": {
"required": false,
"label": "Subdatasets",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"dataset_plans": {
"required": false,
"label": "Dataset plans",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"resources": {
"required": false,
"label": "Resources",
"description": "Clone resources such as memory and CPU",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"features": {
"required": false,
"label": "Features",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"hostname": {
"required": false,
"label": "Hostname",
"description": null,
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9][a-zA-Z\\-_.0-9]{0,62}[a-zA-Z0-9]\\z",
"match": true,
"description": null,
"message": "bad format"
}
},
"default": null,
"protected": false
},
"stop": {
"required": false,
"label": "Stop",
"description": "Do a consistent clone - original VPS is stopped before making a snapshot",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"keep_snapshots": {
"required": false,
"label": "Keep snapshots",
"description": "Keep snapshots created during the cloning process",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "VPS id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "VPS 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"
}
},
"hostname": {
"required": false,
"label": "Hostname",
"description": "VPS hostname",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"manage_hostname": {
"required": false,
"label": "Manage hostname",
"description": "Determines whether vpsAdmin sets VPS hostname or not",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "VPS description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dns_resolver": {
"required": null,
"label": "DNS resolver",
"description": "DNS resolver the VPS will use",
"type": "Resource",
"resource": [
"dns_resolver"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"autostart_enable": {
"required": false,
"label": "Auto-start",
"description": "Start VPS on node boot?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"autostart_priority": {
"required": false,
"label": "Auto-start priority",
"description": "0 is the highest priority, greater numbers have lower priority",
"type": "Integer",
"validators": {
},
"default": 1000,
"protected": false
},
"onstartall": {
"required": false,
"label": "On start all",
"description": "Start VPS on start all action?",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"config": {
"required": false,
"label": "Config",
"description": "Custom configuration options",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": "Limit of maximum CPU usage",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"start_menu_timeout": {
"required": false,
"label": "Start menu timeout",
"description": "Number of seconds the start menu waits for the user",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"allow_admin_modifications": {
"required": false,
"label": "Allow admin modifications",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": "Dataset the VPS resides in",
"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"
}
},
"pool": {
"required": null,
"label": "Pool",
"description": "Storage pool the VPS resides in",
"type": "Resource",
"resource": [
"pool"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/pools",
"method": "GET",
"help": "/v6.0/pools?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"memory": {
"required": false,
"label": "Memory",
"description": "Minimally 512, maximally 16384, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": "Minimally 0, maximally 12288, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu": {
"required": false,
"label": "CPU",
"description": "Minimally 1, maximally 8, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"diskspace": {
"required": false,
"label": "Disk space",
"description": "Minimally 1024, maximally 10485760, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"in_rescue_mode": {
"required": false,
"label": "In rescue mode",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_diskspace": {
"required": false,
"label": "Used disk space",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#clone",
"path": "/v6.0/vpses/{vps_id}/clone",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/clone?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Environment | environment | no | Resource | Environment in which to create the VPS, for non-admins | ||
| Location | location | no | Resource | Location in which to create the VPS, for non-admins | ||
| Address location | address_location | no | Resource | Location to select IP addresses from | ||
| User | user | no | Resource | VPS owner | ||
| Hostname | hostname | yes | String | Present
Format
|
VPS hostname | |
| OS template | os_template | no | Resource | |||
| Cgroup_version | cgroup_version | no | String | Include
|
cgroup_any | |
| Info | info | no | String | VPS description | ||
| DNS resolver | dns_resolver | no | Resource | DNS resolver the VPS will use | ||
| Node | node | no | Resource | Node VPS will run on | ||
| UID/GID mapping | user_namespace_map | no | Resource | |||
| Auto-start | autostart_enable | no | Boolean | Start VPS on node boot? | ||
| Auto-start priority | autostart_priority | no | Integer | Number
|
1000 | 0 is the highest priority, greater numbers have lower priority |
| On start all | onstartall | no | Boolean | true | Start VPS on start all action? | |
| Config | config | no | String | Custom configuration options | ||
| CPU limit | cpu_limit | no | Integer | Number
|
Limit of maximum CPU usage | |
| Start menu timeout | start_menu_timeout | no | Integer | Number
|
Number of seconds the start menu waits for the user | |
| Allow admin modifications | allow_admin_modifications | no | Boolean | |||
| Memory | memory | no | Integer | Minimally 512, maximally 16384, step size is 1 | ||
| Swap | swap | no | Integer | Minimally 0, maximally 12288, step size is 1 | ||
| CPU | cpu | no | Integer | Minimally 1, maximally 8, step size is 1 | ||
| Disk space | diskspace | no | Integer | Minimally 1024, maximally 10485760, step size is 1 | ||
| IPv4 | ipv4 | no | Integer | 1 | ||
| IPv6 | ipv6 | no | Integer | 1 | ||
| Private IPv4 | ipv4_private | no | Integer | 0 | ||
| Start VPS | start | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| VPS id | id | Integer | |
| User | user | Resource | VPS owner |
| Hostname | hostname | String | VPS hostname |
| Manage hostname | manage_hostname | Boolean | Determines whether vpsAdmin sets VPS hostname or not |
| OS template | os_template | Resource | |
| Cgroup_version | cgroup_version | String | |
| Info | info | String | VPS description |
| DNS resolver | dns_resolver | Resource | DNS resolver the VPS will use |
| Node | node | Resource | Node VPS will run on |
| UID/GID mapping | user_namespace_map | Resource | |
| Auto-start | autostart_enable | Boolean | Start VPS on node boot? |
| Auto-start priority | autostart_priority | Integer | 0 is the highest priority, greater numbers have lower priority |
| On start all | onstartall | Boolean | Start VPS on start all action? |
| Config | config | String | Custom configuration options |
| CPU limit | cpu_limit | Integer | Limit of maximum CPU usage |
| Start menu timeout | start_menu_timeout | Integer | Number of seconds the start menu waits for the user |
| Allow admin modifications | allow_admin_modifications | Boolean | |
| Dataset | dataset | Resource | Dataset the VPS resides in |
| Pool | pool | Resource | Storage pool the VPS resides in |
| Created at | created_at | Datetime | |
| Memory | memory | Integer | Minimally 512, maximally 16384, step size is 1 |
| Swap | swap | Integer | Minimally 0, maximally 12288, step size is 1 |
| CPU | cpu | Integer | Minimally 1, maximally 8, step size is 1 |
| Disk space | diskspace | Integer | Minimally 1024, maximally 10485760, step size is 1 |
| Running | is_running | Boolean | |
| In rescue mode | in_rescue_mode | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Used disk space | used_diskspace | Integer | in MB |
| Object state | object_state | String | |
| Expiration | expiration_date | Datetime | A date after which the state will progress |
| Remind after | remind_after_date | Datetime | Mail warnings are silenced until this date |
{
"auth": true,
"description": "Create VPS",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"environment": {
"required": null,
"label": "Environment",
"description": "Environment in which to create the VPS, for non-admins",
"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": "Location in which to create the VPS, for non-admins",
"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"
}
},
"address_location": {
"required": null,
"label": "Address location",
"description": "Location to select IP addresses from",
"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": "VPS 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"
}
},
"hostname": {
"required": true,
"label": "Hostname",
"description": "VPS hostname",
"type": "String",
"validators": {
"present": {
"empty": false,
"message": "must be present and non-empty"
},
"format": {
"rx": "\\A[a-zA-Z0-9][a-zA-Z\\-_.0-9]{0,62}[a-zA-Z0-9]\\z",
"match": true,
"description": null,
"message": "bad format"
}
},
"default": null,
"protected": false
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "VPS description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dns_resolver": {
"required": null,
"label": "DNS resolver",
"description": "DNS resolver the VPS will use",
"type": "Resource",
"resource": [
"dns_resolver"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"autostart_enable": {
"required": false,
"label": "Auto-start",
"description": "Start VPS on node boot?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"autostart_priority": {
"required": false,
"label": "Auto-start priority",
"description": "0 is the highest priority, greater numbers have lower priority",
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": 1000,
"protected": false
},
"onstartall": {
"required": false,
"label": "On start all",
"description": "Start VPS on start all action?",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"config": {
"required": false,
"label": "Config",
"description": "Custom configuration options",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": "Limit of maximum CPU usage",
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": null,
"protected": false
},
"start_menu_timeout": {
"required": false,
"label": "Start menu timeout",
"description": "Number of seconds the start menu waits for the user",
"type": "Integer",
"validators": {
"number": {
"message": "has to be in range <0, 86400>",
"min": 0,
"max": 86400
}
},
"default": null,
"protected": false
},
"allow_admin_modifications": {
"required": false,
"label": "Allow admin modifications",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"memory": {
"required": false,
"label": "Memory",
"description": "Minimally 512, maximally 16384, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": "Minimally 0, maximally 12288, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu": {
"required": false,
"label": "CPU",
"description": "Minimally 1, maximally 8, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"diskspace": {
"required": false,
"label": "Disk space",
"description": "Minimally 1024, maximally 10485760, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"ipv4": {
"required": false,
"label": "IPv4",
"description": null,
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"ipv6": {
"required": false,
"label": "IPv6",
"description": null,
"type": "Integer",
"validators": {
},
"default": 1,
"protected": false
},
"ipv4_private": {
"required": false,
"label": "Private IPv4",
"description": null,
"type": "Integer",
"validators": {
},
"default": 0,
"protected": false
},
"start": {
"required": false,
"label": "Start VPS",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "VPS id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "VPS 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"
}
},
"hostname": {
"required": false,
"label": "Hostname",
"description": "VPS hostname",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"manage_hostname": {
"required": false,
"label": "Manage hostname",
"description": "Determines whether vpsAdmin sets VPS hostname or not",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "VPS description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dns_resolver": {
"required": null,
"label": "DNS resolver",
"description": "DNS resolver the VPS will use",
"type": "Resource",
"resource": [
"dns_resolver"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"autostart_enable": {
"required": false,
"label": "Auto-start",
"description": "Start VPS on node boot?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"autostart_priority": {
"required": false,
"label": "Auto-start priority",
"description": "0 is the highest priority, greater numbers have lower priority",
"type": "Integer",
"validators": {
},
"default": 1000,
"protected": false
},
"onstartall": {
"required": false,
"label": "On start all",
"description": "Start VPS on start all action?",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"config": {
"required": false,
"label": "Config",
"description": "Custom configuration options",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": "Limit of maximum CPU usage",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"start_menu_timeout": {
"required": false,
"label": "Start menu timeout",
"description": "Number of seconds the start menu waits for the user",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"allow_admin_modifications": {
"required": false,
"label": "Allow admin modifications",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": "Dataset the VPS resides in",
"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"
}
},
"pool": {
"required": null,
"label": "Pool",
"description": "Storage pool the VPS resides in",
"type": "Resource",
"resource": [
"pool"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/pools",
"method": "GET",
"help": "/v6.0/pools?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"memory": {
"required": false,
"label": "Memory",
"description": "Minimally 512, maximally 16384, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": "Minimally 0, maximally 12288, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu": {
"required": false,
"label": "CPU",
"description": "Minimally 1, maximally 8, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"diskspace": {
"required": false,
"label": "Disk space",
"description": "Minimally 1024, maximally 10485760, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"in_rescue_mode": {
"required": false,
"label": "In rescue mode",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_diskspace": {
"required": false,
"label": "Used disk space",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"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": [
{
"title": "Create vps",
"comment": "Create VPS owned by user with ID 1, template ID 1 and DNS resolver ID 1. VPS\nwill be created on node ID 1. Action returns ID of newly created VPS.\n",
"path_params": null,
"request": {
"user": 1,
"hostname": "my-vps",
"os_template": 1,
"info": "",
"dns_resolver": 1,
"node": 1,
"onstartall": true
},
"response": {
"id": 150
},
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "vps#create",
"path": "/v6.0/vpses",
"method": "POST",
"help": "/v6.0/vpses?method=POST"
}Create VPS owned by user with ID 1, template ID 1 and DNS resolver ID 1. VPS will be created on node ID 1. Action returns ID of newly created VPS.
require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.vps.create({:user=>1,
:hostname=>"my-vps",
:os_template=>1,
:info=>"",
:dns_resolver=>1,
:node=>1,
:onstartall=>true})
# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 150
import HaveAPI from 'haveapi-client'
var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "6.0"});
api.vps.create({
"user": 1,
"hostname": "my-vps",
"os_template": 1,
"info": "",
"dns_resolver": 1,
"node": 1,
"onstartall": true
}, function (client, reply) {
console.log('Response', reply);
// reply is an instance of HaveAPI.Client.ResourceInstance
// reply.id = 150
});$api = new \HaveAPI\Client("http://api.vpsfree.cz", "6.0");
$reply = $api->vps->create([
"user" => 1,
"hostname" => "my-vps",
"os_template" => 1,
"info" => "",
"dns_resolver" => 1,
"node" => 1,
"onstartall" => true
]);
// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 150
$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 vps create -- \
--user '1' \
--hostname 'my-vps' \
--os-template '1' \
--info '' \
--dns-resolver '1' \
--node '1' \
--onstartall
VPS id: 150
User: -
Hostname: -
Manage hostname: -
OS template: -
Cgroup_version: -
Info: -
DNS resolver: -
Node: -
UID/GID mapping: -
Auto-start: -
Auto-start priority: -
On start all: -
Config: -
CPU limit: -
Start menu timeout: -
Allow admin modifications: -
Dataset: -
Pool: -
Created at: -
Memory: -
Swap: -
CPU: -
Disk space: -
Running: -
In rescue mode: -
Uptime: -
Loadavg: -
Process count: -
Cpu_user: -
Cpu_nice: -
Cpu_system: -
Cpu_idle: -
Cpu_iowait: -
Cpu_irq: -
Cpu_softirq: -
Used memory: -
Used swap: -
Used disk space: -
Object state: -
Expiration: -
Remind after: -
# 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/vps/actions/create
# Prepare input parameters
$ echo '1' > input/user
$ echo 'my-vps' > input/hostname
$ echo '1' > input/os_template
$ echo '' > input/info
$ echo '1' > input/dns_resolver
$ echo '1' > input/node
$ echo 'true' > input/onstartall
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1
# Query the output parameters
$ cat output/id
150
$ curl --request POST \
--data-binary "{
\"vps\": {
\"user\": 1,
\"hostname\": \"my-vps\",
\"os_template\": 1,
\"info\": \"\",
\"dns_resolver\": 1,
\"node\": 1,
\"onstartall\": true
}
}" \
'http://api.vpsfree.cz/v6.0/vpses'
{
"status": true,
"message": null,
"response": {
"vps": {
"id": 150
}
},
"errors": null
}POST /v6.0/vpses HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json
{
"vps": {
"user": 1,
"hostname": "my-vps",
"os_template": 1,
"info": "",
"dns_resolver": 1,
"node": 1,
"onstartall": true
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 113
{
"status": true,
"message": null,
"response": {
"vps": {
"id": 150
}
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Lazy delete | lazy | no | Boolean | true | Only mark VPS as deleted | |
| Object state | object_state | no | String | Include
|
soft_delete | |
| Expiration | expiration_date | no | Datetime | A date after which the state will progress | ||
| Remind after | remind_after_date | no | Datetime | Mail warnings are silenced until this date | ||
| Reason | change_reason | no | String | Reason for the state change. May be mailed to the user. |
No parameters.
{
"auth": true,
"description": "Delete VPS",
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
"lazy": {
"required": false,
"label": "Lazy delete",
"description": "Only mark VPS as deleted",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": "soft_delete",
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": false,
"label": "Reason",
"description": "Reason for the state change. May be mailed to the user.",
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#delete",
"path": "/v6.0/vpses/{vps_id}",
"method": "DELETE",
"help": "/v6.0/vpses/{vps_id}?method=DELETE"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Public key | public_key | yes | Resource |
No parameters.
{
"auth": true,
"description": "Deploy public SSH key",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"public_key": {
"required": true,
"label": "Public key",
"description": null,
"type": "Resource",
"resource": [
"user",
"public_key"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/users/{user_id}/public_keys",
"method": "GET",
"help": "/v6.0/users/{user_id}/public_keys?method=GET"
}
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#deploy_public_key",
"path": "/v6.0/vpses/{vps_id}/deploy_public_key",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/deploy_public_key?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 | Filter by owner | ||
| Node | node | no | Resource | Filter by node | ||
| Location | location | no | Resource | Filter by location | ||
| Environment | environment | no | Resource | Filter by environment | ||
| UID/GID mapping | user_namespace_map | no | Resource | |||
| OS template | os_template | no | Resource | |||
| Hostname_any | hostname_any | no | String | |||
| Hostname_exact | hostname_exact | no | String | |||
| Object state | object_state | no | String | Include
|
| Label | Name | Type | Description |
|---|---|---|---|
| VPS id | id | Integer | |
| User | user | Resource | VPS owner |
| Hostname | hostname | String | VPS hostname |
| Manage hostname | manage_hostname | Boolean | Determines whether vpsAdmin sets VPS hostname or not |
| OS template | os_template | Resource | |
| Cgroup_version | cgroup_version | String | |
| Info | info | String | VPS description |
| DNS resolver | dns_resolver | Resource | DNS resolver the VPS will use |
| Node | node | Resource | Node VPS will run on |
| UID/GID mapping | user_namespace_map | Resource | |
| Auto-start | autostart_enable | Boolean | Start VPS on node boot? |
| Auto-start priority | autostart_priority | Integer | 0 is the highest priority, greater numbers have lower priority |
| On start all | onstartall | Boolean | Start VPS on start all action? |
| Config | config | String | Custom configuration options |
| CPU limit | cpu_limit | Integer | Limit of maximum CPU usage |
| Start menu timeout | start_menu_timeout | Integer | Number of seconds the start menu waits for the user |
| Allow admin modifications | allow_admin_modifications | Boolean | |
| Dataset | dataset | Resource | Dataset the VPS resides in |
| Pool | pool | Resource | Storage pool the VPS resides in |
| Created at | created_at | Datetime | |
| Memory | memory | Integer | Minimally 512, maximally 16384, step size is 1 |
| Swap | swap | Integer | Minimally 0, maximally 12288, step size is 1 |
| CPU | cpu | Integer | Minimally 1, maximally 8, step size is 1 |
| Disk space | diskspace | Integer | Minimally 1024, maximally 10485760, step size is 1 |
| Running | is_running | Boolean | |
| In rescue mode | in_rescue_mode | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Used disk space | used_diskspace | Integer | in MB |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String | |
| Object state | object_state | String | |
| Expiration | expiration_date | Datetime | A date after which the state will progress |
| Remind after | remind_after_date | Datetime | Mail warnings are silenced until this date |
{
"auth": true,
"description": "List VPS",
"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": "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"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Filter by node",
"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"
}
},
"location": {
"required": null,
"label": "Location",
"description": "Filter by location",
"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"
}
},
"environment": {
"required": null,
"label": "Environment",
"description": "Filter 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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"hostname_any": {
"required": false,
"label": "Hostname_any",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"hostname_exact": {
"required": false,
"label": "Hostname_exact",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "VPS id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "VPS 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"
}
},
"hostname": {
"required": false,
"label": "Hostname",
"description": "VPS hostname",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"manage_hostname": {
"required": false,
"label": "Manage hostname",
"description": "Determines whether vpsAdmin sets VPS hostname or not",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "VPS description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dns_resolver": {
"required": null,
"label": "DNS resolver",
"description": "DNS resolver the VPS will use",
"type": "Resource",
"resource": [
"dns_resolver"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"autostart_enable": {
"required": false,
"label": "Auto-start",
"description": "Start VPS on node boot?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"autostart_priority": {
"required": false,
"label": "Auto-start priority",
"description": "0 is the highest priority, greater numbers have lower priority",
"type": "Integer",
"validators": {
},
"default": 1000,
"protected": false
},
"onstartall": {
"required": false,
"label": "On start all",
"description": "Start VPS on start all action?",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"config": {
"required": false,
"label": "Config",
"description": "Custom configuration options",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": "Limit of maximum CPU usage",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"start_menu_timeout": {
"required": false,
"label": "Start menu timeout",
"description": "Number of seconds the start menu waits for the user",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"allow_admin_modifications": {
"required": false,
"label": "Allow admin modifications",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": "Dataset the VPS resides in",
"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"
}
},
"pool": {
"required": null,
"label": "Pool",
"description": "Storage pool the VPS resides in",
"type": "Resource",
"resource": [
"pool"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/pools",
"method": "GET",
"help": "/v6.0/pools?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"memory": {
"required": false,
"label": "Memory",
"description": "Minimally 512, maximally 16384, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": "Minimally 0, maximally 12288, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu": {
"required": false,
"label": "CPU",
"description": "Minimally 1, maximally 8, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"diskspace": {
"required": false,
"label": "Disk space",
"description": "Minimally 1024, maximally 10485760, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"in_rescue_mode": {
"required": false,
"label": "In rescue mode",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_diskspace": {
"required": false,
"label": "Used disk space",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"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
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "vpses"
},
"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": 150,
"user": {
"id": 1,
"name": "somebody"
},
"hostname": "thehostname",
"os_template": {
"id": 1,
"label": "Scientific Linux 6"
},
"info": "My very important VPS",
"dns_resolver": {
"id": 1
},
"node": {
"id": 1,
"name": "node1"
},
"onstartall": true
}
],
"status": true,
"message": null,
"errors": null,
"http_status": 200
}
],
"scope": "vps#index",
"path": "/v6.0/vpses",
"method": "GET",
"help": "/v6.0/vpses?method=GET"
}require 'haveapi-client'
client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "6.0")
reply = client.vps.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.vps.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->vps->index();
// $reply is an instance of \HaveAPI\Client\ResourceInstanceList$ haveapi-cli -u http://api.vpsfree.cz --version 6.0 vps index
VPS id: 150
User: (#1)
Hostname: thehostname
Manage hostname: -
OS template: Scientific Linux 6 (#1)
Cgroup_version: -
Info: My very important VPS
DNS resolver: (#1)
Node: (#1)
UID/GID mapping: -
Auto-start: -
Auto-start priority: -
On start all: true
Config: -
CPU limit: -
Start menu timeout: -
Allow admin modifications: -
Dataset: -
Pool: -
Created at: -
Memory: -
Swap: -
CPU: -
Disk space: -
Running: -
In rescue mode: -
Uptime: -
Loadavg: -
Process count: -
Cpu_user: -
Cpu_nice: -
Cpu_system: -
Cpu_idle: -
Cpu_iowait: -
Cpu_irq: -
Cpu_softirq: -
Used memory: -
Used swap: -
Used disk space: -
Maintenance lock: -
Maintenance reason: -
Object state: -
Expiration: -
Remind after: -
# 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/vps/actions/index
# Execute the action
$ echo 1 > exec
# Query the action's result
$ cat status
1$ curl --request GET \
--data-binary "{
\"vps\": {
}
}" \
'http://api.vpsfree.cz/v6.0/vpses'
{
"status": true,
"message": null,
"response": {
"vpses": [
{
"id": 150,
"user": {
"id": 1,
"name": "somebody"
},
"hostname": "thehostname",
"os_template": {
"id": 1,
"label": "Scientific Linux 6"
},
"info": "My very important VPS",
"dns_resolver": {
"id": 1
},
"node": {
"id": 1,
"name": "node1"
},
"onstartall": true
}
]
},
"errors": null
}GET /v6.0/vpses 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: 538
{
"status": true,
"message": null,
"response": {
"vpses": [
{
"id": 150,
"user": {
"id": 1,
"name": "somebody"
},
"hostname": "thehostname",
"os_template": {
"id": 1,
"label": "Scientific Linux 6"
},
"info": "My very important VPS",
"dns_resolver": {
"id": 1
},
"node": {
"id": 1,
"name": "node1"
},
"onstartall": true
}
]
},
"errors": null
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Node | node | yes | Resource | |||
| Replace IP addresses | replace_ip_addresses | no | Boolean | When migrating to another location, current IP addresses are replaced by addresses from the new location | ||
| Transfer IP addresses | transfer_ip_addresses | no | Boolean | If possible, keep IP addresses and recharge them to a different environment or location | ||
| Swap | swap | no | String | Include
|
enforce | |
| Maintenance window | maintenance_window | no | Boolean | true | Migrate the VPS within the nearest maintenance window | |
| Finish weekday | finish_weekday | no | Integer | Number
|
Prepare the migration and finish it on this day | |
| Finish minutes | finish_minutes | no | Integer | Number
|
Number of minutes from midnight of start_weekday after which the migration is done | |
| Cleanup data | cleanup_data | no | Boolean | true | Remove VPS dataset from the source node | |
| No start | no_start | no | Boolean | false | Do not start the VPS on the target node | |
| Skip start | skip_start | no | Boolean | false | Continue even if the VPS fails to start on the target node | |
| Send e-mails | send_mail | no | Boolean | true | Inform the VPS owner about migration progress | |
| Reason | reason | no | String |
No parameters.
{
"auth": true,
"description": "Migrate VPS to another node",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"node": {
"required": true,
"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"
}
},
"replace_ip_addresses": {
"required": false,
"label": "Replace IP addresses",
"description": "When migrating to another location, current IP addresses are replaced by addresses from the new location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"transfer_ip_addresses": {
"required": false,
"label": "Transfer IP addresses",
"description": "If possible, keep IP addresses and recharge them to a different environment or location",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"enforce"
],
"message": "%{value} cannot be used"
}
},
"default": "enforce",
"protected": false
},
"maintenance_window": {
"required": false,
"label": "Maintenance window",
"description": "Migrate the VPS within the nearest maintenance window",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"finish_weekday": {
"required": false,
"label": "Finish weekday",
"description": "Prepare the migration and finish it on this day",
"type": "Integer",
"validators": {
"number": {
"message": "has to be in range <0, 6>",
"min": 0,
"max": 6
}
},
"default": null,
"protected": false
},
"finish_minutes": {
"required": false,
"label": "Finish minutes",
"description": "Number of minutes from midnight of start_weekday after which the migration is done",
"type": "Integer",
"validators": {
"number": {
"message": "has to be in range <0, 1410>",
"min": 0,
"max": 1410
}
},
"default": null,
"protected": false
},
"cleanup_data": {
"required": false,
"label": "Cleanup data",
"description": "Remove VPS dataset from the source node",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"no_start": {
"required": false,
"label": "No start",
"description": "Do not start the VPS on the target node",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"skip_start": {
"required": false,
"label": "Skip start",
"description": "Continue even if the VPS fails to start on the target node",
"type": "Boolean",
"validators": {
},
"default": false,
"protected": false
},
"send_mail": {
"required": false,
"label": "Send e-mails",
"description": "Inform the VPS owner about migration progress",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#migrate",
"path": "/v6.0/vpses/{vps_id}/migrate",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/migrate?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Type | type | no | String | Include
|
secure |
| Label | Name | Type | Description |
|---|---|---|---|
| Password | password | String | Auto-generated password |
{
"auth": true,
"description": "Set root password",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"type": {
"required": false,
"label": "Type",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"secure",
"simple"
],
"message": "%{value} cannot be used"
}
},
"default": "secure",
"protected": false
}
},
"layout": "hash",
"namespace": "vps"
},
"output": {
"parameters": {
"password": {
"required": false,
"label": "Password",
"description": "Auto-generated password",
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "hash",
"namespace": "vps"
},
"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": [
],
"scope": "vps#passwd",
"path": "/v6.0/vpses/{vps_id}/passwd",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/passwd?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| OS template | os_template | no | Resource |
No parameters.
{
"auth": true,
"description": "Reinstall VPS",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#reinstall",
"path": "/v6.0/vpses/{vps_id}/reinstall",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/reinstall?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Node | node | no | Resource | Clone to node | ||
| Expiration_date | expiration_date | no | Datetime | How long should the original VPS be kept | ||
| Start | start | no | Boolean | true | Start thew new VPS | |
| Reason | reason | no | Text |
| Label | Name | Type | Description |
|---|---|---|---|
| VPS id | id | Integer | |
| User | user | Resource | VPS owner |
| Hostname | hostname | String | VPS hostname |
| Manage hostname | manage_hostname | Boolean | Determines whether vpsAdmin sets VPS hostname or not |
| OS template | os_template | Resource | |
| Cgroup_version | cgroup_version | String | |
| Info | info | String | VPS description |
| DNS resolver | dns_resolver | Resource | DNS resolver the VPS will use |
| Node | node | Resource | Node VPS will run on |
| UID/GID mapping | user_namespace_map | Resource | |
| Auto-start | autostart_enable | Boolean | Start VPS on node boot? |
| Auto-start priority | autostart_priority | Integer | 0 is the highest priority, greater numbers have lower priority |
| On start all | onstartall | Boolean | Start VPS on start all action? |
| Config | config | String | Custom configuration options |
| CPU limit | cpu_limit | Integer | Limit of maximum CPU usage |
| Start menu timeout | start_menu_timeout | Integer | Number of seconds the start menu waits for the user |
| Allow admin modifications | allow_admin_modifications | Boolean | |
| Dataset | dataset | Resource | Dataset the VPS resides in |
| Pool | pool | Resource | Storage pool the VPS resides in |
| Created at | created_at | Datetime | |
| Memory | memory | Integer | Minimally 512, maximally 16384, step size is 1 |
| Swap | swap | Integer | Minimally 0, maximally 12288, step size is 1 |
| CPU | cpu | Integer | Minimally 1, maximally 8, step size is 1 |
| Disk space | diskspace | Integer | Minimally 1024, maximally 10485760, step size is 1 |
| Running | is_running | Boolean | |
| In rescue mode | in_rescue_mode | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Used disk space | used_diskspace | Integer | in MB |
{
"auth": true,
"description": "Replace broken VPS",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"node": {
"required": null,
"label": "Node",
"description": "Clone to node",
"type": "Resource",
"resource": [
"node"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/nodes",
"method": "GET",
"help": "/v6.0/nodes?method=GET"
}
},
"expiration_date": {
"required": false,
"label": "Expiration_date",
"description": "How long should the original VPS be kept",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"start": {
"required": false,
"label": "Start",
"description": "Start thew new VPS",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "VPS id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "VPS 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"
}
},
"hostname": {
"required": false,
"label": "Hostname",
"description": "VPS hostname",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"manage_hostname": {
"required": false,
"label": "Manage hostname",
"description": "Determines whether vpsAdmin sets VPS hostname or not",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "VPS description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dns_resolver": {
"required": null,
"label": "DNS resolver",
"description": "DNS resolver the VPS will use",
"type": "Resource",
"resource": [
"dns_resolver"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"autostart_enable": {
"required": false,
"label": "Auto-start",
"description": "Start VPS on node boot?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"autostart_priority": {
"required": false,
"label": "Auto-start priority",
"description": "0 is the highest priority, greater numbers have lower priority",
"type": "Integer",
"validators": {
},
"default": 1000,
"protected": false
},
"onstartall": {
"required": false,
"label": "On start all",
"description": "Start VPS on start all action?",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"config": {
"required": false,
"label": "Config",
"description": "Custom configuration options",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": "Limit of maximum CPU usage",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"start_menu_timeout": {
"required": false,
"label": "Start menu timeout",
"description": "Number of seconds the start menu waits for the user",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"allow_admin_modifications": {
"required": false,
"label": "Allow admin modifications",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": "Dataset the VPS resides in",
"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"
}
},
"pool": {
"required": null,
"label": "Pool",
"description": "Storage pool the VPS resides in",
"type": "Resource",
"resource": [
"pool"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/pools",
"method": "GET",
"help": "/v6.0/pools?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"memory": {
"required": false,
"label": "Memory",
"description": "Minimally 512, maximally 16384, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": "Minimally 0, maximally 12288, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu": {
"required": false,
"label": "CPU",
"description": "Minimally 1, maximally 8, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"diskspace": {
"required": false,
"label": "Disk space",
"description": "Minimally 1024, maximally 10485760, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"in_rescue_mode": {
"required": false,
"label": "In rescue mode",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_diskspace": {
"required": false,
"label": "Used disk space",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#replace",
"path": "/v6.0/vpses/{vps_id}/replace",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/replace?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Restart VPS",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#restart",
"path": "/v6.0/vpses/{vps_id}/restart",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/restart?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": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#set_maintenance",
"path": "/v6.0/vpses/{vps_id}/set_maintenance",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/set_maintenance?method=POST"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| VPS id | id | Integer | |
| User | user | Resource | VPS owner |
| Hostname | hostname | String | VPS hostname |
| Manage hostname | manage_hostname | Boolean | Determines whether vpsAdmin sets VPS hostname or not |
| OS template | os_template | Resource | |
| Cgroup_version | cgroup_version | String | |
| Info | info | String | VPS description |
| DNS resolver | dns_resolver | Resource | DNS resolver the VPS will use |
| Node | node | Resource | Node VPS will run on |
| UID/GID mapping | user_namespace_map | Resource | |
| Auto-start | autostart_enable | Boolean | Start VPS on node boot? |
| Auto-start priority | autostart_priority | Integer | 0 is the highest priority, greater numbers have lower priority |
| On start all | onstartall | Boolean | Start VPS on start all action? |
| Config | config | String | Custom configuration options |
| CPU limit | cpu_limit | Integer | Limit of maximum CPU usage |
| Start menu timeout | start_menu_timeout | Integer | Number of seconds the start menu waits for the user |
| Allow admin modifications | allow_admin_modifications | Boolean | |
| Dataset | dataset | Resource | Dataset the VPS resides in |
| Pool | pool | Resource | Storage pool the VPS resides in |
| Created at | created_at | Datetime | |
| Memory | memory | Integer | Minimally 512, maximally 16384, step size is 1 |
| Swap | swap | Integer | Minimally 0, maximally 12288, step size is 1 |
| CPU | cpu | Integer | Minimally 1, maximally 8, step size is 1 |
| Disk space | diskspace | Integer | Minimally 1024, maximally 10485760, step size is 1 |
| Running | is_running | Boolean | |
| In rescue mode | in_rescue_mode | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Used memory | used_memory | Integer | in MB |
| Used swap | used_swap | Integer | in MB |
| Used disk space | used_diskspace | Integer | in MB |
| Maintenance lock | maintenance_lock | String | |
| Maintenance reason | maintenance_lock_reason | String | |
| Object state | object_state | String | |
| Expiration | expiration_date | Datetime | A date after which the state will progress |
| Remind after | remind_after_date | Datetime | Mail warnings are silenced until this date |
{
"auth": true,
"description": "Show VPS properties",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "VPS id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"user": {
"required": null,
"label": "User",
"description": "VPS 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"
}
},
"hostname": {
"required": false,
"label": "Hostname",
"description": "VPS hostname",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"manage_hostname": {
"required": false,
"label": "Manage hostname",
"description": "Determines whether vpsAdmin sets VPS hostname or not",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "VPS description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dns_resolver": {
"required": null,
"label": "DNS resolver",
"description": "DNS resolver the VPS will use",
"type": "Resource",
"resource": [
"dns_resolver"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"autostart_enable": {
"required": false,
"label": "Auto-start",
"description": "Start VPS on node boot?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"autostart_priority": {
"required": false,
"label": "Auto-start priority",
"description": "0 is the highest priority, greater numbers have lower priority",
"type": "Integer",
"validators": {
},
"default": 1000,
"protected": false
},
"onstartall": {
"required": false,
"label": "On start all",
"description": "Start VPS on start all action?",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"config": {
"required": false,
"label": "Config",
"description": "Custom configuration options",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": "Limit of maximum CPU usage",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"start_menu_timeout": {
"required": false,
"label": "Start menu timeout",
"description": "Number of seconds the start menu waits for the user",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"allow_admin_modifications": {
"required": false,
"label": "Allow admin modifications",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"dataset": {
"required": null,
"label": "Dataset",
"description": "Dataset the VPS resides in",
"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"
}
},
"pool": {
"required": null,
"label": "Pool",
"description": "Storage pool the VPS resides in",
"type": "Resource",
"resource": [
"pool"
],
"value_id": "id",
"value_label": "name",
"value": null,
"choices": {
"path": "/v6.0/pools",
"method": "GET",
"help": "/v6.0/pools?method=GET"
}
},
"created_at": {
"required": false,
"label": "Created at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"memory": {
"required": false,
"label": "Memory",
"description": "Minimally 512, maximally 16384, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": "Minimally 0, maximally 12288, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu": {
"required": false,
"label": "CPU",
"description": "Minimally 1, maximally 8, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"diskspace": {
"required": false,
"label": "Disk space",
"description": "Minimally 1024, maximally 10485760, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"in_rescue_mode": {
"required": false,
"label": "In rescue mode",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_diskspace": {
"required": false,
"label": "Used disk space",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"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
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#show",
"path": "/v6.0/vpses/{vps_id}",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}?method=GET"
}No parameters.
No parameters.
{
"auth": true,
"description": "Start VPS",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#start",
"path": "/v6.0/vpses/{vps_id}/start",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/start?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Stop VPS",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#stop",
"path": "/v6.0/vpses/{vps_id}/stop",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/stop?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| VPS | vps | yes | Resource | Swap with this VPS | ||
| Resources | resources | no | Boolean | Swap resources (CPU, memory and swap, not disk space) | ||
| Hostname | hostname | no | Boolean | Swap hostname | ||
| Expirations | expirations | no | Boolean | Swap expirations |
No parameters.
{
"auth": true,
"description": "Swap VPS with another",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"vps": {
"required": true,
"label": "VPS",
"description": "Swap with this 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"
}
},
"resources": {
"required": false,
"label": "Resources",
"description": "Swap resources (CPU, memory and swap, not disk space)",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"hostname": {
"required": false,
"label": "Hostname",
"description": "Swap hostname",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"expirations": {
"required": false,
"label": "Expirations",
"description": "Swap expirations",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#swap_with",
"path": "/v6.0/vpses/{vps_id}/swap_with",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/swap_with?method=POST"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| User | user | no | Resource | VPS owner | ||
| Hostname | hostname | no | String | Format
|
VPS hostname | |
| Manage hostname | manage_hostname | no | Boolean | Determines whether vpsAdmin sets VPS hostname or not | ||
| OS template | os_template | no | Resource | |||
| Cgroup_version | cgroup_version | no | String | Include
|
cgroup_any | |
| Info | info | no | String | VPS description | ||
| DNS resolver | dns_resolver | no | Resource | DNS resolver the VPS will use | ||
| Node | node | no | Resource | Node VPS will run on | ||
| UID/GID mapping | user_namespace_map | no | Resource | |||
| Auto-start | autostart_enable | no | Boolean | Start VPS on node boot? | ||
| Auto-start priority | autostart_priority | no | Integer | Number
|
1000 | 0 is the highest priority, greater numbers have lower priority |
| On start all | onstartall | no | Boolean | true | Start VPS on start all action? | |
| Config | config | no | String | Custom configuration options | ||
| CPU limit | cpu_limit | no | Integer | Number
|
Limit of maximum CPU usage | |
| Start menu timeout | start_menu_timeout | no | Integer | Number
|
Number of seconds the start menu waits for the user | |
| Allow admin modifications | allow_admin_modifications | no | Boolean | |||
| CPU | cpu | no | Integer | Minimally 1, maximally 8, step size is 1 | ||
| Memory | memory | no | Integer | Minimally 512, maximally 16384, step size is 1 | ||
| Swap | swap | no | Integer | Minimally 0, maximally 12288, step size is 1 | ||
| Change reason | change_reason | no | Text | If filled, it is send to VPS owner in an email | ||
| 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 | |
| Object state | object_state | no | String | Include
|
||
| Expiration | expiration_date | no | Datetime | A date after which the state will progress | ||
| Remind after | remind_after_date | no | Datetime | Mail warnings are silenced until this date |
No parameters.
{
"auth": true,
"description": "Update VPS",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"user": {
"required": null,
"label": "User",
"description": "VPS 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"
}
},
"hostname": {
"required": false,
"label": "Hostname",
"description": "VPS hostname",
"type": "String",
"validators": {
"format": {
"rx": "\\A[a-zA-Z0-9][a-zA-Z\\-_.0-9]{0,62}[a-zA-Z0-9]\\z",
"match": true,
"description": null,
"message": "bad format"
}
},
"default": null,
"protected": false
},
"manage_hostname": {
"required": false,
"label": "Manage hostname",
"description": "Determines whether vpsAdmin sets VPS hostname or not",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"os_template": {
"required": null,
"label": "OS template",
"description": null,
"type": "Resource",
"resource": [
"os_template"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/os_templates",
"method": "GET",
"help": "/v6.0/os_templates?method=GET"
}
},
"cgroup_version": {
"required": false,
"label": "Cgroup_version",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"cgroup_any",
"cgroup_v1",
"cgroup_v2"
],
"message": "%{value} cannot be used"
}
},
"default": "cgroup_any",
"protected": false
},
"info": {
"required": false,
"label": "Info",
"description": "VPS description",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"dns_resolver": {
"required": null,
"label": "DNS resolver",
"description": "DNS resolver the VPS will use",
"type": "Resource",
"resource": [
"dns_resolver"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/dns_resolvers",
"method": "GET",
"help": "/v6.0/dns_resolvers?method=GET"
}
},
"node": {
"required": null,
"label": "Node",
"description": "Node VPS will run on",
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID mapping",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"autostart_enable": {
"required": false,
"label": "Auto-start",
"description": "Start VPS on node boot?",
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"autostart_priority": {
"required": false,
"label": "Auto-start priority",
"description": "0 is the highest priority, greater numbers have lower priority",
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": 1000,
"protected": false
},
"onstartall": {
"required": false,
"label": "On start all",
"description": "Start VPS on start all action?",
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
},
"config": {
"required": false,
"label": "Config",
"description": "Custom configuration options",
"type": "String",
"validators": {
},
"default": "",
"protected": false
},
"cpu_limit": {
"required": false,
"label": "CPU limit",
"description": "Limit of maximum CPU usage",
"type": "Integer",
"validators": {
"number": {
"message": "has to be minimally 0",
"min": 0
}
},
"default": null,
"protected": false
},
"start_menu_timeout": {
"required": false,
"label": "Start menu timeout",
"description": "Number of seconds the start menu waits for the user",
"type": "Integer",
"validators": {
"number": {
"message": "has to be in range <0, 86400>",
"min": 0,
"max": 86400
}
},
"default": null,
"protected": false
},
"allow_admin_modifications": {
"required": false,
"label": "Allow admin modifications",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"cpu": {
"required": false,
"label": "CPU",
"description": "Minimally 1, maximally 8, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"memory": {
"required": false,
"label": "Memory",
"description": "Minimally 512, maximally 16384, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"swap": {
"required": false,
"label": "Swap",
"description": "Minimally 0, maximally 12288, step size is 1",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"change_reason": {
"required": false,
"label": "Change reason",
"description": "If filled, it is send to VPS owner in an email",
"type": "Text",
"validators": {
},
"default": null,
"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
},
"object_state": {
"required": false,
"label": "Object state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"active",
"suspended",
"soft_delete",
"hard_delete",
"deleted"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration",
"description": "A date after which the state will progress",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after_date": {
"required": false,
"label": "Remind after",
"description": "Mail warnings are silenced until this date",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "vps"
},
"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": [
],
"scope": "vps#update",
"path": "/v6.0/vpses/{vps_id}",
"method": "PUT",
"help": "/v6.0/vpses/{vps_id}?method=PUT"
}Remote console tokens
No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Token | token | String | Authentication token |
| Expiration date | expiration | Datetime | A date after which the token becomes invalid |
{
"auth": true,
"description": null,
"aliases": [
"new"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "console_token"
},
"output": {
"parameters": {
"token": {
"required": false,
"label": "Token",
"description": "Authentication token",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"expiration": {
"required": false,
"label": "Expiration date",
"description": "A date after which the token becomes invalid",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "console_token"
},
"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": [
],
"scope": "vps.console_token#create",
"path": "/v6.0/vpses/{vps_id}/console_token",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/console_token?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": null,
"aliases": [
"destroy"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "console_token"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "console_token"
},
"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": [
],
"scope": "vps.console_token#delete",
"path": "/v6.0/vpses/{vps_id}/console_token",
"method": "DELETE",
"help": "/v6.0/vpses/{vps_id}/console_token?method=DELETE"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Token | token | String | Authentication token |
| Expiration date | expiration | Datetime | A date after which the token becomes invalid |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "console_token"
},
"output": {
"parameters": {
"token": {
"required": false,
"label": "Token",
"description": "Authentication token",
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"expiration": {
"required": false,
"label": "Expiration date",
"description": "A date after which the token becomes invalid",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "console_token"
},
"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": [
],
"scope": "vps.console_token#show",
"path": "/v6.0/vpses/{vps_id}/console_token",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/console_token?method=GET"
}Toggle VPS features
| 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 | |
| Name | name | String | |
| Label | label | String | |
| Enabled | enabled | Boolean |
{
"auth": true,
"description": "List VPS features",
"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": "feature"
},
"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
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "features"
},
"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": [
],
"scope": "vps.feature#index",
"path": "/v6.0/vpses/{vps_id}/features",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/features?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Name | name | String | |
| Label | label | String | |
| Enabled | enabled | Boolean |
{
"auth": true,
"description": "Show VPS feature",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "feature"
},
"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
},
"label": {
"required": false,
"label": "Label",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "feature"
},
"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": [
],
"scope": "vps.feature#show",
"path": "/v6.0/vpses/{vps_id}/features/{feature_id}",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/features/{feature_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Enabled | enabled | no | Boolean |
No parameters.
{
"auth": true,
"description": "Toggle VPS feature",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "feature"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "feature"
},
"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": [
],
"scope": "vps.feature#update",
"path": "/v6.0/vpses/{vps_id}/features/{feature_id}",
"method": "PUT",
"help": "/v6.0/vpses/{vps_id}/features/{feature_id}?method=PUT"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| # |
tun | no | Boolean | |||
| # |
fuse | no | Boolean | |||
| # |
ppp | no | Boolean | |||
| # |
kvm | no | Boolean | |||
| # |
lxc | no | Boolean | |||
| # |
apparmor_dirs | no | Boolean |
No parameters.
{
"auth": true,
"description": "Set all features at once",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"tun": {
"required": false,
"label": "#true}>",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"fuse": {
"required": false,
"label": "#true}>",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"ppp": {
"required": false,
"label": "#",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"kvm": {
"required": false,
"label": "#true}>",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"lxc": {
"required": false,
"label": "#",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"apparmor_dirs": {
"required": false,
"label": "#",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "feature"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "feature"
},
"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": [
],
"scope": "vps.feature#update_all",
"path": "/v6.0/vpses/{vps_id}/features/update_all",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/features/update_all?method=POST"
} Manage VPS maintenance windows
| 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 |
|---|---|---|---|
| Weekday | weekday | Integer | |
| Is_open | is_open | Boolean | |
| Opens_at | opens_at | Integer | |
| Closes_at | closes_at | Integer |
{
"auth": true,
"description": "List maintenance windows",
"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": "maintenance_window"
},
"output": {
"parameters": {
"weekday": {
"required": false,
"label": "Weekday",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"opens_at": {
"required": false,
"label": "Opens_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closes_at": {
"required": false,
"label": "Closes_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "maintenance_windows"
},
"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": [
],
"scope": "vps.maintenance_window#index",
"path": "/v6.0/vpses/{vps_id}/maintenance_windows",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/maintenance_windows?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Weekday | weekday | Integer | |
| Is_open | is_open | Boolean | |
| Opens_at | opens_at | Integer | |
| Closes_at | closes_at | Integer |
{
"auth": true,
"description": "Show maintenance window",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "maintenance_window"
},
"output": {
"parameters": {
"weekday": {
"required": false,
"label": "Weekday",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"opens_at": {
"required": false,
"label": "Opens_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closes_at": {
"required": false,
"label": "Closes_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "maintenance_window"
},
"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": [
],
"scope": "vps.maintenance_window#show",
"path": "/v6.0/vpses/{vps_id}/maintenance_windows/{maintenance_window_id}",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/maintenance_windows/{maintenance_window_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Is_open | is_open | no | Boolean | |||
| Opens_at | opens_at | no | Integer | |||
| Closes_at | closes_at | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Weekday | weekday | Integer | |
| Is_open | is_open | Boolean | |
| Opens_at | opens_at | Integer | |
| Closes_at | closes_at | Integer |
{
"auth": true,
"description": "Resize maintenance window",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"opens_at": {
"required": false,
"label": "Opens_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closes_at": {
"required": false,
"label": "Closes_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "maintenance_window"
},
"output": {
"parameters": {
"weekday": {
"required": false,
"label": "Weekday",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"opens_at": {
"required": false,
"label": "Opens_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closes_at": {
"required": false,
"label": "Closes_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "maintenance_window"
},
"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": [
],
"scope": "vps.maintenance_window#update",
"path": "/v6.0/vpses/{vps_id}/maintenance_windows/{maintenance_window_id}",
"method": "PUT",
"help": "/v6.0/vpses/{vps_id}/maintenance_windows/{maintenance_window_id}?method=PUT"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Is_open | is_open | no | Boolean | |||
| Opens_at | opens_at | no | Integer | |||
| Closes_at | closes_at | no | Integer |
| Label | Name | Type | Description |
|---|---|---|---|
| Weekday | weekday | Integer | |
| Is_open | is_open | Boolean | |
| Opens_at | opens_at | Integer | |
| Closes_at | closes_at | Integer |
{
"auth": true,
"description": "Update maintenance windows for all week days at once",
"aliases": [
],
"blocking": false,
"input": {
"parameters": {
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"opens_at": {
"required": false,
"label": "Opens_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closes_at": {
"required": false,
"label": "Closes_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "maintenance_window"
},
"output": {
"parameters": {
"weekday": {
"required": false,
"label": "Weekday",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"is_open": {
"required": false,
"label": "Is_open",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"opens_at": {
"required": false,
"label": "Opens_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"closes_at": {
"required": false,
"label": "Closes_at",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "maintenance_windows"
},
"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": [
],
"scope": "vps.maintenance_window#update_all",
"path": "/v6.0/vpses/{vps_id}/maintenance_windows",
"method": "PUT",
"help": "/v6.0/vpses/{vps_id}/maintenance_windows?method=PUT"
}Manage mounts
| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| Dataset | dataset | yes | Resource | |||
| UID/GID map | user_namespace_map | no | Resource | |||
| Mountpoint | mountpoint | no | String | |||
| Mode | mode | no | String | Include
|
rw | |
| On mount failure | on_start_fail | no | String | Include
|
What happens when the mount fails during VPS start | |
| Enabled | enabled | no | Boolean | true |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| UID/GID map | user_namespace_map | Resource | |
| Mountpoint | mountpoint | String | |
| Mode | mode | String | |
| On mount failure | on_start_fail | String | What happens when the mount fails during VPS start |
| Expiration date | expiration_date | Datetime | The mount is deleted when expiration date passes |
| Enabled | enabled | Boolean | |
| Master enabled | master_enabled | Boolean | |
| Current state | current_state | String |
{
"auth": true,
"description": "Mount local dataset to directory in VPS",
"aliases": [
"new"
],
"blocking": true,
"input": {
"parameters": {
"dataset": {
"required": true,
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID map",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"mountpoint": {
"required": false,
"label": "Mountpoint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mode": {
"required": false,
"label": "Mode",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"ro",
"rw"
],
"message": "%{value} cannot be used"
}
},
"default": "rw",
"protected": false
},
"on_start_fail": {
"required": false,
"label": "On mount failure",
"description": "What happens when the mount fails during VPS start",
"type": "String",
"validators": {
"include": {
"values": [
"skip",
"mount_later",
"fail_start",
"wait_for_mount"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": true,
"protected": false
}
},
"layout": "object",
"namespace": "mount"
},
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID map",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"mountpoint": {
"required": false,
"label": "Mountpoint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mode": {
"required": false,
"label": "Mode",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"ro",
"rw"
],
"message": "%{value} cannot be used"
}
},
"default": "rw",
"protected": false
},
"on_start_fail": {
"required": false,
"label": "On mount failure",
"description": "What happens when the mount fails during VPS start",
"type": "String",
"validators": {
"include": {
"values": [
"skip",
"mount_later",
"fail_start",
"wait_for_mount"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": "The mount is deleted when expiration date passes",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"master_enabled": {
"required": false,
"label": "Master enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current_state": {
"required": false,
"label": "Current state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"created",
"mounted",
"unmounted",
"skipped",
"delayed",
"waiting"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mount"
},
"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": [
],
"scope": "vps.mount#create",
"path": "/v6.0/vpses/{vps_id}/mounts",
"method": "POST",
"help": "/v6.0/vpses/{vps_id}/mounts?method=POST"
}No parameters.
No parameters.
{
"auth": true,
"description": "Delete mount from VPS",
"aliases": [
"destroy"
],
"blocking": true,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mount"
},
"output": {
"parameters": {
},
"layout": "object",
"namespace": "mount"
},
"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": [
],
"scope": "vps.mount#delete",
"path": "/v6.0/vpses/{vps_id}/mounts/{mount_id}",
"method": "DELETE",
"help": "/v6.0/vpses/{vps_id}/mounts/{mount_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 | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| UID/GID map | user_namespace_map | Resource | |
| Mountpoint | mountpoint | String | |
| Mode | mode | String | |
| On mount failure | on_start_fail | String | What happens when the mount fails during VPS start |
| Expiration date | expiration_date | Datetime | The mount is deleted when expiration date passes |
| Enabled | enabled | Boolean | |
| Master enabled | master_enabled | Boolean | |
| Current state | current_state | String |
{
"auth": true,
"description": "List mounts",
"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": "mount"
},
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID map",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"mountpoint": {
"required": false,
"label": "Mountpoint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mode": {
"required": false,
"label": "Mode",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"ro",
"rw"
],
"message": "%{value} cannot be used"
}
},
"default": "rw",
"protected": false
},
"on_start_fail": {
"required": false,
"label": "On mount failure",
"description": "What happens when the mount fails during VPS start",
"type": "String",
"validators": {
"include": {
"values": [
"skip",
"mount_later",
"fail_start",
"wait_for_mount"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": "The mount is deleted when expiration date passes",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"master_enabled": {
"required": false,
"label": "Master enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current_state": {
"required": false,
"label": "Current state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"created",
"mounted",
"unmounted",
"skipped",
"delayed",
"waiting"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "mounts"
},
"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": [
],
"scope": "vps.mount#index",
"path": "/v6.0/vpses/{vps_id}/mounts",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/mounts?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| UID/GID map | user_namespace_map | Resource | |
| Mountpoint | mountpoint | String | |
| Mode | mode | String | |
| On mount failure | on_start_fail | String | What happens when the mount fails during VPS start |
| Expiration date | expiration_date | Datetime | The mount is deleted when expiration date passes |
| Enabled | enabled | Boolean | |
| Master enabled | master_enabled | Boolean | |
| Current state | current_state | String |
{
"auth": true,
"description": "Show mount",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "mount"
},
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID map",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"mountpoint": {
"required": false,
"label": "Mountpoint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mode": {
"required": false,
"label": "Mode",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"ro",
"rw"
],
"message": "%{value} cannot be used"
}
},
"default": "rw",
"protected": false
},
"on_start_fail": {
"required": false,
"label": "On mount failure",
"description": "What happens when the mount fails during VPS start",
"type": "String",
"validators": {
"include": {
"values": [
"skip",
"mount_later",
"fail_start",
"wait_for_mount"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": "The mount is deleted when expiration date passes",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"master_enabled": {
"required": false,
"label": "Master enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current_state": {
"required": false,
"label": "Current state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"created",
"mounted",
"unmounted",
"skipped",
"delayed",
"waiting"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mount"
},
"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": [
],
"scope": "vps.mount#show",
"path": "/v6.0/vpses/{vps_id}/mounts/{mount_id}",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/mounts/{mount_id}?method=GET"
}| Label | Name | Required | Type | Validators | Default | Description |
|---|---|---|---|---|---|---|
| On mount failure | on_start_fail | no | String | Include
|
What happens when the mount fails during VPS start | |
| Enabled | enabled | no | Boolean | |||
| Master enabled | master_enabled | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| VPS | vps | Resource | |
| Dataset | dataset | Resource | |
| UID/GID map | user_namespace_map | Resource | |
| Mountpoint | mountpoint | String | |
| Mode | mode | String | |
| On mount failure | on_start_fail | String | What happens when the mount fails during VPS start |
| Expiration date | expiration_date | Datetime | The mount is deleted when expiration date passes |
| Enabled | enabled | Boolean | |
| Master enabled | master_enabled | Boolean | |
| Current state | current_state | String |
{
"auth": true,
"description": "Update a mount",
"aliases": [
],
"blocking": true,
"input": {
"parameters": {
"on_start_fail": {
"required": false,
"label": "On mount failure",
"description": "What happens when the mount fails during VPS start",
"type": "String",
"validators": {
"include": {
"values": [
"skip",
"mount_later",
"fail_start",
"wait_for_mount"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"master_enabled": {
"required": false,
"label": "Master enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mount"
},
"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"
}
},
"user_namespace_map": {
"required": null,
"label": "UID/GID map",
"description": null,
"type": "Resource",
"resource": [
"user_namespace_map"
],
"value_id": "id",
"value_label": "label",
"value": null,
"choices": {
"path": "/v6.0/user_namespace_maps",
"method": "GET",
"help": "/v6.0/user_namespace_maps?method=GET"
}
},
"mountpoint": {
"required": false,
"label": "Mountpoint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"mode": {
"required": false,
"label": "Mode",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"ro",
"rw"
],
"message": "%{value} cannot be used"
}
},
"default": "rw",
"protected": false
},
"on_start_fail": {
"required": false,
"label": "On mount failure",
"description": "What happens when the mount fails during VPS start",
"type": "String",
"validators": {
"include": {
"values": [
"skip",
"mount_later",
"fail_start",
"wait_for_mount"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
},
"expiration_date": {
"required": false,
"label": "Expiration date",
"description": "The mount is deleted when expiration date passes",
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"enabled": {
"required": false,
"label": "Enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"master_enabled": {
"required": false,
"label": "Master enabled",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"current_state": {
"required": false,
"label": "Current state",
"description": null,
"type": "String",
"validators": {
"include": {
"values": [
"created",
"mounted",
"unmounted",
"skipped",
"delayed",
"waiting"
],
"message": "%{value} cannot be used"
}
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "mount"
},
"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": [
],
"scope": "vps.mount#update",
"path": "/v6.0/vpses/{vps_id}/mounts/{mount_id}",
"method": "PUT",
"help": "/v6.0/vpses/{vps_id}/mounts/{mount_id}?method=PUT"
}View VPS SSH host keys
| 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 | ||
| Algorithm | algorithm | no | String |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Bits | bits | Integer | |
| Fingerprint | fingerprint | String | |
| Algorithm | algorithm | String | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_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": null,
"protected": false
},
"algorithm": {
"required": false,
"label": "Algorithm",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "ssh_host_key"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bits": {
"required": false,
"label": "Bits",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"fingerprint": {
"required": false,
"label": "Fingerprint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"algorithm": {
"required": false,
"label": "Algorithm",
"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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "ssh_host_keys"
},
"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": [
],
"scope": "vps.ssh_host_key#index",
"path": "/v6.0/vpses/{vps_id}/ssh_host_keys",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/ssh_host_keys?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Bits | bits | Integer | |
| Fingerprint | fingerprint | String | |
| Algorithm | algorithm | String | |
| Created_at | created_at | Datetime | |
| Updated_at | updated_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "ssh_host_key"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"bits": {
"required": false,
"label": "Bits",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"fingerprint": {
"required": false,
"label": "Fingerprint",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"algorithm": {
"required": false,
"label": "Algorithm",
"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
},
"updated_at": {
"required": false,
"label": "Updated_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "ssh_host_key"
},
"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": [
],
"scope": "vps.ssh_host_key#show",
"path": "/v6.0/vpses/{vps_id}/ssh_host_keys/{ssh_host_key_id}",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/ssh_host_keys/{ssh_host_key_id}?method=GET"
}Browse object's state log
| 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 | |
| State | state | String | |
| Changed_at | changed_at | Datetime | |
| Expiration | expiration | Datetime | |
| Remind_after | remind_after | Datetime | |
| User | user | Resource | |
| Reason | reason | Text |
{
"auth": true,
"description": "List object state changes",
"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": "state_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"changed_at": {
"required": false,
"label": "Changed_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"expiration": {
"required": false,
"label": "Expiration",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after": {
"required": false,
"label": "Remind_after",
"description": null,
"type": "Datetime",
"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"
}
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "state_logs"
},
"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": [
],
"scope": "vps.state_log#index",
"path": "/v6.0/vpses/{vps_id}/state_logs",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/state_logs?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| State | state | String | |
| Changed_at | changed_at | Datetime | |
| Expiration | expiration | Datetime | |
| Remind_after | remind_after | Datetime | |
| User | user | Resource | |
| Reason | reason | Text |
{
"auth": true,
"description": "Show object state change",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "state_log"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"state": {
"required": false,
"label": "State",
"description": null,
"type": "String",
"validators": {
},
"default": null,
"protected": false
},
"changed_at": {
"required": false,
"label": "Changed_at",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"expiration": {
"required": false,
"label": "Expiration",
"description": null,
"type": "Datetime",
"validators": {
},
"default": null,
"protected": false
},
"remind_after": {
"required": false,
"label": "Remind_after",
"description": null,
"type": "Datetime",
"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"
}
},
"reason": {
"required": false,
"label": "Reason",
"description": null,
"type": "Text",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "state_log"
},
"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": [
],
"scope": "vps.state_log#show",
"path": "/v6.0/vpses/{vps_id}/state_logs/{state_log_id}",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/state_logs/{state_log_id}?method=GET"
}View VPS statuses in time
| 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 | |||
| Status | status | no | Boolean | |||
| Is_running | is_running | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Status | status | Boolean | |
| Running | is_running | Boolean | |
| In rescue mode | in_rescue_mode | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpus | cpus | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Total_memory | total_memory | Integer | |
| Used memory | used_memory | Integer | in MB |
| Total_swap | total_swap | Integer | |
| Used swap | used_swap | Integer | in MB |
| 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
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Is_running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "status"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"in_rescue_mode": {
"required": false,
"label": "In rescue mode",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"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": "statuses"
},
"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": [
],
"scope": "vps.status#index",
"path": "/v6.0/vpses/{vps_id}/statuses",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/statuses?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Status | status | Boolean | |
| Running | is_running | Boolean | |
| In rescue mode | in_rescue_mode | Boolean | |
| Uptime | uptime | Integer | |
| Loadavg | loadavg | Float | |
| Process count | process_count | Integer | |
| Cpus | cpus | Integer | |
| Cpu_user | cpu_user | Float | |
| Cpu_nice | cpu_nice | Float | |
| Cpu_system | cpu_system | Float | |
| Cpu_idle | cpu_idle | Float | |
| Cpu_iowait | cpu_iowait | Float | |
| Cpu_irq | cpu_irq | Float | |
| Cpu_softirq | cpu_softirq | Float | |
| Total_memory | total_memory | Integer | |
| Used memory | used_memory | Integer | in MB |
| Total_swap | total_swap | Integer | |
| Used swap | used_swap | Integer | in MB |
| Created_at | created_at | Datetime |
{
"auth": true,
"description": null,
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "status"
},
"output": {
"parameters": {
"id": {
"required": false,
"label": "Id",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"status": {
"required": false,
"label": "Status",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"is_running": {
"required": false,
"label": "Running",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"in_rescue_mode": {
"required": false,
"label": "In rescue mode",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
},
"uptime": {
"required": false,
"label": "Uptime",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"loadavg": {
"required": false,
"label": "Loadavg",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"process_count": {
"required": false,
"label": "Process count",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpus": {
"required": false,
"label": "Cpus",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"cpu_user": {
"required": false,
"label": "Cpu_user",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_nice": {
"required": false,
"label": "Cpu_nice",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_system": {
"required": false,
"label": "Cpu_system",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_idle": {
"required": false,
"label": "Cpu_idle",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_iowait": {
"required": false,
"label": "Cpu_iowait",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_irq": {
"required": false,
"label": "Cpu_irq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"cpu_softirq": {
"required": false,
"label": "Cpu_softirq",
"description": null,
"type": "Float",
"validators": {
},
"default": null,
"protected": false
},
"total_memory": {
"required": false,
"label": "Total_memory",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_memory": {
"required": false,
"label": "Used memory",
"description": "in MB",
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"total_swap": {
"required": false,
"label": "Total_swap",
"description": null,
"type": "Integer",
"validators": {
},
"default": null,
"protected": false
},
"used_swap": {
"required": false,
"label": "Used swap",
"description": "in MB",
"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": "status"
},
"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": [
],
"scope": "vps.status#show",
"path": "/v6.0/vpses/{vps_id}/statuses/{status_id}",
"method": "GET",
"help": "/v6.0/vpses/{vps_id}/statuses/{status_id}?method=GET"
}Browse VPSes 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 | |||
| VPS | vps | no | Resource | |||
| User | user | no | Resource | |||
| Environment | environment | no | Resource | |||
| Location | location | no | Resource | |||
| Node | node | no | Resource | |||
| Direct | direct | no | Boolean |
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| VPS | vps | Resource | |
| User | user | Resource | |
| Environment | environment | Resource | |
| Location | location | Resource | |
| Node | node | Resource | |
| Direct | direct | Boolean |
{
"auth": true,
"description": "List VPSes 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"
}
},
"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"
}
},
"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"
}
},
"direct": {
"required": false,
"label": "Direct",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps_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"
}
},
"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"
}
},
"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"
}
},
"direct": {
"required": false,
"label": "Direct",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object_list",
"namespace": "vps_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": [
],
"scope": "vps_outage#index",
"path": "/v6.0/vps_outages",
"method": "GET",
"help": "/v6.0/vps_outages?method=GET"
}No parameters.
| Label | Name | Type | Description |
|---|---|---|---|
| Id | id | Integer | |
| Outage | outage | Resource | |
| VPS | vps | Resource | |
| User | user | Resource | |
| Environment | environment | Resource | |
| Location | location | Resource | |
| Node | node | Resource | |
| Direct | direct | Boolean |
{
"auth": true,
"description": "Show VPS affected by an outage",
"aliases": [
"find"
],
"blocking": false,
"input": {
"parameters": {
},
"layout": "object",
"namespace": "vps_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"
}
},
"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"
}
},
"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"
}
},
"direct": {
"required": false,
"label": "Direct",
"description": null,
"type": "Boolean",
"validators": {
},
"default": null,
"protected": false
}
},
"layout": "object",
"namespace": "vps_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": [
],
"scope": "vps_outage#show",
"path": "/v6.0/vps_outages/{vps_outage_id}",
"method": "GET",
"help": "/v6.0/vps_outages/{vps_outage_id}?method=GET"
}Generated by HaveAPI v0.23.0